List networks. Similar to the ``docker network ls`` command. Args: names (:py:class:`list`): List of names to filter by ids (:py:class:`list`): List of ids to filter by filters (dict): Filters to be processed on the network list.
(self, names=None, ids=None, filters=None)
| 5 | |
| 6 | class NetworkApiMixin: |
| 7 | def networks(self, names=None, ids=None, filters=None): |
| 8 | """ |
| 9 | List networks. Similar to the ``docker network ls`` command. |
| 10 | |
| 11 | Args: |
| 12 | names (:py:class:`list`): List of names to filter by |
| 13 | ids (:py:class:`list`): List of ids to filter by |
| 14 | filters (dict): Filters to be processed on the network list. |
| 15 | Available filters: |
| 16 | - ``driver=[<driver-name>]`` Matches a network's driver. |
| 17 | - ``label=[<key>]``, ``label=[<key>=<value>]`` or a list of |
| 18 | such. |
| 19 | - ``type=["custom"|"builtin"]`` Filters networks by type. |
| 20 | |
| 21 | Returns: |
| 22 | (dict): List of network objects. |
| 23 | |
| 24 | Raises: |
| 25 | :py:class:`docker.errors.APIError` |
| 26 | If the server returns an error. |
| 27 | """ |
| 28 | |
| 29 | if filters is None: |
| 30 | filters = {} |
| 31 | if names: |
| 32 | filters['name'] = names |
| 33 | if ids: |
| 34 | filters['id'] = ids |
| 35 | params = {'filters': utils.convert_filters(filters)} |
| 36 | url = self._url("/networks") |
| 37 | res = self._get(url, params=params) |
| 38 | return self._result(res, json=True) |
| 39 | |
| 40 | def create_network(self, name, driver=None, options=None, ipam=None, |
| 41 | check_duplicate=None, internal=False, labels=None, |