github.com/Ilhicas/nomad@v1.0.4-0.20210304152020-e86851182bc3/website/content/docs/commands/job/periodic-force.mdx (about)

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