summaryrefslogtreecommitdiff
path: root/docker/models/networks.py
diff options
context:
space:
mode:
Diffstat (limited to 'docker/models/networks.py')
-rw-r--r--docker/models/networks.py19
1 files changed, 10 insertions, 9 deletions
diff --git a/docker/models/networks.py b/docker/models/networks.py
index d5e2097..a80c9f5 100644
--- a/docker/models/networks.py
+++ b/docker/models/networks.py
@@ -32,17 +32,18 @@ class Network(Model):
container (str): Container to connect to this network, as either
an ID, name, or :py:class:`~docker.models.containers.Container`
object.
- aliases (list): A list of aliases for this endpoint. Names in that
- list can be used within the network to reach the container.
- Defaults to ``None``.
- links (list): A list of links for this endpoint. Containers
- declared in this list will be linkedto this container.
- Defaults to ``None``.
+ aliases (:py:class:`list`): A list of aliases for this endpoint.
+ Names in that list can be used within the network to reach the
+ container. Defaults to ``None``.
+ links (:py:class:`list`): A list of links for this endpoint.
+ Containers declared in this list will be linkedto this
+ container. Defaults to ``None``.
ipv4_address (str): The IP address of this container on the
network, using the IPv4 protocol. Defaults to ``None``.
ipv6_address (str): The IP address of this container on the
network, using the IPv6 protocol. Defaults to ``None``.
- link_local_ips (list): A list of link-local (IPv4/IPv6) addresses.
+ link_local_ips (:py:class:`list`): A list of link-local (IPv4/IPv6)
+ addresses.
Raises:
:py:class:`docker.errors.APIError`
@@ -167,8 +168,8 @@ class NetworkCollection(Collection):
List networks. Similar to the ``docker networks ls`` command.
Args:
- names (list): List of names to filter by.
- ids (list): List of ids to filter by.
+ names (:py:class:`list`): List of names to filter by.
+ ids (:py:class:`list`): List of ids to filter by.
Returns:
(list of :py:class:`Network`) The networks on the server.