github.com/taylorchu/nomad@v0.5.3-rc1.0.20170407200202-db11e7dd7b55/website/source/docs/commands/status.html.md.erb (about)

     1  ---
     2  layout: "docs"
     3  page_title: "Commands: status"
     4  sidebar_current: "docs-commands-status"
     5  description: >
     6    Display information and status of jobs.
     7  ---
     8  
     9  # Command: status
    10  
    11  The `status` command displays status information for jobs.
    12  
    13  ## Usage
    14  
    15  ```
    16  nomad status [options] [job]
    17  ```
    18  
    19  This command accepts an optional job ID or prefix as the sole argument. If there
    20  is an exact match based on the provided job ID or prefix, then information about
    21  the specific job is queried and displayed. Otherwise, a list of matching jobs and
    22  information will be displayed.
    23  
    24  If the ID is omitted, the command lists out all of the existing jobs and a few of
    25  the most useful status fields for each.
    26  
    27  ## General Options
    28  
    29  <%= partial "docs/commands/_general_options" %>
    30  
    31  ## Status Options
    32  
    33  * `-evals`: Display the evaluations associated with the job.
    34  
    35  * `-short`: Display short output. Used only when a single node is being queried.
    36    Drops verbose node allocation data from the output.
    37  
    38  * `-verbose`: Show full information.
    39  
    40  ## Examples
    41  
    42  List of all jobs:
    43  
    44  ```
    45  $ nomad status
    46  ID     Type     Priority  Status
    47  job1   service  3         pending
    48  job2   service  3         running
    49  job3   service  2         pending
    50  job4   service  1         complete
    51  ```
    52  
    53  Short view of a specific job:
    54  
    55  ```
    56  $ nomad status -short job1
    57  ID            = job1
    58  Name          = Test Job
    59  Type          = service
    60  Priority      = 3
    61  Datacenters   = dc1,dc2,dc3
    62  Status        = pending
    63  Periodic      = false
    64  Parameterized = false
    65  ```
    66  
    67  Full status information of a job:
    68  
    69  ```
    70  $ nomad status example
    71  ID            = example
    72  Name          = example
    73  Type          = service
    74  Priority      = 50
    75  Datacenters   = dc1
    76  Status        = running
    77  Periodic      = false
    78  Parameterized = false
    79  
    80  Summary
    81  Task Group  Queued  Starting  Running  Failed  Complete  Lost
    82  cache       0       0         1        0       0         0
    83  
    84  Allocations
    85  ID        Eval ID   Node ID   Task Group  Desired  Status   Created At
    86  24cfd201  81efc2fa  8d0331e9  cache       run      running  08/08/16 21:03:19 CDT
    87  ```
    88  
    89  Full status information of a perodic job:
    90  
    91  ```
    92  ID                   = example
    93  Name                 = example
    94  Type                 = batch
    95  Priority             = 50
    96  Datacenters          = dc1
    97  Status               = running
    98  Periodic             = true
    99  Parameterized        = false
   100  Next Periodic Launch = 01/26/17 06:19:46 UTC (1s from now)
   101  
   102  Children Job Summary
   103  Pending  Running  Dead
   104  0        5        0
   105  
   106  Previously Launched Jobs
   107  ID                           Status
   108  example/periodic-1485411581  running
   109  example/periodic-1485411582  running
   110  example/periodic-1485411583  running
   111  example/periodic-1485411584  running
   112  example/periodic-1485411585  running
   113  ```
   114  
   115  Full status information of a parameterized job:
   116  
   117  ```
   118  ID            = example
   119  Name          = example
   120  Type          = batch
   121  Priority      = 50
   122  Datacenters   = dc1
   123  Status        = running
   124  Periodic      = false
   125  Parameterized = true
   126  
   127  Parameterized Job
   128  Payload           = required
   129  Required Metadata = foo
   130  Optional Metadata = bar
   131  
   132  Parameterized Job Summary
   133  Pending  Running  Dead
   134  0        2        0
   135  
   136  Dispatched Jobs
   137  ID                                    Status
   138  example/dispatch-1485411496-58f24d2d  running
   139  example/dispatch-1485411499-fa2ee40e  running
   140  ```
   141  
   142  Full status information of a job with placement failures:
   143  
   144  ```
   145  $ nomad status example
   146  ID            = example
   147  Name          = example
   148  Type          = service
   149  Priority      = 50
   150  Datacenters   = dc1
   151  Status        = running
   152  Periodic      = false
   153  Parameterized = false
   154  
   155  Summary
   156  Task Group  Queued  Starting  Running  Failed  Complete  Lost
   157  cache       0       0         5        0       0         0
   158  
   159  Placement Failure
   160  Task Group "cache":
   161    * Resources exhausted on 1 nodes
   162    * Dimension "cpu exhausted" exhausted on 1 nodes
   163  
   164  Allocations
   165  ID        Eval ID   Node ID   Task Group  Desired  Status   Created At
   166  0b8b9e37  8bf94335  8d0331e9  cache       run      running  08/08/16 21:03:19 CDT
   167  b206088c  8bf94335  8d0331e9  cache       run      running  08/08/16 21:03:18 CDT
   168  b82f58b6  8bf94335  8d0331e9  cache       run      running  08/08/16 21:03:17 CDT
   169  ed3665f5  8bf94335  8d0331e9  cache       run      running  08/08/16 21:03:21 CDT
   170  24cfd201  8bf94335  8d0331e9  cache       run      running  08/08/16 21:03:19 CDT
   171  ```
   172  
   173  Full status information showing evaluations with a placement failure. The in
   174  progress evaluation denotes that Nomad is blocked waiting for resources to
   175  become availables so that it can place the remaining allocations.
   176  
   177  ```
   178  $ nomad status -evals example
   179  ID            = example
   180  Name          = example
   181  Type          = service
   182  Priority      = 50
   183  Datacenters   = dc1
   184  Status        = running
   185  Periodic      = false
   186  Parameterized = false
   187  
   188  Summary
   189  Task Group  Queued  Starting  Running  Failed  Complete  Lost
   190  cache       0       0         5        0       0         0
   191  
   192  Evaluations
   193  ID        Priority  Triggered By  Status    Placement Failures
   194  69f34a37  50        job-register  blocked   N/A - In Progress
   195  8bf94335  50        job-register  complete  true
   196  df79bec7  50        job-register  complete  false
   197  81efc2fa  50        job-register  complete  false
   198  
   199  Placement Failure
   200  Task Group "cache":
   201    * Resources exhausted on 1 nodes
   202    * Dimension "cpu exhausted" exhausted on 1 nodes
   203  
   204  Allocations
   205  ID        Eval ID   Node ID   Task Group  Desired  Status   Created At
   206  0b8b9e37  8bf94335  8d0331e9  cache       run      running  08/08/16 21:03:19 CDT
   207  b206088c  8bf94335  8d0331e9  cache       run      running  08/08/16 21:03:19 CDT
   208  b82f58b6  8bf94335  8d0331e9  cache       run      running  08/08/16 21:03:19 CDT
   209  ed3665f5  8bf94335  8d0331e9  cache       run      running  08/08/16 21:03:19 CDT
   210  24cfd201  8bf94335  8d0331e9  cache       run      running  08/08/16 21:03:19 CDT
   211  ```