nomad scaling policy info command reference

Info is used to return detailed information on the specified scaling policy.

Usage

nomad scaling policy info [options] <policy_id>

If ACLs are enabled, this command requires a token with the read-job and list-jobs capabilities for the policy's namespace.

Options

• -json : Output the scaling policy in its JSON format.
• -t : Format and display the scaling policy using a Go template.

Examples

Inspect an individual scaling policy:

$ nomad scaling policy info 31a53813-24df-b2ad-77dc-1b4bad4e7dca

ID      = 31a53813-24df-b2ad-77dc-1b4bad4e7dca
Enabled = true
Target  = Namespace:default,Job:webapp,Group:demo
Min     = 1
Max     = 20

Policy:
{
    "check": [
        {
            "avg_sessions": [
                {
                    "query": "scalar(sum(traefik_entrypoint_open_connections{entrypoint=\"horizontal-webapp\"}))",
                    "source": "prometheus",
                    "strategy": [
                        {
                            "target-value": [
                                {
                                    "target": 10.0
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ],
    "cooldown": "1m",
    "evaluation_interval": "30s"
}

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.