News HashiCorp to join IBM to accelerate multi-cloud automation. Read the blog →
Nomad
Nomad Home

You are viewing documentation for version v1.6.x. View latest version.

Command: namespace status

The namespace status command is used to view the status of a particular namespace.

Tip

Visit the Nomad Namespaces tutorial for more information.

Usage

nomad namespace status [options] <namespace_name>

If ACLs are enabled, this command requires a management ACL token or a token that has a capability associated with the namespace.

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.

  • -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.

Status Options

  • -json : Output the namespace status in its JSON format.
  • -t : Format and display the namespace status using a Go template.

Examples

View the status of a namespace:

$ nomad namespace status defaultName            = api-prodDescription     = Prod API serversQuota           = prodEnabledDrivers  = docker,execDisabledDrivers = raw_exec Metadatacontact = platform-eng@example.com Quota LimitsRegion  CPU Usage   Memory Usageglobal  500 / 2500  256 / 2000

The -json flag can be used to get the namespace status in json format:

$ nomad namespace status -json default{    "Capabilities": null,    "CreateIndex": 1,    "Description": "Default shared namespace",    "Meta": null,    "ModifyIndex": 1,    "Name": "default",    "Quota": ""} Or use the `-t` flag to format and display the status using a Go template: ```shell-session$ nomad namespace status -t {{.Description}} defaultDefault shared namespace