HashiConf 2024 Now streaming live from Boston! Attend for free
Nomad
Nomad Home

You are viewing documentation for version v1.5.x. View latest version.

Nomad Commands (CLI)

Nomad is controlled via a very easy to use command-line interface (CLI). Nomad is only a single command-line application: nomad, which takes a subcommand such as "agent" or "status". The complete list of subcommands is in the navigation to the left.

The Nomad CLI is a well-behaved command line application. In erroneous cases, a non-zero exit status will be returned. It also responds to -h and --help as you would most likely expect.

To view a list of the available commands at any time, just run Nomad with no arguments. To get help for any specific subcommand, run the subcommand with the -h argument.

Each command has been conveniently documented on this website. Links to each command can be found on the left.

Autocomplete

Nomad's CLI supports command autocomplete. Autocomplete can be installed or uninstalled by running the following on bash, zsh or fish shells:

$ nomad -autocomplete-install
$ nomad -autocomplete-uninstall

Command Contexts

Nomad's CLI commands have implied contexts in their naming convention. Because the CLI is most commonly used to manipulate or query jobs, you can assume that any given command is working in that context unless the command name implies otherwise.

For example, the nomad job run command is used to run a new job, the nomad status command queries information about existing jobs, etc. Conversely, commands with a prefix in their name likely operate in a different context. Examples include the nomad agent-info or nomad node drain commands, which operate in the agent or node contexts respectively.

Remote Usage

The Nomad CLI may be used to interact with a remote Nomad cluster, even when the local machine does not have a running Nomad agent. To do so, set the NOMAD_ADDR environment variable or use the -address=<addr> flag when running commands.

$ NOMAD_ADDR=https://remote-address:4646 nomad status
$ nomad status -address=https://remote-address:4646

The provided address must be reachable from your local machine. There are a variety of ways to accomplish this (VPN, SSH Tunnel, etc). If the port is exposed to the public internet it is highly recommended to configure TLS.

Environment Variables

Nomad can use environment variables to configure command-line tool options. These environment variables can be overridden as needed using individual flags.

Connection Environment Variables

  • NOMAD_ADDR - The address of the Nomad server. Defaults to http://127.0.0.1:4646.

  • NOMAD_REGION - The region of the Nomad server to forward commands to. Defaults to the Agent's local region

  • NOMAD_NAMESPACE - The target namespace for queries and actions bound to a namespace. If set to *, job and alloc subcommands query all namespacecs authorized to user. Defaults to the "default" namespace.

  • NOMAD_HTTP_AUTH - (Optional) This allows users to supply "Basic" HTTP authentication scheme (RFC 7617) information in environments where the Nomad API is behind an authenticating proxy server.

ACL Environment Variables

  • NOMAD_TOKEN - The SecretID of an ACL token to use to authenticate API requests with.

CLI Environment Variables

mTLS Environment Variables

  • NOMAD_CLIENT_CERT - Path to a PEM encoded client certificate for TLS authentication to the Nomad server. Must also specify NOMAD_CLIENT_KEY.

  • NOMAD_CLIENT_KEY - Path to an unencrypted PEM encoded private key matching the client certificate from NOMAD_CLIENT_CERT.

  • NOMAD_CACERT - Path to a PEM encoded CA cert file to use to verify the Nomad server SSL certificate.

  • NOMAD_CAPATH - Path to a directory of PEM encoded CA cert files to verify the Nomad server SSL certificate. If both NOMAD_CACERT and NOMAD_CAPATH are specified, NOMAD_CACERT is used.

  • NOMAD_SKIP_VERIFY - Do not verify TLS certificate. This is highly not recommended.

  • NOMAD_TLS_SERVER_NAME - The server name to use as the SNI host when connecting via TLS.

Nomad Enterprise Licensing Environment Variables

  • NOMAD_LICENSE_PATH - An absolute path to a Nomad Enterprise license file, for example /etc/nomad.d/license.hclic.

  • NOMAD_LICENSE - The Nomad Enterprise license file contents as a string.