ansible-collections/community.docker
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.docker.git synced 2025-12-16 20:08:41 +00:00
Code Packages Projects Releases Wiki Activity

docker_network: adjust documentation to reality for state=absent + force=true. (#1016) (#1017)

Browse Source 
(cherry picked from commit d17ee667ce)

Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
patchback[bot] 2024-12-20 23:06:19 +01:00 committed by GitHub
parent ad3ed495fd
commit 27366f4926
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
plugins/modules/docker_network.py
View File

@ -73,9 +73,7 @@ options:
force: force:
description: description:
- With state V(absent) forces disconnecting all containers from the - With state V(present) will disconnect all containers for existing networks, delete the network and re-create the
network prior to deleting the network. With state V(present) will
disconnect all containers, delete the network and re-create the
network. network.
- This option is required if you have changed the IPAM or driver options - This option is required if you have changed the IPAM or driver options
and want an existing network to be updated to use the new options. and want an existing network to be updated to use the new options.
@ -133,9 +131,8 @@ options:
state: state:
description: description:
- V(absent) deletes the network. If a network has connected containers, it - V(absent) deletes the network. If a network has connected containers, these will be
cannot be deleted. Use the O(force) option to disconnect all containers detached from the network.
and delete the network.
- V(present) creates the network, if it does not already exist with the - V(present) creates the network, if it does not already exist with the
specified parameters, and connects the list of containers provided via specified parameters, and connects the list of containers provided via
the connected parameter. Containers not on the list will be disconnected. the connected parameter. Containers not on the list will be disconnected.
@ -259,7 +256,6 @@ EXAMPLES = '''
community.docker.docker_network: community.docker.docker_network:
name: network_one name: network_one
state: absent state: absent
force: true
''' '''
RETURN = ''' RETURN = '''