nomad operator utilization command reference

The operator utilization command allows Nomad Enterprise users to generate utilization reporting bundles. If you have disabled automated reporting, use this command to manually generate the report and send it to HashiCorp. Nomad takes a new snapshot when there are no snapshots from the past twenty-four hours.

If ACLs are enabled, this command requires a token with the operator:write capability.

Options

• -message (string; "") - Provide context about the conditions under which the report was generated and submitted. This message is not included in the utilization bundle but is included in the Nomad server logs.

• -output (string; "") - Specifies the output path for the bundle. Defaults to a time-based generated file name in the current working directory.

• -today-only (bool: false) - Include snapshots from the previous 24 hours, not historical snapshots.

Examples

Create a utilization reporting bundle that includes all persisted historical snapshots and has the default bundle name (nomad-utilization-<time_stamp>.json).

$ nomad operator utilization
Success! Utilization reporting bundle written to: nomad-utilization-2024-02-16T22-23-25Z.json

Create a utilization reporting bundle with a message about the bundle, and output the file at the specified path, /utilization/reports/latest.json.

$ nomad operator utilization \
    -message="Change Control 654987" \
    -output="/utilization/reports/latest.json"

Example output

Success! Utilization reporting bundle written to: /utilization/reports/latest.json

The message, Change Control 654987, is included in the server log, but not in the bundle.

Example entry in the server log

[INFO]  reporting: reporting bundle generated: message="Change Control 654987"

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.