HashiTalks 2025 Learn about unique use cases, homelab setups, and best practices at scale at our 24-hour virtual knowledge sharing event. Register
Nomad
Nomad Home

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

nomad volume claim delete reference

The volume claim delete command deletes a task group host volume claim. Stateful deployments use these claims.

Usage

nomad volume claim delete [options] <claim_id>

This command accepts claim ID or prefix as the sole argument. The command deletes the claim if there is an exact match based on the provided claim ID or prefix, Otherwise, the command displays a list of matching claims and information.

When ACLs are enabled, this command requires a token with the host-volume-write capability in the volume'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.

Delete options

  • -y: Automatically answers "yes" to all the questions, making the deletion non-interactive. Defaults to "false."

Example

List all volumes.

$ nomad volume claim delete 3f25be9a

  If you delete a volume claim, the allocation that uses this claim to "stick"
  to a particular volume ID will no longer use it upon its next reschedule or
  migration. The deployment of the task group the allocation runs will still
  claim another feasible volume ID during reschedule or replacement.

[?] Are you sure you want to delete task group host volume claim 3f25be9a? [Y/n]
Task group host volume claim 3f25be9a-a2ee-3d7f-c248-45099fd54939 successfully deleted