Commands Cheat Sheet

Heading

Cheatsheet

(Perfect for DevOps & SREs)

Most-used commands
Your email is safe with us. No spam, ever.

Thankyou for your submission

We have sent the cheatsheet on your email!
Oops! Something went wrong while submitting the form.

Connection

export NOMAD_ADDR=http://nomad-server:4646
Set the Nomad server address

nomad version
Check Nomad version and verify connection

nomad status
Check the status of Nomad server

nomad server members
List the members of the Nomad server cluster

job_management

nomad job status
List all jobs

nomad job status
Get status of a specific job

nomad job run
Submit a new job or update an existing job

nomad job stop
Stop a running job

nomad job inspect
Inspect a job's specification

nomad job history
Display all tracked versions of a job

nomad job plan
Dry-run a job update to determine effect

allocation_management

nomad alloc status
List all allocations

nomad alloc status
Display allocation status and details

nomad alloc logs
View logs of an allocation

nomad alloc exec -i -t
Execute command in allocation container interactively

nomad alloc restart
Restart a specific allocation

node_management

nomad node status
List all client nodes

nomad node status
Show detailed status of a client node

nomad node drain -enable
Enable drain mode on a node

nomad node drain -disable
Disable drain mode on a node

nomad node eligibility -enable
Set node as eligible for scheduling

nomad node eligibility -disable
Set node as ineligible for scheduling

evaluation_and_deployment

nomad eval status
Display evaluation details

nomad deployment status
List all deployments

nomad deployment status
Show deployment status and details

nomad deployment fail
Manually fail a deployment

nomad deployment pause
Pause a deployment

nomad deployment resume
Resume a paused deployment

agent_operations

nomad agent-info
Display status of the local agent

nomad operator raft list-peers
List Raft peers

nomad operator debug
Create an archive with Nomad debug information

nomad system gc
Force a garbage collection of jobs, allocations, etc.

templates_and_validation

nomad job init
Create an example job file

nomad job validate
Check if a job specification is valid

nomad namespace apply
Create or update a namespace

nomad namespace list
List all namespaces

monitoring

nomad monitor
Stream logs from a Nomad agent

nomad ui
Open the Nomad web UI (in supported environments)

nomad operator metrics
View the current metrics of the Nomad server

nomad quota status
List all quotas