a-c-m
/
community.general
mirror of https://github.com/ansible-collections/community.general.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

u[a-s]*: normalize docs (#9338) 

* u[a-s]*: normalize docs

* Update plugins/modules/udm_dns_record.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/udm_dns_record.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/udm_dns_record.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/udm_dns_zone.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Update plugins/modules/ufw.py

Co-authored-by: Felix Fontein <felix@fontein.de>

* Apply suggestions from code review

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
pull/9371/head
Alexei Znamensky 2024-12-25 00:00:30 +13:00 committed by GitHub
parent b429e8a2cf
commit 2005125af4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
9 changed files with 846 additions and 888 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
plugins/modules/udm_dns_record.py
View File

@ -10,15 +10,14 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: udm_dns_record
author:
- Tobias Rüetschi (@keachi)
short_description: Manage dns entries on a univention corporate server
description:
- "This module allows to manage dns records on a univention corporate server (UCS).
It uses the python API of the UCS to create a new object or edit it."
- This module allows to manage dns records on a univention corporate server (UCS). It uses the Python API of the UCS to create a new object
or edit it.
requirements:
- Univention
- ipaddress (for O(type=ptr_record))
@ -40,33 +39,31 @@ options:
type: str
required: true
description:
- "Name of the record, this is also the DNS record. E.g. www for
www.example.com."
- Name of the record, this is also the DNS record. For example V(www) for www.example.com.
- For PTR records this has to be the IP address.
zone:
type: str
required: true
description:
- Corresponding DNS zone for this record, e.g. example.com.
- Corresponding DNS zone for this record, for example V(example.com).
- For PTR records this has to be the full reverse zone (for example V(1.1.192.in-addr.arpa)).
type:
type: str
required: true
description:
- "Define the record type. V(host_record) is a A or AAAA record,
V(alias) is a CNAME, V(ptr_record) is a PTR record, V(srv_record)
is a SRV record and V(txt_record) is a TXT record."
- "The available choices are: V(host_record), V(alias), V(ptr_record), V(srv_record), V(txt_record)."
- Define the record type. V(host_record) is a A or AAAA record, V(alias) is a CNAME, V(ptr_record) is a PTR record, V(srv_record) is a SRV
record and V(txt_record) is a TXT record.
- 'The available choices are: V(host_record), V(alias), V(ptr_record), V(srv_record), V(txt_record).'
data:
type: dict
default: {}
description:
- "Additional data for this record, for example V({'a': '192.0.2.1'})."
- Required if O(state=present).
'''
"""
EXAMPLES = '''
EXAMPLES = r"""
- name: Create a DNS record on a UCS
community.general.udm_dns_record:
name: www
@ -92,10 +89,10 @@ EXAMPLES = '''
type: ptr_record
data:
ptr_record: "www.example.com."
'''
"""
RETURN = '''#'''
RETURN = """#"""
from ansible.module_utils.basic import AnsibleModule

24
plugins/modules/udm_dns_zone.py
View File

@ -10,15 +10,14 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: udm_dns_zone
author:
- Tobias Rüetschi (@keachi)
short_description: Manage dns zones on a univention corporate server
description:
- "This module allows to manage dns zones on a univention corporate server (UCS).
It uses the python API of the UCS to create a new object or edit it."
- This module allows to manage dns zones on a univention corporate server (UCS). It uses the Python API of the UCS to create a new object or
edit it.
extends_documentation_fragment:
- community.general.attributes
attributes:
@ -32,13 +31,13 @@ options:
default: "present"
choices: [present, absent]
description:
- Whether the dns zone is present or not.
- Whether the DNS zone is present or not.
type:
type: str
required: true
description:
- Define if the zone is a forward or reverse DNS zone.
- "The available choices are: V(forward_zone), V(reverse_zone)."
- 'The available choices are: V(forward_zone), V(reverse_zone).'
zone:
type: str
required: true
@ -56,9 +55,7 @@ options:
elements: str
default: []
description:
- List of interface IP addresses, on which the server should
response this zone. Required if O(state=present).
- List of interface IP addresses, on which the server should response this zone. Required if O(state=present).
refresh:
type: int
default: 3600
@ -79,7 +76,6 @@ options:
default: 600
description:
- Minimum TTL field that should be exported with any RR from this zone.
contact:
type: str
default: ''
@ -91,10 +87,10 @@ options:
default: []
description:
- List of MX servers. (Must declared as A or AAAA records).
'''
"""
EXAMPLES = '''
EXAMPLES = r"""
- name: Create a DNS zone on a UCS
community.general.udm_dns_zone:
zone: example.com
@ -103,10 +99,10 @@ EXAMPLES = '''
- ucs.example.com
interfaces:
- 192.0.2.1
'''
"""
RETURN = '''# '''
RETURN = """# """
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.univention_umc import (

24
plugins/modules/udm_group.py
View File

@ -10,15 +10,14 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: udm_group
author:
- Tobias Rüetschi (@keachi)
short_description: Manage of the posix group
description:
- "This module allows to manage user groups on a univention corporate server (UCS).
It uses the python API of the UCS to create a new object or edit it."
- This module allows to manage user groups on a univention corporate server (UCS). It uses the Python API of the UCS to create a new object
or edit it.
extends_documentation_fragment:
- community.general.attributes
attributes:
@ -37,7 +36,7 @@ options:
name:
required: true
description:
- Name of the posix group.
- Name of the POSIX group.
type: str
description:
required: false
@ -47,26 +46,25 @@ options:
position:
required: false
description:
- define the whole ldap position of the group, e.g.
C(cn=g123m-1A,cn=classes,cn=schueler,cn=groups,ou=schule,dc=example,dc=com).
- Define the whole LDAP position of the group, for example V(cn=g123m-1A,cn=classes,cn=schueler,cn=groups,ou=schule,dc=example,dc=com).
type: str
default: ''
ou:
required: false
description:
- LDAP OU, e.g. school for LDAP OU C(ou=school,dc=example,dc=com).
- LDAP OU, for example V(school) for LDAP OU V(ou=school,dc=example,dc=com).
type: str
default: ''
subpath:
required: false
description:
- Subpath inside the OU, e.g. C(cn=classes,cn=students,cn=groups).
- Subpath inside the OU, for example V(cn=classes,cn=students,cn=groups).
type: str
default: "cn=groups"
'''
"""
EXAMPLES = '''
EXAMPLES = r"""
- name: Create a POSIX group
community.general.udm_group:
name: g123m-1A
@ -84,10 +82,10 @@ EXAMPLES = '''
community.general.udm_group:
name: g123m-1A
position: 'cn=classes,cn=students,cn=groups,ou=school,dc=school,dc=example,dc=com'
'''
"""
RETURN = '''# '''
RETURN = """# """
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.univention_umc import (

18
plugins/modules/udm_share.py
View File

@ -10,16 +10,14 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: udm_share
author:
- Tobias Rüetschi (@keachi)
short_description: Manage samba shares on a univention corporate server
description:
- "This module allows to manage samba shares on a univention corporate
server (UCS).
It uses the python API of the UCS to create a new object or edit it."
- This module allows to manage samba shares on a univention corporate server (UCS). It uses the Python API of the UCS to create a new object
or edit it.
extends_documentation_fragment:
- community.general.attributes
attributes:
@ -37,7 +35,7 @@ options:
name:
required: true
description:
- Name
- Name.
type: str
host:
required: false
@ -329,20 +327,20 @@ options:
type: list
elements: str
aliases: [nfs_custom_settings]
'''
"""
EXAMPLES = '''
EXAMPLES = r"""
- name: Create a share named home on the server ucs.example.com with the path /home
community.general.udm_share:
name: home
path: /home
host: ucs.example.com
sambaName: Home
'''
"""
RETURN = '''# '''
RETURN = """# """
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.community.general.plugins.module_utils.univention_umc import (

76
plugins/modules/udm_user.py
View File

@ -10,20 +10,17 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = r'''
---
DOCUMENTATION = r"""
module: udm_user
author:
- Tobias Rüetschi (@keachi)
short_description: Manage posix users on a univention corporate server
description:
- "This module allows to manage posix users on a univention corporate
server (UCS).
It uses the python API of the UCS to create a new object or edit it."
- This module allows to manage posix users on a univention corporate server (UCS). It uses the Python API of the UCS to create a new object
or edit it.
notes:
- This module requires the deprecated L(crypt Python module,
https://docs.python.org/3.12/library/crypt.html) library which was removed from Python 3.13.
For Python 3.13 or newer, you need to install L(legacycrypt, https://pypi.org/project/legacycrypt/).
- This module requires the deprecated L(crypt Python module, https://docs.python.org/3.12/library/crypt.html) library which was removed from
Python 3.13. For Python 3.13 or newer, you need to install L(legacycrypt, https://pypi.org/project/legacycrypt/).
requirements:
- legacycrypt (on Python 3.13 or newer)
extends_documentation_fragment:
@ -43,7 +40,7 @@ options:
username:
required: true
description:
- User name
- User name.
aliases: ['name']
type: str
firstname:
@ -60,7 +57,7 @@ options:
type: str
birthday:
description:
- Birthday
- Birthday.
type: str
city:
description:
@ -77,11 +74,11 @@ options:
type: str
description:
description:
- Description (not gecos)
- Description (not gecos).
type: str
display_name:
description:
- Display name (not gecos)
- Display name (not gecos).
aliases: [displayName]
type: str
email:
@ -92,30 +89,27 @@ options:
elements: str
employee_number:
description:
- Employee number
- Employee number.
aliases: [employeeNumber]
type: str
employee_type:
description:
- Employee type
- Employee type.
aliases: [employeeType]
type: str
gecos:
description:
- GECOS
- GECOS.
type: str
groups:
default: []
description:
- "POSIX groups, the LDAP DNs of the groups will be found with the
LDAP filter for each group as $GROUP:
V((&(objectClass=posixGroup\\)(cn=$GROUP\\)\\))."
- 'POSIX groups, the LDAP DNs of the groups will be found with the LDAP filter for each group as $GROUP: V((&(objectClass=posixGroup\)(cn=$GROUP\)\)).'
type: list
elements: str
home_share:
description:
- "Home NFS share. Must be a LDAP DN, e.g.
V(cn=home,cn=shares,ou=school,dc=example,dc=com)."
- Home NFS share. Must be a LDAP DN, for example V(cn=home,cn=shares,ou=school,dc=example,dc=com).
aliases: [homeShare]
type: str
home_share_path:
@ -143,37 +137,37 @@ options:
elements: str
mail_home_server:
description:
- FQDN of mail server
- FQDN of mail server.
aliases: [mailHomeServer]
type: str
mail_primary_address:
description:
- Primary e-mail address
- Primary e-mail address.
aliases: [mailPrimaryAddress]
type: str
mobile_telephone_number:
default: []
description:
- Mobile phone number
- Mobile phone number.
aliases: [mobileTelephoneNumber]
type: list
elements: str
organisation:
description:
- Organisation
- Organisation.
aliases: [organization]
type: str
overridePWHistory:
type: bool
default: false
description:
- Override password history
- Override password history.
aliases: [override_pw_history]
overridePWLength:
type: bool
default: false
description:
- Override password check
- Override password check.
aliases: [override_pw_length]
pager_telephonenumber:
default: []
@ -200,7 +194,7 @@ options:
type: str
profilepath:
description:
- Windows profile directory
- Windows profile directory.
type: str
pwd_change_next_login:
choices: ['0', '1']
@ -215,8 +209,7 @@ options:
type: str
samba_privileges:
description:
- "Samba privilege, like allow printer administration, do domain
join."
- Samba privilege, like allow printer administration, do domain join.
aliases: [sambaPrivileges]
type: list
elements: str
@ -251,7 +244,7 @@ options:
shell:
default: '/bin/bash'
description:
- Login shell
- Login shell.
type: str
street:
description:
@ -263,7 +256,7 @@ options:
type: str
unixhome:
description:
- Unix home directory
- Unix home directory.
- If not specified, it defaults to C(/home/$USERNAME).
type: str
userexpiry:
@ -274,33 +267,28 @@ options:
position:
default: ''
description:
- "Define the whole position of users object inside the LDAP tree,
for example V(cn=employee,cn=users,ou=school,dc=example,dc=com)."
- Define the whole position of users object inside the LDAP tree, for example V(cn=employee,cn=users,ou=school,dc=example,dc=com).
type: str
update_password:
default: always
choices: [always, on_create]
description:
- "V(always) will update passwords if they differ.
V(on_create) will only set the password for newly created users."
- V(always) will update passwords if they differ. V(on_create) will only set the password for newly created users.
type: str
ou:
default: ''
description:
- "Organizational Unit inside the LDAP Base DN, for example V(school) for
LDAP OU C(ou=school,dc=example,dc=com)."
- Organizational Unit inside the LDAP Base DN, for example V(school) for LDAP OU C(ou=school,dc=example,dc=com).
type: str
subpath:
default: 'cn=users'
description:
- "LDAP subpath inside the organizational unit, for example
V(cn=teachers,cn=users) for LDAP container
C(cn=teachers,cn=users,dc=example,dc=com)."
- LDAP subpath inside the organizational unit, for example V(cn=teachers,cn=users) for LDAP container C(cn=teachers,cn=users,dc=example,dc=com).
type: str
'''
"""
EXAMPLES = '''
EXAMPLES = r"""
- name: Create a user on a UCS
community.general.udm_user:
name: FooBar
@ -325,10 +313,10 @@ EXAMPLES = '''
firstname: Foo
lastname: Bar
position: 'cn=teachers,cn=users,ou=school,dc=school,dc=example,dc=com'
'''
"""
RETURN = '''# '''
RETURN = """# """
from datetime import date, timedelta
import traceback

66
plugins/modules/ufw.py
View File

@ -11,8 +11,7 @@
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = r'''
---
DOCUMENTATION = r"""
module: ufw
short_description: Manage firewall with UFW
description:
@ -23,10 +22,9 @@ author:
- Ahti Kitsik (@ahtik)
notes:
- See C(man ufw) for more examples.
- >
B(Warning:) Whilst the module itself can be run using concurrent strategies, C(ufw) does not support concurrency,
as firewall rules are meant to be ordered and parallel executions do not guarantee order.
B(Do not use concurrency:) The results are unpredictable and the module may fail silently if you do.
- "B(Warning:) Whilst the module itself can be run using concurrent strategies, C(ufw) does not support concurrency, as firewall rules are meant
to be ordered and parallel executions do not guarantee order. B(Do not use concurrency:) The results are unpredictable and the module may
fail silently if you do."
requirements:
- C(ufw) package
extends_documentation_fragment:
@ -53,8 +51,7 @@ options:
aliases: [policy]
direction:
description:
- Select direction for a rule or default policy command. Mutually
exclusive with O(interface_in) and O(interface_out).
- Select direction for a rule or default policy command. Mutually exclusive with O(interface_in) and O(interface_out).
type: str
choices: [in, incoming, out, outgoing, routed]
logging:
@ -66,37 +63,31 @@ options:
description:
- Insert the corresponding rule as rule number NUM.
- Note that ufw numbers rules starting with 1.
- If O(delete=true) and a value is provided for O(insert),
then O(insert) is ignored.
- If O(delete=true) and a value is provided for O(insert), then O(insert) is ignored.
type: int
insert_relative_to:
description:
- Allows to interpret the index in O(insert) relative to a position.
- V(zero) interprets the rule number as an absolute index (i.e. 1 is
the first rule).
- V(first-ipv4) interprets the rule number relative to the index of the
first IPv4 rule, or relative to the position where the first IPv4 rule
- V(zero) interprets the rule number as an absolute index (that is, 1 is the first rule).
- V(first-ipv4) interprets the rule number relative to the index of the first IPv4 rule, or relative to the position where the first IPv4
rule would be if there is currently none.
- V(last-ipv4) interprets the rule number relative to the index of the last IPv4 rule, or relative to the position where the last IPv4 rule
would be if there is currently none.
- V(last-ipv4) interprets the rule number relative to the index of the
last IPv4 rule, or relative to the position where the last IPv4 rule
would be if there is currently none.
- V(first-ipv6) interprets the rule number relative to the index of the
first IPv6 rule, or relative to the position where the first IPv6 rule
would be if there is currently none.
- V(last-ipv6) interprets the rule number relative to the index of the
last IPv6 rule, or relative to the position where the last IPv6 rule
- V(first-ipv6) interprets the rule number relative to the index of the first IPv6 rule, or relative to the position where the first IPv6
rule would be if there is currently none.
- V(last-ipv6) interprets the rule number relative to the index of the last IPv6 rule, or relative to the position where the last IPv6 rule
would be if there is currently none.
type: str
choices: [first-ipv4, first-ipv6, last-ipv4, last-ipv6, zero]
default: zero
rule:
description:
- Add firewall rule
- Add firewall rule.
type: str
choices: [allow, deny, limit, reject]
log:
description:
- Log new connections matched to this rule
- Log new connections matched to this rule.
type: bool
default: false
from_ip:
@ -134,32 +125,27 @@ options:
delete:
description:
- Delete rule.
- If O(delete=true) and a value is provided for O(insert),
then O(insert) is ignored.
- If O(delete=true) and a value is provided for O(insert), then O(insert) is ignored.
type: bool
default: false
interface:
description:
- Specify interface for the rule. The direction (in or out) used
for the interface depends on the value of O(direction). See
O(interface_in) and O(interface_out) for routed rules that needs
to supply both an input and output interface. Mutually
exclusive with O(interface_in) and O(interface_out).
- Specify interface for the rule. The direction (in or out) used for the interface depends on the value of O(direction). See O(interface_in)
and O(interface_out) for routed rules that needs to supply both an input and output interface. Mutually exclusive with O(interface_in)
and O(interface_out).
type: str
aliases: [if]
interface_in:
description:
- Specify input interface for the rule. This is mutually
exclusive with O(direction) and O(interface). However, it is
compatible with O(interface_out) for routed rules.
- Specify input interface for the rule. This is mutually exclusive with O(direction) and O(interface). However, it is compatible with O(interface_out)
for routed rules.
type: str
aliases: [if_in]
version_added: '0.2.0'
interface_out:
description:
- Specify output interface for the rule. This is mutually
exclusive with O(direction) and O(interface). However, it is
compatible with O(interface_in) for routed rules.
- Specify output interface for the rule. This is mutually exclusive with O(direction) and O(interface). However, it is compatible with O(interface_in)
for routed rules.
type: str
aliases: [if_out]
version_added: '0.2.0'
@ -172,9 +158,9 @@ options:
description:
- Add a comment to the rule. Requires UFW version >=0.35.
type: str
'''
"""
EXAMPLES = r'''
EXAMPLES = r"""
- name: Allow everything and enable UFW
community.general.ufw:
state: enabled
@ -299,7 +285,7 @@ EXAMPLES = r'''
route: true
src: 192.0.2.0/24
dest: 198.51.100.0/24
'''
"""
import re

11
plugins/modules/uptimerobot.py
View File

@ -8,12 +8,11 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
DOCUMENTATION = r"""
module: uptimerobot
short_description: Pause and start Uptime Robot monitoring
description:
- This module will let you start and pause Uptime Robot Monitoring
- This module will let you start and pause Uptime Robot Monitoring.
author: "Nate Kingsley (@nate-kingsley)"
requirements:
- Valid Uptime Robot API Key
@ -43,9 +42,9 @@ options:
required: true
notes:
- Support for adding and removing monitors and alert contacts has not yet been implemented.
'''
"""
EXAMPLES = '''
EXAMPLES = r"""
- name: Pause the monitor with an ID of 12345
community.general.uptimerobot:
monitorid: 12345
@ -57,7 +56,7 @@ EXAMPLES = '''
monitorid: 12345
apikey: 12345-1234512345
state: started
'''
"""
import json

17
plugins/modules/urpmi.py
View File

@ -11,12 +11,11 @@
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: urpmi
short_description: Urpmi manager
description:
- Manages packages with C(urpmi) (such as for Mageia or Mandriva)
- Manages packages with C(urpmi) (such as for Mageia or Mandriva).
extends_documentation_fragment:
- community.general.attributes
attributes:
@ -50,21 +49,19 @@ options:
default: true
force:
description:
- Assume "yes" is the answer to any question urpmi has to ask.
Corresponds to the C(--force) option for C(urpmi).
- Assume "yes" is the answer to any question urpmi has to ask. Corresponds to the C(--force) option for C(urpmi).
type: bool
default: true
root:
description:
- Specifies an alternative install root, relative to which all packages will be installed.
Corresponds to the C(--root) option for C(urpmi).
- Specifies an alternative install root, relative to which all packages will be installed. Corresponds to the C(--root) option for C(urpmi).
aliases: [installroot]
type: str
author:
- Philippe Makowski (@pmakowski)
'''
"""
EXAMPLES = '''
EXAMPLES = r"""
- name: Install package foo
community.general.urpmi:
pkg: foo
@ -85,7 +82,7 @@ EXAMPLES = '''
name: bar
state: present
update_cache: true
'''
"""
from ansible.module_utils.basic import AnsibleModule

13
plugins/modules/usb_facts.py
View File

@ -10,8 +10,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = '''
---
DOCUMENTATION = r"""
module: usb_facts
short_description: Allows listing information about USB devices
version_added: 8.5.0
@ -25,9 +24,9 @@ extends_documentation_fragment:
- community.general.attributes.facts_module
requirements:
- lsusb binary on PATH (usually installed through the package usbutils and preinstalled on many systems)
'''
"""
EXAMPLES = '''
EXAMPLES = r"""
- name: Get information about USB devices
community.general.usb_facts:
@ -35,9 +34,9 @@ EXAMPLES = '''
ansible.builtin.debug:
msg: "On bus {{ item.bus }} device {{ item.device }} with id {{ item.id }} is {{ item.name }}"
loop: "{{ ansible_facts.usb_devices }}"
'''
"""
RETURN = r'''
RETURN = r"""
ansible_facts:
description: Dictionary containing details of connected USB devices.
returned: always
@ -69,7 +68,7 @@ ansible_facts:
returned: always
type: str
sample: Linux Foundation 2.0 root hub
'''
"""
import re
from ansible.module_utils.basic import AnsibleModule