mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-22 18:31:25 -07:00
[ip ... j]*.py: normalize docs (#9392)
* [ip ... j]*.py: normalize docs * Update plugins/modules/ip_netns.py Co-authored-by: Felix Fontein <felix@fontein.de> --------- Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
parent
cea6eeef37
commit
a99f72fc36
43 changed files with 1290 additions and 1429 deletions
|
@ -7,37 +7,36 @@
|
|||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
DOCUMENTATION = r"""
|
||||
module: ip_netns
|
||||
author: "Arie Bregman (@bregman-arie)"
|
||||
short_description: Manage network namespaces
|
||||
requirements: [ ip ]
|
||||
requirements: [ip]
|
||||
description:
|
||||
- Create or delete network namespaces using the ip command.
|
||||
- Create or delete network namespaces using the C(ip) command.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
- community.general.attributes
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
check_mode:
|
||||
support: full
|
||||
diff_mode:
|
||||
support: none
|
||||
options:
|
||||
name:
|
||||
required: false
|
||||
description:
|
||||
- Name of the namespace
|
||||
type: str
|
||||
state:
|
||||
required: false
|
||||
default: "present"
|
||||
choices: [ present, absent ]
|
||||
description:
|
||||
- Whether the namespace should exist
|
||||
type: str
|
||||
'''
|
||||
name:
|
||||
required: false
|
||||
description:
|
||||
- Name of the namespace.
|
||||
type: str
|
||||
state:
|
||||
required: false
|
||||
default: "present"
|
||||
choices: [present, absent]
|
||||
description:
|
||||
- Whether the namespace should exist.
|
||||
type: str
|
||||
"""
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r"""
|
||||
- name: Create a namespace named mario
|
||||
community.general.ip_netns:
|
||||
name: mario
|
||||
|
@ -47,11 +46,11 @@ EXAMPLES = '''
|
|||
community.general.ip_netns:
|
||||
name: luigi
|
||||
state: absent
|
||||
'''
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
RETURN = r"""
|
||||
# Default return values
|
||||
'''
|
||||
"""
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
from ansible.module_utils.common.text.converters import to_text
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue