docs/_data/engine-cli/docker_node_inspect.yaml

56 lines
5.0 KiB
YAML

command: docker node inspect
short: Display detailed information on one or more nodes
long: |-
Returns information about a node. By default, this command renders all results
in a JSON array. You can specify an alternate format to execute a
given template for each result. Go's
[text/template](http://golang.org/pkg/text/template/) package describes all the
details of the format.
usage: docker node inspect [OPTIONS] self|NODE [NODE...]
pname: docker node
plink: docker_node.yaml
options:
- option: format
shorthand: f
description: Format the output using the given Go template
- option: pretty
default_value: "false"
description: Print the information in a human friendly format
examples: "### Inspect a node\n\n```none\n$ docker node inspect swarm-manager\n\n[\n{\n
\ \"ID\": \"e216jshn25ckzbvmwlnh5jr3g\",\n \"Version\": {\n \"Index\":
10\n },\n \"CreatedAt\": \"2017-05-16T22:52:44.9910662Z\",\n \"UpdatedAt\":
\"2017-05-16T22:52:45.230878043Z\",\n \"Spec\": {\n \"Role\": \"manager\",\n
\ \"Availability\": \"active\"\n },\n \"Description\": {\n \"Hostname\":
\"swarm-manager\",\n \"Platform\": {\n \"Architecture\": \"x86_64\",\n
\ \"OS\": \"linux\"\n },\n \"Resources\": {\n \"NanoCPUs\":
1000000000,\n \"MemoryBytes\": 1039843328\n },\n \"Engine\":
{\n \"EngineVersion\": \"17.06.0-ce\",\n \"Plugins\": [\n
\ {\n \"Type\": \"Volume\",\n \"Name\":
\"local\"\n },\n {\n \"Type\":
\"Network\",\n \"Name\": \"overlay\"\n },\n {\n
\ \"Type\": \"Network\",\n \"Name\": \"null\"\n
\ },\n {\n \"Type\": \"Network\",\n
\ \"Name\": \"host\"\n },\n {\n
\ \"Type\": \"Network\",\n \"Name\": \"bridge\"\n
\ },\n {\n \"Type\": \"Network\",\n
\ \"Name\": \"overlay\"\n }\n ]\n },\n
\ \"TLSInfo\": {\n \"TrustRoot\": \"-----BEGIN CERTIFICATE-----\\nMIIBazCCARCgAwIBAgIUOzgqU4tA2q5Yv1HnkzhSIwGyIBswCgYIKoZIzj0EAwIw\\nEzERMA8GA1UEAxMIc3dhcm0tY2EwHhcNMTcwNTAyMDAyNDAwWhcNMzcwNDI3MDAy\\nNDAwWjATMREwDwYDVQQDEwhzd2FybS1jYTBZMBMGByqGSM49AgEGCCqGSM49AwEH\\nA0IABMbiAmET+HZyve35ujrnL2kOLBEQhFDZ5MhxAuYs96n796sFlfxTxC1lM/2g\\nAh8DI34pm3JmHgZxeBPKUURJHKWjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMB\\nAf8EBTADAQH/MB0GA1UdDgQWBBS3sjTJOcXdkls6WSY2rTx1KIJueTAKBggqhkjO\\nPQQDAgNJADBGAiEAoeVWkaXgSUAucQmZ3Yhmx22N/cq1EPBgYHOBZmHt0NkCIQC3\\nzONcJ/+WA21OXtb+vcijpUOXtNjyHfcox0N8wsLDqQ==\\n-----END
CERTIFICATE-----\\n\",\n \"CertIssuerSubject\": \"MBMxETAPBgNVBAMTCHN3YXJtLWNh\",\n
\ \"CertIssuerPublicKey\": \"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExuICYRP4dnK97fm6OucvaQ4sERCEUNnkyHEC5iz3qfv3qwWV/FPELWUz/aACHwMjfimbcmYeBnF4E8pRREkcpQ==\"\n
\ }\n },\n \"Status\": {\n \"State\": \"ready\",\n \"Addr\":
\"168.0.32.137\"\n },\n \"ManagerStatus\": {\n \"Leader\": true,\n
\ \"Reachability\": \"reachable\",\n \"Addr\": \"168.0.32.137:2377\"\n
\ }\n}\n]\n```\n\n### Specify an output format\n\n```none\n$ docker node inspect
--format '{{ .ManagerStatus.Leader }}' self\n\nfalse\n\n$ docker node inspect --pretty
self\nID: e216jshn25ckzbvmwlnh5jr3g\nHostname: swarm-manager\nJoined
at: 2017-05-16 22:52:44.9910662 +0000 utc\nStatus:\n State: Ready\n
Availability: Active\n Address: 172.17.0.2\nManager Status:\n
Address: 172.17.0.2:2377\n Raft Status: Reachable\n Leader:
\ Yes\nPlatform:\n Operating System: linux\n Architecture: x86_64\nResources:\n
CPUs: 4\n Memory: 7.704 GiB\nPlugins:\n Network:
\ overlay, bridge, null, host, overlay\n Volume: local\nEngine
Version: 17.06.0-ce\nTLS Info:\n TrustRoot:\n-----BEGIN CERTIFICATE-----\nMIIBazCCARCgAwIBAgIUOzgqU4tA2q5Yv1HnkzhSIwGyIBswCgYIKoZIzj0EAwIw\nEzERMA8GA1UEAxMIc3dhcm0tY2EwHhcNMTcwNTAyMDAyNDAwWhcNMzcwNDI3MDAy\nNDAwWjATMREwDwYDVQQDEwhzd2FybS1jYTBZMBMGByqGSM49AgEGCCqGSM49AwEH\nA0IABMbiAmET+HZyve35ujrnL2kOLBEQhFDZ5MhxAuYs96n796sFlfxTxC1lM/2g\nAh8DI34pm3JmHgZxeBPKUURJHKWjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMB\nAf8EBTADAQH/MB0GA1UdDgQWBBS3sjTJOcXdkls6WSY2rTx1KIJueTAKBggqhkjO\nPQQDAgNJADBGAiEAoeVWkaXgSUAucQmZ3Yhmx22N/cq1EPBgYHOBZmHt0NkCIQC3\nzONcJ/+WA21OXtb+vcijpUOXtNjyHfcox0N8wsLDqQ==\n-----END
CERTIFICATE-----\n\n Issuer Public Key:\tMFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExuICYRP4dnK97fm6OucvaQ4sERCEUNnkyHEC5iz3qfv3qwWV/FPELWUz/aACHwMjfimbcmYeBnF4E8pRREkcpQ==\n
Issuer Subject:\tMBMxETAPBgNVBAMTCHN3YXJtLWNh\n```"