mirror of https://github.com/docker/cli.git
176 lines
3.9 KiB
Markdown
176 lines
3.9 KiB
Markdown
---
|
|
title: "service inspect"
|
|
description: "The service inspect command description and usage"
|
|
keywords: "service, inspect"
|
|
---
|
|
|
|
# service inspect
|
|
|
|
```Markdown
|
|
Usage: docker service inspect [OPTIONS] SERVICE [SERVICE...]
|
|
|
|
Display detailed information on one or more services
|
|
|
|
Options:
|
|
-f, --format string Format output using a custom template:
|
|
'json': Print in JSON format
|
|
'TEMPLATE': Print output using the given Go template.
|
|
Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates
|
|
--pretty Print the information in a human friendly format
|
|
--help Print usage
|
|
```
|
|
|
|
## Description
|
|
|
|
Inspects the specified service.
|
|
|
|
By default, this renders all results in a JSON array. If a format is specified,
|
|
the given template will be executed for each result.
|
|
|
|
Go's [text/template](https://golang.org/pkg/text/template/) package
|
|
describes all the details of the format.
|
|
|
|
> **Note**
|
|
>
|
|
> This is a cluster management command, and must be executed on a swarm
|
|
> manager node. To learn about managers and workers, refer to the
|
|
> [Swarm mode section](https://docs.docker.com/engine/swarm/) in the
|
|
> documentation.
|
|
|
|
## Examples
|
|
|
|
### Inspect a service by name or ID
|
|
|
|
You can inspect a service, either by its *name*, or *ID*
|
|
|
|
For example, given the following service;
|
|
|
|
```console
|
|
$ docker service ls
|
|
ID NAME MODE REPLICAS IMAGE
|
|
dmu1ept4cxcf redis replicated 3/3 redis:3.0.6
|
|
```
|
|
|
|
Both `docker service inspect redis`, and `docker service inspect dmu1ept4cxcf`
|
|
produce the same result:
|
|
|
|
```console
|
|
$ docker service inspect redis
|
|
```
|
|
|
|
The output is in JSON format, for example:
|
|
|
|
```json
|
|
[
|
|
{
|
|
"ID": "dmu1ept4cxcfe8k8lhtux3ro3",
|
|
"Version": {
|
|
"Index": 12
|
|
},
|
|
"CreatedAt": "2016-06-17T18:44:02.558012087Z",
|
|
"UpdatedAt": "2016-06-17T18:44:02.558012087Z",
|
|
"Spec": {
|
|
"Name": "redis",
|
|
"TaskTemplate": {
|
|
"ContainerSpec": {
|
|
"Image": "redis:3.0.6"
|
|
},
|
|
"Resources": {
|
|
"Limits": {},
|
|
"Reservations": {}
|
|
},
|
|
"RestartPolicy": {
|
|
"Condition": "any",
|
|
"MaxAttempts": 0
|
|
},
|
|
"Placement": {}
|
|
},
|
|
"Mode": {
|
|
"Replicated": {
|
|
"Replicas": 1
|
|
}
|
|
},
|
|
"UpdateConfig": {},
|
|
"EndpointSpec": {
|
|
"Mode": "vip"
|
|
}
|
|
},
|
|
"Endpoint": {
|
|
"Spec": {}
|
|
}
|
|
}
|
|
]
|
|
```
|
|
|
|
```console
|
|
$ docker service inspect dmu1ept4cxcf
|
|
|
|
[
|
|
{
|
|
"ID": "dmu1ept4cxcfe8k8lhtux3ro3",
|
|
"Version": {
|
|
"Index": 12
|
|
},
|
|
...
|
|
}
|
|
]
|
|
```
|
|
|
|
### <a name=pretty></a> Formatting (--pretty)
|
|
|
|
You can print the inspect output in a human-readable format instead of the default
|
|
JSON output, by using the `--pretty` option:
|
|
|
|
```console
|
|
$ docker service inspect --pretty frontend
|
|
|
|
ID: c8wgl7q4ndfd52ni6qftkvnnp
|
|
Name: frontend
|
|
Labels:
|
|
- org.example.projectname=demo-app
|
|
Service Mode: REPLICATED
|
|
Replicas: 5
|
|
Placement:
|
|
UpdateConfig:
|
|
Parallelism: 0
|
|
On failure: pause
|
|
Max failure ratio: 0
|
|
ContainerSpec:
|
|
Image: nginx:alpine
|
|
Resources:
|
|
Networks: net1
|
|
Endpoint Mode: vip
|
|
Ports:
|
|
PublishedPort = 4443
|
|
Protocol = tcp
|
|
TargetPort = 443
|
|
PublishMode = ingress
|
|
```
|
|
|
|
You can also use `--format pretty` for the same effect.
|
|
|
|
|
|
#### Find the number of tasks running as part of a service
|
|
|
|
The `--format` option can be used to obtain specific information about a
|
|
service. For example, the following command outputs the number of replicas
|
|
of the "redis" service.
|
|
|
|
```console
|
|
$ docker service inspect --format='{{.Spec.Mode.Replicated.Replicas}}' redis
|
|
|
|
10
|
|
```
|
|
|
|
|
|
## Related commands
|
|
|
|
* [service create](service_create.md)
|
|
* [service logs](service_logs.md)
|
|
* [service ls](service_ls.md)
|
|
* [service ps](service_ps.md)
|
|
* [service rm](service_rm.md)
|
|
* [service rollback](service_rollback.md)
|
|
* [service scale](service_scale.md)
|
|
* [service update](service_update.md)
|