Command: alloc status

The alloc status command displays status information and metadata about an existing allocation and its tasks. It can be useful while debugging to reveal the underlying reasons for scheduling decisions or failures, as well as the current state of its tasks.

Usage

nomad alloc status [options] <allocation>

An allocation ID or prefix must be provided. If there is an exact match, the full details of the allocation will be displayed. Otherwise, a list of matching allocations and information will be displayed.

When ACLs are enabled, this command requires a token with the read-job and list-jobs capabilities for the allocation's 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.
-namespace=<namespace>: The target namespace for queries and actions bound to a namespace. Overrides the NOMAD_NAMESPACE environment variable if set. If set to '*', subcommands which support this functionality 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.

Alloc Status Options

-short: Display short output. Shows only the most recent task event.
-verbose: Show full information.
-json : Output the allocation in its JSON format.
-t : Format and display the allocation using a Go template.

Examples

Short status of an alloc:

$ nomad alloc status --short 0af996edID                  = 0af996edEval ID             = be9bde98Name                = example.cache[0]Node ID             = 43c0b14eJob ID              = exampleJob Version         = 0Client Status       = runningClient Description  = <none>Desired Status      = runDesired Description = <none>Created At          = 07/25/17 16:12:48 UTCDeployment ID       = 0c83a3b1Deployment Health   = healthy TasksName   State    Last Event  Timeredis  running  Started     07/25/17 16:12:48 UTCweb    running  Started     07/25/17 16:12:49 UTC

Full status of an alloc, which shows one of the tasks dying and then being restarted:

$ nomad alloc status 0af996edID                   = 0af996edEval ID              = be9bde98Name                 = example.cache[0]Node ID              = 43c0b14eJob ID               = exampleJob Version          = 0Client Status        = runningClient Description   = <none>Desired Status       = runDesired Description  = <none>Created              = 5m agoModified             = 5m agoDeployment ID        = 0c83a3b1Deployment Health    = healthyReplacement Alloc ID = 0bc894caReschedule Attempts  = 1/3 Task "redis" is "running"Task ResourcesCPU        Memory           Disk     Addresses1/500 MHz  6.3 MiB/256 MiB  300 MiB  db: 127.0.0.1:27908 CSI Volumes:ID            Plugin  Provider  Schedulable  Mount Optionsvol-4150af42  ebs0    aws.ebs   true         <none> Task Events:Started At     = 07/25/17 16:12:48 UTCFinished At    = N/ATotal Restarts = 0Last Restart   = N/A Recent Events:Time                   Type        Description07/25/17 16:12:48 UTC  Started     Task started by client07/25/17 16:12:48 UTC  Task Setup  Building Task Directory07/25/17 16:12:48 UTC  Received    Task received by client Task "web" is "running"Task ResourcesCPU        Memory           Disk     Addresses1/500 MHz  6.3 MiB/256 MiB  300 MiB  db: 127.0.0.1:30572 Task Events:Started At     = 07/25/17 16:12:49 UTCFinished At    = N/ATotal Restarts = 0Last Restart   = N/A Recent Events:07/25/17 16:12:49 UTC  Started     Task started by client07/25/17 16:12:48 UTC  Task Setup  Building Task Directory07/25/17 16:12:48 UTC  Received    Task received by client

Verbose status can also be accessed:

$ nomad alloc status -verbose 0af996edID                     = 0af996ed-aff4-8ddb-a566-e55ebf8969c9Eval ID                = be9bde98-0490-1beb-ced0-012d10ddf22eName                   = example.cache[0]Node ID                = 43c0b14e-7f96-e432-a7da-06605257ce0cJob ID                 = exampleJob Version            = 0Client Status          = runningClient Description     = <none>Desired Status         = runDesired Description    = <none>Created                = 07/25/17 16:12:48 UTCModified               = 07/25/17 16:12:48 UTCDeployment ID          = 0c83a3b1-8a7b-136b-0e11-8383dc6c9276Deployment Health      = healthyReschedule Eligibility = 2m from nowEvaluated Nodes        = 1Filtered Nodes         = 0Exhausted Nodes        = 0Allocation Time        = 38.474µsFailures               = 0 Task "redis" is "running"Task ResourcesCPU        Memory           Disk     Addresses1/500 MHz  6.3 MiB/256 MiB  300 MiB  db: 127.0.0.1:27908 Task Events:Started At     = 07/25/17 16:12:48 UTCFinished At    = N/ATotal Restarts = 0Last Restart   = N/A Recent Events:Time                   Type        Description07/25/17 16:12:48 UTC  Started     Task started by client07/25/17 16:12:48 UTC  Task Setup  Building Task Directory07/25/17 16:12:48 UTC  Received    Task received by client Task "web" is "running"Task ResourcesCPU        Memory           Disk     Addresses1/500 MHz  6.3 MiB/256 MiB  300 MiB  db: 127.0.0.1:30572 Task Events:Started At     = 07/25/17 16:12:49 UTCFinished At    = N/ATotal Restarts = 0Last Restart   = N/A Recent Events:Time                   Type        Description07/25/17 16:12:49 UTC  Started     Task started by client07/25/17 16:12:48 UTC  Task Setup  Building Task Directory07/25/17 16:12:48 UTC  Received    Task received by client