open-nomad/website/source/docs/commands/status.html.md.erb

212 lines
5.6 KiB
Plaintext
Raw Normal View History

2015-09-15 03:24:04 +00:00
---
layout: "docs"
page_title: "Commands: status"
sidebar_current: "docs-commands-status"
description: >
Display information and status of jobs.
---
# Command: status
The `status` command displays status information for jobs.
## Usage
```
nomad status [options] [job]
```
This command accepts an optional job ID or prefix as the sole argument. If there
is an exact match based on the provided job ID or prefix, then information about
the specific job is queried and displayed. Otherwise, a list of matching jobs and
information will be displayed.
If the ID is omitted, the command lists out all of the existing jobs and a few of
the most useful status fields for each.
2015-09-15 03:24:04 +00:00
## General Options
2016-10-28 00:46:20 +00:00
<%= partial "docs/commands/_general_options" %>
2015-09-15 03:24:04 +00:00
## Status Options
2016-06-16 21:00:45 +00:00
* `-evals`: Display the evaluations associated with the job.
* `-short`: Display short output. Used only when a single node is being queried.
Drops verbose node allocation data from the output.
2016-06-16 21:00:45 +00:00
2016-01-19 23:01:26 +00:00
* `-verbose`: Show full information.
2015-09-15 03:24:04 +00:00
## Examples
List of all jobs:
2015-09-15 03:24:04 +00:00
```
$ nomad status
ID Type Priority Status
job1 service 3 pending
job2 service 3 running
job3 service 2 pending
job4 service 1 complete
```
Short view of a specific job:
```
$ nomad status -short job1
2017-01-26 06:21:51 +00:00
ID = job1
Name = Test Job
Type = service
Priority = 3
Datacenters = dc1,dc2,dc3
Status = pending
Periodic = false
Parameterized = false
```
Full status information of a job:
2015-09-15 03:24:04 +00:00
```
2016-06-16 21:00:45 +00:00
$ nomad status example
2017-01-26 06:21:51 +00:00
ID = example
Name = example
Type = service
Priority = 50
Datacenters = dc1
Status = running
Periodic = false
Parameterized = false
2016-06-16 21:00:45 +00:00
2016-08-08 00:38:29 +00:00
Summary
Task Group Queued Starting Running Failed Complete Lost
cache 0 0 1 0 0 0
2016-06-16 21:00:45 +00:00
Allocations
2016-08-16 02:40:34 +00:00
ID Eval ID Node ID Task Group Desired Status Created At
24cfd201 81efc2fa 8d0331e9 cache run running 08/08/16 21:03:19 CDT
2016-06-16 21:00:45 +00:00
```
2017-01-26 06:21:51 +00:00
Full status information of a perodic job:
```
ID = example
Name = example
Type = batch
Priority = 50
Datacenters = dc1
Status = running
Periodic = true
Parameterized = false
Next Periodic Launch = 01/26/17 06:19:46 UTC (1s from now)
Children Job Summary
Pending Running Dead
0 5 0
Previously Launched Jobs
ID Status
example/periodic-1485411581 running
example/periodic-1485411582 running
example/periodic-1485411583 running
example/periodic-1485411584 running
example/periodic-1485411585 running
```
Full status information of a parameterized job:
```
ID = example
Name = example
Type = batch
Priority = 50
Datacenters = dc1
Status = running
Periodic = false
Parameterized = true
Parameterized Job
Payload = required
Required Metadata = foo
Optional Metadata = bar
Parameterized Job Summary
Pending Running Dead
0 2 0
Dispatched Jobs
ID Status
example/dispatch-1485411496-58f24d2d running
example/dispatch-1485411499-fa2ee40e running
```
2016-06-16 21:00:45 +00:00
Full status information of a job with placement failures:
2016-06-16 21:00:45 +00:00
```
$ nomad status example
2017-01-26 06:21:51 +00:00
ID = example
Name = example
Type = service
Priority = 50
Datacenters = dc1
Status = running
Periodic = false
Parameterized = false
2016-06-16 21:00:45 +00:00
2016-08-08 00:38:29 +00:00
Summary
Task Group Queued Starting Running Failed Complete Lost
cache 0 0 5 0 0 0
2016-06-16 21:00:45 +00:00
Placement Failure
Task Group "cache":
* Resources exhausted on 1 nodes
* Dimension "cpu exhausted" exhausted on 1 nodes
Allocations
2016-08-16 02:40:34 +00:00
ID Eval ID Node ID Task Group Desired Status Created At
0b8b9e37 8bf94335 8d0331e9 cache run running 08/08/16 21:03:19 CDT
b206088c 8bf94335 8d0331e9 cache run running 08/08/16 21:03:18 CDT
b82f58b6 8bf94335 8d0331e9 cache run running 08/08/16 21:03:17 CDT
ed3665f5 8bf94335 8d0331e9 cache run running 08/08/16 21:03:21 CDT
24cfd201 8bf94335 8d0331e9 cache run running 08/08/16 21:03:19 CDT
2016-06-16 21:00:45 +00:00
```
Full status information showing evaluations with a placement failure. The in
progress evaluation denotes that Nomad is blocked waiting for resources to
become availables so that it can place the remaining allocations.
```
$ nomad status -evals example
2017-01-26 06:21:51 +00:00
ID = example
Name = example
Type = service
Priority = 50
Datacenters = dc1
Status = running
Periodic = false
Parameterized = false
2016-06-16 21:00:45 +00:00
2016-08-08 00:38:29 +00:00
Summary
Task Group Queued Starting Running Failed Complete Lost
cache 0 0 5 0 0 0
2016-06-16 21:00:45 +00:00
Evaluations
ID Priority Triggered By Status Placement Failures
69f34a37 50 job-register blocked N/A - In Progress
8bf94335 50 job-register complete true
df79bec7 50 job-register complete false
81efc2fa 50 job-register complete false
Placement Failure
Task Group "cache":
* Resources exhausted on 1 nodes
* Dimension "cpu exhausted" exhausted on 1 nodes
Allocations
2016-08-16 02:40:34 +00:00
ID Eval ID Node ID Task Group Desired Status Created At
0b8b9e37 8bf94335 8d0331e9 cache run running 08/08/16 21:03:19 CDT
b206088c 8bf94335 8d0331e9 cache run running 08/08/16 21:03:19 CDT
b82f58b6 8bf94335 8d0331e9 cache run running 08/08/16 21:03:19 CDT
ed3665f5 8bf94335 8d0331e9 cache run running 08/08/16 21:03:19 CDT
24cfd201 8bf94335 8d0331e9 cache run running 08/08/16 21:03:19 CDT
2015-09-15 03:24:04 +00:00
```