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 version v1.8.x. View latest version.

Command: recommendation info

The recommendation info command is used to read the specified recommendation.

Recommendation commands are only available with Nomad Enterprise.

Usage

nomad recommendation info [options] <recommendation_id>

The recommendation info command requires a single argument, a recommendation ID.

When ACLs are enabled, this command requires a token with the read-job capability for the recommendation'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.

Info Options

  • -json : Output the recommendation in its JSON format.

  • -t : Format and display the recommendation using a Go template.

Examples

View the information of a specific recommendation:

$ nomad recommendation info 68236421-c90f-efa6-fc02-37ae2d59bf03
ID         = 68236421-c90f-efa6-fc02-37ae2d59bf03
Namespace  = default
Job ID     = example
Task Group = cache
Task       = redis
Resource   = CPU
Value      = 57
Current    = 500

Stats
max   mean  min   p99
5.89  1.66  0.44  5.89

Meta
nomad_policy_id       = e20dc742-dd5d-5419-8add-c5e0233933f5
num_evaluated_windows = 2
window_size           = 3e+11