nomad alloc pause command reference

Override the schedule for tasks using time based execution.

Usage

nomad alloc pause [options] <allocation> <command>

The alloc pause command allows a user to override the schedule for tasks that use time based execution. A user may override a task's schedule and force it to run or stop. The schedule will be ignored until a user resets the override.

When ACLs are enabled, this command requires the job-submit capability for the allocation'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.

Pause options

• -state: Override the current scheduled task state to be the specified state or reset to the scheduled state. Must be one of pause, run, or scheduled. When set to pause the task is halted. When set to run the task is started. When set to scheduled the task respects its schedule.

• -status: Get the current time based task execution state.

• -task: Override the schedule of the specified task. May also be specified as a positional argument.

• -verbose: Show full information.

Examples

The following command stops the schedtask task of the allocation 4d37a9d1 overriding the task's schedule block:

$ nomad alloc pause -state=pause 4d37a9d1 schedtask

The following command runs the task overriding the tasks current state or schedule:

$ nomad alloc pause -state=pause 4d37a9d1 schedtask

The following command returns the task to its schedule:

$ nomad alloc pause -state=scheduled 4d37a9d1 schedtask