summaryrefslogtreecommitdiff
path: root/docs/nodes.rst
blob: 8ef1e20b2925d0dcfb8b7369a246df75b594333a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
Nodes
=====

.. py:module:: docker.models.nodes

Get and list nodes in a swarm. Before you can use these methods, you first need to :doc:`join or initialize a swarm <swarm>`.

Methods available on ``client.nodes``:

.. rst-class:: hide-signature
.. py:class:: NodeCollection

  .. automethod:: get(id_or_name)
  .. automethod:: list(**kwargs)

Node objects
------------

.. autoclass:: Node()

  .. autoattribute:: id
  .. autoattribute:: short_id
  .. py:attribute:: attrs

    The raw representation of this object from the server.

  .. autoattribute:: version

  .. automethod:: reload
  .. automethod:: update