github.com/jrxfive/nomad@v0.6.1-0.20170802162750-1fef470e89bf/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          Submit Date
    47  job1     service  80        running         07/25/17 15:47:11 UTC
    48  job2     batch    40        complete        07/24/17 19:22:11 UTC
    49  job3     service  50        dead (stopped)  07/22/17 16:34:48 UTC
    50  ```
    51  
    52  Short view of a specific job:
    53  
    54  ```
    55  $ nomad status -short job1
    56  ID            = job1
    57  Name          = Test Job
    58  Submit Date   = 07/25/17 15:47:11 UTC
    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  Submit Date   = 07/25/17 15:53:04 UTC
    74  Type          = service
    75  Priority      = 50
    76  Datacenters   = dc1
    77  Status        = running
    78  Periodic      = false
    79  Parameterized = false
    80  
    81  Summary
    82  Task Group  Queued  Starting  Running  Failed  Complete  Lost
    83  cache       0       0         1        0       0         0
    84  
    85  Latest Deployment
    86  ID          = 6294be0c
    87  Status      = successful
    88  Description = Deployment completed successfully
    89  
    90  Deployed
    91  Task Group  Desired  Placed  Healthy  Unhealthy
    92  cache       1        1       1        0
    93  
    94  Allocations
    95  ID        Node ID   Task Group  Version  Desired  Status   Created At
    96  478ce836  5ed166e8  cache       0        run      running  07/25/17 15:53:04 UTC
    97  ```
    98  
    99  Full status information of a perodic job:
   100  
   101  ```
   102  $ nomad status example
   103  ID                   = example
   104  Name                 = example
   105  Submit Date          = 07/25/17 15:59:52 UTC
   106  Type                 = batch
   107  Priority             = 50
   108  Datacenters          = dc1
   109  Status               = running
   110  Periodic             = true
   111  Parameterized        = false
   112  Next Periodic Launch = 07/25/17 16:00:30 UTC (5s from now)
   113  
   114  Children Job Summary
   115  Pending  Running  Dead
   116  0        3        0
   117  
   118  Previously Launched Jobs
   119  ID                           Status
   120  example/periodic-1500998400  running
   121  example/periodic-1500998410  running
   122  example/periodic-1500998420  running
   123  ```
   124  
   125  Full status information of a parameterized job:
   126  
   127  ```
   128  $ nomad status example
   129  ID            = example
   130  Name          = example
   131  Submit Date   = 07/25/17 15:59:52 UTC
   132  Type          = batch
   133  Priority      = 50
   134  Datacenters   = dc1
   135  Status        = running
   136  Periodic      = false
   137  Parameterized = true
   138  
   139  Parameterized Job
   140  Payload           = required
   141  Required Metadata = foo
   142  Optional Metadata = bar
   143  
   144  Parameterized Job Summary
   145  Pending  Running  Dead
   146  0        2        0
   147  
   148  Dispatched Jobs
   149  ID                                    Status
   150  example/dispatch-1485411496-58f24d2d  running
   151  example/dispatch-1485411499-fa2ee40e  running
   152  ```
   153  
   154  Full status information of a job with placement failures:
   155  
   156  ```
   157  $ nomad status example
   158  ID            = example
   159  Name          = example
   160  Submit Date   = 07/25/17 15:55:27 UTC
   161  Type          = service
   162  Priority      = 50
   163  Datacenters   = dc1
   164  Status        = running
   165  Periodic      = false
   166  Parameterized = false
   167  
   168  Summary
   169  Task Group  Queued  Starting  Running  Failed  Complete  Lost
   170  cache       1       0         4        0       0         0
   171  
   172  Placement Failure
   173  Task Group "cache":
   174    * Resources exhausted on 1 nodes
   175    * Dimension "cpu exhausted" exhausted on 1 nodes
   176  
   177  Latest Deployment
   178  ID          = bb4b2fb1
   179  Status      = running
   180  Description = Deployment is running
   181  
   182  Deployed
   183  Task Group  Desired  Placed  Healthy  Unhealthy
   184  cache       5        4       4        0
   185  
   186  Allocations
   187  ID        Node ID   Task Group  Version  Desired  Status   Created At
   188  048c1e9e  3f38ecb4  cache       0        run      running  07/25/17 15:55:27 UTC
   189  250f9dec  3f38ecb4  cache       0        run      running  07/25/17 15:55:27 UTC
   190  2eb772a1  3f38ecb4  cache       0        run      running  07/25/17 15:55:27 UTC
   191  a17b7d3d  3f38ecb4  cache       0        run      running  07/25/17 15:55:27 UTC
   192  ```
   193  
   194  Full status information showing evaluations with a placement failure. The in
   195  progress evaluation denotes that Nomad is blocked waiting for resources to
   196  become availables so that it can place the remaining allocations.
   197  
   198  ```
   199  $ nomad status -evals example
   200  ID            = example
   201  Name          = example
   202  Submit Date   = 07/25/17 15:55:27 UTC
   203  Type          = service
   204  Priority      = 50
   205  Datacenters   = dc1
   206  Status        = running
   207  Periodic      = false
   208  Parameterized = false
   209  
   210  Summary
   211  Task Group  Queued  Starting  Running  Failed  Complete  Lost
   212  cache       1       0         4        0       0         0
   213  
   214  Evaluations
   215  ID        Priority  Triggered By        Status    Placement Failures
   216  e44a39e8  50        deployment-watcher  canceled  false
   217  97018573  50        deployment-watcher  complete  true
   218  d5a7300c  50        deployment-watcher  canceled  false
   219  f05a4495  50        deployment-watcher  complete  true
   220  e3f3bdb4  50        deployment-watcher  canceled  false
   221  b5f08700  50        deployment-watcher  complete  true
   222  73bb867a  50        job-register        blocked   N/A - In Progress
   223  85052989  50        job-register        complete  true
   224  
   225  Placement Failure
   226  Task Group "cache":
   227    * Resources exhausted on 1 nodes
   228    * Dimension "cpu exhausted" exhausted on 1 nodes
   229  
   230  Latest Deployment
   231  ID          = bb4b2fb1
   232  Status      = running
   233  Description = Deployment is running
   234  
   235  Deployed
   236  Task Group  Desired  Placed  Healthy  Unhealthy
   237  cache       5        4       4        0
   238  
   239  Allocations
   240  ID        Node ID   Task Group  Version  Desired  Status   Created At
   241  048c1e9e  3f38ecb4  cache       0        run      running  07/25/17 15:55:27 UTC
   242  250f9dec  3f38ecb4  cache       0        run      running  07/25/17 15:55:27 UTC
   243  2eb772a1  3f38ecb4  cache       0        run      running  07/25/17 15:55:27 UTC
   244  a17b7d3d  3f38ecb4  cache       0        run      running  07/25/17 15:55:27 UTC
   245  ```