summaryrefslogtreecommitdiff
path: root/devdocs/docker/engine%2Freference%2Fcommandline%2Fnode_inspect%2Findex.html
diff options
context:
space:
mode:
Diffstat (limited to 'devdocs/docker/engine%2Freference%2Fcommandline%2Fnode_inspect%2Findex.html')
-rw-r--r--devdocs/docker/engine%2Freference%2Fcommandline%2Fnode_inspect%2Findex.html119
1 files changed, 119 insertions, 0 deletions
diff --git a/devdocs/docker/engine%2Freference%2Fcommandline%2Fnode_inspect%2Findex.html b/devdocs/docker/engine%2Freference%2Fcommandline%2Fnode_inspect%2Findex.html
new file mode 100644
index 00000000..1925d228
--- /dev/null
+++ b/devdocs/docker/engine%2Freference%2Fcommandline%2Fnode_inspect%2Findex.html
@@ -0,0 +1,119 @@
+<h1>docker node inspect</h1> <p><br></p> <p>Display detailed information on one or more nodes</p> <p><span class="badge badge-info" data-toggle="tooltip" data-placement="right" title="This command works with the Swarm orchestrator.">Swarm</span> This command works with the Swarm orchestrator.</p> <h2 id="usage">Usage</h2> <div class="highlight"><pre class="highlight" data-language="">$ docker node inspect [OPTIONS] self|NODE [NODE...]
+</pre></div> <p>Refer to the <a href="#options">options section</a> for an overview of available <a href="#options"><code class="language-plaintext highlighter-rouge">OPTIONS</code></a> for this command.</p> <h2 id="description">Description</h2> <p name="extended-description">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 <a href="https://golang.org/pkg/text/template/">text/template</a> package describes all the details of the format.</p> <blockquote> <p><strong>Note</strong></p> <p>This is a cluster management command, and must be executed on a swarm manager node. To learn about managers and workers, refer to the <a href="../../../swarm/index">Swarm mode section</a> in the documentation.</p> </blockquote> <p>For example uses of this command, refer to the <a href="#examples">examples section</a> below.</p> <h2 id="options">Options</h2> <table> <thead> <tr> <td>Name, shorthand</td> <td>Default</td> <td>Description</td> </tr> </thead> <tbody> <tr> <td>
+<code class="language-plaintext highlighter-rouge">--format</code> , <code class="language-plaintext highlighter-rouge">-f</code>
+</td> <td></td> <td>Format the output using the given Go template</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">--pretty</code></td> <td></td> <td>Print the information in a human friendly format</td> </tr> </tbody> </table> <h2 id="examples">Examples</h2> <h3 id="inspect-a-node">Inspect a node</h3> <div class="highlight"><pre class="highlight" data-language="">$ docker node inspect swarm-manager
+</pre></div> <div class="highlight"><pre class="highlight" data-language="">[
+ {
+ "ID": "e216jshn25ckzbvmwlnh5jr3g",
+ "Version": {
+ "Index": 10
+ },
+ "CreatedAt": "2017-05-16T22:52:44.9910662Z",
+ "UpdatedAt": "2017-05-16T22:52:45.230878043Z",
+ "Spec": {
+ "Role": "manager",
+ "Availability": "active"
+ },
+ "Description": {
+ "Hostname": "swarm-manager",
+ "Platform": {
+ "Architecture": "x86_64",
+ "OS": "linux"
+ },
+ "Resources": {
+ "NanoCPUs": 1000000000,
+ "MemoryBytes": 1039843328
+ },
+ "Engine": {
+ "EngineVersion": "17.06.0-ce",
+ "Plugins": [
+ {
+ "Type": "Volume",
+ "Name": "local"
+ },
+ {
+ "Type": "Network",
+ "Name": "overlay"
+ },
+ {
+ "Type": "Network",
+ "Name": "null"
+ },
+ {
+ "Type": "Network",
+ "Name": "host"
+ },
+ {
+ "Type": "Network",
+ "Name": "bridge"
+ },
+ {
+ "Type": "Network",
+ "Name": "overlay"
+ }
+ ]
+ },
+ "TLSInfo": {
+ "TrustRoot": "-----BEGIN CERTIFICATE-----\nMIIBazCCARCgAwIBAgIUOzgqU4tA2q5Yv1HnkzhSIwGyIBswCgYIKoZIzj0EAwIw\nEzERMA8GA1UEAxMIc3dhcm0tY2EwHhcNMTcwNTAyMDAyNDAwWhcNMzcwNDI3MDAy\nNDAwWjATMREwDwYDVQQDEwhzd2FybS1jYTBZMBMGByqGSM49AgEGCCqGSM49AwEH\nA0IABMbiAmET+HZyve35ujrnL2kOLBEQhFDZ5MhxAuYs96n796sFlfxTxC1lM/2g\nAh8DI34pm3JmHgZxeBPKUURJHKWjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMB\nAf8EBTADAQH/MB0GA1UdDgQWBBS3sjTJOcXdkls6WSY2rTx1KIJueTAKBggqhkjO\nPQQDAgNJADBGAiEAoeVWkaXgSUAucQmZ3Yhmx22N/cq1EPBgYHOBZmHt0NkCIQC3\nzONcJ/+WA21OXtb+vcijpUOXtNjyHfcox0N8wsLDqQ==\n-----END CERTIFICATE-----\n",
+ "CertIssuerSubject": "MBMxETAPBgNVBAMTCHN3YXJtLWNh",
+ "CertIssuerPublicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExuICYRP4dnK97fm6OucvaQ4sERCEUNnkyHEC5iz3qfv3qwWV/FPELWUz/aACHwMjfimbcmYeBnF4E8pRREkcpQ=="
+ }
+ },
+ "Status": {
+ "State": "ready",
+ "Addr": "168.0.32.137"
+ },
+ "ManagerStatus": {
+ "Leader": true,
+ "Reachability": "reachable",
+ "Addr": "168.0.32.137:2377"
+ }
+ }
+]
+</pre></div> <h3 id="specify-an-output-format">Specify an output format</h3> <div class="highlight"><pre class="highlight" data-language="">$ docker node inspect --format '{{ .ManagerStatus.Leader }}' self
+
+false
+</pre></div> <p>Use <code class="language-plaintext highlighter-rouge">--format=pretty</code> or the <code class="language-plaintext highlighter-rouge">--pretty</code> shorthand to pretty-print the output:</p> <div class="highlight"><pre class="highlight" data-language="">$ docker node inspect --format=pretty self
+
+ID: e216jshn25ckzbvmwlnh5jr3g
+Hostname: swarm-manager
+Joined at: 2017-05-16 22:52:44.9910662 +0000 utc
+Status:
+ State: Ready
+ Availability: Active
+ Address: 172.17.0.2
+Manager Status:
+ Address: 172.17.0.2:2377
+ Raft Status: Reachable
+ Leader: Yes
+Platform:
+ Operating System: linux
+ Architecture: x86_64
+Resources:
+ CPUs: 4
+ Memory: 7.704 GiB
+Plugins:
+ Network: overlay, bridge, null, host, overlay
+ Volume: local
+Engine Version: 17.06.0-ce
+TLS Info:
+ TrustRoot:
+-----BEGIN CERTIFICATE-----
+MIIBazCCARCgAwIBAgIUOzgqU4tA2q5Yv1HnkzhSIwGyIBswCgYIKoZIzj0EAwIw
+EzERMA8GA1UEAxMIc3dhcm0tY2EwHhcNMTcwNTAyMDAyNDAwWhcNMzcwNDI3MDAy
+NDAwWjATMREwDwYDVQQDEwhzd2FybS1jYTBZMBMGByqGSM49AgEGCCqGSM49AwEH
+A0IABMbiAmET+HZyve35ujrnL2kOLBEQhFDZ5MhxAuYs96n796sFlfxTxC1lM/2g
+Ah8DI34pm3JmHgZxeBPKUURJHKWjQjBAMA4GA1UdDwEB/wQEAwIBBjAPBgNVHRMB
+Af8EBTADAQH/MB0GA1UdDgQWBBS3sjTJOcXdkls6WSY2rTx1KIJueTAKBggqhkjO
+PQQDAgNJADBGAiEAoeVWkaXgSUAucQmZ3Yhmx22N/cq1EPBgYHOBZmHt0NkCIQC3
+zONcJ/+WA21OXtb+vcijpUOXtNjyHfcox0N8wsLDqQ==
+-----END CERTIFICATE-----
+
+ Issuer Public Key: MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAExuICYRP4dnK97fm6OucvaQ4sERCEUNnkyHEC5iz3qfv3qwWV/FPELWUz/aACHwMjfimbcmYeBnF4E8pRREkcpQ==
+ Issuer Subject: MBMxETAPBgNVBAMTCHN3YXJtLWNh
+</pre></div> <h2 id="parent-command">Parent command</h2> <table> <thead> <tr> <th style="text-align: left">Command</th> <th style="text-align: left">Description</th> </tr> </thead> <tbody> <tr> <td style="text-align: left"><a href="../node/index">docker node</a></td> <td style="text-align: left">Manage Swarm nodes</td> </tr> </tbody> </table> <h2 id="related-commands">Related commands</h2> <table> <thead> <tr> <td>Command</td> <td>Description</td> </tr> </thead> <tbody> <tr> <td><a href="../node_demote/index">docker node demote</a></td> <td>Demote one or more nodes from manager in the swarm</td> </tr> <tr> <td><a href="index">docker node inspect</a></td> <td>Display detailed information on one or more nodes</td> </tr> <tr> <td><a href="../node_ls/index">docker node ls</a></td> <td>List nodes in the swarm</td> </tr> <tr> <td><a href="../node_promote/index">docker node promote</a></td> <td>Promote one or more nodes to manager in the swarm</td> </tr> <tr> <td><a href="../node_ps/index">docker node ps</a></td> <td>List tasks running on one or more nodes, defaults to current node</td> </tr> <tr> <td><a href="../node_rm/index">docker node rm</a></td> <td>Remove one or more nodes from the swarm</td> </tr> <tr> <td><a href="../node_update/index">docker node update</a></td> <td>Update a node</td> </tr> </tbody> </table> <div class="_attribution">
+ <p class="_attribution-p">
+ &copy; 2019 Docker, Inc.<br>Licensed under the Apache License, Version 2.0.<br>Docker and the Docker logo are trademarks or registered trademarks of Docker, Inc. in the United States and/or other countries.<br>Docker, Inc. and other parties may also have trademark rights in other terms used herein.<br>
+ <a href="https://docs.docker.com/engine/reference/commandline/node_inspect/" class="_attribution-link">https://docs.docker.com/engine/reference/commandline/node_inspect/</a>
+ </p>
+</div>