github.com/ferranbt/nomad@v0.9.3-0.20190607002617-85c449b7667c/website/source/docs/commands/job/periodic-force.html.md.erb (about)

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