1aceff7806
Most job subcommands allow for job ID prefix match as a convenience functionality so users don't have to type the full job ID. But this introduces a hard ACL requirement that the token used to run these commands have the `list-jobs` permission, even if the token has enough permission to execute the basic command action and the user passed an exact job ID. This change softens this requirement by not failing the prefix match in case the request results in a permission denied error and instead using the information passed by the user directly.
72 lines
2.3 KiB
Plaintext
72 lines
2.3 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: 'Commands: job periodic force'
|
|
description: >
|
|
The job periodic force command is used to force the evaluation of a periodic
|
|
job.
|
|
---
|
|
|
|
# Command: job periodic force
|
|
|
|
The `job periodic force` command is used to [force the evaluation] of a
|
|
[periodic job].
|
|
|
|
## Usage
|
|
|
|
```plaintext
|
|
nomad job periodic force [options] <job id>
|
|
```
|
|
|
|
The `job periodic force` command requires a single argument, specifying the ID
|
|
of the job. This job must be a periodic job. This is used to immediately run a
|
|
periodic job, even if it violates the job's `prohibit_overlap` setting.
|
|
|
|
By default, on successful job submission the command will enter an interactive
|
|
monitor and display log information detailing the scheduling decisions and
|
|
placement information for the forced evaluation. The monitor will exit after
|
|
scheduling has finished or failed.
|
|
|
|
When ACLs are enabled, this command requires a token with the `submit-job`
|
|
capability for the job's namespace. The `list-jobs` capability is required to
|
|
run the command with a job prefix instead of the exact job ID. The `read-job`
|
|
capability is required to monitor the resulting evaluation when `-detach` is
|
|
not used.
|
|
|
|
## General Options
|
|
|
|
@include 'general_options.mdx'
|
|
|
|
## Run Options
|
|
|
|
- `-detach`: Return immediately instead of monitoring. A new evaluation ID
|
|
will be output, which can be used to examine the evaluation using the
|
|
[eval status] command.
|
|
|
|
- `-verbose`: Show full information.
|
|
|
|
## Examples
|
|
|
|
Force the evaluation of the job `example`, monitoring placement:
|
|
|
|
```shell-session
|
|
$ nomad job periodic force example
|
|
==> Monitoring evaluation "54b2d6d9"
|
|
Evaluation triggered by job "example/periodic-1555094493"
|
|
Allocation "637aee17" created: node "a35ab8fc", group "cache"
|
|
Allocation "637aee17" status changed: "pending" -> "running" (Tasks are running)
|
|
Evaluation status changed: "pending" -> "complete"
|
|
==> Evaluation "54b2d6d9" finished with status "complete"
|
|
```
|
|
|
|
Force the evaluation of the job `example` and return immediately:
|
|
|
|
```shell-session
|
|
$ nomad job periodic force -detach example
|
|
Force periodic successful
|
|
Evaluation ID: 0865fbf3-30de-5f53-0811-821e73e63178
|
|
```
|
|
|
|
[eval status]: /nomad/docs/commands/eval/status
|
|
[force the evaluation]: /nomad/api-docs/jobs#force-new-periodic-instance
|
|
[periodic job]: /nomad/docs/job-specification/periodic
|