docker node ls

内容説明	Swarm 内ノードを一覧表示します。
利用方法	`docker node ls [OPTIONS]`
エイリアス	`docker node list`

Swarm このコマンドは Swarm オーケストレーターにおいて動作します。

内容説明

Docker Swarm マネージャーが管理するノードを一覧表示します。 -f または --filter フラグを使えばフィルター検索を行うことができます。フィルター検索時のオプションの詳細はフィルター検索の節を参照してください。

メモ
これはクラスター管理コマンドであるため、Swarm のマネージャーノード上で実行する必要があります。マネージャーノードとワーカーノードについては、本ドキュメントの Swarm モードを参照してください。

オプション

オプション	デフォルト	内容説明
`-f, --filter`		指定された条件に基づいてフィルター検索を行います。
`--format`		カスタムテンプレートを使って出力をフォーマットします。 'table': カラムヘッダー付きの表形式により出力します。(デフォルト) 'table TEMPLATE': 指定された Go テンプレートを使って表形式により出力します。 'json': JSON 書式により出力します。 'TEMPLATE': 指定された Go テンプレートを使って出力します。テンプレートを使ったフォーマット出力の詳細は https://matsuand.github.io/docker.docs-ja/engine/cli/formatting/ を参照してください。
`-q, --quiet`		ID のみを表示します。

利用例

$ docker node ls

ID                           HOSTNAME        STATUS  AVAILABILITY  MANAGER STATUS
1bcef6utixb0l0ca7gxuivsj0    swarm-worker2   Ready   Active
38ciaotwjuritcdtn9npbnkuz    swarm-worker1   Ready   Active
e216jshn25ckzbvmwlnh5jr3g *  swarm-manager1  Ready   Active        Leader

メモ
上の例における出力では、隠れ項目として.Selfがあります。そのノードが、カレントな Docker デーモンとしてのノードであることを表わします。アスタリスク * (例では e216jshn25ckzbvmwlnh5jr3g *) は、それがカレントな Docker デーモンのノードであることを意味しています。

フィルター検索 (--filter)

フィルターフラグ (-f または --filter) の書式は "key=value" ペアとして指定します。フィルターが複数必要な場合は、フラグを複数回指定します (たとえば --filter "foo=bar" --filter "bif=baz" とします)。

現在サポートされているフィルターは以下のとおりです。

id
label
node.label
membership
name
role

id

id フィルターは、ノード ID の全部または一部を検索します。

$ docker node ls -f id=1

ID                         HOSTNAME       STATUS  AVAILABILITY  MANAGER STATUS
1bcef6utixb0l0ca7gxuivsj0  swarm-worker2  Ready   Active

label

label フィルターは engine ラベルに対応するノードを検索するものであり、label のみが存在するノードか、あるいは label と値が存在するノードに対しての検索を行います。 Engine ラベルはデーモン設定において設定されます。 Swarm の node ラベルを検索する場合は、これではなく node.label を用いてください。

以下の例では foo ラベルを持ったノードを検索します。この場合、その値の内容は問いません。

$ docker node ls -f "label=foo"

ID                         HOSTNAME       STATUS  AVAILABILITY  MANAGER STATUS
1bcef6utixb0l0ca7gxuivsj0  swarm-worker2  Ready   Active

node.label

node.label フィルターはノードラベルを検索するものであり、node.label のみが存在するノードか、あるいは node.label と値が存在するノードに対しての検索を行います。

以下のフィルターでは、各ノードに対して region というノードラベルを更新します。

$ docker node update --label-add region=region-a swarm-test-01
$ docker node update --label-add region=region-a swarm-test-02
$ docker node update --label-add region=region-b swarm-test-03
$ docker node update --label-add region=region-b swarm-test-04

以下は region というノードラベルを持つノードをすべて検索します。

$ docker node ls --filter node.label=region

