diff --git a/plugins/modules/cloud/univention/udm_dns_record.py b/plugins/modules/cloud/univention/udm_dns_record.py index 42cc8a5cef..13eb4feed4 100644 --- a/plugins/modules/cloud/univention/udm_dns_record.py +++ b/plugins/modules/cloud/univention/udm_dns_record.py @@ -56,7 +56,7 @@ options: default: {} description: - "Additional data for this record, e.g. ['a': '192.0.2.1']. - Required if C(state=present)." + Required if I(state=present)." ''' diff --git a/plugins/modules/cloud/univention/udm_dns_zone.py b/plugins/modules/cloud/univention/udm_dns_zone.py index 831ef3474a..9b80368536 100644 --- a/plugins/modules/cloud/univention/udm_dns_zone.py +++ b/plugins/modules/cloud/univention/udm_dns_zone.py @@ -44,13 +44,13 @@ options: type: list elements: str description: - - List of appropriate name servers. Required if C(state=present). + - List of appropriate name servers. Required if I(state=present). interfaces: type: list elements: str description: - List of interface IP addresses, on which the server should - response this zone. Required if C(state=present). + response this zone. Required if I(state=present). refresh: type: int diff --git a/plugins/modules/cloud/univention/udm_share.py b/plugins/modules/cloud/univention/udm_share.py index 9438f338cb..c0077bdc1c 100644 --- a/plugins/modules/cloud/univention/udm_share.py +++ b/plugins/modules/cloud/univention/udm_share.py @@ -38,17 +38,17 @@ options: required: false description: - Host FQDN (server which provides the share), e.g. C({{ - ansible_fqdn }}). Required if C(state=present). + ansible_fqdn }}). Required if I(state=present). type: str path: required: false description: - - Directory on the providing server, e.g. C(/home). Required if C(state=present). + - Directory on the providing server, e.g. C(/home). Required if I(state=present). type: path sambaName: required: false description: - - Windows name. Required if C(state=present). + - Windows name. Required if I(state=present). type: str aliases: [ samba_name ] ou: diff --git a/plugins/modules/cloud/univention/udm_user.py b/plugins/modules/cloud/univention/udm_user.py index de7e474d8a..5fef1a337a 100644 --- a/plugins/modules/cloud/univention/udm_user.py +++ b/plugins/modules/cloud/univention/udm_user.py @@ -37,15 +37,15 @@ options: type: str firstname: description: - - First name. Required if C(state=present). + - First name. Required if I(state=present). type: str lastname: description: - - Last name. Required if C(state=present). + - Last name. Required if I(state=present). type: str password: description: - - Password. Required if C(state=present). + - Password. Required if I(state=present). type: str birthday: description: diff --git a/plugins/modules/cloud/webfaction/webfaction_domain.py b/plugins/modules/cloud/webfaction/webfaction_domain.py index c10baf83a2..79485d629c 100644 --- a/plugins/modules/cloud/webfaction/webfaction_domain.py +++ b/plugins/modules/cloud/webfaction/webfaction_domain.py @@ -19,7 +19,7 @@ description: - Add or remove domains or subdomains on a Webfaction host. Further documentation at https://github.com/quentinsf/ansible-webfaction. author: Quentin Stafford-Fraser (@quentinsf) notes: - - If you are I(deleting) domains by using C(state=absent), then note that if you specify subdomains, just those particular subdomains will be deleted. + - If you are I(deleting) domains by using I(state=absent), then note that if you specify subdomains, just those particular subdomains will be deleted. If you don't specify subdomains, the domain will be deleted. - > You can run playbooks that use this on a local machine, or on a Webfaction host, or elsewhere, since the scripts use the remote webfaction API. diff --git a/plugins/modules/files/ini_file.py b/plugins/modules/files/ini_file.py index 1ad82a5180..aaef3bb3db 100644 --- a/plugins/modules/files/ini_file.py +++ b/plugins/modules/files/ini_file.py @@ -33,7 +33,7 @@ options: aliases: [ dest ] section: description: - - Section name in INI file. This is added if C(state=present) automatically when + - Section name in INI file. This is added if I(state=present) automatically when a single value is being set. - If left empty or set to C(null), the I(option) will be placed before the first I(section). - Using C(null) is also required if the config format does not support sections. @@ -69,11 +69,11 @@ options: state: description: - If set to C(absent) and I(exclusive) set to C(true) all matching I(option) lines are removed. - - If set to C(absent) and I(exclusive) set to C(false) the specified C(option=value) lines are removed, + - If set to C(absent) and I(exclusive) set to C(false) the specified I(option=value) lines are removed, but the other I(option)s with the same name are not touched. - - If set to C(present) and I(exclusive) set to C(false) the specified C(option=values) lines are added, + - If set to C(present) and I(exclusive) set to C(false) the specified I(option=values) lines are added, but the other I(option)s with the same name are not touched. - - If set to C(present) and I(exclusive) set to C(true) all given C(option=values) lines will be + - If set to C(present) and I(exclusive) set to C(true) all given I(option=values) lines will be added and the other I(option)s with the same name are removed. type: str choices: [ absent, present ] diff --git a/plugins/modules/files/iso_extract.py b/plugins/modules/files/iso_extract.py index fb88f09882..6693fc3884 100644 --- a/plugins/modules/files/iso_extract.py +++ b/plugins/modules/files/iso_extract.py @@ -28,7 +28,7 @@ description: mounts the ISO image to a temporary location, and copies files to a given destination, if needed. requirements: -- Either 7z (from I(7zip) or I(p7zip) package) +- Either 7z (from C(7zip) or C(p7zip) package) - Or mount capabilities (root-access, or CAP_SYS_ADMIN capability on Linux) options: image: @@ -62,7 +62,7 @@ options: type: path notes: - Only the file checksum (content) is taken into account when extracting files - from the ISO image. If C(force=false), only checks the presence of the file. + from the ISO image. If I(force=false), only checks the presence of the file. - In Ansible 2.3 this module was using C(mount) and C(umount) commands only, requiring root access. This is no longer needed with the introduction of 7zip for extraction. diff --git a/plugins/modules/files/xml.py b/plugins/modules/files/xml.py index 1f8f50c4a4..05bbdf00c8 100644 --- a/plugins/modules/files/xml.py +++ b/plugins/modules/files/xml.py @@ -22,13 +22,13 @@ options: description: - Path to the file to operate on. - This file must exist ahead of time. - - This parameter is required, unless C(xmlstring) is given. + - This parameter is required, unless I(xmlstring) is given. type: path aliases: [ dest, file ] xmlstring: description: - A string containing XML on which to operate. - - This parameter is required, unless C(path) is given. + - This parameter is required, unless I(path) is given. type: str xpath: description: @@ -49,7 +49,7 @@ options: aliases: [ ensure ] attribute: description: - - The attribute to select when using parameter C(value). + - The attribute to select when using parameter I(value). - This is a string, not prepended with C(@). type: raw value: @@ -61,31 +61,31 @@ options: type: raw add_children: description: - - Add additional child-element(s) to a selected element for a given C(xpath). + - Add additional child-element(s) to a selected element for a given I(xpath). - Child elements must be given in a list and each item may be either a string (eg. C(children=ansible) to add an empty C() child element), or a hash where the key is an element name and the value is the element value. - - This parameter requires C(xpath) to be set. + - This parameter requires I(xpath) to be set. type: list elements: raw set_children: description: - - Set the child-element(s) of a selected element for a given C(xpath). + - Set the child-element(s) of a selected element for a given I(xpath). - Removes any existing children. - - Child elements must be specified as in C(add_children). - - This parameter requires C(xpath) to be set. + - Child elements must be specified as in I(add_children). + - This parameter requires I(xpath) to be set. type: list elements: raw count: description: - - Search for a given C(xpath) and provide the count of any matches. - - This parameter requires C(xpath) to be set. + - Search for a given I(xpath) and provide the count of any matches. + - This parameter requires I(xpath) to be set. type: bool default: false print_match: description: - - Search for a given C(xpath) and print out any matches. - - This parameter requires C(xpath) to be set. + - Search for a given I(xpath) and print out any matches. + - This parameter requires I(xpath) to be set. type: bool default: false pretty_print: @@ -95,13 +95,13 @@ options: default: false content: description: - - Search for a given C(xpath) and get content. - - This parameter requires C(xpath) to be set. + - Search for a given I(xpath) and get content. + - This parameter requires I(xpath) to be set. type: str choices: [ attribute, text ] input_type: description: - - Type of input for C(add_children) and C(set_children). + - Type of input for I(add_children) and I(set_children). type: str choices: [ xml, yaml ] default: yaml @@ -119,20 +119,20 @@ options: default: false insertbefore: description: - - Add additional child-element(s) before the first selected element for a given C(xpath). + - Add additional child-element(s) before the first selected element for a given I(xpath). - Child elements must be given in a list and each item may be either a string (eg. C(children=ansible) to add an empty C() child element), or a hash where the key is an element name and the value is the element value. - - This parameter requires C(xpath) to be set. + - This parameter requires I(xpath) to be set. type: bool default: false insertafter: description: - - Add additional child-element(s) after the last selected element for a given C(xpath). + - Add additional child-element(s) after the last selected element for a given I(xpath). - Child elements must be given in a list and each item may be either a string (eg. C(children=ansible) to add an empty C() child element), or a hash where the key is an element name and the value is the element value. - - This parameter requires C(xpath) to be set. + - This parameter requires I(xpath) to be set. type: bool default: false requirements: @@ -141,7 +141,7 @@ notes: - Use the C(--check) and C(--diff) options when testing your expressions. - The diff output is automatically pretty-printed, so may not reflect the actual file content, only the file structure. - This module does not handle complicated xpath expressions, so limit xpath selectors to simple expressions. -- Beware that in case your XML elements are namespaced, you need to use the C(namespaces) parameter, see the examples. +- Beware that in case your XML elements are namespaced, you need to use the I(namespaces) parameter, see the examples. - Namespaces prefix should be used for all children of an element where namespace is defined, unless another namespace is defined for them. seealso: - name: Xml module development community wiki diff --git a/plugins/modules/monitoring/nagios.py b/plugins/modules/monitoring/nagios.py index b36c6691d2..fe2f66065d 100644 --- a/plugins/modules/monitoring/nagios.py +++ b/plugins/modules/monitoring/nagios.py @@ -23,11 +23,11 @@ description: - The C(nagios) module is not idempotent. - All actions require the I(host) parameter to be given explicitly. In playbooks you can use the C({{inventory_hostname}}) variable to refer to the host the playbook is currently running on. - - You can specify multiple services at once by separating them with commas, .e.g., C(services=httpd,nfs,puppet). + - You can specify multiple services at once by separating them with commas, .e.g. I(services=httpd,nfs,puppet). - When specifying what service to handle there is a special service value, I(host), which will handle alerts/downtime/acknowledge for the I(host itself), - e.g., C(service=host). This keyword may not be given with other services at the same time. + e.g., I(service=host). This keyword may not be given with other services at the same time. I(Setting alerts/downtime/acknowledge for a host does not affect alerts/downtime/acknowledge for any of the services running on it.) - To schedule downtime for all services on particular host use keyword "all", e.g., C(service=all). + To schedule downtime for all services on particular host use keyword "all", e.g., I(service=all). options: action: description: @@ -52,17 +52,17 @@ options: author: description: - Author to leave downtime comments as. - Only usable with the C(downtime) and C(acknowledge) action. + Only used when I(action) is C(downtime) or C(acknowledge). type: str default: Ansible comment: description: - - Comment for C(downtime) and C(acknowledge)action. + - Comment when I(action) is C(downtime) or C(acknowledge). type: str default: Scheduling downtime start: description: - - When downtime should start, in time_t format (epoch seconds). + - When downtime should start, in C(time_t) format (epoch seconds). version_added: '0.2.0' type: str minutes: @@ -73,9 +73,10 @@ options: default: 30 services: description: - - What to manage downtime/alerts for. Separate multiple services with commas. - C(service) is an alias for C(services). - B(Required) option when using the C(downtime), C(acknowledge), C(forced_check), C(enable_alerts), and C(disable_alerts) actions. + - > + What to manage downtime/alerts for. Separate multiple services with commas. + I(service) is an alias for I(services). + B(Required) option when I(action) is one of: C(downtime), C(acknowledge), C(forced_check), C(enable_alerts), C(disable_alerts). aliases: [ "service" ] type: str servicegroup: diff --git a/plugins/modules/monitoring/spectrum_device.py b/plugins/modules/monitoring/spectrum_device.py index a72fd029c8..c2bab55016 100644 --- a/plugins/modules/monitoring/spectrum_device.py +++ b/plugins/modules/monitoring/spectrum_device.py @@ -29,7 +29,7 @@ options: type: str description: - SNMP community used for device discovery. - - Required when C(state=present). + - Required when I(state=present). required: true landscape: type: str @@ -38,7 +38,6 @@ options: - Landscape handle of the SpectroServer to which add or remove the device. state: type: str - required: false description: - On C(present) creates the device when it does not exist. - On C(absent) removes the device when it exists. @@ -49,7 +48,7 @@ options: aliases: [ oneclick_url ] required: true description: - - HTTP, HTTPS URL of the Oneclick server in the form (http|https)://host.domain[:port] + - HTTP, HTTPS URL of the Oneclick server in the form C((http|https)://host.domain[:port]). url_username: type: str aliases: [ oneclick_user ] @@ -63,17 +62,14 @@ options: description: - Oneclick user password. use_proxy: - required: false description: - - if C(false), it will not use a proxy, even if one is defined in an environment - variable on the target hosts. + - if C(false), it will not use a proxy, even if one is defined in an environment variable on the target hosts. default: true type: bool validate_certs: - required: false description: - If C(false), SSL certificates will not be validated. This should only be used - on personally controlled sites using self-signed certificates. + on personally controlled sites using self-signed certificates. default: true type: bool agentport: diff --git a/plugins/modules/net_tools/cloudflare_dns.py b/plugins/modules/net_tools/cloudflare_dns.py index 12cd484565..dca9a8e176 100644 --- a/plugins/modules/net_tools/cloudflare_dns.py +++ b/plugins/modules/net_tools/cloudflare_dns.py @@ -44,39 +44,39 @@ options: algorithm: description: - Algorithm number. - - Required for C(type=DS) and C(type=SSHFP) when C(state=present). + - Required for I(type=DS) and I(type=SSHFP) when I(state=present). type: int cert_usage: description: - Certificate usage number. - - Required for C(type=TLSA) when C(state=present). + - Required for I(type=TLSA) when I(state=present). type: int choices: [ 0, 1, 2, 3 ] hash_type: description: - Hash type number. - - Required for C(type=DS), C(type=SSHFP) and C(type=TLSA) when C(state=present). + - Required for I(type=DS), I(type=SSHFP) and I(type=TLSA) when I(state=present). type: int choices: [ 1, 2 ] key_tag: description: - DNSSEC key tag. - - Needed for C(type=DS) when C(state=present). + - Needed for I(type=DS) when I(state=present). type: int port: description: - Service port. - - Required for C(type=SRV) and C(type=TLSA). + - Required for I(type=SRV) and I(type=TLSA). type: int priority: description: - Record priority. - - Required for C(type=MX) and C(type=SRV) + - Required for I(type=MX) and I(type=SRV) default: 1 type: int proto: description: - - Service protocol. Required for C(type=SRV) and C(type=TLSA). + - Service protocol. Required for I(type=SRV) and I(type=TLSA). - Common values are TCP and UDP. - Before Ansible 2.6 only TCP and UDP were available. type: str @@ -88,7 +88,7 @@ options: record: description: - Record to add. - - Required if C(state=present). + - Required if I(state=present). - Default is C(@) (e.g. the zone name). type: str default: '@' @@ -96,7 +96,7 @@ options: selector: description: - Selector number. - - Required for C(type=TLSA) when C(state=present). + - Required for I(type=TLSA) when I(state=present). choices: [ 0, 1 ] type: int service: @@ -107,7 +107,7 @@ options: solo: description: - Whether the record should be the only one for that record type and record name. - - Only use with C(state=present). + - Only use with I(state=present). - This will delete all other records with the same record name and type. type: bool state: @@ -129,20 +129,20 @@ options: default: 1 type: description: - - The type of DNS record to create. Required if C(state=present). - - C(type=DS), C(type=SSHFP) and C(type=TLSA) added in Ansible 2.7. + - The type of DNS record to create. Required if I(state=present). + - I(type=DS), I(type=SSHFP) and I(type=TLSA) added in Ansible 2.7. type: str choices: [ A, AAAA, CNAME, DS, MX, NS, SPF, SRV, SSHFP, TLSA, TXT ] value: description: - The record value. - - Required for C(state=present). + - Required for I(state=present). type: str aliases: [ content ] weight: description: - Service weight. - - Required for C(type=SRV). + - Required for I(type=SRV). type: int default: 1 zone: