open-nomad/website/source/docs/commands/job/inspect.html.md.erb
Alex Dadgar 1e3c3cb287 Deprecate IOPS
IOPS have been modelled as a resource since Nomad 0.1 but has never
actually been detected and there is no plan in the short term to add
detection. This is because IOPS is a bit simplistic of a unit to define
the performance requirements from the underlying storage system. In its
current state it adds unnecessary confusion and can be removed without
impacting any users. This PR leaves IOPS defined at the jobspec parsing
level and in the api/ resources since these are the two public uses of
the field. These should be considered deprecated and only exist to allow
users to stop using them during the Nomad 0.9.x release. In the future,
there should be no expectation that the field will exist.
2018-12-06 15:09:26 -08:00

156 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
```
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](/api/jobs.html). 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:
```
$ 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
}
}
```