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

Command: operator autopilot set-config

The Autopilot operator command is used to set the current Autopilot configuration. See the Autopilot Guide for more information about Autopilot.

Usage

nomad operator autopilot set-config [options]

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

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.

  • -no-color: Disables colored command output. Alternatively, NOMAD_CLI_NO_COLOR may be set.

  • -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.

Set Config Options

  • -cleanup-dead-servers - Specifies whether to enable automatic removal of dead servers upon the successful joining of new servers to the cluster. Must be one of [true|false].

  • -last-contact-threshold - Controls the maximum amount of time a server can go without contact from the leader before being considered unhealthy. Must be a duration value such as 200ms.

  • -max-trailing-logs - Controls the maximum number of log entries that a server can trail the leader by before being considered unhealthy.

  • -server-stabilization-time - Controls the minimum amount of time a server must be stable in the 'healthy' state before being added to the cluster. Only takes effect if all servers are running Raft protocol version 3 or higher. Must be a duration value such as 10s.

  • -disable-upgrade-migration - (Enterprise-only) Controls whether Nomad will avoid promoting new servers until it can perform a migration. Must be one of [true|false].

  • -redundancy-zone-tag- (Enterprise-only) Controls the redundancy_zone used for separating servers into different redundancy zones.

  • -upgrade-version-tag - (Enterprise-only) Controls the upgrade_version to use for version info when performing upgrade migrations. If left blank, the Nomad version will be used.

The output looks like this:

Configuration updated!

The return code will indicate success or failure.