nomad queue status command reference

The nomad queue status command reports the status of a node pool's batch job queue. For a dynamic priority queue, the command lists the tenants and their allocated resources.

Usage

nomad queue status [options]

For a dynamic priority queue, the queue status command lists each tenant that the queue tracks. For each tenant, the command shows the CPU in MHz and the memory in MB that Nomad allocated to the tenant's batch jobs next to the total for all tenants, and the tenant's percentage of the total. Refer to Tenant fairshare for details. To configure a dynamic priority queue, refer to Queue batch jobs.

The command reports status for dynamic priority queues only. For a first in, first out (FIFO) queue, the command returns Queue type "fifo" does not implement status and exits with code 255. When the node pool does not have a batch job queue, the command returns No batch job queue configured.

When ACLs are enabled, this command requires a token with operator:read permissions.

Options

• -node-pool: The node pool whose queue to inspect. This flag is required.

• -json: Output the status in JSON format.

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.

Examples

View the status of the dynamic priority queue of the batch node pool.

$ nomad queue status -node-pool batch
Batch Queue Status
Tenant  Resource  Current / Total  Percentage
team-a                             100
        cpu       600.00 / 600.00
        memory    256.00 / 256.00
team-b                             0
        cpu       0.00 / 600.00
        memory    0.00 / 256.00

View the status in JSON format.

$ nomad queue status -node-pool batch -json
[{"PercentageUsed":100,"TenantFairshare":{"cpu":600,"memory":256},"TenantID":"team-a","TotalFairshare":{"cpu":600,"memory":256}},{"PercentageUsed":0,"TenantFairshare":{"cpu":0,"memory":0},"TenantID":"team-b","TotalFairshare":{"cpu":600,"memory":256}}]