community.general.docker_node_info – Retrieves facts about docker swarm node from Swarm Manager¶
This plugin is part of the community.general collection.
To install it use:
ansible-galaxy collection install community.general.
To use it in a playbook, specify:
Retrieves facts about a docker node.
Essentially returns the output of
docker node inspect <name>.
Must be executed on a host running as Swarm Manager, otherwise the module will fail.
The below requirements are needed on the host that executes this module.
Docker API >= 1.24
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-pymust be used. Otherwise, it is recommended to install the
dockerPython 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 >= 2.4.0
Connect to the Docker daemon by providing parameters with each task or by defining environment variables. You can define
DOCKER_TIMEOUT. If you are using docker machine, run the script shipped with the product that sets up the environment. It will set these variables for you. See https://docs.docker.com/machine/reference/env/ for more details.
When connecting to Docker daemon with TLS, you might need to install additional Python packages. For the Docker SDK for Python, version 2.4 or newer, this can be done by installing
Note that the Docker SDK for Python only allows to specify the path to the Docker configuration for very few functions. In general, it will use
DOCKER_CONFIGenvironment variable is not specified, and use
- name: Get info on all nodes community.general.docker_node_info: register: result - name: Get info on node community.general.docker_node_info: name: mynode register: result - name: Get info on list of nodes community.general.docker_node_info: name: - mynode1 - mynode2 register: result - name: Get info on host if it is Swarm Manager community.general.docker_node_info: self: true register: result
Common return values are documented here, the following are the fields unique to this module: