ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-24 13:50:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 10

[PR #10409/a36ad54b backport][stable-10] doc style adjustments: modules i* (#10410)

Browse source 
doc style adjustments: modules i* (#10409)

(cherry picked from commit a36ad54b53)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot] 2025-07-14 15:34:36 +02:00 • committed by GitHub
commit 003f9e498e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
28 changed files with 305 additions and 306 deletions
Download patch file Download diff file Expand all files Collapse all files

4
plugins/modules/ibm_sa_host.py
View file

@ -41,8 +41,8 @@ options:
type: str
domain:
description:
- The domains the cluster will be attached to. To include more than one domain, separate domain names with commas. To
include all existing domains, use an asterisk (V(*)).
- The domains the cluster is attached to. To include more than one domain, separate domain names with commas. To include
all existing domains, use an asterisk (V(*)).
required: false
type: str
iscsi_chap_name:

14
plugins/modules/icinga2_host.py
View file

@ -30,13 +30,13 @@ options:
- HTTP, HTTPS, or FTP URL in the form V((http|https|ftp\)://[user[:pass]]@host.domain[:port]/path).
use_proxy:
description:
- If V(false), it will not use a proxy, even if one is defined in an environment variable on the target hosts.
- If V(false), it does not use a proxy, even if one is defined in an environment variable on the target hosts.
type: bool
default: true
validate_certs:
description:
- If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using
self-signed certificates.
- If V(false), SSL certificates are not validated. This should only be used on personally controlled sites using self-signed
certificates.
type: bool
default: true
url_username:
@ -48,12 +48,12 @@ options:
type: str
description:
- The password for use in HTTP basic authentication.
- If the O(url_username) parameter is not specified, the O(url_password) parameter will not be used.
- If the O(url_username) parameter is not specified, the O(url_password) parameter is not used.
force_basic_auth:
description:
- C(httplib2), the library used by Ansible's HTTP request code only sends authentication information when a webservice responds to
an initial request with a 401 status. Since some basic auth services do not properly send a 401, logins will fail.
This option forces the sending of the Basic authentication header upon initial request.
- C(httplib2), the library used by Ansible's HTTP request code only sends authentication information when a webservice
responds to an initial request with a 401 status. Since some basic auth services do not properly send a 401, logins
may fail. This option forces the sending of the Basic authentication header upon initial request.
type: bool
default: false
client_cert:

12
plugins/modules/imc_rest.py
View file

@ -57,8 +57,8 @@ options:
description:
- When used instead of O(path), sets the content of the API requests directly.
- This may be convenient to template simple requests, for anything complex use the M(ansible.builtin.template) module.
- You can collate multiple IMC XML fragments and they will be processed sequentially in a single stream, the Cisco IMC
output is subsequently merged.
- You can collate multiple IMC XML fragments and they are processed sequentially in a single stream, the Cisco IMC output
is subsequently merged.
- Parameter O(content) is mutual exclusive with parameter O(path).
type: str
protocol:
@ -71,12 +71,12 @@ options:
description:
- The socket level timeout in seconds.
- This is the time that every single connection (every fragment) can spend. If this O(timeout) is reached, the module
will fail with a C(Connection failure) indicating that C(The read operation timed out).
fails with a C(Connection failure) indicating that C(The read operation timed out).
default: 60
type: int
validate_certs:
description:
- If V(false), SSL certificates will not be validated.
- If V(false), SSL certificates are not validated.
- This should only set to V(false) used on personally controlled sites using self-signed certificates.
type: bool
default: true
@ -84,8 +84,8 @@ notes:
- The XML fragments do not need an authentication cookie, this is injected by the module automatically.
- The Cisco IMC XML output is being translated to JSON using the Cobra convention.
- Any configConfMo change requested has a return status of C(modified), even if there was no actual change from the previous
configuration. As a result, this module will always report a change on subsequent runs. In case this behaviour is fixed
in a future update to Cisco IMC, this module will automatically adapt.
configuration. As a result, this module always reports a change on subsequent runs. In case this behaviour is fixed in
a future update to Cisco IMC, this module is meant to automatically adapt.
- If you get a C(Connection failure) related to C(The read operation timed out) increase the O(timeout) parameter. Some
XML fragments can take longer than the default timeout.
- More information about the IMC REST API is available from

2
plugins/modules/imgadm.py
View file

@ -44,7 +44,7 @@ options:
choices: [present, absent, deleted, imported, updated, vacuumed]
description:
- State the object operated on should be in. V(imported) is an alias for for V(present) and V(deleted) for V(absent).
When set to V(vacuumed) and O(uuid=*), it will remove all unused images.
When set to V(vacuumed) and O(uuid=*), it removes all unused images.
type: str
type:

6
plugins/modules/influxdb_user.py
View file

@ -37,7 +37,7 @@ options:
admin:
description:
- Whether the user should be in the admin role or not.
- Since version 2.8, the role will also be updated.
- Since version 2.8, the role is also updated.
default: false
type: bool
state:
@ -50,8 +50,8 @@ options:
description:
- Privileges to grant to this user.
- Takes a list of dicts containing the "database" and "privilege" keys.
- If this argument is not provided, the current grants will be left alone.
- If an empty list is provided, all grants for the user will be removed.
- If this argument is not provided, the current grants are left alone.
- If an empty list is provided, all grants for the user are removed.
type: list
elements: dict
extends_documentation_fragment:

12
plugins/modules/ini_file.py
View file

@ -39,7 +39,7 @@ options:
section:
description:
- Section name in INI file. This is added if O(state=present) automatically when a single value is being set.
- If being omitted, the O(option) will be placed before the first O(section).
- If being omitted, the O(option) is placed before the first O(section).
- Omitting O(section) is also required if the config format does not support sections.
type: str
section_has_values:
@ -63,7 +63,7 @@ options:
elements: str
description:
- Among possibly multiple sections of the same name, select the first one that contains matching options and values.
- With O(state=present), if a suitable section is not found, a new section will be added, including the required options.
- With O(state=present), if a suitable section is not found, a new section is added, including the required options.
- With O(state=absent), at most one O(section) is removed if it contains the values.
version_added: 8.6.0
option:
@ -100,8 +100,8 @@ options:
O(option)s with the same name are not touched.
- If set to V(present) and O(exclusive) set to V(false) the specified O(option=values) lines are added, but the other
O(option)s with the same name are not touched.
- If set to V(present) and O(exclusive) set to V(true) all given O(option=values) lines will be added and the other
O(option)s with the same name are removed.
- If set to V(present) and O(exclusive) set to V(true) all given O(option=values) lines are added and the other O(option)s
with the same name are removed.
type: str
choices: [absent, present]
default: present
@ -126,8 +126,8 @@ options:
version_added: 7.5.0
create:
description:
- If set to V(false), the module will fail if the file does not already exist.
- By default it will create the file if it is missing.
- If set to V(false), the module fails if the file does not already exist.
- By default it creates the file if it is missing.
type: bool
default: true
allow_no_value:

2
plugins/modules/installp.py
View file

@ -47,7 +47,7 @@ options:
choices: [absent, present]
default: present
notes:
- If the package is already installed, even the package/fileset is new, the module will not install it.
- If the package is already installed, even the package/fileset is new, the module does not install it.
"""
EXAMPLES = r"""

12
plugins/modules/interfaces_file.py
View file

@ -45,10 +45,10 @@ options:
value:
type: str
description:
- If O(option) is not presented for the O(iface) and O(state) is V(present) option will be added. If O(option) already
exists and is not V(pre-up), V(up), V(post-up) or V(down), its value will be updated. V(pre-up), V(up), V(post-up)
and V(down) options cannot be updated, only adding new options, removing existing ones or cleaning the whole option
set are supported.
- If O(option) is not presented for the O(iface) and O(state) is V(present), then O(option) is added. If O(option) already
exists and is not V(pre-up), V(up), V(post-up) or V(down), its value is updated. V(pre-up), V(up), V(post-up) and
V(down) options cannot be updated, only adding new options, removing existing ones or cleaning the whole option set
are supported.
backup:
description:
- Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered
@ -58,12 +58,12 @@ options:
state:
type: str
description:
- If set to V(absent) the option or section will be removed if present instead of created.
- If set to V(absent) the option or section is removed if present instead of created.
default: "present"
choices: ["present", "absent"]
notes:
- If option is defined multiple times last one will be updated but all will be deleted in case of an absent state.
- If option is defined multiple times last one is updated but all others are deleted in case of an O(state=absent).
requirements: []
author: "Roman Belyakovsky (@hryamzik)"
"""

42
plugins/modules/ipa_dnsrecord.py
View file

@ -45,33 +45,31 @@ options:
- Manage DNS record name with this value.
- Mutually exclusive with O(record_values), and exactly one of O(record_value) and O(record_values) has to be specified.
- Use O(record_values) if you need to specify multiple values.
- In the case of V(A) or V(AAAA) record types, this will be the IP address.
- In the case of V(A6) record type, this will be the A6 Record data.
- In the case of V(CNAME) record type, this will be the hostname.
- In the case of V(DNAME) record type, this will be the DNAME target.
- In the case of V(NS) record type, this will be the name server hostname. Hostname must already have a valid A or AAAA
record.
- In the case of V(PTR) record type, this will be the hostname.
- In the case of V(TXT) record type, this will be a text.
- In the case of V(SRV) record type, this will be a service record.
- In the case of V(MX) record type, this will be a mail exchanger record.
- In the case of V(SSHFP) record type, this will be an SSH fingerprint record.
- In the case of V(A) or V(AAAA) record types, this is the IP address.
- In the case of V(A6) record type, this is the A6 Record data.
- In the case of V(CNAME) record type, this is the hostname.
- In the case of V(DNAME) record type, this is the DNAME target.
- In the case of V(NS) record type, this is the name server hostname. Hostname must already have a valid A or AAAA record.
- In the case of V(PTR) record type, this is the hostname.
- In the case of V(TXT) record type, this is a text.
- In the case of V(SRV) record type, this is a service record.
- In the case of V(MX) record type, this is a mail exchanger record.
- In the case of V(SSHFP) record type, this is an SSH fingerprint record.
type: str
record_values:
description:
- Manage DNS record name with this value.
- Mutually exclusive with O(record_value), and exactly one of O(record_value) and O(record_values) has to be specified.
- In the case of V(A) or V(AAAA) record types, this will be the IP address.
- In the case of V(A6) record type, this will be the A6 Record data.
- In the case of V(CNAME) record type, this will be the hostname.
- In the case of V(DNAME) record type, this will be the DNAME target.
- In the case of V(NS) record type, this will be the name server hostname. Hostname must already have a valid A or AAAA
record.
- In the case of V(PTR) record type, this will be the hostname.
- In the case of V(TXT) record type, this will be a text.
- In the case of V(SRV) record type, this will be a service record.
- In the case of V(MX) record type, this will be a mail exchanger record.
- In the case of V(SSHFP) record type, this will be an SSH fingerprint record.
- In the case of V(A) or V(AAAA) record types, this is the IP address.
- In the case of V(A6) record type, this is the A6 Record data.
- In the case of V(CNAME) record type, this is the hostname.
- In the case of V(DNAME) record type, this is the DNAME target.
- In the case of V(NS) record type, this is the name server hostname. Hostname must already have a valid A or AAAA record.
- In the case of V(PTR) record type, this is the hostname.
- In the case of V(TXT) record type, this is a text.
- In the case of V(SRV) record type, this is a service record.
- In the case of V(MX) record type, this is a mail exchanger record.
- In the case of V(SSHFP) record type, this is an SSH fingerprint record.
type: list
elements: str
record_ttl:

6
plugins/modules/ipa_getkeytab.py
View file

@ -67,15 +67,15 @@ options:
retrieve_mode:
description:
- Retrieve an existing key from the server instead of generating a new one.
- This is incompatible with the O(password), and will work only against a IPA server more recent than version 3.3.
- This is incompatible with the O(password), and works only against a IPA server more recent than version 3.3.
- The user requesting the keytab must have access to the keys for this operation to succeed.
- Be aware that if set V(true), a new keytab will be generated.
- Be aware that if set V(true), a new keytab is generated.
- This invalidates all previously retrieved keytabs for this service principal.
type: bool
encryption_types:
description:
- The list of encryption types to use to generate keys.
- It will use local client defaults if not provided.
- It uses local client defaults if not provided.
- Valid values depend on the Kerberos library version and configuration.
type: str
state:

20
plugins/modules/ipa_group.py
View file

@ -22,7 +22,7 @@ options:
append:
description:
- If V(true), add the listed O(user) and O(group) to the group members.
- If V(false), only the listed O(user) and O(group) will be group members, removing any other members.
- If V(false), only the listed O(user) and O(group) are set as group members, removing any other members.
default: false
type: bool
version_added: 4.0.0
@ -49,10 +49,10 @@ options:
group:
description:
- List of group names assigned to this group.
- If O(append=false) and an empty list is passed all groups will be removed from this group.
- Groups that are already assigned but not passed will be removed.
- If O(append=true) the listed groups will be assigned without removing other groups.
- If option is omitted assigned groups will not be checked or changed.
- If O(append=false) and an empty list is passed all groups are removed from this group.
- Groups that are already assigned but not passed are removed.
- If O(append=true) the listed groups are assigned without removing other groups.
- If option is omitted assigned groups are not checked or changed.
type: list
elements: str
nonposix:
@ -62,10 +62,10 @@ options:
user:
description:
- List of user names assigned to this group.
- If O(append=false) and an empty list is passed all users will be removed from this group.
- Users that are already assigned but not passed will be removed.
- If O(append=true) the listed users will be assigned without removing other users.
- If option is omitted assigned users will not be checked or changed.
- If O(append=false) and an empty list is passed all users are removed from this group.
- Users that are already assigned but not passed are removed.
- If O(append=true) the listed users are assigned without removing other users.
- If option is omitted assigned users are not checked or changed.
type: list
elements: str
external_user:
@ -73,7 +73,7 @@ options:
- List of external users assigned to this group.
- Behaves identically to O(user) with respect to O(append) attribute.
- List entries can be in V(DOMAIN\\\\username) or SID format.
- Unless SIDs are provided, the module will always attempt to make changes even if the group already has all the users.
- Unless SIDs are provided, the module always attempts to make changes even if the group already has all the users.
This is because only SIDs are returned by IPA query.
- O(external=true) is needed for this option to work.
type: list

32
plugins/modules/ipa_hbacrule.py
View file

@ -32,8 +32,8 @@ options:
host:
description:
- List of host names to assign.
- If an empty list is passed all hosts will be removed from the rule.
- If option is omitted hosts will not be checked or changed.
- If an empty list is passed all hosts are removed from the rule.
- If option is omitted hosts are not checked or changed.
required: false
type: list
elements: str
@ -44,15 +44,15 @@ options:
hostgroup:
description:
- List of hostgroup names to assign.
- If an empty list is passed all hostgroups will be removed from the rule.
- If option is omitted hostgroups will not be checked or changed.
- If an empty list is passed all hostgroups are removed from the rule.
- If option is omitted hostgroups are not checked or changed.
type: list
elements: str
service:
description:
- List of service names to assign.
- If an empty list is passed all services will be removed from the rule.
- If option is omitted services will not be checked or changed.
- If an empty list is passed all services are removed from the rule.
- If option is omitted services are not checked or changed.
type: list
elements: str
servicecategory:
@ -62,15 +62,15 @@ options:
servicegroup:
description:
- List of service group names to assign.
- If an empty list is passed all assigned service groups will be removed from the rule.
- If option is omitted service groups will not be checked or changed.
- If an empty list is passed all assigned service groups are removed from the rule.
- If option is omitted service groups are not checked or changed.
type: list
elements: str
sourcehost:
description:
- List of source host names to assign.
- If an empty list if passed all assigned source hosts will be removed from the rule.
- If option is omitted source hosts will not be checked or changed.
- If an empty list if passed all assigned source hosts are removed from the rule.
- If option is omitted source hosts are not checked or changed.
type: list
elements: str
sourcehostcategory:
@ -80,8 +80,8 @@ options:
sourcehostgroup:
description:
- List of source host group names to assign.
- If an empty list if passed all assigned source host groups will be removed from the rule.
- If option is omitted source host groups will not be checked or changed.
- If an empty list if passed all assigned source host groups are removed from the rule.
- If option is omitted source host groups are not checked or changed.
type: list
elements: str
state:
@ -92,8 +92,8 @@ options:
user:
description:
- List of user names to assign.
- If an empty list if passed all assigned users will be removed from the rule.
- If option is omitted users will not be checked or changed.
- If an empty list if passed all assigned users are removed from the rule.
- If option is omitted users are not checked or changed.
type: list
elements: str
usercategory:
@ -103,8 +103,8 @@ options:
usergroup:
description:
- List of user group names to assign.
- If an empty list if passed all assigned user groups will be removed from the rule.
- If option is omitted user groups will not be checked or changed.
- If an empty list if passed all assigned user groups are removed from the rule.
- If option is omitted user groups are not checked or changed.
type: list
elements: str
extends_documentation_fragment:

12
plugins/modules/ipa_host.py
View file

@ -42,9 +42,9 @@ options:
mac_address:
description:
- List of Hardware MAC address(es) off this host.
- If option is omitted MAC addresses will not be checked or changed.
- If an empty list is passed all assigned MAC addresses will be removed.
- MAC addresses that are already assigned but not passed will be removed.
- If option is omitted MAC addresses are not checked nor changed.
- If an empty list is passed all assigned MAC addresses are removed.
- MAC addresses that are already assigned but not passed are removed.
aliases: ["macaddress"]
type: list
elements: str
@ -66,9 +66,9 @@ options:
user_certificate:
description:
- List of Base-64 encoded server certificates.
- If option is omitted certificates will not be checked or changed.
- If an empty list is passed all assigned certificates will be removed.
- Certificates already assigned but not passed will be removed.
- If option is omitted certificates are not checked nor changed.
- If an empty list is passed all assigned certificates are removed.
- Certificates already assigned but not passed are removed.
aliases: ["usercertificate"]
type: list
elements: str

14
plugins/modules/ipa_hostgroup.py
View file

@ -22,7 +22,7 @@ options:
append:
description:
- If V(true), add the listed O(host) to the O(hostgroup).
- If V(false), only the listed O(host) will be in O(hostgroup), removing any other hosts.
- If V(false), only the listed O(host) is set in O(hostgroup), removing any other hosts.
default: false
type: bool
version_added: 6.6.0
@ -40,17 +40,17 @@ options:
host:
description:
- List of hosts that belong to the host-group.
- If an empty list is passed all hosts will be removed from the group.
- If option is omitted hosts will not be checked or changed.
- If option is passed all assigned hosts that are not passed will be unassigned from the group.
- If an empty list is passed all hosts are removed from the group.
- If option is omitted hosts are not checked nor changed.
- If option is passed all assigned hosts that are not passed are unassigned from the group.
type: list
elements: str
hostgroup:
description:
- List of host-groups than belong to that host-group.
- If an empty list is passed all host-groups will be removed from the group.
- If option is omitted host-groups will not be checked or changed.
- If option is passed all assigned hostgroups that are not passed will be unassigned from the group.
- If an empty list is passed all host-groups are removed from the group.
- If option is omitted host-groups are not checked nor changed.
- If option is passed all assigned hostgroups that are not passed are unassigned from the group.
type: list
elements: str
state:

10
plugins/modules/ipa_otptoken.py
View file

@ -26,7 +26,7 @@ options:
aliases: ["name"]
type: str
newuniqueid:
description: If specified, the unique ID specified will be changed to this.
description: If specified, the unique ID specified is changed to this.
type: str
otptype:
description:
@ -37,7 +37,7 @@ options:
secretkey:
description:
- Token secret (Base64).
- If OTP is created and this is not specified, a random secret will be generated by IPA.
- If OTP is created and this is not specified, a random secret is generated by IPA.
- B(Note:) Cannot be modified after OTP is created.
type: str
description:
@ -54,13 +54,13 @@ options:
description:
- First date/time the token can be used.
- In the format C(YYYYMMddHHmmss).
- For example, V(20180121182022) will allow the token to be used starting on 21 January 2018 at 18:20:22.
- For example, V(20180121182022) allows the token to be used starting on 21 January 2018 at 18:20:22.
type: str
notafter:
description:
- Last date/time the token can be used.
- In the format C(YYYYMMddHHmmss).
- For example, V(20200121182022) will allow the token to be used until 21 January 2020 at 18:20:22.
- For example, V(20200121182022) allows the token to be used until 21 January 2020 at 18:20:22.
type: str
vendor:
description: Token vendor name (informational only).
@ -84,7 +84,7 @@ options:
type: str
digits:
description:
- Number of digits each token code will have.
- Number of digits each token code has.
- B(Note:) Cannot be modified after OTP is created.
choices: [6, 8]
type: int

34
plugins/modules/ipa_role.py
View file

@ -33,41 +33,41 @@ options:
group:
description:
- List of group names assign to this role.
- If an empty list is passed all assigned groups will be unassigned from the role.
- If option is omitted groups will not be checked or changed.
- If option is passed all assigned groups that are not passed will be unassigned from the role.
- If an empty list is passed all assigned groups are unassigned from the role.
- If option is omitted groups are not checked nor changed.
- If option is passed all assigned groups that are not passed are unassigned from the role.
type: list
elements: str
host:
description:
- List of host names to assign.
- If an empty list is passed all assigned hosts will be unassigned from the role.
- If option is omitted hosts will not be checked or changed.
- If option is passed all assigned hosts that are not passed will be unassigned from the role.
- If an empty list is passed all assigned hosts are unassigned from the role.
- If option is omitted hosts are not checked nor changed.
- If option is passed all assigned hosts that are not passed are unassigned from the role.
type: list
elements: str
hostgroup:
description:
- List of host group names to assign.
- If an empty list is passed all assigned host groups will be removed from the role.
- If option is omitted host groups will not be checked or changed.
- If option is passed all assigned hostgroups that are not passed will be unassigned from the role.
- If an empty list is passed all assigned host groups are removed from the role.
- If option is omitted host groups are not checked nor changed.
- If option is passed all assigned hostgroups that are not passed are unassigned from the role.
type: list
elements: str
privilege:
description:
- List of privileges granted to the role.
- If an empty list is passed all assigned privileges will be removed.
- If option is omitted privileges will not be checked or changed.
- If option is passed all assigned privileges that are not passed will be removed.
- If an empty list is passed all assigned privileges are removed.
- If option is omitted privileges are not checked nor changed.
- If option is passed all assigned privileges that are not passed are removed.
type: list
elements: str
service:
description:
- List of service names to assign.
- If an empty list is passed all assigned services will be removed from the role.
- If option is omitted services will not be checked or changed.
- If option is passed all assigned services that are not passed will be removed from the role.
- If an empty list is passed all assigned services are removed from the role.
- If option is omitted services are not checked nor changed.
- If option is passed all assigned services that are not passed are removed from the role.
type: list
elements: str
state:
@ -78,8 +78,8 @@ options:
user:
description:
- List of user names to assign.
- If an empty list is passed all assigned users will be removed from the role.
- If option is omitted users will not be checked or changed.
- If an empty list is passed all assigned users are removed from the role.
- If option is omitted users are not checked nor changed.
type: list
elements: str
extends_documentation_fragment:

4
plugins/modules/ipa_sudocmdgroup.py
View file

@ -37,8 +37,8 @@ options:
sudocmd:
description:
- List of sudo commands to assign to the group.
- If an empty list is passed all assigned commands will be removed from the group.
- If option is omitted sudo commands will not be checked or changed.
- If an empty list is passed all assigned commands are removed from the group.
- If option is omitted sudo commands are not checked nor changed.
type: list
elements: str
extends_documentation_fragment:

32
plugins/modules/ipa_sudorule.py
View file

@ -34,31 +34,31 @@ options:
cmd:
description:
- List of commands assigned to the rule.
- If an empty list is passed all commands will be removed from the rule.
- If option is omitted commands will not be checked or changed.
- If an empty list is passed all commands are removed from the rule.
- If option is omitted commands are not checked nor changed.
type: list
elements: str
cmdgroup:
description:
- List of command groups assigned to the rule.
- If an empty list is passed all command groups will be removed from the rule.
- If option is omitted command groups will not be checked or changed.
- If an empty list is passed all command groups are removed from the rule.
- If option is omitted command groups are not checked nor changed.
type: list
elements: str
version_added: 2.0.0
deny_cmd:
description:
- List of denied commands assigned to the rule.
- If an empty list is passed all commands will be removed from the rule.
- If option is omitted commands will not be checked or changed.
- If an empty list is passed all commands are removed from the rule.
- If option is omitted commands are not checked nor changed.
type: list
elements: str
version_added: 8.1.0
deny_cmdgroup:
description:
- List of denied command groups assigned to the rule.
- If an empty list is passed all command groups will be removed from the rule.
- If option is omitted command groups will not be checked or changed.
- If an empty list is passed all command groups are removed from the rule.
- If option is omitted command groups are not checked nor changed.
type: list
elements: str
version_added: 8.1.0
@ -69,8 +69,8 @@ options:
host:
description:
- List of hosts assigned to the rule.
- If an empty list is passed all hosts will be removed from the rule.
- If option is omitted hosts will not be checked or changed.
- If an empty list is passed all hosts are removed from the rule.
- If option is omitted hosts are not checked nor changed.
- Option O(hostcategory) must be omitted to assign hosts.
type: list
elements: str
@ -84,8 +84,8 @@ options:
hostgroup:
description:
- List of host groups assigned to the rule.
- If an empty list is passed all host groups will be removed from the rule.
- If option is omitted host groups will not be checked or changed.
- If an empty list is passed all host groups are removed from the rule.
- If option is omitted host groups are not checked nor changed.
- Option O(hostcategory) must be omitted to assign host groups.
type: list
elements: str
@ -113,8 +113,8 @@ options:
user:
description:
- List of users assigned to the rule.
- If an empty list is passed all users will be removed from the rule.
- If option is omitted users will not be checked or changed.
- If an empty list is passed all users are removed from the rule.
- If option is omitted users are not checked nor changed.
type: list
elements: str
usercategory:
@ -125,8 +125,8 @@ options:
usergroup:
description:
- List of user groups assigned to the rule.
- If an empty list is passed all user groups will be removed from the rule.
- If option is omitted user groups will not be checked or changed.
- If an empty list is passed all user groups are removed from the rule.
- If option is omitted user groups are not checked nor changed.
type: list
elements: str
state:

18
plugins/modules/ipa_user.py
View file

@ -35,9 +35,9 @@ options:
type: str
krbpasswordexpiration:
description:
- Date at which the user password will expire.
- Date at which the user password expires.
- In the format YYYYMMddHHmmss.
- For example V(20180121182022) will expire on 21 January 2018 at 18:20:22.
- For example V(20180121182022) expires on 21 January 2018 at 18:20:22.
type: str
loginshell:
description: Login shell.
@ -45,14 +45,14 @@ options:
mail:
description:
- List of mail addresses assigned to the user.
- If an empty list is passed all assigned email addresses will be deleted.
- If None is passed email addresses will not be checked or changed.
- If an empty list is passed all assigned email addresses are deleted.
- If None is passed email addresses are not checked nor changed.
type: list
elements: str
password:
description:
- Password for a user.
- Will not be set for an existing user unless O(update_password=always), which is the default.
- It is not set for an existing user unless O(update_password=always), which is the default.
type: str
sn:
description:
@ -62,8 +62,8 @@ options:
sshpubkey:
description:
- List of public SSH key.
- If an empty list is passed all assigned public keys will be deleted.
- If None is passed SSH public keys will not be checked or changed.
- If an empty list is passed all assigned public keys are deleted.
- If None is passed SSH public keys are not checked nor changed.
type: list
elements: str
state:
@ -74,8 +74,8 @@ options:
telephonenumber:
description:
- List of telephone numbers assigned to the user.
- If an empty list is passed all assigned telephone numbers will be deleted.
- If None is passed telephone numbers will not be checked or changed.
- If an empty list is passed all assigned telephone numbers are deleted.
- If None is passed telephone numbers are not checked nor changed.
type: list
elements: str
title:

277
plugins/modules/ipbase_info.py
View file

@ -21,7 +21,7 @@ extends_documentation_fragment:
options:
ip:
description:
- The IP you want to get the info for. If not specified the API will detect the IP automatically.
- The IP you want to get the info for. If not specified the API detects the IP automatically.
required: false
type: str
apikey:
@ -31,7 +31,7 @@ options:
type: str
hostname:
description:
- If the O(hostname) parameter is set to V(true), the API response will contain the hostname of the IP.
- If the O(hostname) parameter is set to V(true), the API response contains the hostname of the IP.
required: false
type: bool
default: false
@ -71,147 +71,148 @@ data:
of the response."
returned: success
type: dict
sample: {
"ip": "1.1.1.1",
"hostname": "one.one.one.one",
"type": "v4",
"range_type": {
"type": "PUBLIC",
"description": "Public address"
},
"connection": {
"asn": 13335,
"organization": "Cloudflare, Inc.",
"isp": "APNIC Research and Development",
"range": "1.1.1.1/32"
},
"location": {
"geonames_id": 5332870,
"latitude": 34.053611755371094,
"longitude": -118.24549865722656,
"zip": "90012",
"continent": {
"code": "NA",
"name": "North America",
"name_translated": "North America"
sample:
{
"ip": "1.1.1.1",
"hostname": "one.one.one.one",
"type": "v4",
"range_type": {
"type": "PUBLIC",
"description": "Public address"
},
"country": {
"alpha2": "US",
"alpha3": "USA",
"calling_codes": [
"+1"
],
"currencies": [
{
"symbol": "$",
"name": "US Dollar",
"symbol_native": "$",
"decimal_digits": 2,
"rounding": 0,
"code": "USD",
"name_plural": "US dollars"
}
],
"emoji": "...",
"ioc": "USA",
"languages": [
{
"name": "English",
"name_native": "English"
}
],
"name": "United States",
"name_translated": "United States",
"timezones": [
"America/New_York",
"America/Detroit",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/Indiana/Indianapolis",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Vevay",
"America/Chicago",
"America/Indiana/Tell_City",
"America/Indiana/Knox",
"America/Menominee",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/North_Dakota/Beulah",
"America/Denver",
"America/Boise",
"America/Phoenix",
"America/Los_Angeles",
"America/Anchorage",
"America/Juneau",
"America/Sitka",
"America/Metlakatla",
"America/Yakutat",
"America/Nome",
"America/Adak",
"Pacific/Honolulu"
],
"is_in_european_union": false,
"fips": "US",
"geonames_id": 6252001,
"hasc_id": "US",
"wikidata_id": "Q30"
"connection": {
"asn": 13335,
"organization": "Cloudflare, Inc.",
"isp": "APNIC Research and Development",
"range": "1.1.1.1/32"
},
"city": {
"fips": "644000",
"alpha2": null,
"geonames_id": 5368753,
"hasc_id": null,
"wikidata_id": "Q65",
"name": "Los Angeles",
"name_translated": "Los Angeles"
"location": {
"geonames_id": 5332870,
"latitude": 34.053611755371094,
"longitude": -118.24549865722656,
"zip": "90012",
"continent": {
"code": "NA",
"name": "North America",
"name_translated": "North America"
},
"country": {
"alpha2": "US",
"alpha3": "USA",
"calling_codes": [
"+1"
],
"currencies": [
{
"symbol": "$",
"name": "US Dollar",
"symbol_native": "$",
"decimal_digits": 2,
"rounding": 0,
"code": "USD",
"name_plural": "US dollars"
}
],
"emoji": "...",
"ioc": "USA",
"languages": [
{
"name": "English",
"name_native": "English"
}
],
"name": "United States",
"name_translated": "United States",
"timezones": [
"America/New_York",
"America/Detroit",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/Indiana/Indianapolis",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Vevay",
"America/Chicago",
"America/Indiana/Tell_City",
"America/Indiana/Knox",
"America/Menominee",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/North_Dakota/Beulah",
"America/Denver",
"America/Boise",
"America/Phoenix",
"America/Los_Angeles",
"America/Anchorage",
"America/Juneau",
"America/Sitka",
"America/Metlakatla",
"America/Yakutat",
"America/Nome",
"America/Adak",
"Pacific/Honolulu"
],
"is_in_european_union": false,
"fips": "US",
"geonames_id": 6252001,
"hasc_id": "US",
"wikidata_id": "Q30"
},
"city": {
"fips": "644000",
"alpha2": null,
"geonames_id": 5368753,
"hasc_id": null,
"wikidata_id": "Q65",
"name": "Los Angeles",
"name_translated": "Los Angeles"
},
"region": {
"fips": "US06",
"alpha2": "US-CA",
"geonames_id": 5332921,
"hasc_id": "US.CA",
"wikidata_id": "Q99",
"name": "California",
"name_translated": "California"
}
},
"region": {
"fips": "US06",
"alpha2": "US-CA",
"geonames_id": 5332921,
"hasc_id": "US.CA",
"wikidata_id": "Q99",
"name": "California",
"name_translated": "California"
"tlds": [
".us"
],
"timezone": {
"id": "America/Los_Angeles",
"current_time": "2023-05-04T04:30:28-07:00",
"code": "PDT",
"is_daylight_saving": true,
"gmt_offset": -25200
},
"security": {
"is_anonymous": false,
"is_datacenter": false,
"is_vpn": false,
"is_bot": false,
"is_abuser": true,
"is_known_attacker": true,
"is_proxy": false,
"is_spam": false,
"is_tor": false,
"is_icloud_relay": false,
"threat_score": 100
},
"domains": {
"count": 10943,
"domains": [
"eliwise.academy",
"accountingprose.academy",
"pistola.academy",
"1and1-test-ntlds-fr.accountant",
"omnergy.africa"
]
}
},
"tlds": [
".us"
],
"timezone": {
"id": "America/Los_Angeles",
"current_time": "2023-05-04T04:30:28-07:00",
"code": "PDT",
"is_daylight_saving": true,
"gmt_offset": -25200
},
"security": {
"is_anonymous": false,
"is_datacenter": false,
"is_vpn": false,
"is_bot": false,
"is_abuser": true,
"is_known_attacker": true,
"is_proxy": false,
"is_spam": false,
"is_tor": false,
"is_icloud_relay": false,
"threat_score": 100
},
"domains": {
"count": 10943,
"domains": [
"eliwise.academy",
"accountingprose.academy",
"pistola.academy",
"1and1-test-ntlds-fr.accountant",
"omnergy.africa"
]
}
}
"""
from ansible.module_utils.basic import AnsibleModule

4
plugins/modules/ipify_facts.py
View file

@ -24,7 +24,7 @@ options:
api_url:
description:
- URL of the ipify.org API service.
- C(?format=json) will be appended per default.
- C(?format=json) is appended by default.
type: str
default: https://api.ipify.org/
timeout:
@ -34,7 +34,7 @@ options:
default: 10
validate_certs:
description:
- When set to V(false), SSL certificates will not be validated.
- When set to V(false), SSL certificates are not validated.
type: bool
default: true
notes:

6
plugins/modules/ipmi_boot.py
View file

@ -95,17 +95,17 @@ author: "Bulat Gaifullin (@bgaifullin) <gaifullinbf@gmail.com>"
RETURN = r"""
bootdev:
description: The boot device name which will be used beyond next boot.
description: The boot device name which is used beyond next boot.
returned: success
type: str
sample: default
persistent:
description: If True, system firmware will use this device beyond next boot.
description: If V(true), system firmware uses this device beyond next boot.
returned: success
type: bool
sample: false
uefimode:
description: If True, system firmware will use UEFI boot explicitly beyond next boot.
description: If V(true), system firmware uses UEFI boot explicitly beyond next boot.
returned: success
type: bool
sample: false

4
plugins/modules/iptables_state.py
View file

@ -27,8 +27,8 @@ description:
notes:
- The rollback feature is not a module option and depends on task's attributes. To enable it, the module must be played
asynchronously, in other words by setting task attributes C(poll) to V(0), and C(async) to a value less or equal to C(ANSIBLE_TIMEOUT).
If C(async) is greater, the rollback will still happen if it shall happen, but you will experience a connection timeout
instead of more relevant info returned by the module after its failure.
If C(async) is greater, the rollback still happens when needed, but you experience a connection timeout instead of more
relevant info returned by the module after its failure.
attributes:
check_mode:
support: full

2
plugins/modules/ipwcli_dns.py
View file

@ -16,7 +16,7 @@ short_description: Manage DNS Records for Ericsson IPWorks using C(ipwcli)
version_added: '0.2.0'
description:
- Manage DNS records for the Ericsson IPWorks DNS server. The module will use the C(ipwcli) to deploy the DNS records.
- Manage DNS records for the Ericsson IPWorks DNS server. The module uses the C(ipwcli) to deploy the DNS records.
requirements:
- ipwcli (installed on Ericsson IPWorks)

6
plugins/modules/irc.py
View file

@ -73,13 +73,13 @@ options:
channel:
type: str
description:
- Channel name. One of nick_to or channel needs to be set. When both are set, the message will be sent to both of them.
- Channel name. One of nick_to or channel needs to be set. When both are set, the message is sent to both of them.
nick_to:
type: list
elements: str
description:
- A list of nicknames to send the message to. One of nick_to or channel needs to be set. When both are defined, the
message will be sent to both of them.
message is sent to both of them.
key:
type: str
description:
@ -118,7 +118,7 @@ options:
default: none
validate_certs:
description:
- If set to V(false), the SSL certificates will not be validated.
- If set to V(false), the SSL certificates are not validated.
- This should always be set to V(true). Using V(false) is unsafe and should only be done if the network between between
Ansible and the IRC server is known to be safe.
- B(Note:) for security reasons, you should always set O(use_tls=true) and O(validate_certs=true) whenever possible.

6
plugins/modules/iso_create.py
View file

@ -32,8 +32,8 @@ attributes:
options:
src_files:
description:
- This is a list of absolute paths of source files or folders which will be contained in the new generated ISO file.
- Will fail if specified file or folder in O(src_files) does not exist on local machine.
- This is a list of absolute paths of source files or folders to be contained in the new generated ISO file.
- The module fails if specified file or folder in O(src_files) does not exist on local machine.
- 'Note: With all ISO9660 levels from 1 to 3, all file names are restricted to uppercase letters, numbers and underscores
(_). File names are limited to 31 characters, directory nesting is limited to 8 levels, and path names are limited
to 255 characters.'
@ -43,7 +43,7 @@ options:
dest_iso:
description:
- The absolute path with file name of the new generated ISO file on local machine.
- Will create intermediate folders when they does not exist.
- It creates intermediate folders when they do not exist.
type: path
required: true
interchange_level:

10
plugins/modules/iso_customize.py
View file

@ -14,7 +14,7 @@ module: iso_customize
short_description: Add/remove/change files in ISO file
description:
- This module is used to add/remove/change files in ISO file.
- The file inside ISO will be overwritten if it exists by option O(add_files).
- The file inside ISO is overwritten if it exists by option O(add_files).
author:
- Yuhua Zou (@ZouYuhua) <zouy@vmware.com>
requirements:
@ -51,7 +51,7 @@ options:
add_files:
description:
- Allows to add and replace files in the ISO file.
- Will create intermediate folders inside the ISO file when they do not exist.
- It creates intermediate folders inside the ISO file when they do not exist.
type: list
required: false
elements: dict
@ -69,9 +69,9 @@ options:
required: true
notes:
- The C(pycdlib) library states it supports Python 2.7 and 3.4+.
- The function C(add_file) in pycdlib will overwrite the existing file in ISO with type ISO9660 / Rock Ridge 1.12 / Joliet
/ UDF. But it will not overwrite the existing file in ISO with Rock Ridge 1.09 / 1.10. So we take workaround "delete the
existing file and then add file for ISO with Rock Ridge".
- The function C(add_file) in pycdlib is designed to overwrite the existing file in ISO with type ISO9660 / Rock Ridge 1.12
/ Joliet / UDF. But it does not overwrite the existing file in ISO with Rock Ridge 1.09 / 1.10. So we take workaround
"delete the existing file and then add file for ISO with Rock Ridge".
"""
EXAMPLES = r"""

8
plugins/modules/iso_extract.py
View file

@ -55,19 +55,19 @@ options:
required: true
force:
description:
- If V(true), which will replace the remote file when contents are different than the source.
- If V(false), the file will only be extracted and copied if the destination does not already exist.
- If V(true), it replaces the remote file when contents are different than the source.
- If V(false), the file is only extracted and copied if the destination does not already exist.
type: bool
default: true
executable:
description:
- The path to the C(7z) executable to use for extracting files from the ISO.
- If not provided, it will assume the value V(7z).
- If not provided, it assumes the value V(7z).
type: path
password:
description:
- Password used to decrypt files from the ISO.
- Will only be used if 7z is used.
- It is only used if C(7z) is used.
- The password is used as a command line argument to 7z. This is a B(potential security risk) that allows passwords
to be revealed if someone else can list running processes on the same machine in the right moment.
type: str