kemko/nomad
1
0
Fork 0
mirror of https://github.com/kemko/nomad.git synced 2026-01-08 03:15:42 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
36d423ceda6230b9bf2df60efe30e2df312d31f3
nomad/website/content/commands/node/status.mdx
Aimee Ukasick 53b083b8c5 Docs: Nomad IA (#26063) 
* Move commands from docs to its own root-level directory

* temporarily use modified dev-portal branch with nomad ia changes

* explicitly clone nomad ia exp branch

* retrigger build, fixed dev-portal broken build

* architecture, concepts and get started individual pages

* fix get started section destinations

* reference section

* update repo comment in website-build.sh to show branch

* docs nav file update capitalization

* update capitalization to force deploy

* remove nomad-vs-kubernetes dir; move content to what is nomad pg

* job section

* Nomad operations category, deploy section

* operations category, govern section

* operations - manage

* operations/scale; concepts scheduling fix

* networking

* monitor

* secure section

* remote auth-methods folder and move up pages to sso; linkcheck

* Fix install2deploy redirects

* fix architecture redirects

* Job section: Add missing section index pages

* Add section index pages so breadcrumbs build correctly

* concepts/index fix front matter indentation

* move task driver plugin config to new deploy section

* Finish adding full URL to tutorials links in nav

* change SSO to Authentication in nav and file system

* Docs NomadIA: Move tutorials into NomadIA branch (#26132)

* Move governance and policy from tutorials to docs

* Move tutorials content to job-declare section

* run jobs section

* stateful workloads

* advanced job scheduling

* deploy section

* manage section

* monitor section

* secure/acl and secure/authorization

* fix example that contains an unseal key in real format

* remove images from sso-vault

* secure/traffic

* secure/workload-identities

* vault-acl change unseal key and root token in command output sample

* remove lines from sample output

* fix front matter

* move nomad pack tutorials to tools

* search/replace /nomad/tutorials links

* update acl overview with content from deleted architecture/acl

* fix spelling mistake

* linkcheck - fix broken links

* fix link to Nomad variables tutorial

* fix link to Prometheus tutorial

* move who uses Nomad to use cases page; move spec/config shortcuts

add dividers

* Move Consul out of Integrations; move namespaces to govern

* move integrations/vault to secure/vault; delete integrations

* move ref arch to docs; rename Deploy Nomad back to Install Nomad

* address feedback

* linkcheck fixes

* Fixed raw_exec redirect

* add info from /nomad/tutorials/manage-jobs/jobs

* update page content with newer tutorial

* link updates for architecture sub-folders

* Add redirects for removed section index pages. Fix links.

* fix broken links from linkcheck

* Revert to use dev-portal main branch instead of nomadIA branch

* build workaround: add intro-nav-data.json with single entry

* fix content-check error

* add intro directory to get around Vercel build error

* workound for emtpry directory

* remove mdx from /intro/ to fix content-check and git snafu

* Add intro index.mdx so Vercel build should work

---------

Co-authored-by: Tu Nguyen <im2nguyen@gmail.com>
2025-07-08 19:24:52 -05:00

416 lines
12 KiB
Plaintext
Raw Blame History

---
layout: docs
page_title: 'nomad node status command reference'
description: |
The `nomad node status` command displays status information about registered client nodes.
---
# `nomad node status` command reference
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
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
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.
## Options
- `-self`: Query the status of the local node.
- `-stats`: Display detailed resource usage statistics.
- `-allocs`: When a specific node is not being queried, shows the number of
running allocations per node.
- `-short`: Display short output. Used only when querying a single node.
- `-verbose`: Show full information.
- `-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.
- `-t` : Format and display node using a Go template.
- `-ui` : Open the node status page in the browser
## Examples
List view:
```shell-session
$ nomad node status
ID Node Pool DC Name Class Drain Eligibility Status
a72dfba2 default dc1 node1 <none> false eligible ready
1f3f03ea dev dc1 node2 <none> false eligible ready
```
List view, with operating system name:
```shell-session
$ nomad node status -os
ID Node Pool DC Name Class OS Drain Eligibility Status
a72dfba2 default dc1 node1 <none> ubuntu false eligible ready
f73e3993 dev 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 conjunction with `-verbose` or `-json`.
List view with verbose:
```shell-session
$ nomad node status -verbose
ID Node Pool DC Name Class Address Version Drain Eligibility Status
4d2ba53b default dc1 node1 <none> 127.0.0.1 1.10.1 false eligible ready
34dfba32 dev dc1 node2 <none> 127.0.0.1 1.10.1 false eligible ready
```
List view, with running allocations:
```shell-session
$ nomad node status -allocs
ID Node Pool DC Name Class Address Version Drain Eligibility Status Running Allocs
4d2ba53b default dc1 node1 <none> 127.0.0.1 1.10.1 false eligible ready 1
34dfba32 dev dc1 node2 <none> 127.0.0.1 1.10.1 false eligible ready 3
```
Single-node view in short mode:
```shell-session
$ nomad node status -short 1f3f03ea
ID = c754da1f
Name = nomad
Node Pool = default
Class = <none>
DC = dc1
Drain = false
Status = ready
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:
```shell-session
$ nomad node status 1f3f03ea
ID = c754da1f
Name = nomad-server01
Node Pool = default
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
Node Events
Time Subsystem Message
2018-03-29T17:24:42Z Driver: docker Driver docker is not detected
2018-03-29T17:23:42Z Cluster Node registered
Allocated Resources
CPU Memory Disk Alloc Count
500/2600 MHz 256 MiB/2.0 GiB 300 MiB/32 GiB 1/50
Allocation Resource Utilization
CPU Memory
430/2600 MHz 199 MiB/2.0 GiB
Host Resource Utilization
CPU Memory Disk
513/3000 MHz 551 MiB/2.4 GiB 4.2 GiB/52 GiB
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:
```shell-session
$ nomad node status -self
ID = c754da1f
Name = nomad-client01
Node Pool = default
Class = <none>
DC = dc1
Drain = false
Status = ready
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
Node Events
Time Subsystem Message
2018-03-29T17:24:42Z Driver: docker Driver docker is not detected
2018-03-29T17:23:42Z Cluster Node registered
Allocated Resources
CPU Memory Disk Alloc Count
2500/2600 MHz 1.3 GiB/2.0 GiB 1.5 GiB/32 GiB 5/50
Allocation Resource Utilization
CPU Memory
2200/2600 MHz 1.7 GiB/2.0 GiB
Host Resource Utilization
CPU Memory Disk
2430/3000 MHz 1.8 GiB/2.4 GiB 6.5 GiB/40 GiB
Allocations
ID Eval ID Job ID Task Group Desired Status Client Status
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
```
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:
- _run_: The allocation should run
- _stop_: The allocation should stop
Client Status represents the emergent state of the allocation and include
the following:
- _pending_: The allocation is pending and will be running
- _running_: The allocation is currently running
- _complete_: The allocation was running and completed successfully
- _failed_: The allocation was running and completed with a non-zero exit code
- _lost_: The node that was running the allocation has failed or has been
partitioned
Using `-stats` to see detailed to resource usage information on the node:
```shell-session
$ nomad node status -stats c754da1f
ID = c754da1f
Name = nomad-client01
Node Pool = default
Class = <none>
DC = dc1
Drain = false
Status = ready
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
Node Events
Time Subsystem Message
2018-03-29T17:24:42Z Driver: docker Driver docker is not detected
2018-03-29T17:23:42Z Cluster Node registered
Allocated Resources
CPU Memory Disk Alloc Count
2500/2600 MHz 1.3 GiB/2.0 GiB 1.5 GiB/32 GiB 5/50
Allocation Resource Utilization
CPU Memory
2200/2600 MHz 1.7 GiB/2.0 GiB
Host Resource Utilization
CPU Memory Disk
2430/3000 MHz 1.8 GiB/2.4 GiB 3.9 GiB/40 GiB
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
ID Eval ID Job ID Task Group Desired Status Client Status
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
```
To view verbose information about the node:
```shell-session
$ nomad node status -verbose c754da1f
ID = c754da1f-6337-b86d-47dc-2ef4c71aca14
Name = nomad
Node Pool = default
Class = <none>
DC = dc1
Drain = false
Status = ready
Uptime = 17h7m41s
Host Volumes
Name ReadOnly Source
CSI Volumes
ID Name Namespace Plugin ID Schedulable Access Mode Mount options
402f2c83 vol default 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
Node Events
Time Subsystem Message Details
2018-03-29T17:24:42Z Driver: docker Driver docker is not detected driver: docker,
2018-03-29T17:23:42Z Cluster Node registered <none>
Allocated Resources
CPU Memory Disk Alloc Count
2500/2600 MHz 1.3 GiB/2.0 GiB 1.5 GiB/32 GiB 0/50
Allocation Resource Utilization
CPU Memory
2200/2600 MHz 1.7 GiB/2.0 GiB
Host Resource Utilization
CPU Memory Disk
230/3000 MHz 121 MiB/2.4 GiB 6.5 GiB/40 GiB
Allocations
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
Attributes
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
```
## General options
@include 'general_options_no_namespace.mdx'
Reference in New Issue View Git Blame Copy Permalink