community.missing_collection.docker_plugins_info_module.rst

community.missing_collection.docker_plugins_info

Get information about Docker Plugins.

Version added: 0.4.0

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

Synopsis

• Get information about Docker Plugins.
• https://docker-py.readthedocs.io/en/stable/plugins.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 plugin

Examples

- name: get all plugins
  community.missing_collection.docker_plugins_info:
  register: '__'

- name: get info about one plugin
  community.missing_collection.docker_plugins_info:
    id: '{{ __.plugins[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 plugin Sample: {'Config': {'Args': {'Description': '', 'Name': '', 'Settable': None, 'Value': None}, 'Description': 'sshFS plugin for Docker', 'DockerVersion': '18.05.0-ce-rc1', 'Documentation': 'https://docs.docker.com/engine/extend/plugins/', 'Entrypoint': ['/docker-volume-sshfs'], 'Env': [{'Description': '', 'Name': 'DEBUG', 'Settable': ['value'], 'Value': '0'}], 'Interface': {'Socket': 'sshfs.sock', 'Types': ['docker.volumedriver/1.0']}, 'IpcHost': False, 'Linux': {'AllowAllDevices': False, 'Capabilities': ['CAP_SYS_ADMIN'], 'Devices': [{'Description': '', 'Name': '', 'Path': '/dev/fuse', 'Settable': None}]}, 'Mounts': [{'Description': '', 'Destination': '/mnt/state', 'Name': 'state', 'Options': ['rbind'], 'Settable': ['source'], 'Source': '/var/lib/docker/plugins/', 'Type': 'bind'}, {'Description': '', 'Destination': '/root/.ssh', 'Name': 'sshkey', 'Options': ['rbind'], 'Settable': ['source'], 'Source': '', 'Type': 'bind'}], 'Network': {'Type': 'host'}, 'PidHost': False, 'PropagatedMount': '/mnt/volumes', 'User': {}, 'WorkDir': '', 'rootfs': {'diff_ids': ['sha256:ce2b7a99c5db05cfe263bcd3640f2c1ce7c6f4619339633d44e65a8168ec3587'], 'type': 'layers'}}, 'Enabled': True, 'Id': '299f9f87dd9bd0052fb52fa2f5bd6d983b0d7b4f9d505cc07e37742bb17337bd', 'Name': 'vieux/sshfs:latest', 'PluginReference': 'docker.io/vieux/sshfs:latest', 'Settings': {'Args': [], 'Devices': [{'Description': '', 'Name': '', 'Path': '/dev/fuse', 'Settable': None}], 'Env': ['DEBUG=0'], 'Mounts': [{'Description': '', 'Destination': '/mnt/state', 'Name': 'state', 'Options': ['rbind'], 'Settable': ['source'], 'Source': '/var/lib/docker/plugins/', 'Type': 'bind'}, {'Description': '', 'Destination': '/root/.ssh', 'Name': 'sshkey', 'Options': ['rbind'], 'Settable': ['source'], 'Source': '', 'Type': 'bind'}]}}
plugins list	when success.	list of all the docker plugins. Sample: [{'enabled': True, 'id': '299f9f87dd9bd0052fb52fa2f5bd6d983b0d7b4f9d505cc07e37742bb17337bd', 'name': 'vieux/sshfs:latest'}]

Status

Authors

• Davinder Pal (@116davinder) <[email protected]>