News HashiCorp to join IBM to accelerate multi-cloud automation. Read the blog →
Nomad
Nomad Home

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

Command: operator api

The operator api command allows easy access to Nomad's HTTP API similar to the popular curl program. Nomad's operator api command reads environment variables to dramatically ease HTTP API access compared to trying to manually write the same command with the third party curl command.

For example for the following environment:

NOMAD_TOKEN=d4434353-c797-19e4-a14d-4068241f86a4NOMAD_CACERT=$HOME/.nomad/ca.pemNOMAD_CLIENT_CERT=$HOME/.nomad/cli.pemNOMAD_CLIENT_KEY=$HOME/.nomad/client-key.pemNOMAD_TLS_SERVER_NAME=client.global.nomadNOMAD_ADDR=https://remote.client123.internal:4646

Accessing Nomad's /v1/jobs HTTP endpoint with nomad operator api would require:

nomad operator api /v1/jobs

Performing the same request using the external curl tool would require:

curl \  --cacert "$HOME/.nomad/ca.pem" \  --cert "$HOME/.nomad/client.pem" \  --key "$HOME/.nomad/client-key.pem" \  --connect-to "client.global.nomad:4646:remote.client123.internal:4646" \  -H "X-Nomad-Token: ${NOMAD_TOKEN}" \  https://client.global.nomad:4646/v1/jobs

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 '*', job and alloc subcommands 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.

Operator API Options

  • -dryrun: output a curl command instead of performing the HTTP request immediately. Note that you do not need the 3rd party curl command installed to use operator api. The curl output from -dryrun is intended for use in scripts or running in locations without a Nomad binary present.

  • -filter: Specifies an expression used to filter query results.

  • -H: Adds an additional HTTP header to the request. May be specified more than once. These headers take precedence over automatically set ones such as X-Nomad-Token.

  • -verbose: Output extra information to stderr similar to curl's --verbose flag.

  • -X: HTTP method of request. If there is data piped to stdin, then the method defaults to POST. Otherwise the method defaults to GET.

Examples

$ nomad operator api -verbose /v1/agent/members?pretty> GET http://127.0.0.1:4646/v1/agent/members?pretty=* Sending request and receiving response...< HTTP/1.1 200 OK< Date: Wed, 02 Mar 2022 01:10:59 GMT< Content-Type: application/json< Vary: Accept-Encoding{    "Members": [...  $ nomad operator api -region eu-west -filter 'Status == "completed"' -dryrun /v1/evaluationscurl \  -X GET \    http://127.0.0.1:4646/v1/evaluations?filter=.Status+%3D%3D+%22completed%22&region=eu-west