open-nomad/website/content/docs/commands/node/status.mdx

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

398 lines
11 KiB
Plaintext
Raw Normal View History

---
2020-02-06 23:45:31 +00:00
layout: docs
page_title: 'Commands: node status'
description: |
2018-03-22 17:56:06 +00:00
The node status command is used to display information about nodes.
---
2018-03-22 17:56:06 +00:00
# Command: node status
2018-03-22 17:56:06 +00:00
The `node status` command is used to display information about client nodes. A
node must first be registered with the servers before it will be visible in this
output.
## Usage
```plaintext
2018-03-22 17:56:06 +00:00
nomad node status [options] [node]
```
If no node ID is passed, then the command will enter "list mode" and dump a
high-level list of all known nodes. This list output contains less information
but is a good way to get a bird's-eye view of things.
If there is an exact match based on the provided node ID or prefix, then that
2016-06-16 21:47:06 +00:00
particular node will be queried, and detailed information will be displayed,
including resource usage statistics. Otherwise, a list of matching nodes and
information will be displayed. If running the command on a Nomad Client, the
`-self` flag is useful to quickly access the status of the local node.
If ACLs are enabled, this option requires a token with the 'node:read'
capability.
## General Options
@include 'general_options_no_namespace.mdx'
2018-03-22 17:56:06 +00:00
## Status Options
- `-self`: Query the status of the local node.
2016-06-16 21:47:06 +00:00
- `-stats`: Display detailed resource usage statistics.
2016-06-16 21:47:06 +00:00
- `-allocs`: When a specific node is not being queried, shows the number of
2016-06-16 21:47:06 +00:00
running allocations per node.
- `-short`: Display short output. Used only when querying a single node.
2016-06-16 21:47:06 +00:00
- `-verbose`: Show full information.
2016-08-05 17:51:22 +00:00
- `-per-page`: How many results to show per page.
- `-page-token`: Where to start pagination.
- `-filter`: Specifies an expression used to filter query results.
- `-os`: Display operating system name.
- `-quiet`: Display only node IDs.
- `-json` : Output the node in its JSON format.
2016-08-05 17:51:22 +00:00
- `-t` : Format and display node using a Go template.
2015-09-15 03:24:04 +00:00
## Examples
List view:
2020-05-18 20:53:06 +00:00
```shell-session
$ nomad node status
ID DC Name Class Drain Eligibility Status
a72dfba2 dc1 node1 <none> false eligible ready
1f3f03ea dc1 node2 <none> false eligible ready
```
List view, with operating system name:
```shell-session
$ nomad node status -os
ID DC Name Class OS Drain Eligibility Status
a72dfba2 dc1 node1 <none> ubuntu false eligible ready
f73e3993 dc1 node2 <none> centos false eligible ready
```
List view, with quiet:
```shell-session
$ nomad node status -quiet
820561cf-830d-b089-cg03-f2cfc4cecff7
07949e3a-4c25-e1bf-3dbh-984c2e28fec2
8bc2c581-37ba-dj08-9f67-53bc217f36f8
f35be281-85a5-d1e6-d268-6e8a6f0684df
```
**NOTE**: `-quiet` cannot be used in conjuction with `-verbose` or `-json`.
List view, with running allocations:
2020-05-18 20:53:06 +00:00
```shell-session
$ nomad node status -allocs
ID DC Name Class Drain Eligibility Status Running Allocs
4d2ba53b dc1 node1 <none> false eligible ready 1
34dfba32 dc1 node2 <none> false eligible ready 3
```
Single-node view in short mode:
2020-05-18 20:53:06 +00:00
```shell-session
$ nomad node status -short 1f3f03ea
2016-03-29 19:36:24 +00:00
ID = c754da1f
Name = nomad
Class = <none>
DC = dc1
Drain = false
Status = ready
2016-06-16 21:47:06 +00:00
Uptime = 17h2m25s
Allocations
ID Eval ID Job ID Task Group Desired Status Client Status
0b8b9e37 8bf94335 example cache run running
```
Full output for a single node:
2020-05-18 20:53:06 +00:00
```shell-session
$ nomad node status 1f3f03ea
2016-03-29 19:36:24 +00:00
ID = c754da1f
2016-06-16 21:47:06 +00:00
Name = nomad-server01
Class = <none>
DC = dc1
Drain = false
Status = ready
Uptime = 17h42m50s
Drivers
Driver Detected Healthy
docker false false
exec true true
java true true
qemu true true
raw_exec true true
rkt true true
2018-03-20 19:06:04 +00:00
Node Events
Time Subsystem Message
2018-03-29T17:24:42Z Driver: docker Driver docker is not detected
2018-05-12 00:26:25 +00:00
2018-03-29T17:23:42Z Cluster Node registered
2018-03-20 19:06:04 +00:00
2016-06-16 21:47:06 +00:00
Allocated Resources
CPU Memory Disk
500/2600 MHz 256 MiB/2.0 GiB 300 MiB/32 GiB
2016-06-16 21:47:06 +00:00
Allocation Resource Utilization
2016-08-07 10:03:57 +00:00
CPU Memory
430/2600 MHz 199 MiB/2.0 GiB
2016-06-16 21:47:06 +00:00
Host Resource Utilization
2016-08-07 10:03:57 +00:00
CPU Memory Disk
513/3000 MHz 551 MiB/2.4 GiB 4.2 GiB/52 GiB
2016-06-16 21:47:06 +00:00
Allocations
ID Eval ID Job ID Task Group Desired Status Client Status
7bff7214 b3a6b9d2 example cache run running
```
Using `-self` when on a Nomad Client:
2020-05-18 20:53:06 +00:00
```shell-session
$ nomad node status -self
2016-06-16 21:47:06 +00:00
ID = c754da1f
Name = nomad-client01
2016-03-29 19:36:24 +00:00
Class = <none>
DC = dc1
Drain = false
Status = ready
2016-06-16 21:47:06 +00:00
Uptime = 17h7m41s
2016-03-29 19:36:24 +00:00
Drivers
Driver Detected Healthy
docker false false
exec true true
java true true
qemu true true
raw_exec true true
rkt true true
2018-03-20 19:06:04 +00:00
Node Events
Time Subsystem Message
2018-03-29T17:24:42Z Driver: docker Driver docker is not detected
2018-05-12 00:26:25 +00:00
2018-03-29T17:23:42Z Cluster Node registered
2018-03-20 19:06:04 +00:00
2016-06-16 21:47:06 +00:00
Allocated Resources
CPU Memory Disk
2500/2600 MHz 1.3 GiB/2.0 GiB 1.5 GiB/32 GiB
2016-03-29 19:36:24 +00:00
2016-06-16 21:47:06 +00:00
Allocation Resource Utilization
2016-08-07 10:03:57 +00:00
CPU Memory
2200/2600 MHz 1.7 GiB/2.0 GiB
2016-06-16 21:47:06 +00:00
Host Resource Utilization
2016-08-07 10:03:57 +00:00
CPU Memory Disk
2430/3000 MHz 1.8 GiB/2.4 GiB 6.5 GiB/40 GiB
2016-06-16 21:47:06 +00:00
Allocations
2016-03-29 19:36:24 +00:00
ID Eval ID Job ID Task Group Desired Status Client Status
2016-06-16 21:47:06 +00:00
0b8b9e37 8bf94335 example cache run running
b206088c 8bf94335 example cache run running
b82f58b6 8bf94335 example cache run running
ed3665f5 8bf94335 example cache run running
24cfd201 8bf94335 example cache run running
2016-03-29 19:36:24 +00:00
```
You will note that in the above examples, the **Allocations** output contains
columns labeled **Desired Status** and **Client status**.
Desired Status represents the goal of the scheduler on the allocation with
the following valid statuses:
2020-02-06 23:45:31 +00:00
- _run_: The allocation should run
- _stop_: The allocation should stop
Client Status represents the emergent state of the allocation and include
the following:
2020-02-06 23:45:31 +00:00
- _pending_: The allocation is pending and will be running
2020-02-06 23:45:31 +00:00
- _running_: The allocation is currently running
2020-02-06 23:45:31 +00:00
- _complete_: The allocation was running and completed successfully
2020-02-06 23:45:31 +00:00
- _failed_: The allocation was running and completed with a non-zero exit code
2020-02-06 23:45:31 +00:00
- _lost_: The node that was running the allocation has failed or has been
partitioned
2016-06-16 21:47:06 +00:00
Using `-stats` to see detailed to resource usage information on the node:
2016-03-29 19:36:24 +00:00
2020-05-18 20:53:06 +00:00
```shell-session
$ nomad node status -stats c754da1f
2016-03-29 19:36:24 +00:00
ID = c754da1f
2016-06-16 21:47:06 +00:00
Name = nomad-client01
2016-03-29 19:36:24 +00:00
Class = <none>
DC = dc1
Drain = false
Status = ready
2016-06-16 21:47:06 +00:00
Uptime = 17h7m41s
Drivers
Driver Detected Healthy
docker false false
exec true true
java true true
qemu true true
raw_exec true true
rkt true true
2018-03-20 19:06:04 +00:00
Node Events
Time Subsystem Message
2018-03-29T17:24:42Z Driver: docker Driver docker is not detected
2018-05-12 00:26:25 +00:00
2018-03-29T17:23:42Z Cluster Node registered
2018-03-20 19:06:04 +00:00
2016-06-16 21:47:06 +00:00
Allocated Resources
CPU Memory Disk
2500/2600 MHz 1.3 GiB/2.0 GiB 1.5 GiB/32 GiB
2016-06-16 21:47:06 +00:00
Allocation Resource Utilization
2016-08-07 10:03:57 +00:00
CPU Memory
2200/2600 MHz 1.7 GiB/2.0 GiB
2016-06-16 21:47:06 +00:00
Host Resource Utilization
2016-08-07 10:03:57 +00:00
CPU Memory Disk
2430/3000 MHz 1.8 GiB/2.4 GiB 3.9 GiB/40 GiB
2016-06-16 21:47:06 +00:00
CPU Stats
CPU = cpu0
User = 96.94%
System = 1.02%
Idle = 2.04%
CPU = cpu1
User = 97.92%
System = 2.08%
Idle = 0.00%
Memory Stats
Total = 2.4 GiB
Available = 612 MiB
Used = 1.8 GiB
Free = 312 MiB
Disk Stats
Device = /dev/mapper/ubuntu--14--vg-root
MountPoint = /
Size = 38 GiB
Used = 3.9 GiB
Available = 32 GiB
Used Percent = 10.31%
Inodes Percent = 3.85%
Device = /dev/sda1
MountPoint = /boot
Size = 235 MiB
Used = 45 MiB
Available = 178 MiB
Used Percent = 19.17%
Inodes Percent = 0.48%
Allocations
2016-03-29 19:36:24 +00:00
ID Eval ID Job ID Task Group Desired Status Client Status
2016-06-16 21:47:06 +00:00
0b8b9e37 8bf94335 example cache run running
b206088c 8bf94335 example cache run running
b82f58b6 8bf94335 example cache run running
ed3665f5 8bf94335 example cache run running
24cfd201 8bf94335 example cache run running
2016-03-29 19:36:24 +00:00
```
To view verbose information about the node:
2020-05-18 20:53:06 +00:00
```shell-session
$ nomad node status -verbose c754da1f
2016-03-29 19:36:24 +00:00
ID = c754da1f-6337-b86d-47dc-2ef4c71aca14
Name = nomad
Class = <none>
DC = dc1
Drain = false
Status = ready
2016-06-16 21:47:06 +00:00
Uptime = 17h7m41s
Host Volumes
Name ReadOnly Source
CSI Volumes
ID Name Plugin ID Schedulable Access Mode Mount Options
402f2c83 vol plug true single-node-writer <none>
Drivers
Driver Detected Healthy Message Time
docker false false Driver docker is not detected 2018-03-29T17:24:42Z
exec true true <none> 2018-03-29T17:23:42Z
java true true <none> 2018-03-29T17:23:41Z
qemu true true <none> 2018-03-29T17:23:41Z
raw_exec true true <none> 2018-03-29T17:23:42Z
rkt true true <none> 2018-03-29T17:23:42Z
2018-03-20 19:06:04 +00:00
Node Events
Time Subsystem Message Details
2018-03-29T17:24:42Z Driver: docker Driver docker is not detected driver: docker,
2018-05-12 00:26:25 +00:00
2018-03-29T17:23:42Z Cluster Node registered <none>
2018-03-20 19:06:04 +00:00
2016-06-16 21:47:06 +00:00
Allocated Resources
CPU Memory Disk
2500/2600 MHz 1.3 GiB/2.0 GiB 1.5 GiB/32 GiB
2016-06-16 21:47:06 +00:00
Allocation Resource Utilization
2016-08-07 10:03:57 +00:00
CPU Memory
2200/2600 MHz 1.7 GiB/2.0 GiB
2016-03-29 19:36:24 +00:00
2016-06-16 21:47:06 +00:00
Host Resource Utilization
2016-08-07 10:03:57 +00:00
CPU Memory Disk
230/3000 MHz 121 MiB/2.4 GiB 6.5 GiB/40 GiB
2016-03-29 19:36:24 +00:00
2016-06-16 21:47:06 +00:00
Allocations
2016-03-29 19:36:24 +00:00
ID Eval ID Job ID Task Group Desired Status Client Status
3d743cff-8d57-18c3-2260-a41d3f6c5204 2fb686da-b2b0-f8c2-5d57-2be5600435bd example cache run complete
2016-06-16 21:47:06 +00:00
Attributes
2016-03-29 19:36:24 +00:00
arch = amd64
cpu.frequency = 1300.000000
cpu.modelname = Intel(R) Core(TM) M-5Y71 CPU @ 1.20GHz
cpu.numcores = 2
cpu.totalcompute = 2600.000000
driver.docker = 1
driver.docker.version = 1.10.3
driver.exec = 1
driver.java = 1
driver.java.runtime = OpenJDK Runtime Environment (IcedTea 2.6.4) (7u95-2.6.4-0ubuntu0.14.04.2)
driver.java.version = 1.7.0_95
driver.java.vm = OpenJDK 64-Bit Server VM (build 24.95-b01, mixed mode)
driver.qemu = 1
driver.qemu.version = 2.0.0
driver.raw_exec = 1
driver.rkt = 1
driver.rkt.appc.version = 0.7.4
driver.rkt.version = 1.2.0
hostname = nomad
kernel.name = linux
kernel.version = 3.19.0-25-generic
memory.totalbytes = 2094473216
nomad.revision = '270da7a60ccbf39eeeadc4064a59ca06bf9ac6fc+CHANGES'
nomad.version = 0.3.2dev
os.name = ubuntu
os.version = 14.04
unique.cgroup.mountpoint = /sys/fs/cgroup
unique.network.ip-address = 127.0.0.1
unique.storage.bytesfree = 36044333056
unique.storage.bytestotal = 41092214784
unique.storage.volume = /dev/mapper/ubuntu--14--vg-root
```