github.com/pwn-term/docker@v0.0.0-20210616085119-6e977cce2565/cli/docs/reference/commandline/node_ps.md (about)

     1  ---
     2  title: "node ps"
     3  description: "The node ps command description and usage"
     4  keywords: node, tasks, ps
     5  aliases: ["/engine/reference/commandline/node_tasks/"]
     6  ---
     7  
     8  # node ps
     9  
    10  ```markdown
    11  Usage:  docker node ps [OPTIONS] [NODE...]
    12  
    13  List tasks running on one or more nodes, defaults to current node.
    14  
    15  Options:
    16    -f, --filter filter   Filter output based on conditions provided
    17        --format string   Pretty-print tasks using a Go template
    18        --help            Print usage
    19        --no-resolve      Do not map IDs to Names
    20        --no-trunc        Do not truncate output
    21    -q, --quiet           Only display task IDs
    22  ```
    23  
    24  ## Description
    25  
    26  Lists all the tasks on a Node that Docker knows about. You can filter using the
    27  `-f` or `--filter` flag. Refer to the [filtering](#filtering) section for more
    28  information about available filter options.
    29  
    30  > **Note**
    31  >
    32  > This is a cluster management command, and must be executed on a swarm
    33  > manager node. To learn about managers and workers, refer to the
    34  > [Swarm mode section](https://docs.docker.com/engine/swarm/) in the
    35  > documentation.
    36  
    37  ## Examples
    38  
    39  ```bash
    40  $ docker node ps swarm-manager1
    41  NAME                                IMAGE        NODE            DESIRED STATE  CURRENT STATE
    42  redis.1.7q92v0nr1hcgts2amcjyqg3pq   redis:3.0.6  swarm-manager1  Running        Running 5 hours
    43  redis.6.b465edgho06e318egmgjbqo4o   redis:3.0.6  swarm-manager1  Running        Running 29 seconds
    44  redis.7.bg8c07zzg87di2mufeq51a2qp   redis:3.0.6  swarm-manager1  Running        Running 5 seconds
    45  redis.9.dkkual96p4bb3s6b10r7coxxt   redis:3.0.6  swarm-manager1  Running        Running 5 seconds
    46  redis.10.0tgctg8h8cech4w0k0gwrmr23  redis:3.0.6  swarm-manager1  Running        Running 5 seconds
    47  ```
    48  
    49  ### Filtering
    50  
    51  The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more
    52  than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
    53  
    54  The currently supported filters are:
    55  
    56  * [name](#name)
    57  * [id](#id)
    58  * [label](#label)
    59  * [desired-state](#desired-state)
    60  
    61  #### name
    62  
    63  The `name` filter matches on all or part of a task's name.
    64  
    65  The following filter matches all tasks with a name containing the `redis` string.
    66  
    67  ```bash
    68  $ docker node ps -f name=redis swarm-manager1
    69  
    70  NAME                                IMAGE        NODE            DESIRED STATE  CURRENT STATE
    71  redis.1.7q92v0nr1hcgts2amcjyqg3pq   redis:3.0.6  swarm-manager1  Running        Running 5 hours
    72  redis.6.b465edgho06e318egmgjbqo4o   redis:3.0.6  swarm-manager1  Running        Running 29 seconds
    73  redis.7.bg8c07zzg87di2mufeq51a2qp   redis:3.0.6  swarm-manager1  Running        Running 5 seconds
    74  redis.9.dkkual96p4bb3s6b10r7coxxt   redis:3.0.6  swarm-manager1  Running        Running 5 seconds
    75  redis.10.0tgctg8h8cech4w0k0gwrmr23  redis:3.0.6  swarm-manager1  Running        Running 5 seconds
    76  ```
    77  
    78  #### id
    79  
    80  The `id` filter matches a task's id.
    81  
    82  ```bash
    83  $ docker node ps -f id=bg8c07zzg87di2mufeq51a2qp swarm-manager1
    84  
    85  NAME                                IMAGE        NODE            DESIRED STATE  CURRENT STATE
    86  redis.7.bg8c07zzg87di2mufeq51a2qp   redis:3.0.6  swarm-manager1  Running        Running 5 seconds
    87  ```
    88  
    89  #### label
    90  
    91  The `label` filter matches tasks based on the presence of a `label` alone or a `label` and a
    92  value.
    93  
    94  The following filter matches tasks with the `usage` label regardless of its value.
    95  
    96  ```bash
    97  $ docker node ps -f "label=usage"
    98  
    99  NAME                               IMAGE        NODE            DESIRED STATE  CURRENT STATE
   100  redis.6.b465edgho06e318egmgjbqo4o  redis:3.0.6  swarm-manager1  Running        Running 10 minutes
   101  redis.7.bg8c07zzg87di2mufeq51a2qp  redis:3.0.6  swarm-manager1  Running        Running 9 minutes
   102  ```
   103  
   104  
   105  #### desired-state
   106  
   107  The `desired-state` filter can take the values `running`, `shutdown`, or `accepted`.
   108  
   109  
   110  ### Formatting
   111  
   112  The formatting options (`--format`) pretty-prints tasks output
   113  using a Go template.
   114  
   115  Valid placeholders for the Go template are listed below:
   116  
   117  Placeholder     | Description
   118  ----------------|------------------------------------------------------------------------------------------
   119  `.ID`           | Task ID
   120  `.Name`         | Task name
   121  `.Image`        | Task image
   122  `.Node`         | Node ID
   123  `.DesiredState` | Desired state of the task (`running`, `shutdown`, or `accepted`)
   124  `.CurrentState` | Current state of the task
   125  `.Error`        | Error
   126  `.Ports`        | Task published ports
   127  
   128  When using the `--format` option, the `node ps` command will either
   129  output the data exactly as the template declares or, when using the
   130  `table` directive, includes column headers as well.
   131  
   132  The following example uses a template without headers and outputs the
   133  `Name` and `Image` entries separated by a colon (`:`) for all tasks:
   134  
   135  ```bash
   136  $ docker node ps --format "{{.Name}}: {{.Image}}"
   137  top.1: busybox
   138  top.2: busybox
   139  top.3: busybox
   140  ```
   141  
   142  ## Related commands
   143  
   144  * [node demote](node_demote.md)
   145  * [node inspect](node_inspect.md)
   146  * [node ls](node_ls.md)
   147  * [node promote](node_promote.md)
   148  * [node rm](node_rm.md)
   149  * [node update](node_update.md)