Type '/' to Search

»Command: service list

The service list command is used to list the registered Nomad services.

Service commands are new in Nomad 1.3.

»Usage

nomad service list [options]

nomad service list [options]

The service list command requires no arguments.

When ACLs are enabled, this command requires a token with the read-job capability for the namespace being queried.

The command supports the wildcard namespace identifier. Any namespaces that the token does not have access to will have its services filtered from the results.

»General Options

  • -address=<addr>: The address of the Nomad server. Overrides the NOMAD_ADDR environment variable if set. Defaults to http://127.0.0.1:4646.

  • -region=<region>: The region of the Nomad server to forward commands to. Overrides the NOMAD_REGION environment variable if set. Defaults to the Agent's local region.

  • -namespace=<namespace>: The target namespace for queries and actions bound to a namespace. Overrides the NOMAD_NAMESPACE environment variable if set. If set to '*', job and alloc subcommands query all namespaces authorized to user. Defaults to the "default" namespace.

  • -no-color: Disables colored command output. Alternatively, NOMAD_CLI_NO_COLOR may be set. This option takes precedence over -force-color.

  • -force-color: Forces colored command output. This can be used in cases where the usual terminal detection fails. Alternatively, NOMAD_CLI_FORCE_COLOR may be set. This option has no effect if -no-color is also used.

  • -ca-cert=<path>: Path to a PEM encoded CA cert file to use to verify the Nomad server SSL certificate. Overrides the NOMAD_CACERT environment variable if set.

  • -ca-path=<path>: Path to a directory of PEM encoded CA cert files to verify the Nomad server SSL certificate. If both -ca-cert and -ca-path are specified, -ca-cert is used. Overrides the NOMAD_CAPATH environment variable if set.

  • -client-cert=<path>: Path to a PEM encoded client certificate for TLS authentication to the Nomad server. Must also specify -client-key. Overrides the NOMAD_CLIENT_CERT environment variable if set.

  • -client-key=<path>: Path to an unencrypted PEM encoded private key matching the client certificate from -client-cert. Overrides the NOMAD_CLIENT_KEY environment variable if set.

  • -tls-server-name=<value>: The server name to use as the SNI host when connecting via TLS. Overrides the NOMAD_TLS_SERVER_NAME environment variable if set.

  • -tls-skip-verify: Do not verify TLS certificate. This is highly not recommended. Verification will also be skipped if NOMAD_SKIP_VERIFY is set.

  • -token: The SecretID of an ACL token to use to authenticate API requests with. Overrides the NOMAD_TOKEN environment variable if set.

»List Options

  • -json: Output the services in its JSON format.

  • -t: Format and display the services using a Go template.

»Examples

List all services in the default namespace:

$ nomad service list
Service Name         Tags
example-cache-redis  [cache,db]

$ nomad service list
Service Name         Tags
example-cache-redis  [cache,db]

List all services in all namespaces:

$ nomad service list -namespace="*"
Service Name                  Namespace  Tags
example-cache-redis           default    [cache,db]
platform-example-cache-redis  platform   []

$ nomad service list -namespace="*"
Service Name                  Namespace  Tags
example-cache-redis           default    [cache,db]
platform-example-cache-redis  platform   []