community.docker.docker_network_info – Retrieves facts about docker network

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values

Synopsis

• Retrieves facts about a docker network.
• Essentially returns the output of docker network inspect <name>, similar to what community.docker.docker_network returns for a non-absent network.

Requirements

The below requirements are needed on the host that executes this module.

• Docker API >= 1.21
• Docker SDK for Python: Please note that the docker-py Python module has been superseded by docker (see here for details). For Python 2.6, docker-py must be used. Otherwise, it is recommended to install the docker Python module. Note that both modules should not be installed at the same time. Also note that when both modules are installed and one of them is uninstalled, the other might no longer function and a reinstall of it is required.
• Docker SDK for Python >= 1.8.0 (use docker-py for Python 2.6)

Parameters

Notes

Examples

- name: Get infos on network
  community.docker.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 Values

Common return values are documented here, the following are the fields unique to this module:

Authors

• Dave Bendit (@DBendit)