#!/usr/bin/python # # Copyright 2016 Red Hat | Ansible # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) from __future__ import absolute_import, division, print_function __metaclass__ = type DOCUMENTATION = ''' --- module: docker_network_info short_description: Retrieves facts about docker network description: - Retrieves facts about a docker network. - Essentially returns the output of C(docker network inspect ), similar to what M(community.general.docker_network) returns for a non-absent network. options: name: description: - The name of the network to inspect. - When identifying an existing network name may be a name or a long or short network ID. type: str required: yes extends_documentation_fragment: - community.general.docker - community.general.docker.docker_py_1_documentation author: - "Dave Bendit (@DBendit)" requirements: - "L(Docker SDK for Python,https://docker-py.readthedocs.io/en/stable/) >= 1.8.0 (use L(docker-py,https://pypi.org/project/docker-py/) for Python 2.6)" - "Docker API >= 1.21" ''' EXAMPLES = ''' - name: Get infos on network community.general.docker_network_info: name: mydata register: result - name: Does network exist? ansible.builtin.debug: msg: "The network {{ 'exists' if result.exists else 'does not exist' }}" - name: Print information about network ansible.builtin.debug: var: result.network when: result.exists ''' RETURN = ''' exists: description: - Returns whether the network exists. type: bool returned: always sample: true network: description: - Facts representing the current state of the network. Matches the docker inspection output. - Will be C(none) if network does not exist. returned: always type: dict sample: '{ "Attachable": false, "ConfigFrom": { "Network": "" }, "ConfigOnly": false, "Containers": {}, "Created": "2018-12-07T01:47:51.250835114-06:00", "Driver": "bridge", "EnableIPv6": false, "IPAM": { "Config": [ { "Gateway": "192.168.96.1", "Subnet": "192.168.96.0/20" } ], "Driver": "default", "Options": null }, "Id": "0856968545f22026c41c2c7c3d448319d3b4a6a03a40b148b3ac4031696d1c0a", "Ingress": false, "Internal": false, "Labels": {}, "Name": "ansible-test-f2700bba", "Options": {}, "Scope": "local" }' ''' import traceback try: from docker.errors import DockerException except ImportError: # missing Docker SDK for Python handled in ansible.module_utils.docker.common pass from ansible_collections.community.general.plugins.module_utils.docker.common import ( AnsibleDockerClient, RequestException, ) def main(): argument_spec = dict( name=dict(type='str', required=True), ) client = AnsibleDockerClient( argument_spec=argument_spec, supports_check_mode=True, min_docker_api_version='1.21', ) try: network = client.get_network(client.module.params['name']) client.module.exit_json( changed=False, exists=(True if network else False), network=network, ) except DockerException as e: client.fail('An unexpected docker error occurred: {0}'.format(e), exception=traceback.format_exc()) except RequestException as e: client.fail('An unexpected requests error occurred when docker-py tried to talk to the docker daemon: {0}'.format(e), exception=traceback.format_exc()) if __name__ == '__main__': main()