HashiConf 2025 Don't miss the live stream of HashiConf Day 2 happening now View live stream
Nomad
Nomad Home

You are viewing documentation for pre-release version v1.11.0 (beta). View latest version.

Command: volume claim list

The volume claim list command displays all task group host volume claims. Stateful deployments use these claims.

Usage

nomad volume claim list [options] [claim_id]

This command accepts an optional claim ID or prefix as the sole argument. If there is an exact match based on the provided volume ID or prefix, then the command displays information about the specific claim. Otherwise, the command displays a list of matching claims.

If you omit the ID, the command lists out all of the existing claims and a few of the most useful status fields for each.

When ACLs are enabled, this command requires a token with the host-volume-read capability in the volume's namespace.

Options

  • -job: Show only volume claims from a particular job ID.

  • -group: Show only volume claims from a particular task group name.

  • -volume-name: Show only volume claims from a particular volume name.

  • -verbose: Display full information.

Examples

List of all task group host volume claim for job ID "example".

$ nomad volume claim list -job=example
ID        Namespace  Job ID   Volume ID  Volume Name
81b43af2  default    example  18377894   sticky-volume
7ce38017  default    example  c3c27514   example-volume

List of all task group host volume claims, prefix by 81. .

$ nomad volume claim list 81
ID        Namespace  Job ID   Volume ID  Volume Name
81b43af2  default    example  18377894   sticky-volume

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.