summaryrefslogtreecommitdiff
path: root/docs/containers.rst
blob: 7c41bfdd9289bd00259f5d2dd31db4938a4cc480 (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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
Containers
==========

.. py:module:: docker.models.containers

Run and manage containers on the server.

Methods available on ``client.containers``:

.. rst-class:: hide-signature
.. autoclass:: ContainerCollection

  .. automethod:: run(image, command=None, **kwargs)
  .. automethod:: create(image, command=None, **kwargs)
  .. automethod:: get(id_or_name)
  .. automethod:: list(**kwargs)
  .. automethod:: prune

Container objects
-----------------

.. autoclass:: Container()

  .. py:attribute:: attrs
  .. autoattribute:: id
  .. autoattribute:: image
  .. autoattribute:: labels
  .. autoattribute:: name
  .. autoattribute:: short_id
  .. autoattribute:: status

    The raw representation of this object from the server.

  .. automethod:: attach
  .. automethod:: attach_socket
  .. automethod:: commit
  .. automethod:: diff
  .. automethod:: exec_run
  .. automethod:: export
  .. automethod:: get_archive
  .. automethod:: kill
  .. automethod:: logs
  .. automethod:: pause
  .. automethod:: put_archive
  .. automethod:: reload
  .. automethod:: remove
  .. automethod:: rename
  .. automethod:: resize
  .. automethod:: restart
  .. automethod:: start
  .. automethod:: stats
  .. automethod:: stop
  .. automethod:: top
  .. automethod:: unpause
  .. automethod:: update
  .. automethod:: wait