ID                            HOSTNAME        STATUS    AVAILABILITY   MANAGER STATUS   ENGINE VERSION
yg550ettvsjn6g6t840iaiwgb *   swarm-test-01   Ready     Active         Leader           23.0.3
2lm9w9kbepgvkzkkeyku40e65     swarm-test-02   Ready     Active         Reachable        23.0.3
hc0pu7ntc7s4uvj4pv7z7pz15     swarm-test-03   Ready     Active         Reachable        23.0.3
n41b2cijmhifxxvz56vwrs12q     swarm-test-04   Ready     Active                          23.0.3

以下は region というノードラベルを持ち、かつ値として region-a を持つものを検索します。

$ docker node ls --filter node.label=region=region-a

ID                            HOSTNAME        STATUS    AVAILABILITY   MANAGER STATUS   ENGINE VERSION
yg550ettvsjn6g6t840iaiwgb *   swarm-test-01   Ready     Active         Leader           23.0.3
2lm9w9kbepgvkzkkeyku40e65     swarm-test-02   Ready     Active         Reachable        23.0.3

membership

membership フィルターは membership というラベルが存在するノードであって、その値が accepted か pending であるものを検索します。

以下の例では membership ラベルに対して accepted が設定されているノードを検索します。

$ docker node ls -f "membership=accepted"

ID                           HOSTNAME        STATUS  AVAILABILITY  MANAGER STATUS
1bcef6utixb0l0ca7gxuivsj0    swarm-worker2   Ready   Active
38ciaotwjuritcdtn9npbnkuz    swarm-worker1   Ready   Active

name

name フィルターはノード名の全部または一部を検索します。

以下のフィルター指定では swarm-master という名前に一致するノードすべてを検索します。

$ docker node ls -f name=swarm-manager1

ID                           HOSTNAME        STATUS  AVAILABILITY  MANAGER STATUS
e216jshn25ckzbvmwlnh5jr3g *  swarm-manager1  Ready   Active        Leader

role

role フィルターは role というラベルが存在するノードであって、その値が worker か manager であるものを検索します。

以下の例では manager ロールが設定されているノードを検索します。

$ docker node ls -f "role=manager"

ID                           HOSTNAME        STATUS  AVAILABILITY  MANAGER STATUS
e216jshn25ckzbvmwlnh5jr3g *  swarm-manager1  Ready   Active        Leader

フォーマット指定 (--format)

フォーマットオプション (--format) の指定により、Go 言語テンプレートを使ったわかりやすい検索結果を得ることができます。

Go 言語テンプレートによるプレースホルダー（placeholder）は以下のとおりです。

プレースホルダー	内容説明
`.ID`	ノード ID
`.Self`	デーモンノード (`true/false`, `true` は現在の Docker デーモンとノードが同一であることを表わす)
`.Hostname`	ノードホスト名
`.Status`	ノードのステータス
`.Availability`	ノードの利用状況 ("active", "pause", "drain")
`.ManagerStatus`	ノードのマネージャーステータス
`.TLSStatus`	ノードの TLS ステータス ("Ready", または "Needs Rotation" は TLS 証明書が古い CA により署名されている)
`.EngineVersion`	Engine バージョン

--format オプションを利用すると node ls コマンドは、テンプレートが定めるデータを直接出力します。あるいは table ディレクティブを指定していれば、カラムヘッダーも同時に出力されます。

以下はヘッダーを含めずにテンプレートを利用する例です。すべてのノードにおける ID、Hostname、TLS Status の各項目がコロン (:) で区切られて表示されます。

$ docker node ls --format "{{.ID}}: {{.Hostname}} {{.TLSStatus}}"

e216jshn25ckzbvmwlnh5jr3g: swarm-manager1 Ready
35o6tiywb700jesrt3dmllaza: swarm-worker1 Needs Rotation

ノードすべてを JSON 書式により一覧表示するには json ディレクティブを用います。

$ docker node ls --format json
{"Availability":"Active","EngineVersion":"23.0.3","Hostname":"docker-desktop","ID":"k8f4w7qtzpj5sqzclcqafw35g","ManagerStatus":"Leader","Self":true,"Status":"Ready","TLSStatus":"Ready"}