Nomad
Command: recommendation list
The recommendation list
command is used to list the available recommendations.
Recommendation commands are only available with Nomad Enterprise.
Usage
nomad recommendation list [options]
The recommendation list
command requires no arguments.
When ACLs are enabled, this command requires a token with the submit-job
,
read-job
, and submit-recommendation
capabilities for the namespace being
queried.
General Options
-address=<addr>
: The address of the Nomad server. Overrides theNOMAD_ADDR
environment variable if set. Defaults tohttp://127.0.0.1:4646
.-region=<region>
: The region of the Nomad server to forward commands to. Overrides theNOMAD_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 theNOMAD_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 theNOMAD_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 theNOMAD_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 theNOMAD_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 theNOMAD_CLIENT_KEY
environment variable if set.-tls-server-name=<value>
: The server name to use as the SNI host when connecting via TLS. Overrides theNOMAD_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 ifNOMAD_SKIP_VERIFY
is set.-token
: The SecretID of an ACL token to use to authenticate API requests with. Overrides theNOMAD_TOKEN
environment variable if set.
List Options
-job
: Specifies the job ID to filter the recommendations list by.-group
: Specifies the task group name to filter within a job. If specified, the-job
flag must also be specified.-task
: Specifies the task name to filter within a job and task group. If specified, the-job
and-group
flags must also be specified.-json
: Output the recommendations in its JSON format.-t
: Format and display the recommendations using a Go template.
Examples
List all available recommendations:
$ nomad recommendation list
ID Job Group Task Resource Value
ea130ac3-1410-cfe0-f34d-adc3ca94712d example cache-lb nginx CPU 57
68236421-c90f-efa6-fc02-37ae2d59bf03 example cache redis CPU 57
980c2554-7a1b-0c51-933a-f46850a228bd example cache redis MemoryMB 10
List all available recommendations for the job example
and the task group cache
:
$ nomad recommendation list -job=example -group=cache
ID Job Group Task Resource Value
68236421-c90f-efa6-fc02-37ae2d59bf03 example cache redis CPU 57
980c2554-7a1b-0c51-933a-f46850a228bd example cache redis MemoryMB 10