mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Merge pull request #14739 from chouseknecht/docker_network_facts_proposal
Adding docker_network_facts module proposal.
This commit is contained in:
commit
4b5bb5dd89
1 changed files with 48 additions and 0 deletions
48
docs/proposals/docker/docker_network_facts.md
Normal file
48
docs/proposals/docker/docker_network_facts.md
Normal file
|
@ -0,0 +1,48 @@
|
|||
|
||||
# Docker_Network_Facts Module Proposal
|
||||
|
||||
## Purpose and Scope
|
||||
|
||||
Docker_network_facts will inspect networks.
|
||||
|
||||
Docker_network_facts will use docker-py to communicate with either a local or remote API. It will
|
||||
support API versions >= 1.14. API connection details will be handled externally in a shared utility module similar
|
||||
to how other cloud modules operate.
|
||||
|
||||
## Parameters
|
||||
|
||||
Docker_network_facts will accept the parameters listed below. API connection parameters will be part of a shared
|
||||
utility module as mentioned above.
|
||||
|
||||
```
|
||||
name:
|
||||
description:
|
||||
- Network name or list of network names.
|
||||
default: null
|
||||
|
||||
```
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
```
|
||||
- name: Inspect all networks
|
||||
docker_network_facts
|
||||
register: network_facts
|
||||
|
||||
- name: Inspect a specific network and format the output
|
||||
docker_network_facts
|
||||
name: web_app
|
||||
register: web_app_facts
|
||||
```
|
||||
|
||||
# Returns
|
||||
|
||||
```
|
||||
{
|
||||
changed: False
|
||||
failed: False
|
||||
rc: 0
|
||||
results: [ < inspection output > ]
|
||||
}
|
||||
```
|
Loading…
Reference in a new issue