Command: job stop
job stop command is used to stop a running job and signals the scheduler
to cancel all the running allocations.
nomad job stop [options] <job 1> <job 2> ... <job N>
job stop command requires at least one job ID or prefix to stop. If there
is an exact match based on the provided job ID or prefix, then the job will be
cancelled. Otherwise, a list of matching jobs and information will be
Stop will issue a request to deregister the matched jobs and then invoke an interactive monitor that exits automatically once the scheduler has processed the requests. It is safe to exit the monitor early using ctrl+c.
When ACLs are enabled, this command requires a token with the
read-job capabilities for the job's namespace. The
capability is required to run the command with job prefixes instead of exact
-address=<addr>: The address of the Nomad server. Overrides the
NOMAD_ADDRenvironment variable if set. Defaults to
-region=<region>: The region of the Nomad server to forward commands to. Overrides the
NOMAD_REGIONenvironment 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_NAMESPACEenvironment variable if set. If set to
'*', job and alloc subcommands query all namespaces authorized to user. Defaults to the "default" namespace.
-no-color: Disables colored command output. Alternatively,
NOMAD_CLI_NO_COLORmay be set. This option takes precedence over
-force-color: Forces colored command output. This can be used in cases where the usual terminal detection fails. Alternatively,
NOMAD_CLI_FORCE_COLORmay be set. This option has no effect if
-no-coloris 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_CACERTenvironment 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-certis used. Overrides the
NOMAD_CAPATHenvironment 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_CERTenvironment 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_KEYenvironment 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_NAMEenvironment variable if set.
-tls-skip-verify: Do not verify TLS certificate. This is highly not recommended. Verification will also be skipped if
-token: The SecretID of an ACL token to use to authenticate API requests with. Overrides the
NOMAD_TOKENenvironment variable if set.
-detach: Return immediately instead of entering monitor mode. After the deregister command is submitted, a new evaluation ID is printed to the screen, which can be used to examine the evaluation using the eval status command.
-eval-priority: Override the priority of the evaluations produced as a result of this job deregistration. By default, this is set to the priority of the job.
-verbose: Show full information.
-yes: Automatic yes to prompts.
-purge: Purge is used to stop the job and purge it from the system. If not set, the job will still be queryable and will be purged by the garbage collector.
-globalStop a multi-region job in all its regions. By default,
job stopwill stop only a single region at a time. Ignored for single-region jobs.
-no-shutdown-delayIgnore the group and task
shutdown_delayconfiguration so that there is no delay between service deregistration and task shutdown. Note that using this flag will result in failed network connections to the allocations being stopped.
Stop the job with ID "job1":
$ nomad job stop job1 ==> Monitoring evaluation "43bfe672" Evaluation status changed: "pending" -> "complete" ==> Evaluation "43bfe672" finished with status "complete"
Stop multiple jobs:
$ nomad job stop job1 job2 ==> 2022-12-16T15:19:28-08:00: Monitoring evaluation "166c39c5" ==> 2022-12-16T15:19:28-08:00: Monitoring evaluation "049404c2" 2022-12-16T15:19:28-08:00: Evaluation triggered by job "job1" 2022-12-16T15:19:28-08:00: Evaluation triggered by job "job2" 2022-12-16T15:19:28-08:00: Evaluation within deployment: "90885ce7" 2022-12-16T15:19:28-08:00: Evaluation status changed: "pending" -> "complete" ==> 2022-12-16T15:19:28-08:00: Evaluation "166c39c5" finished with status "complete" ==> 2022-12-16T15:19:28-08:00: Monitoring deployment "90885ce7" ✓ Deployment "90885ce7" successful 2022-12-16T15:19:28-08:00 ID = 90885ce7 Job ID = job1 Job Version = 0 Status = successful Description = Deployment completed successfully Deployed Task Group Desired Placed Healthy Unhealthy Progress Deadline example 1 1 1 0 2022-12-16T15:29:03-08:00 ==> 2022-12-16T15:19:29-08:00: Monitoring evaluation "049404c2" 2022-12-16T15:19:29-08:00: Evaluation within deployment: "a13df8f8" 2022-12-16T15:19:29-08:00: Evaluation status changed: "pending" -> "complete" ==> 2022-12-16T15:19:29-08:00: Evaluation "049404c2" finished with status "complete" ==> 2022-12-16T15:19:29-08:00: Monitoring deployment "a13df8f8" ✓ Deployment "a13df8f8" successful 2022-12-16T15:19:29-08:00 ID = a13df8f8 Job ID = job2 Job Version = 0 Status = successful Description = Deployment completed successfully Deployed Task Group Desired Placed Healthy Unhealthy Progress Deadline example2 1 1 1 0 2022-12-16T15:29:16-08:00
Stop the job with ID "job1" and return immediately:
$ nomad job stop -detach job1 507d26cb