github.com/anth0d/nomad@v0.0.0-20221214183521-ae3a0a2cad06/website/content/docs/commands/job/periodic-force.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: 'Commands: job periodic force'
     4  description: >
     5    The job periodic force command is used to force the evaluation of a periodic
     6    job.
     7  ---
     8  
     9  # Command: job periodic force
    10  
    11  The `job periodic force` command is used to [force the evaluation] of a
    12  [periodic job].
    13  
    14  ## Usage
    15  
    16  ```plaintext
    17  nomad job periodic force [options] <job id>
    18  ```
    19  
    20  The `job periodic force` command requires a single argument, specifying the ID
    21  of the job. This job must be a periodic job. This is used to immediately run a
    22  periodic job, even if it violates the job's `prohibit_overlap` setting.
    23  
    24  By default, on successful job submission the command will enter an interactive
    25  monitor and display log information detailing the scheduling decisions and
    26  placement information for the forced evaluation. The monitor will exit after
    27  scheduling has finished or failed.
    28  
    29  When ACLs are enabled, this command requires a token with the `submit-job`
    30  and `list-jobs` capabilities for the job's namespace.
    31  
    32  ## General Options
    33  
    34  @include 'general_options.mdx'
    35  
    36  ## Run Options
    37  
    38  - `-detach`: Return immediately instead of monitoring. A new evaluation ID
    39    will be output, which can be used to examine the evaluation using the
    40    [eval status] command.
    41  
    42  - `-verbose`: Show full information.
    43  
    44  ## Examples
    45  
    46  Force the evaluation of the job `example`, monitoring placement:
    47  
    48  ```shell-session
    49  $ nomad job periodic force example
    50  ==> Monitoring evaluation "54b2d6d9"
    51      Evaluation triggered by job "example/periodic-1555094493"
    52      Allocation "637aee17" created: node "a35ab8fc", group "cache"
    53      Allocation "637aee17" status changed: "pending" -> "running" (Tasks are running)
    54      Evaluation status changed: "pending" -> "complete"
    55  ==> Evaluation "54b2d6d9" finished with status "complete"
    56  ```
    57  
    58  Force the evaluation of the job `example` and return immediately:
    59  
    60  ```shell-session
    61  $ nomad job periodic force -detach example
    62  Force periodic successful
    63  Evaluation ID: 0865fbf3-30de-5f53-0811-821e73e63178
    64  ```
    65  
    66  [eval status]: /docs/commands/eval/status
    67  [force the evaluation]: /api-docs/jobs#force-new-periodic-instance
    68  [periodic job]: /docs/job-specification/periodic