open-nomad/website/source/docs/commands/job/inspect.html.md.erb
Charlie Voiselle 870e3f58a6 Fixup for command section of website
* changed list indicator from * -> -
* moved in-text links to reference links
* made commands `plaintext`
* made command examples `console`
* rewrapped text
2019-10-22 17:42:08 -04:00

157 lines
4.8 KiB
Plaintext

---
layout: "docs"
page_title: "Commands: job inspect"
sidebar_current: "docs-commands-job-inspect"
description: >
The job inspect command is used to inspect a submitted job.
---
# Command: job inspect
**Alias: `nomad inspect`**
The `job inspect` command is used to inspect the content of a submitted job.
## Usage
```plaintext
nomad job inspect [options] <job>
```
The `job inspect` command requires a single argument, a submitted job's name, and
will retrieve the JSON version of the job. This JSON is valid to be submitted to
the [Job HTTP API]. This command is useful to inspect what version of a job
Nomad is running.
## General Options
<%= partial "docs/commands/_general_options" %>
## Inspect Options
- `-version`: Display only the job at the given job version.
- `-json` : Output the job in its JSON format.
- `-t` : Format and display the job using a Go template.
## Examples
Inspect a submitted job:
```shell
$ nomad job inspect redis
{
"Job": {
"Region": "global",
"ID": "redis
"Name": "redis
"Type": "service",
"Priority": 50,
"AllAtOnce": false,
"Datacenters": [
"dc1"
],
"Constraints": [
{
"LTarget": "${attr.kernel.name}",
"RTarget": "linux",
"Operand": "="
}
],
"TaskGroups": [
{
"Name": "cache",
"Count": 1,
"Constraints": null,
"Tasks": [
{
"Name": "redis",
"Driver": "docker",
"User": "",
"Config": {
"image": "redis:latest",
"port_map": [
{
"db": 6379
}
]
},
"Constraints": null,
"Env": null,
"Services": [
{
"Id": "",
"Name": "cache-redis",
"Tags": [
"global",
"cache"
],
"PortLabel": "db",
"Checks": [
{
"Id": "",
"Name": "alive",
"Type": "tcp",
"Command": "",
"Args": null,
"Path": "",
"Protocol": "",
"Interval": 10000000000,
"Timeout": 2000000000
}
]
}
],
"Resources": {
"CPU": 500,
"MemoryMB": 256,
"DiskMB": 300,
"Networks": [
{
"Public": false,
"CIDR": "",
"ReservedPorts": null,
"DynamicPorts": [
{
"Label": "db",
"Value": 0
}
],
"IP": "",
"MBits": 10
}
]
},
"Meta": null,
"KillTimeout": 5000000000,
"LogConfig": {
"MaxFiles": 10,
"MaxFileSizeMB": 10
},
"Artifacts": null
}
],
"RestartPolicy": {
"Interval": 300000000000,
"Attempts": 10,
"Delay": 25000000000,
"Mode": "delay"
},
"Meta": null
}
],
"Update": {
"Stagger": 10000000000,
"MaxParallel": 1
},
"Periodic": null,
"Meta": null,
"Status": "running",
"StatusDescription": "",
"CreateIndex": 5,
"ModifyIndex": 7
}
}
```
[Job HTTP API]: /api/jobs.html