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.

nomad volume create command reference

The volume create command creates storage volumes as either Container Storage Interface (CSI) volumes or dynamic host volumes.

The volume create command can create dynamic host volumes if host volume plugins are installed on the node, or CSI volumes if the CSI plugins implement the Controller interface. The volume create command automatically registers the volume as well.

Usage

nomad volume create [options] [file]

The volume create command requires a single argument, specifying the path to a file containing a valid volume specification. Nomad reads the file and submits the volume to the server for placement. If the supplied path is "-", the volume file is read from STDIN. Otherwise the file is read from the file at the supplied path.

When ACLs are enabled, this command requires a token with the appropriate capability in the volume's namespace: the csi-write-volume capability for CSI volumes or host-volume-create for dynamic host volumes.

Options

  • -detach: Return immediately instead of entering monitor mode for dynamic host volumes. After creating a volume, Nomad prints the volume ID to the screen, which you can use to examine the volume using the volume status command. If -detach is omitted or false, the command monitors the state of the volume until it has been fingerprinted by the client and is ready to be scheduled. Not valid for CSI volumes.

  • -verbose: Display full information when monitoring volume state. Used for dynamic host volumes only. Not valid for CSI volumes.

  • -policy-override: Sets the flag to force override any soft mandatory Sentinel policies.

Volume specification

Refer to the CSI Volume Specification and the Dynamic Host Volume Specification for further information.

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.