community.missing_collection.docker_configs_info_module.rst

community.missing_collection.docker_configs_info

Get information about Docker Configs.

Version added: 0.4.0

• Synopsis
• Requirements
• Parameters
• Examples
• Return Values
• Status

Synopsis

• Get information about Docker Configs.
• https://docker-py.readthedocs.io/en/stable/configs.html#

Requirements

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

• docker

Parameters

Parameter	Choices/Defaults	Comments
base_url string	Default: "unix://var/run/docker.sock"	docker unix sock location.
id string		id of docker config

Examples

- name: get all configs
  community.missing_collection.docker_configs_info:
  register: '__'

- name: get info about one config
  community.missing_collection.docker_configs_info:
    id: '{{ __.configs[0].id }}'

Return Values

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

Key	Returned	Description
attrs dictionary	when success and defined id.	attributes of given config
configs list	when success.	list of all the docker configs.

Status

Authors

• Davinder Pal (@116davinder) <dpsangwal@gmail.com>