Skip to content

Commit 2737714

Browse files
[PR #10409/a36ad54b backport][stable-11] doc style adjustments: modules i* (#10411)
doc style adjustments: modules i* (#10409) (cherry picked from commit a36ad54) Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
1 parent ffa1436 commit 2737714

28 files changed

+305
-306
lines changed

plugins/modules/ibm_sa_host.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@
4141
type: str
4242
domain:
4343
description:
44-
- The domains the cluster will be attached to. To include more than one domain, separate domain names with commas. To
45-
include all existing domains, use an asterisk (V(*)).
44+
- The domains the cluster is attached to. To include more than one domain, separate domain names with commas. To include
45+
all existing domains, use an asterisk (V(*)).
4646
required: false
4747
type: str
4848
iscsi_chap_name:

plugins/modules/icinga2_host.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@
3030
- HTTP, HTTPS, or FTP URL in the form V((http|https|ftp\)://[user[:pass]]@host.domain[:port]/path).
3131
use_proxy:
3232
description:
33-
- If V(false), it will not use a proxy, even if one is defined in an environment variable on the target hosts.
33+
- If V(false), it does not use a proxy, even if one is defined in an environment variable on the target hosts.
3434
type: bool
3535
default: true
3636
validate_certs:
3737
description:
38-
- If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using
39-
self-signed certificates.
38+
- If V(false), SSL certificates are not validated. This should only be used on personally controlled sites using self-signed
39+
certificates.
4040
type: bool
4141
default: true
4242
url_username:
@@ -48,12 +48,12 @@
4848
type: str
4949
description:
5050
- The password for use in HTTP basic authentication.
51-
- If the O(url_username) parameter is not specified, the O(url_password) parameter will not be used.
51+
- If the O(url_username) parameter is not specified, the O(url_password) parameter is not used.
5252
force_basic_auth:
5353
description:
54-
- C(httplib2), the library used by Ansible's HTTP request code only sends authentication information when a webservice responds to
55-
an initial request with a 401 status. Since some basic auth services do not properly send a 401, logins will fail.
56-
This option forces the sending of the Basic authentication header upon initial request.
54+
- C(httplib2), the library used by Ansible's HTTP request code only sends authentication information when a webservice
55+
responds to an initial request with a 401 status. Since some basic auth services do not properly send a 401, logins
56+
may fail. This option forces the sending of the Basic authentication header upon initial request.
5757
type: bool
5858
default: false
5959
client_cert:

plugins/modules/imc_rest.py

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

plugins/modules/imgadm.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
choices: [present, absent, deleted, imported, updated, vacuumed]
4545
description:
4646
- State the object operated on should be in. V(imported) is an alias for for V(present) and V(deleted) for V(absent).
47-
When set to V(vacuumed) and O(uuid=*), it will remove all unused images.
47+
When set to V(vacuumed) and O(uuid=*), it removes all unused images.
4848
type: str
4949
5050
type:

plugins/modules/influxdb_user.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
admin:
3838
description:
3939
- Whether the user should be in the admin role or not.
40-
- Since version 2.8, the role will also be updated.
40+
- Since version 2.8, the role is also updated.
4141
default: false
4242
type: bool
4343
state:
@@ -50,8 +50,8 @@
5050
description:
5151
- Privileges to grant to this user.
5252
- Takes a list of dicts containing the "database" and "privilege" keys.
53-
- If this argument is not provided, the current grants will be left alone.
54-
- If an empty list is provided, all grants for the user will be removed.
53+
- If this argument is not provided, the current grants are left alone.
54+
- If an empty list is provided, all grants for the user are removed.
5555
type: list
5656
elements: dict
5757
extends_documentation_fragment:

plugins/modules/ini_file.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
section:
4040
description:
4141
- Section name in INI file. This is added if O(state=present) automatically when a single value is being set.
42-
- If being omitted, the O(option) will be placed before the first O(section).
42+
- If being omitted, the O(option) is placed before the first O(section).
4343
- Omitting O(section) is also required if the config format does not support sections.
4444
type: str
4545
section_has_values:
@@ -63,7 +63,7 @@
6363
elements: str
6464
description:
6565
- Among possibly multiple sections of the same name, select the first one that contains matching options and values.
66-
- With O(state=present), if a suitable section is not found, a new section will be added, including the required options.
66+
- With O(state=present), if a suitable section is not found, a new section is added, including the required options.
6767
- With O(state=absent), at most one O(section) is removed if it contains the values.
6868
version_added: 8.6.0
6969
option:
@@ -100,8 +100,8 @@
100100
O(option)s with the same name are not touched.
101101
- If set to V(present) and O(exclusive) set to V(false) the specified O(option=values) lines are added, but the other
102102
O(option)s with the same name are not touched.
103-
- If set to V(present) and O(exclusive) set to V(true) all given O(option=values) lines will be added and the other
104-
O(option)s with the same name are removed.
103+
- 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
104+
with the same name are removed.
105105
type: str
106106
choices: [absent, present]
107107
default: present
@@ -126,8 +126,8 @@
126126
version_added: 7.5.0
127127
create:
128128
description:
129-
- If set to V(false), the module will fail if the file does not already exist.
130-
- By default it will create the file if it is missing.
129+
- If set to V(false), the module fails if the file does not already exist.
130+
- By default it creates the file if it is missing.
131131
type: bool
132132
default: true
133133
allow_no_value:

plugins/modules/installp.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
choices: [absent, present]
4848
default: present
4949
notes:
50-
- If the package is already installed, even the package/fileset is new, the module will not install it.
50+
- If the package is already installed, even the package/fileset is new, the module does not install it.
5151
"""
5252

5353
EXAMPLES = r"""

plugins/modules/interfaces_file.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,10 @@
4545
value:
4646
type: str
4747
description:
48-
- If O(option) is not presented for the O(iface) and O(state) is V(present) option will be added. If O(option) already
49-
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)
50-
and V(down) options cannot be updated, only adding new options, removing existing ones or cleaning the whole option
51-
set are supported.
48+
- 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
49+
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
50+
V(down) options cannot be updated, only adding new options, removing existing ones or cleaning the whole option set
51+
are supported.
5252
backup:
5353
description:
5454
- Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered
@@ -58,12 +58,12 @@
5858
state:
5959
type: str
6060
description:
61-
- If set to V(absent) the option or section will be removed if present instead of created.
61+
- If set to V(absent) the option or section is removed if present instead of created.
6262
default: "present"
6363
choices: ["present", "absent"]
6464
6565
notes:
66-
- If option is defined multiple times last one will be updated but all will be deleted in case of an absent state.
66+
- If option is defined multiple times last one is updated but all others are deleted in case of an O(state=absent).
6767
requirements: []
6868
author: "Roman Belyakovsky (@hryamzik)"
6969
"""

plugins/modules/ipa_dnsrecord.py

Lines changed: 20 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -45,33 +45,31 @@
4545
- Manage DNS record name with this value.
4646
- Mutually exclusive with O(record_values), and exactly one of O(record_value) and O(record_values) has to be specified.
4747
- Use O(record_values) if you need to specify multiple values.
48-
- In the case of V(A) or V(AAAA) record types, this will be the IP address.
49-
- In the case of V(A6) record type, this will be the A6 Record data.
50-
- In the case of V(CNAME) record type, this will be the hostname.
51-
- In the case of V(DNAME) record type, this will be the DNAME target.
52-
- In the case of V(NS) record type, this will be the name server hostname. Hostname must already have a valid A or AAAA
53-
record.
54-
- In the case of V(PTR) record type, this will be the hostname.
55-
- In the case of V(TXT) record type, this will be a text.
56-
- In the case of V(SRV) record type, this will be a service record.
57-
- In the case of V(MX) record type, this will be a mail exchanger record.
58-
- In the case of V(SSHFP) record type, this will be an SSH fingerprint record.
48+
- In the case of V(A) or V(AAAA) record types, this is the IP address.
49+
- In the case of V(A6) record type, this is the A6 Record data.
50+
- In the case of V(CNAME) record type, this is the hostname.
51+
- In the case of V(DNAME) record type, this is the DNAME target.
52+
- In the case of V(NS) record type, this is the name server hostname. Hostname must already have a valid A or AAAA record.
53+
- In the case of V(PTR) record type, this is the hostname.
54+
- In the case of V(TXT) record type, this is a text.
55+
- In the case of V(SRV) record type, this is a service record.
56+
- In the case of V(MX) record type, this is a mail exchanger record.
57+
- In the case of V(SSHFP) record type, this is an SSH fingerprint record.
5958
type: str
6059
record_values:
6160
description:
6261
- Manage DNS record name with this value.
6362
- Mutually exclusive with O(record_value), and exactly one of O(record_value) and O(record_values) has to be specified.
64-
- In the case of V(A) or V(AAAA) record types, this will be the IP address.
65-
- In the case of V(A6) record type, this will be the A6 Record data.
66-
- In the case of V(CNAME) record type, this will be the hostname.
67-
- In the case of V(DNAME) record type, this will be the DNAME target.
68-
- In the case of V(NS) record type, this will be the name server hostname. Hostname must already have a valid A or AAAA
69-
record.
70-
- In the case of V(PTR) record type, this will be the hostname.
71-
- In the case of V(TXT) record type, this will be a text.
72-
- In the case of V(SRV) record type, this will be a service record.
73-
- In the case of V(MX) record type, this will be a mail exchanger record.
74-
- In the case of V(SSHFP) record type, this will be an SSH fingerprint record.
63+
- In the case of V(A) or V(AAAA) record types, this is the IP address.
64+
- In the case of V(A6) record type, this is the A6 Record data.
65+
- In the case of V(CNAME) record type, this is the hostname.
66+
- In the case of V(DNAME) record type, this is the DNAME target.
67+
- In the case of V(NS) record type, this is the name server hostname. Hostname must already have a valid A or AAAA record.
68+
- In the case of V(PTR) record type, this is the hostname.
69+
- In the case of V(TXT) record type, this is a text.
70+
- In the case of V(SRV) record type, this is a service record.
71+
- In the case of V(MX) record type, this is a mail exchanger record.
72+
- In the case of V(SSHFP) record type, this is an SSH fingerprint record.
7573
type: list
7674
elements: str
7775
record_ttl:

plugins/modules/ipa_getkeytab.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,15 +67,15 @@
6767
retrieve_mode:
6868
description:
6969
- Retrieve an existing key from the server instead of generating a new one.
70-
- This is incompatible with the O(password), and will work only against a IPA server more recent than version 3.3.
70+
- This is incompatible with the O(password), and works only against a IPA server more recent than version 3.3.
7171
- The user requesting the keytab must have access to the keys for this operation to succeed.
72-
- Be aware that if set V(true), a new keytab will be generated.
72+
- Be aware that if set V(true), a new keytab is generated.
7373
- This invalidates all previously retrieved keytabs for this service principal.
7474
type: bool
7575
encryption_types:
7676
description:
7777
- The list of encryption types to use to generate keys.
78-
- It will use local client defaults if not provided.
78+
- It uses local client defaults if not provided.
7979
- Valid values depend on the Kerberos library version and configuration.
8080
type: str
8181
state:

0 commit comments

Comments
 (0)