News HashiCorp to join IBM to accelerate multi-cloud automation. Read the blog →
Nomad
Nomad Home

You are viewing documentation for version v1.5.x. View latest version.

Command: alloc stop

The alloc stop command allows a user to perform an in-place restart of an entire allocation or individual task.

Usage

nomad alloc stop [options] <allocation>

The alloc stop command requires a single argument, specifying the alloc ID or prefix to stop. If there is an exact match based on the provided alloc ID or prefix, then the alloc will be stopped and rescheduled. Otherwise, a list of matching allocs and information will be displayed.

Stop will issue a request to stop and reschedule the allocation. An interactive monitoring session will display log lines as the allocation completes shutting down. It is safe to exit the monitor early with ctrl-c.

When ACLs are enabled, this command requires a token with the alloc-lifecycle, read-job, and list-jobs capabilities 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 '*', 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_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.

Stop Options

  • -detach: Return immediately instead of entering monitor mode. After the stop command is submitted, a new evaluation ID is printed to the screen, which can be used to examine the rescheduling evaluation using the eval status command.

  • -verbose: Display verbose output.

  • -no-shutdown-delay Ignore the group and task shutdown_delay configuration 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 allocation being stopped.

Examples

$ nomad alloc stop c1488bb5==> Monitoring evaluation "26172081"    Evaluation triggered by job "example"    Allocation "4dcb1c98" created: node "b4dc52b9", group "cache"    Evaluation within deployment: "c0c594d0"    Evaluation status changed: "pending" -> "complete"==> Evaluation "26172081" finished with status "complete" $ nomad alloc stop -detach eb17e5578a91f0f3-9d6b-ac83-479a-5aa186ab7795