From eff0cb0ed97c70ce14d545c73dcfa1eb87f57e28 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Thu, 15 Jun 2023 15:48:51 +0200 Subject: [PATCH] Use semantic markup (modules r-s) (#6683) * Use semantic markup. * Use 'ignore:' for alias reference. * Ignore sanity errors for older ansible-core versions. * Improve markup for RHSM modules. Co-authored-by: Pino Toscano * 'ignore:' is no longer needed. * E() now works better. --------- Co-authored-by: Pino Toscano --- plugins/modules/rax.py | 30 +++++------ plugins/modules/rax_files_objects.py | 12 ++--- plugins/modules/rax_mon_check.py | 52 +++++++++---------- plugins/modules/rax_scaling_group.py | 6 +-- plugins/modules/rax_scaling_policy.py | 8 +-- plugins/modules/read_csv.py | 18 ++++--- plugins/modules/redhat_subscription.py | 50 +++++++++--------- plugins/modules/redis_data_incr.py | 6 +-- plugins/modules/rhevm.py | 8 +-- plugins/modules/rhn_register.py | 8 +-- plugins/modules/rhsm_release.py | 4 +- plugins/modules/rhsm_repository.py | 6 +-- plugins/modules/rocketchat.py | 16 +++--- plugins/modules/rundeck_job_run.py | 6 +-- plugins/modules/scaleway_compute.py | 8 +-- .../scaleway_compute_private_network.py | 4 +- plugins/modules/scaleway_container.py | 6 +-- .../modules/scaleway_container_namespace.py | 4 +- .../modules/scaleway_container_registry.py | 6 +-- plugins/modules/scaleway_database_backup.py | 28 +++++----- plugins/modules/scaleway_function.py | 6 +-- .../modules/scaleway_function_namespace.py | 4 +- plugins/modules/scaleway_ip.py | 4 +- plugins/modules/scaleway_private_network.py | 4 +- plugins/modules/scaleway_security_group.py | 6 +-- .../modules/scaleway_security_group_rule.py | 6 +-- plugins/modules/scaleway_sshkey.py | 4 +- plugins/modules/scaleway_volume.py | 4 +- plugins/modules/sefcontext.py | 36 ++++++------- plugins/modules/sendgrid.py | 6 +-- plugins/modules/sensu_check.py | 18 +++---- plugins/modules/shutdown.py | 6 +-- plugins/modules/slack.py | 40 +++++++------- plugins/modules/snap.py | 4 +- plugins/modules/snmp_facts.py | 18 +++---- plugins/modules/solaris_zone.py | 22 ++++---- plugins/modules/sorcery.py | 30 +++++------ plugins/modules/spectrum_device.py | 14 ++--- plugins/modules/ssh_config.py | 18 +++---- plugins/modules/stacki_host.py | 12 ++--- plugins/modules/sudoers.py | 12 ++--- plugins/modules/supervisorctl.py | 10 ++-- plugins/modules/svr4pkg.py | 12 ++--- plugins/modules/swupd.py | 6 +-- plugins/modules/sysrc.py | 22 ++++---- tests/sanity/ignore-2.11.txt | 1 + tests/sanity/ignore-2.12.txt | 1 + tests/sanity/ignore-2.13.txt | 1 + tests/sanity/ignore-2.14.txt | 1 + 49 files changed, 311 insertions(+), 303 deletions(-) diff --git a/plugins/modules/rax.py b/plugins/modules/rax.py index 47c0a6d1bb..76e4299447 100644 --- a/plugins/modules/rax.py +++ b/plugins/modules/rax.py @@ -24,15 +24,15 @@ options: auto_increment: description: - Whether or not to increment a single number with the name of the - created servers. Only applicable when used with the I(group) attribute + created servers. Only applicable when used with the O(group) attribute or meta key. type: bool default: true boot_from_volume: description: - Whether or not to boot the instance from a Cloud Block Storage volume. - If C(true) and I(image) is specified a new volume will be created at - boot time. I(boot_volume_size) is required with I(image) to create a + If V(true) and O(image) is specified a new volume will be created at + boot time. O(boot_volume_size) is required with O(image) to create a new volume at boot time. type: bool default: false @@ -45,11 +45,11 @@ options: type: int description: - Size of the volume to create in Gigabytes. This is only required with - I(image) and I(boot_from_volume). + O(image) and O(boot_from_volume). default: 100 boot_volume_terminate: description: - - Whether the I(boot_volume) or newly created volume from I(image) will + - Whether the O(boot_volume) or newly created volume from O(image) will be terminated when the server is terminated type: bool default: false @@ -72,16 +72,16 @@ options: type: str description: - Disk partitioning strategy - - If not specified it will assume the value C(auto). + - If not specified it will assume the value V(auto). choices: - auto - manual exact_count: description: - Explicitly ensure an exact count of instances, used with - state=active/present. If specified as C(true) and I(count) is less than + state=active/present. If specified as V(true) and O(count) is less than the servers matched, servers will be deleted to match the count. If - the number of matched servers is fewer than specified in I(count) + the number of matched servers is fewer than specified in O(count) additional servers will be added. type: bool default: false @@ -116,7 +116,7 @@ options: type: str description: - image to use for the instance. Can be an C(id), C(human_id) or C(name). - With I(boot_from_volume), a Cloud Block Storage volume will be created + With O(boot_from_volume), a Cloud Block Storage volume will be created with this image instance_ids: type: list @@ -161,7 +161,7 @@ options: type: str description: - Data to be uploaded to the servers config drive. This option implies - I(config_drive). Can be a file path or a string + O(config_drive). Can be a file path or a string wait: description: - wait for the instance to be in state 'running' before returning @@ -176,11 +176,11 @@ author: - "Jesse Keating (@omgjlk)" - "Matt Martz (@sivel)" notes: - - I(exact_count) can be "destructive" if the number of running servers in - the I(group) is larger than that specified in I(count). In such a case, the - I(state) is effectively set to C(absent) and the extra servers are deleted. - In the case of deletion, the returned data structure will have C(action) - set to C(delete), and the oldest servers in the group will be deleted. + - O(exact_count) can be "destructive" if the number of running servers in + the O(group) is larger than that specified in O(count). In such a case, the + O(state) is effectively set to V(absent) and the extra servers are deleted. + In the case of deletion, the returned data structure will have RV(ignore:action) + set to V(delete), and the oldest servers in the group will be deleted. extends_documentation_fragment: - community.general.rackspace.openstack - community.general.attributes diff --git a/plugins/modules/rax_files_objects.py b/plugins/modules/rax_files_objects.py index 49ac40daf0..bbcdfe4f80 100644 --- a/plugins/modules/rax_files_objects.py +++ b/plugins/modules/rax_files_objects.py @@ -23,7 +23,7 @@ options: clear_meta: description: - Optionally clear existing metadata when applying metadata to existing objects. - Selecting this option is only appropriate when setting I(type=meta). + Selecting this option is only appropriate when setting O(type=meta). type: bool default: false container: @@ -36,7 +36,7 @@ options: description: - The destination of a C(get) operation; i.e. a local directory, C(/home/user/myfolder). Used to specify the destination of an operation on a remote object; i.e. a file name, - C(file1), or a comma-separated list of remote objects, C(file1,file2,file17). + V(file1), or a comma-separated list of remote objects, V(file1,file2,file17). expires: type: int description: @@ -50,8 +50,8 @@ options: type: str description: - > - The method of operation to be performed: C(put) to upload files, C(get) to download files or - C(delete) to remove remote objects in Cloud Files. + The method of operation to be performed: V(put) to upload files, V(get) to download files or + V(delete) to remove remote objects in Cloud Files. choices: - get - put @@ -61,8 +61,8 @@ options: type: str description: - Source from which to upload files. Used to specify a remote object as a source for - an operation, i.e. a file name, C(file1), or a comma-separated list of remote objects, - C(file1,file2,file17). Parameters I(src) and I(dest) are mutually exclusive on remote-only object operations + an operation, i.e. a file name, V(file1), or a comma-separated list of remote objects, + V(file1,file2,file17). Parameters O(src) and O(dest) are mutually exclusive on remote-only object operations structure: description: - Used to specify whether to maintain nested directory structure when downloading objects diff --git a/plugins/modules/rax_mon_check.py b/plugins/modules/rax_mon_check.py index 878ae14e8e..253c26dcf5 100644 --- a/plugins/modules/rax_mon_check.py +++ b/plugins/modules/rax_mon_check.py @@ -29,7 +29,7 @@ options: state: type: str description: - - Ensure that a check with this C(label) exists or does not exist. + - Ensure that a check with this O(label) exists or does not exist. choices: ["present", "absent"] default: present entity_id: @@ -50,27 +50,27 @@ options: that have a non-null C(agent_id). - | Choices for this option are: - - C(remote.dns) - - C(remote.ftp-banner) - - C(remote.http) - - C(remote.imap-banner) - - C(remote.mssql-banner) - - C(remote.mysql-banner) - - C(remote.ping) - - C(remote.pop3-banner) - - C(remote.postgresql-banner) - - C(remote.smtp-banner) - - C(remote.smtp) - - C(remote.ssh) - - C(remote.tcp) - - C(remote.telnet-banner) - - C(agent.filesystem) - - C(agent.memory) - - C(agent.load_average) - - C(agent.cpu) - - C(agent.disk) - - C(agent.network) - - C(agent.plugin) + - V(remote.dns) + - V(remote.ftp-banner) + - V(remote.http) + - V(remote.imap-banner) + - V(remote.mssql-banner) + - V(remote.mysql-banner) + - V(remote.ping) + - V(remote.pop3-banner) + - V(remote.postgresql-banner) + - V(remote.smtp-banner) + - V(remote.smtp) + - V(remote.ssh) + - V(remote.tcp) + - V(remote.telnet-banner) + - V(agent.filesystem) + - V(agent.memory) + - V(agent.load_average) + - V(agent.cpu) + - V(agent.disk) + - V(agent.network) + - V(agent.plugin) required: true monitoring_zones_poll: type: str @@ -81,15 +81,15 @@ options: target_hostname: type: str description: - - One of I(target_hostname) and I(target_alias) is required for remote.* checks, + - One of O(target_hostname) and O(target_alias) is required for remote.* checks, but prohibited for agent.* checks. The hostname this check should target. Must be a valid IPv4, IPv6, or FQDN. target_alias: type: str description: - - One of I(target_alias) and I(target_hostname) is required for remote.* checks, + - One of O(target_alias) and O(target_hostname) is required for remote.* checks, but prohibited for agent.* checks. Use the corresponding key in the entity's - I(ip_addresses) hash to resolve an IP address to target. + C(ip_addresses) hash to resolve an IP address to target. details: type: dict default: {} @@ -99,7 +99,7 @@ options: 256 items. disabled: description: - - If C(true), ensure the check is created, but don't actually use it yet. + - If V(true), ensure the check is created, but don't actually use it yet. type: bool default: false metadata: diff --git a/plugins/modules/rax_scaling_group.py b/plugins/modules/rax_scaling_group.py index 677a75b336..f4bb790255 100644 --- a/plugins/modules/rax_scaling_group.py +++ b/plugins/modules/rax_scaling_group.py @@ -36,7 +36,7 @@ options: type: str description: - Disk partitioning strategy - - If not specified, it will fallback to C(auto). + - If not specified, it will fallback to V(auto). choices: - auto - manual @@ -53,7 +53,7 @@ options: image: type: str description: - - image to use for the instance. Can be an C(id), C(human_id) or C(name) + - image to use for the instance. Can be an C(id), C(human_id) or C(name). required: true key_name: type: str @@ -113,7 +113,7 @@ options: type: str description: - Data to be uploaded to the servers config drive. This option implies - I(config_drive). Can be a file path or a string + O(config_drive). Can be a file path or a string wait: description: - wait for the scaling group to finish provisioning the minimum amount of diff --git a/plugins/modules/rax_scaling_policy.py b/plugins/modules/rax_scaling_policy.py index 60b48bb2a9..2869a69105 100644 --- a/plugins/modules/rax_scaling_policy.py +++ b/plugins/modules/rax_scaling_policy.py @@ -25,18 +25,18 @@ options: description: - The UTC time when this policy will be executed. The time must be formatted according to C(yyyy-MM-dd'T'HH:mm:ss.SSS) such as - C(2013-05-19T08:07:08Z) + V(2013-05-19T08:07:08Z) change: type: int description: - The change, either as a number of servers or as a percentage, to make in the scaling group. If this is a percentage, you must set - I(is_percent) to C(true) also. + O(is_percent) to V(true) also. cron: type: str description: - The time when the policy will be executed, as a cron entry. For - example, if this is parameter is set to C(1 0 * * *) + example, if this is parameter is set to V(1 0 * * *). cooldown: type: int description: @@ -51,7 +51,7 @@ options: many servers should be in the scaling group. is_percent: description: - - Whether the value in I(change) is a percent value + - Whether the value in O(change) is a percent value default: false type: bool name: diff --git a/plugins/modules/read_csv.py b/plugins/modules/read_csv.py index f2a359fa7d..d1ba0262c3 100644 --- a/plugins/modules/read_csv.py +++ b/plugins/modules/read_csv.py @@ -33,13 +33,13 @@ options: key: description: - The column name used as a key for the resulting dictionary. - - If C(key) is unset, the module returns a list of dictionaries, + - If O(key) is unset, the module returns a list of dictionaries, where each dictionary is a row in the CSV file. type: str dialect: description: - The CSV dialect to use when parsing the CSV file. - - Possible values include C(excel), C(excel-tab) or C(unix). + - Possible values include V(excel), V(excel-tab) or V(unix). type: str default: excel fieldnames: @@ -50,29 +50,31 @@ options: elements: str unique: description: - - Whether the C(key) used is expected to be unique. + - Whether the O(key) used is expected to be unique. type: bool default: true delimiter: description: - A one-character string used to separate fields. - - When using this parameter, you change the default value used by I(dialect). + - When using this parameter, you change the default value used by O(dialect). - The default value depends on the dialect used. type: str skipinitialspace: description: - Whether to ignore any whitespaces immediately following the delimiter. - - When using this parameter, you change the default value used by I(dialect). + - When using this parameter, you change the default value used by O(dialect). - The default value depends on the dialect used. type: bool strict: description: - Whether to raise an exception on bad CSV input. - - When using this parameter, you change the default value used by I(dialect). + - When using this parameter, you change the default value used by O(dialect). - The default value depends on the dialect used. type: bool -notes: -- Ansible also ships with the C(csvfile) lookup plugin, which can be used to do selective lookups in CSV files from Jinja. +seealso: + - plugin: community.general.csvfile + plugin_type: lookup + description: Can be used to do selective lookups in CSV files from Jinja. ''' EXAMPLES = r''' diff --git a/plugins/modules/redhat_subscription.py b/plugins/modules/redhat_subscription.py index 685c07a968..3e49504d93 100644 --- a/plugins/modules/redhat_subscription.py +++ b/plugins/modules/redhat_subscription.py @@ -27,20 +27,20 @@ notes: parameters, which is I(not) secure, as they can be easily stolen by checking the process listing on the system. Due to limitations of the D-Bus interface of C(rhsm), the module will I(not) use D-Bus for registation when trying either to register - using I(token), or when specifying I(environment), or when the system is old + using O(token), or when specifying O(environment), or when the system is old (typically RHEL 6 and older). - In order to register a system, subscription-manager requires either a username and password, or an activationkey and an Organization ID. - - Since 2.5 values for I(server_hostname), I(server_insecure), I(rhsm_baseurl), - I(server_proxy_hostname), I(server_proxy_port), I(server_proxy_user) and - I(server_proxy_password) are no longer taken from the C(/etc/rhsm/rhsm.conf) - config file and default to None. + - Since 2.5 values for O(server_hostname), O(server_insecure), O(rhsm_baseurl), + O(server_proxy_hostname), O(server_proxy_port), O(server_proxy_user) and + O(server_proxy_password) are no longer taken from the C(/etc/rhsm/rhsm.conf) + config file and default to V(null). - It is possible to interact with C(subscription-manager) only as root, so root permissions are required to successfully run this module. - - Since community.general 6.5.0, credentials (that is, I(username) and I(password), - I(activationkey), or I(token)) are needed only in case the the system is not registered, - or I(force_register) is specified; this makes it possible to use the module to tweak an - already registered system, for example attaching pools to it (using I(pool), or I(pool_ids)), - and modifying the C(syspurpose) attributes (using I(syspurpose)). + - Since community.general 6.5.0, credentials (that is, O(username) and O(password), + O(activationkey), or O(token)) are needed only in case the the system is not registered, + or O(force_register) is specified; this makes it possible to use the module to tweak an + already registered system, for example attaching pools to it (using O(pool), or O(pool_ids)), + and modifying the C(syspurpose) attributes (using O(syspurpose)). requirements: - subscription-manager - Optionally the C(dbus) Python library; this is usually included in the OS @@ -55,7 +55,7 @@ attributes: options: state: description: - - whether to register and subscribe (C(present)), or unregister (C(absent)) a system + - whether to register and subscribe (V(present)), or unregister (V(absent)) a system choices: [ "present", "absent" ] default: "present" type: str @@ -74,11 +74,11 @@ options: version_added: 6.3.0 server_hostname: description: - - Specify an alternative Red Hat Subscription Management or Red Hat Satellite or Katello server + - Specify an alternative Red Hat Subscription Management or Red Hat Satellite or Katello server. type: str server_insecure: description: - - Enable or disable https server certificate verification when connecting to C(server_hostname) + - Enable or disable https server certificate verification when connecting to O(server_hostname). type: str server_prefix: description: @@ -104,7 +104,7 @@ options: type: str server_proxy_scheme: description: - - Specify an HTTP proxy scheme, for example C(http) or C(https). + - Specify an HTTP proxy scheme, for example V(http) or V(https). type: str version_added: 6.2.0 server_proxy_port: @@ -123,8 +123,8 @@ options: description: - Upon successful registration, auto-consume available subscriptions - | - Added in favor of the deprecated I(autosubscribe) option in - Ansible 2.5; please note that I(autosubscribe) will be removed in + Added in favor of the deprecated O(autosubscribe) option in + Ansible 2.5; please note that O(autosubscribe) will be removed in community.general 9.0.0. type: bool aliases: [autosubscribe] @@ -144,9 +144,9 @@ options: description: - | Specify a subscription pool name to consume. Regular expressions accepted. - Mutually exclusive with I(pool_ids). + Mutually exclusive with O(pool_ids). - | - Please use I(pool_ids) instead: specifying pool IDs is much faster, + Please use O(pool_ids) instead: specifying pool IDs is much faster, and it avoids to match new pools that become available for the system and are not explicitly wanted. Also, this option does not support quantities. @@ -158,11 +158,11 @@ options: pool_ids: description: - | - Specify subscription pool IDs to consume. Prefer over I(pool) when possible as it is much faster. - A pool ID may be specified as a C(string) - just the pool ID (ex. C(0123456789abcdef0123456789abcdef)), - or as a C(dict) with the pool ID as the key, and a quantity as the value (ex. - C(0123456789abcdef0123456789abcdef: 2). If the quantity is provided, it is used to consume multiple - entitlements from a pool (the pool must support this). Mutually exclusive with I(pool). + Specify subscription pool IDs to consume. Prefer over O(pool) when possible as it is much faster. + A pool ID may be specified as a C(string) - just the pool ID (for example V(0123456789abcdef0123456789abcdef)), + or as a C(dict) with the pool ID as the key, and a quantity as the value (for example + V(0123456789abcdef0123456789abcdef: 2). If the quantity is provided, it is used to consume multiple + entitlements from a pool (the pool must support this). Mutually exclusive with O(pool). default: [] type: list elements: raw @@ -216,8 +216,8 @@ options: elements: str sync: description: - - When this option is true, then syspurpose attributes are synchronized with - RHSM server immediately. When this option is false, then syspurpose attributes + - When this option is V(true), then syspurpose attributes are synchronized with + RHSM server immediately. When this option is V(false), then syspurpose attributes will be synchronized with RHSM server by rhsmcertd daemon. type: bool default: false diff --git a/plugins/modules/redis_data_incr.py b/plugins/modules/redis_data_incr.py index f927fb11f0..b359e0cb94 100644 --- a/plugins/modules/redis_data_incr.py +++ b/plugins/modules/redis_data_incr.py @@ -16,15 +16,15 @@ version_added: 4.0.0 description: - Increment integers or float keys in Redis database and get new value. - Default increment for all keys is 1. For specific increments use the - I(increment_int) and I(increment_float) options. + O(increment_int) and O(increment_float) options. author: "Andreas Botzner (@paginabianca)" attributes: check_mode: support: partial details: - - For C(check_mode) to work, the specified I(redis_user) needs permission to + - For C(check_mode) to work, the specified O(login_user) needs permission to run the C(GET) command on the key, otherwise the module will fail. - - When using I(check_mode) the module will try to calculate the value that + - When using C(check_mode) the module will try to calculate the value that Redis would return. If the key is not present, 0.0 is used as value. diff_mode: support: none diff --git a/plugins/modules/rhevm.py b/plugins/modules/rhevm.py index c129a2df52..7f23009972 100644 --- a/plugins/modules/rhevm.py +++ b/plugins/modules/rhevm.py @@ -141,14 +141,14 @@ options: default: true cd_drive: description: - - The CD you wish to have mounted on the VM when I(state = 'CD'). + - The CD you wish to have mounted on the VM when O(state=cd). type: str timeout: description: - The timeout you wish to define for power actions. - - When I(state = 'up'). - - When I(state = 'down'). - - When I(state = 'restarted'). + - When O(state=up). + - When O(state=down). + - When O(state=restarted). type: int ''' diff --git a/plugins/modules/rhn_register.py b/plugins/modules/rhn_register.py index e72be60247..cd1b708e48 100644 --- a/plugins/modules/rhn_register.py +++ b/plugins/modules/rhn_register.py @@ -32,7 +32,7 @@ attributes: options: state: description: - - Whether to register (C(present)), or unregister (C(absent)) a system. + - Whether to register (V(present)), or unregister (V(absent)) a system. type: str choices: [ absent, present ] default: present @@ -47,7 +47,7 @@ options: server_url: description: - Specify an alternative Red Hat Network server URL. - - The default is the current value of I(serverURL) from C(/etc/sysconfig/rhn/up2date). + - The default is the current value of C(serverURL) from C(/etc/sysconfig/rhn/up2date). type: str activationkey: description: @@ -80,12 +80,12 @@ options: default: [] enable_eus: description: - - If C(false), extended update support will be requested. + - If V(false), extended update support will be requested. type: bool default: false nopackages: description: - - If C(true), the registered node will not upload its installed packages information to Satellite server. + - If V(true), the registered node will not upload its installed packages information to Satellite server. type: bool default: false deprecated: diff --git a/plugins/modules/rhsm_release.py b/plugins/modules/rhsm_release.py index 4e14dff39d..8c74ca8192 100644 --- a/plugins/modules/rhsm_release.py +++ b/plugins/modules/rhsm_release.py @@ -16,7 +16,7 @@ description: - Sets or unsets the release version used by RHSM repositories. notes: - This module will fail on an unregistered system. - Use the C(redhat_subscription) module to register a system + Use the M(community.general.redhat_subscription) module to register a system prior to setting the RHSM release. - It is possible to interact with C(subscription-manager) only as root, so root permissions are required to successfully run this module. @@ -33,7 +33,7 @@ options: release: description: - RHSM release version to use. - - To unset either pass C(null) for this option, or omit this option. + - To unset either pass V(null) for this option, or omit this option. type: str author: - Sean Myers (@seandst) diff --git a/plugins/modules/rhsm_repository.py b/plugins/modules/rhsm_repository.py index 3225161e85..c7f88b03ef 100644 --- a/plugins/modules/rhsm_repository.py +++ b/plugins/modules/rhsm_repository.py @@ -18,7 +18,7 @@ description: author: Giovanni Sciortino (@giovannisciortino) notes: - In order to manage RHSM repositories the system must be already registered - to RHSM manually or using the Ansible C(redhat_subscription) module. + to RHSM manually or using the Ansible M(community.general.redhat_subscription) module. - It is possible to interact with C(subscription-manager) only as root, so root permissions are required to successfully run this module. @@ -53,8 +53,8 @@ options: elements: str purge: description: - - Disable all currently enabled repositories that are not not specified in C(name). - Only set this to C(True) if passing in a list of repositories to the C(name) field. + - Disable all currently enabled repositories that are not not specified in O(name). + Only set this to V(true) if passing in a list of repositories to the O(name) field. Using this with C(loop) will most likely not have the desired result. type: bool default: false diff --git a/plugins/modules/rocketchat.py b/plugins/modules/rocketchat.py index 23d6d529e7..473f0150ab 100644 --- a/plugins/modules/rocketchat.py +++ b/plugins/modules/rocketchat.py @@ -29,8 +29,8 @@ options: domain: type: str description: - - The domain for your environment without protocol. (i.e. - C(example.com) or C(chat.example.com)) + - The domain for your environment without protocol. (For example + V(example.com) or V(chat.example.com).) required: true token: type: str @@ -42,7 +42,7 @@ options: protocol: type: str description: - - Specify the protocol used to send notification messages before the webhook url. (i.e. http or https) + - Specify the protocol used to send notification messages before the webhook URL (that is, V(http) or V(https)). default: https choices: - 'http' @@ -54,7 +54,7 @@ options: channel: type: str description: - - Channel to send the message to. If absent, the message goes to the channel selected for the I(token) + - Channel to send the message to. If absent, the message goes to the channel selected for the O(token) specified during the creation of webhook. username: type: str @@ -70,18 +70,20 @@ options: type: str description: - Emoji for the message sender. The representation for the available emojis can be - got from Rocket Chat. (for example :thumbsup:) (if I(icon_emoji) is set, I(icon_url) will not be used) + got from Rocket Chat. + - For example V(:thumbsup:). + - If O(icon_emoji) is set, O(icon_url) will not be used. link_names: type: int description: - - Automatically create links for channels and usernames in I(msg). + - Automatically create links for channels and usernames in O(msg). default: 1 choices: - 1 - 0 validate_certs: description: - - If C(false), SSL certificates will not be validated. This should only be used + - If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. type: bool default: true diff --git a/plugins/modules/rundeck_job_run.py b/plugins/modules/rundeck_job_run.py index 894f1bb6f9..2ef1447401 100644 --- a/plugins/modules/rundeck_job_run.py +++ b/plugins/modules/rundeck_job_run.py @@ -42,7 +42,7 @@ options: type: str description: - Schedule the job execution to run at specific date and time. - - ISO-8601 date and time format like C(2021-10-05T15:45:00-03:00). + - ISO-8601 date and time format like V(2021-10-05T15:45:00-03:00). loglevel: type: str description: @@ -64,12 +64,12 @@ options: description: - Job execution wait timeout in seconds. - If the timeout is reached, the job will be aborted. - - Keep in mind that there is a sleep based on I(wait_execution_delay) after each job status check. + - Keep in mind that there is a sleep based on O(wait_execution_delay) after each job status check. default: 120 abort_on_timeout: type: bool description: - - Send a job abort request if exceeded the I(wait_execution_timeout) specified. + - Send a job abort request if exceeded the O(wait_execution_timeout) specified. default: false extends_documentation_fragment: - community.general.rundeck diff --git a/plugins/modules/scaleway_compute.py b/plugins/modules/scaleway_compute.py index 9bd8218071..7f85bc6686 100644 --- a/plugins/modules/scaleway_compute.py +++ b/plugins/modules/scaleway_compute.py @@ -37,8 +37,8 @@ options: description: - Manage public IP on a Scaleway server - Could be Scaleway IP address UUID - - C(dynamic) Means that IP is destroyed at the same time the host is destroyed - - C(absent) Means no public IP at all + - V(dynamic) Means that IP is destroyed at the same time the host is destroyed + - V(absent) Means no public IP at all default: absent enable_ipv6: @@ -62,13 +62,13 @@ options: type: str description: - Organization identifier. - - Exactly one of I(project) and I(organization) must be specified. + - Exactly one of O(project) and O(organization) must be specified. project: type: str description: - Project identifier. - - Exactly one of I(project) and I(organization) must be specified. + - Exactly one of O(project) and O(organization) must be specified. version_added: 4.3.0 state: diff --git a/plugins/modules/scaleway_compute_private_network.py b/plugins/modules/scaleway_compute_private_network.py index 9a9d9adde8..b41720be58 100644 --- a/plugins/modules/scaleway_compute_private_network.py +++ b/plugins/modules/scaleway_compute_private_network.py @@ -49,7 +49,7 @@ options: region: type: str description: - - Scaleway region to use (for example C(par1)). + - Scaleway region to use (for example V(par1)). required: true choices: - ams1 @@ -98,7 +98,7 @@ EXAMPLES = ''' RETURN = ''' scaleway_compute_private_network: description: Information on the VPC. - returned: success when I(state=present) + returned: success when O(state=present) type: dict sample: { diff --git a/plugins/modules/scaleway_container.py b/plugins/modules/scaleway_container.py index 19ffae4197..c4bba1fe9f 100644 --- a/plugins/modules/scaleway_container.py +++ b/plugins/modules/scaleway_container.py @@ -51,7 +51,7 @@ options: region: type: str description: - - Scaleway region to use (for example C(fr-par)). + - Scaleway region to use (for example V(fr-par)). required: true choices: - fr-par @@ -109,7 +109,7 @@ options: privacy: description: - Privacy policies define whether a container can be executed anonymously. - - Choose C(public) to enable anonymous execution, or C(private) to protect your container with an authentication mechanism provided by the Scaleway API. + - Choose V(public) to enable anonymous execution, or V(private) to protect your container with an authentication mechanism provided by the Scaleway API. type: str default: public choices: @@ -174,7 +174,7 @@ EXAMPLES = ''' RETURN = ''' container: description: The container information. - returned: when I(state=present) + returned: when O(state=present) type: dict sample: cpu_limit: 140 diff --git a/plugins/modules/scaleway_container_namespace.py b/plugins/modules/scaleway_container_namespace.py index fb01b86728..65865f0fcf 100644 --- a/plugins/modules/scaleway_container_namespace.py +++ b/plugins/modules/scaleway_container_namespace.py @@ -51,7 +51,7 @@ options: region: type: str description: - - Scaleway region to use (for example C(fr-par)). + - Scaleway region to use (for example V(fr-par)). required: true choices: - fr-par @@ -110,7 +110,7 @@ EXAMPLES = ''' RETURN = ''' container_namespace: description: The container namespace information. - returned: when I(state=present) + returned: when O(state=present) type: dict sample: description: "" diff --git a/plugins/modules/scaleway_container_registry.py b/plugins/modules/scaleway_container_registry.py index 5eee571ec7..71011aea44 100644 --- a/plugins/modules/scaleway_container_registry.py +++ b/plugins/modules/scaleway_container_registry.py @@ -49,7 +49,7 @@ options: region: type: str description: - - Scaleway region to use (for example C(fr-par)). + - Scaleway region to use (for example V(fr-par)). required: true choices: - fr-par @@ -72,7 +72,7 @@ options: type: str description: - Default visibility policy. - - Everyone will be able to pull images from a C(public) registry. + - Everyone will be able to pull images from a V(public) registry. choices: - public - private @@ -99,7 +99,7 @@ EXAMPLES = ''' RETURN = ''' container_registry: description: The container registry information. - returned: when I(state=present) + returned: when O(state=present) type: dict sample: created_at: "2022-10-14T09:51:07.949716Z" diff --git a/plugins/modules/scaleway_database_backup.py b/plugins/modules/scaleway_database_backup.py index edc9f6cab4..592ec0b7ff 100644 --- a/plugins/modules/scaleway_database_backup.py +++ b/plugins/modules/scaleway_database_backup.py @@ -32,10 +32,10 @@ options: state: description: - Indicate desired state of the database backup. - - C(present) creates a backup. - - C(absent) deletes the backup. - - C(exported) creates a download link for the backup. - - C(restored) restores the backup to a new database. + - V(present) creates a backup. + - V(absent) deletes the backup. + - V(exported) creates a download link for the backup. + - V(restored) restores the backup to a new database. type: str default: present choices: @@ -46,7 +46,7 @@ options: region: description: - - Scaleway region to use (for example C(fr-par)). + - Scaleway region to use (for example V(fr-par)). type: str required: true choices: @@ -57,37 +57,37 @@ options: id: description: - UUID used to identify the database backup. - - Required for C(absent), C(exported) and C(restored) states. + - Required for V(absent), V(exported) and V(restored) states. type: str name: description: - Name used to identify the database backup. - - Required for C(present) state. - - Ignored when I(state=absent), I(state=exported) or I(state=restored). + - Required for V(present) state. + - Ignored when O(state=absent), O(state=exported) or O(state=restored). type: str required: false database_name: description: - Name used to identify the database. - - Required for C(present) and C(restored) states. - - Ignored when I(state=absent) or I(state=exported). + - Required for V(present) and V(restored) states. + - Ignored when O(state=absent) or O(state=exported). type: str required: false instance_id: description: - UUID of the instance associated to the database backup. - - Required for C(present) and C(restored) states. - - Ignored when I(state=absent) or I(state=exported). + - Required for V(present) and V(restored) states. + - Ignored when O(state=absent) or O(state=exported). type: str required: false expires_at: description: - Expiration datetime of the database backup (ISO 8601 format). - - Ignored when I(state=absent), I(state=exported) or I(state=restored). + - Ignored when O(state=absent), O(state=exported) or O(state=restored). type: str required: false @@ -145,7 +145,7 @@ EXAMPLES = ''' RETURN = ''' metadata: description: Backup metadata. - returned: when I(state=present), I(state=exported) or I(state=restored) + returned: when O(state=present), O(state=exported), or O(state=restored) type: dict sample: { "metadata": { diff --git a/plugins/modules/scaleway_function.py b/plugins/modules/scaleway_function.py index 3785458660..90e86d68b5 100644 --- a/plugins/modules/scaleway_function.py +++ b/plugins/modules/scaleway_function.py @@ -51,7 +51,7 @@ options: region: type: str description: - - Scaleway region to use (for example C(fr-par)). + - Scaleway region to use (for example V(fr-par)). required: true choices: - fr-par @@ -121,7 +121,7 @@ options: privacy: description: - Privacy policies define whether a function can be executed anonymously. - - Choose C(public) to enable anonymous execution, or C(private) to protect your function with an authentication mechanism provided by the Scaleway API. + - Choose V(public) to enable anonymous execution, or V(private) to protect your function with an authentication mechanism provided by the Scaleway API. type: str default: public choices: @@ -160,7 +160,7 @@ EXAMPLES = ''' RETURN = ''' function: description: The function information. - returned: when I(state=present) + returned: when O(state=present) type: dict sample: cpu_limit: 140 diff --git a/plugins/modules/scaleway_function_namespace.py b/plugins/modules/scaleway_function_namespace.py index f6310b35be..fec2a74751 100644 --- a/plugins/modules/scaleway_function_namespace.py +++ b/plugins/modules/scaleway_function_namespace.py @@ -51,7 +51,7 @@ options: region: type: str description: - - Scaleway region to use (for example C(fr-par)). + - Scaleway region to use (for example V(fr-par)). required: true choices: - fr-par @@ -110,7 +110,7 @@ EXAMPLES = ''' RETURN = ''' function_namespace: description: The function namespace information. - returned: when I(state=present) + returned: when O(state=present) type: dict sample: description: "" diff --git a/plugins/modules/scaleway_ip.py b/plugins/modules/scaleway_ip.py index cf8e2e6015..1c9042742b 100644 --- a/plugins/modules/scaleway_ip.py +++ b/plugins/modules/scaleway_ip.py @@ -94,8 +94,8 @@ EXAMPLES = ''' RETURN = ''' data: - description: This is only present when I(state=present). - returned: when I(state=present) + description: This is only present when O(state=present). + returned: when O(state=present) type: dict sample: { "ips": [ diff --git a/plugins/modules/scaleway_private_network.py b/plugins/modules/scaleway_private_network.py index 33fb7381ca..0cc9b900f4 100644 --- a/plugins/modules/scaleway_private_network.py +++ b/plugins/modules/scaleway_private_network.py @@ -48,7 +48,7 @@ options: region: type: str description: - - Scaleway region to use (for example C(par1)). + - Scaleway region to use (for example V(par1)). required: true choices: - ams1 @@ -93,7 +93,7 @@ EXAMPLES = ''' RETURN = ''' scaleway_private_network: description: Information on the VPC. - returned: success when I(state=present) + returned: success when O(state=present) type: dict sample: { diff --git a/plugins/modules/scaleway_security_group.py b/plugins/modules/scaleway_security_group.py index 5523da41ce..c09bc34bad 100644 --- a/plugins/modules/scaleway_security_group.py +++ b/plugins/modules/scaleway_security_group.py @@ -45,7 +45,7 @@ options: region: description: - - Scaleway region to use (for example C(par1)). + - Scaleway region to use (for example V(par1)). type: str required: true choices: @@ -110,8 +110,8 @@ EXAMPLES = ''' RETURN = ''' data: - description: This is only present when I(state=present). - returned: when I(state=present) + description: This is only present when O(state=present). + returned: when O(state=present) type: dict sample: { "scaleway_security_group": { diff --git a/plugins/modules/scaleway_security_group_rule.py b/plugins/modules/scaleway_security_group_rule.py index 136631d03d..becbc7c6b6 100644 --- a/plugins/modules/scaleway_security_group_rule.py +++ b/plugins/modules/scaleway_security_group_rule.py @@ -44,7 +44,7 @@ options: region: type: str description: - - Scaleway region to use (for example C(par1)). + - Scaleway region to use (for example V(par1)). required: true choices: - ams1 @@ -119,8 +119,8 @@ EXAMPLES = ''' RETURN = ''' data: - description: This is only present when I(state=present). - returned: when I(state=present) + description: This is only present when O(state=present). + returned: when O(state=present) type: dict sample: { "scaleway_security_group_rule": { diff --git a/plugins/modules/scaleway_sshkey.py b/plugins/modules/scaleway_sshkey.py index a39e57aa39..5647f9cd05 100644 --- a/plugins/modules/scaleway_sshkey.py +++ b/plugins/modules/scaleway_sshkey.py @@ -72,8 +72,8 @@ EXAMPLES = ''' RETURN = ''' data: - description: This is only present when I(state=present). - returned: when I(state=present) + description: This is only present when O(state=present). + returned: when O(state=present) type: dict sample: { "ssh_public_keys": [ diff --git a/plugins/modules/scaleway_volume.py b/plugins/modules/scaleway_volume.py index 2ff09da544..46d72288e7 100644 --- a/plugins/modules/scaleway_volume.py +++ b/plugins/modules/scaleway_volume.py @@ -96,8 +96,8 @@ EXAMPLES = ''' RETURN = ''' data: - description: This is only present when I(state=present). - returned: when I(state=present) + description: This is only present when O(state=present). + returned: when O(state=present) type: dict sample: { "volume": { diff --git a/plugins/modules/sefcontext.py b/plugins/modules/sefcontext.py index b2fb367673..19c128fa7b 100644 --- a/plugins/modules/sefcontext.py +++ b/plugins/modules/sefcontext.py @@ -36,43 +36,43 @@ options: description: - The file type that should have SELinux contexts applied. - "The following file type options are available:" - - C(a) for all files, - - C(b) for block devices, - - C(c) for character devices, - - C(d) for directories, - - C(f) for regular files, - - C(l) for symbolic links, - - C(p) for named pipes, - - C(s) for socket files. + - V(a) for all files, + - V(b) for block devices, + - V(c) for character devices, + - V(d) for directories, + - V(f) for regular files, + - V(l) for symbolic links, + - V(p) for named pipes, + - V(s) for socket files. type: str choices: [ a, b, c, d, f, l, p, s ] default: a setype: description: - - SELinux type for the specified I(target). + - SELinux type for the specified O(target). type: str substitute: description: - - Path to use to substitute file context(s) for the specified I(target). The context labeling for the I(target) subtree is made equivalent to this path. + - Path to use to substitute file context(s) for the specified O(target). The context labeling for the O(target) subtree is made equivalent to this path. - This is also referred to as SELinux file context equivalence and it implements the C(equal) functionality of the SELinux management tools. version_added: 6.4.0 type: str aliases: [ equal ] seuser: description: - - SELinux user for the specified I(target). - - Defaults to C(system_u) for new file contexts and to existing value when modifying file contexts. + - SELinux user for the specified O(target). + - Defaults to V(system_u) for new file contexts and to existing value when modifying file contexts. type: str selevel: description: - - SELinux range for the specified I(target). - - Defaults to C(s0) for new file contexts and to existing value when modifying file contexts. + - SELinux range for the specified O(target). + - Defaults to V(s0) for new file contexts and to existing value when modifying file contexts. type: str aliases: [ serange ] state: description: - - Whether the SELinux file context must be C(absent) or C(present). - - Specifying C(absent) without either I(setype) or I(substitute) deletes both SELinux type or path substitution mappings that match I(target). + - Whether the SELinux file context must be V(absent) or V(present). + - Specifying V(absent) without either O(setype) or O(substitute) deletes both SELinux type or path substitution mappings that match O(target). type: str choices: [ absent, present ] default: present @@ -89,8 +89,8 @@ options: default: false notes: - The changes are persistent across reboots. -- I(setype) and I(substitute) are mutually exclusive. -- If I(state=present) then one of I(setype) or I(substitute) is mandatory. +- O(setype) and O(substitute) are mutually exclusive. +- If O(state=present) then one of O(setype) or O(substitute) is mandatory. - The M(community.general.sefcontext) module does not modify existing files to the new SELinux context(s), so it is advisable to first create the SELinux file contexts before creating files, or run C(restorecon) manually diff --git a/plugins/modules/sendgrid.py b/plugins/modules/sendgrid.py index 2c0cc9a5b2..8b577b8607 100644 --- a/plugins/modules/sendgrid.py +++ b/plugins/modules/sendgrid.py @@ -24,7 +24,7 @@ notes: account." - "In order to use api_key, cc, bcc, attachments, from_name, html_body, headers you must pip install sendgrid" - - "since 2.2 I(username) and I(password) are not required if you supply an I(api_key)" + - "Since Ansible 2.2 O(username) and O(password) are not required if you supply an O(api_key)" requirements: - sendgrid Python library 1.6.22 or lower (Sendgrid API V2 supported) extends_documentation_fragment: @@ -39,12 +39,12 @@ options: type: str description: - Username for logging into the SendGrid account. - - Since 2.2 it is only required if I(api_key) is not supplied. + - Since 2.2 it is only required if O(api_key) is not supplied. password: type: str description: - Password that corresponds to the username. - - Since 2.2 it is only required if I(api_key) is not supplied. + - Since 2.2 it is only required if O(api_key) is not supplied. from_address: type: str description: diff --git a/plugins/modules/sensu_check.py b/plugins/modules/sensu_check.py index 1ac2316a84..1430d6a6ce 100644 --- a/plugins/modules/sensu_check.py +++ b/plugins/modules/sensu_check.py @@ -16,7 +16,7 @@ short_description: Manage Sensu checks description: - Manage the checks that should be run on a machine by I(Sensu). - Most options do not have a default and will not be added to the check definition unless specified. - - All defaults except I(path), I(state), I(backup) and I(metric) are not managed by this module, + - All defaults except O(path), O(state), O(backup) and O(metric) are not managed by this module, - they are simply specified for your convenience. extends_documentation_fragment: - community.general.attributes @@ -42,8 +42,8 @@ options: type: str description: - Path to the json file of the check to be added/removed. - - Will be created if it does not exist (unless I(state=absent)). - - The parent folders need to exist when I(state=present), otherwise an error will be thrown + - Will be created if it does not exist (unless O(state=absent)). + - The parent folders need to exist when O(state=present), otherwise an error will be thrown default: /etc/sensu/conf.d/checks.json backup: description: @@ -54,7 +54,7 @@ options: command: type: str description: - - Path to the sensu check to run (not required when I(state=absent)) + - Path to the sensu check to run (not required when O(state=absent)) handlers: type: list elements: str @@ -82,7 +82,7 @@ options: handle: description: - Whether the check should be handled or not - - Default is C(false). + - Default is V(false). type: bool subdue_begin: type: str @@ -105,14 +105,14 @@ options: standalone: description: - Whether the check should be scheduled by the sensu client or server - - This option obviates the need for specifying the I(subscribers) option - - Default is C(false). + - This option obviates the need for specifying the O(subscribers) option + - Default is V(false). type: bool publish: description: - Whether the check should be scheduled at all. - You can still issue it via the sensu api - - Default is C(false). + - Default is V(false). type: bool occurrences: type: int @@ -127,7 +127,7 @@ options: description: - Classifies the check as an aggregate check, - making it available via the aggregate API - - Default is C(false). + - Default is V(false). type: bool low_flap_threshold: type: int diff --git a/plugins/modules/shutdown.py b/plugins/modules/shutdown.py index 3132af3426..f4a9c1acf6 100644 --- a/plugins/modules/shutdown.py +++ b/plugins/modules/shutdown.py @@ -12,9 +12,9 @@ DOCUMENTATION = r''' module: shutdown short_description: Shut down a machine notes: - - C(PATH) is ignored on the remote node when searching for the C(shutdown) command. Use I(search_paths) + - C(PATH) is ignored on the remote node when searching for the C(shutdown) command. Use O(search_paths) to specify locations to search if the default paths do not work. - - The I(msg) and I(delay) options are not supported when a shutdown command is not found in I(search_paths), instead + - The O(msg) and O(delay) options are not supported when a shutdown command is not found in O(search_paths), instead the module will attempt to shutdown the system by calling C(systemctl shutdown). description: - Shut downs a machine. @@ -76,7 +76,7 @@ EXAMPLES = r''' RETURN = r''' shutdown: - description: C(true) if the machine has been shut down. + description: V(true) if the machine has been shut down. returned: always type: bool sample: true diff --git a/plugins/modules/slack.py b/plugins/modules/slack.py index 4e26f1973c..bc3ed171d2 100644 --- a/plugins/modules/slack.py +++ b/plugins/modules/slack.py @@ -19,7 +19,7 @@ DOCUMENTATION = """ module: slack short_description: Send Slack notifications description: - - The C(slack) module sends notifications to U(http://slack.com) via the Incoming WebHook integration + - The M(community.general.slack) module sends notifications to U(http://slack.com) via the Incoming WebHook integration author: "Ramon de la Fuente (@ramondelafuente)" extends_documentation_fragment: - community.general.attributes @@ -32,8 +32,8 @@ options: domain: type: str description: - - Slack (sub)domain for your environment without protocol. (i.e. - C(example.slack.com)) In 1.8 and beyond, this is deprecated and may + - Slack (sub)domain for your environment without protocol. (For example + V(example.slack.com).) In Ansible 1.8 and beyond, this is deprecated and may be ignored. See token documentation for information. token: type: str @@ -41,9 +41,9 @@ options: - Slack integration token. This authenticates you to the slack service. Make sure to use the correct type of token, depending on what method you use. - "Webhook token: - Prior to 1.8, a token looked like C(3Ffe373sfhRE6y42Fg3rvf4GlK). In - 1.8 and above, ansible adapts to the new slack API where tokens look - like C(G922VJP24/D921DW937/3Ffe373sfhRE6y42Fg3rvf4GlK). If tokens + Prior to Ansible 1.8, a token looked like V(3Ffe373sfhRE6y42Fg3rvf4GlK). In + Ansible 1.8 and above, Ansible adapts to the new slack API where tokens look + like V(G922VJP24/D921DW937/3Ffe373sfhRE6y42Fg3rvf4GlK). If tokens are in the new format then slack will ignore any value of domain. If the token is in the old format the domain is required. Ansible has no control of when slack will get rid of the old API. When slack does @@ -55,8 +55,8 @@ options: that the incoming webhooks can be added. The key is on the end of the URL given to you in that section." - "WebAPI token: - Slack WebAPI requires a personal, bot or work application token. These tokens start with C(xoxp-), C(xoxb-) - or C(xoxa-), eg. C(xoxb-1234-56789abcdefghijklmnop). WebAPI token is required if you intend to receive thread_id. + Slack WebAPI requires a personal, bot or work application token. These tokens start with V(xoxp-), V(xoxb-) + or V(xoxa-), for example V(xoxb-1234-56789abcdefghijklmnop). WebAPI token is required if you intend to receive thread_id. See Slack's documentation (U(https://api.slack.com/docs/token-types)) for more information." required: true msg: @@ -68,7 +68,7 @@ options: channel: type: str description: - - Channel to send the message to. If absent, the message goes to the channel selected for the I(token). + - Channel to send the message to. If absent, the message goes to the channel selected for the O(token). thread_id: description: - Optional. Timestamp of parent message to thread this message. https://api.slack.com/docs/message-threading @@ -76,7 +76,7 @@ options: message_id: description: - Optional. Message ID to edit, instead of posting a new message. - - If supplied I(channel_id) must be in form of C(C0xxxxxxx). use C({{ slack_response.channel_id }}) to get I(channel_id) from previous task run. + - If supplied O(channel) must be in form of C(C0xxxxxxx). use C({{ slack_response.channel_id }}) to get RV(ignore:channel_id) from previous task run. - Corresponds to C(ts) in the Slack API (U(https://api.slack.com/messaging/modifying)). type: str version_added: 1.2.0 @@ -88,17 +88,17 @@ options: icon_url: type: str description: - - URL for the message sender's icon (default C(https://docs.ansible.com/favicon.ico)) + - URL for the message sender's icon. default: https://docs.ansible.com/favicon.ico icon_emoji: type: str description: - Emoji for the message sender. See Slack documentation for options. - (if I(icon_emoji) is set, I(icon_url) will not be used) + - If O(icon_emoji) is set, O(icon_url) will not be used. link_names: type: int description: - - Automatically create links for channels and usernames in I(msg). + - Automatically create links for channels and usernames in O(msg). default: 1 choices: - 1 @@ -112,7 +112,7 @@ options: - 'none' validate_certs: description: - - If C(false), SSL certificates will not be validated. This should only be used + - If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. type: bool default: true @@ -139,12 +139,12 @@ options: prepend_hash: type: str description: - - Setting for automatically prepending a C(#) symbol on the passed in I(channel_id). - - The C(auto) method prepends a C(#) unless I(channel_id) starts with one of C(#), C(@), C(C0), C(GF), C(G0), C(CP). - These prefixes only cover a small set of the prefixes that should not have a C(#) prepended. - Since an exact condition which I(channel_id) values must not have the C(#) prefix is not known, - the value C(auto) for this option will be deprecated in the future. It is best to explicitly set - I(prepend_hash=always) or I(prepend_hash=never) to obtain the needed behavior. + - Setting for automatically prepending a V(#) symbol on the passed in O(channel). + - The V(auto) method prepends a V(#) unless O(channel) starts with one of V(#), V(@), V(C0), V(GF), V(G0), V(CP). + These prefixes only cover a small set of the prefixes that should not have a V(#) prepended. + Since an exact condition which O(channel) values must not have the V(#) prefix is not known, + the value V(auto) for this option will be deprecated in the future. It is best to explicitly set + O(prepend_hash=always) or O(prepend_hash=never) to obtain the needed behavior. choices: - 'always' - 'never' diff --git a/plugins/modules/snap.py b/plugins/modules/snap.py index 43abe4e913..6dd303509b 100644 --- a/plugins/modules/snap.py +++ b/plugins/modules/snap.py @@ -36,7 +36,7 @@ options: description: - Desired state of the package. - > - When I(state=present) the module will use C(snap install) if the snap is not installed, + When O(state=present) the module will use C(snap install) if the snap is not installed, and C(snap refresh) if it is installed but from a different channel. default: present choices: [ absent, present, enabled, disabled ] @@ -60,7 +60,7 @@ options: options: description: - Set options with pattern C(key=value) or C(snap:key=value). If a snap name is given, the option will be applied - to that snap only. If the snap name is omitted, the options will be applied to all snaps listed in I(name). Options will + to that snap only. If the snap name is omitted, the options will be applied to all snaps listed in O(name). Options will only be applied to active snaps. required: false type: list diff --git a/plugins/modules/snmp_facts.py b/plugins/modules/snmp_facts.py index e54473ffaf..aecc08f325 100644 --- a/plugins/modules/snmp_facts.py +++ b/plugins/modules/snmp_facts.py @@ -36,46 +36,46 @@ options: required: true version: description: - - SNMP Version to use, C(v2), C(v2c) or C(v3). + - SNMP Version to use, V(v2), V(v2c) or V(v3). type: str required: true choices: [ v2, v2c, v3 ] community: description: - - The SNMP community string, required if I(version) is C(v2) or C(v2c). + - The SNMP community string, required if O(version) is V(v2) or V(v2c). type: str level: description: - Authentication level. - - Required if I(version) is C(v3). + - Required if O(version=v3). type: str choices: [ authNoPriv, authPriv ] username: description: - Username for SNMPv3. - - Required if I(version) is C(v3). + - Required if O(version=v3). type: str integrity: description: - Hashing algorithm. - - Required if I(version) is C(v3). + - Required if O(version=v3). type: str choices: [ md5, sha ] authkey: description: - Authentication key. - - Required I(version) is C(v3). + - Required O(version=v3). type: str privacy: description: - Encryption algorithm. - - Required if I(level) is C(authPriv). + - Required if O(level=authPriv). type: str choices: [ aes, des ] privkey: description: - Encryption key. - - Required if I(level) is C(authPriv). + - Required if O(level=authPriv). type: str timeout: description: @@ -137,7 +137,7 @@ ansible_sysname: type: str sample: ubuntu-user ansible_syslocation: - description: The physical location of this node (e.g., C(telephone closet, 3rd floor)). + description: The physical location of this node (for example, V(telephone closet, 3rd floor)). returned: success type: str sample: Sitting on the Dock of the Bay diff --git a/plugins/modules/solaris_zone.py b/plugins/modules/solaris_zone.py index 0f970704ef..a8d7956c91 100644 --- a/plugins/modules/solaris_zone.py +++ b/plugins/modules/solaris_zone.py @@ -29,16 +29,16 @@ attributes: options: state: description: - - C(present), configure and install the zone. - - C(installed), synonym for C(present). - - C(running), if the zone already exists, boot it, otherwise, configure and install + - V(present), configure and install the zone. + - V(installed), synonym for V(present). + - V(running), if the zone already exists, boot it, otherwise, configure and install the zone first, then boot it. - - C(started), synonym for C(running). - - C(stopped), shutdown a zone. - - C(absent), destroy the zone. - - C(configured), configure the ready so that it's to be attached. - - C(attached), attach a zone, but do not boot it. - - C(detached), shutdown and detach a zone + - V(started), synonym for V(running). + - V(stopped), shutdown a zone. + - V(absent), destroy the zone. + - V(configured), configure the ready so that it's to be attached. + - V(attached), attach a zone, but do not boot it. + - V(detached), shutdown and detach a zone type: str choices: [ absent, attached, configured, detached, installed, present, running, started, stopped ] default: present @@ -47,7 +47,7 @@ options: - Zone name. - A zone name must be unique name. - A zone name must begin with an alpha-numeric character. - - The name can contain alpha-numeric characters, underbars I(_), hyphens I(-), and periods I(.). + - The name can contain alpha-numeric characters, underscores V(_), hyphens V(-), and periods V(.). - The name cannot be longer than 64 characters. type: str required: true @@ -58,7 +58,7 @@ options: type: str sparse: description: - - Whether to create a sparse (C(true)) or whole root (C(false)) zone. + - Whether to create a sparse (V(true)) or whole root (V(false)) zone. type: bool default: false root_password: diff --git a/plugins/modules/sorcery.py b/plugins/modules/sorcery.py index 538d91de11..de63fcc47d 100644 --- a/plugins/modules/sorcery.py +++ b/plugins/modules/sorcery.py @@ -36,8 +36,8 @@ options: description: - Name of the spell - multiple names can be given, separated by commas - - special value '*' in conjunction with states C(latest) or - C(rebuild) will update or rebuild the whole system respectively + - special value '*' in conjunction with states V(latest) or + V(rebuild) will update or rebuild the whole system respectively aliases: ["spell"] type: list elements: str @@ -45,9 +45,9 @@ options: state: description: - Whether to cast, dispel or rebuild a package - - state C(cast) is an equivalent of C(present), not C(latest) - - state C(latest) always triggers I(update_cache=true) - - state C(rebuild) implies cast of all specified spells, not only + - state V(cast) is an equivalent of V(present), not V(latest) + - state V(latest) always triggers O(update_cache=true) + - state V(rebuild) implies cast of all specified spells, not only those existed before choices: ["present", "latest", "absent", "cast", "dispelled", "rebuild"] default: "present" @@ -57,31 +57,31 @@ options: description: - Comma-separated list of _optional_ dependencies to build a spell (or make sure it is built) with; use +/- in front of dependency - to turn it on/off ('+' is optional though) - - this option is ignored if C(name) parameter is equal to '*' or - contains more than one spell - - providers must be supplied in the form recognized by Sorcery, e.g. - 'openssl(SSL)' + to turn it on/off ('+' is optional though). + - this option is ignored if O(name) parameter is equal to V(*) or + contains more than one spell. + - providers must be supplied in the form recognized by Sorcery, for example + 'openssl(SSL)'. type: str update: description: - - Whether or not to update sorcery scripts at the very first stage + - Whether or not to update sorcery scripts at the very first stage. type: bool default: false update_cache: description: - - Whether or not to update grimoire collection before casting spells + - Whether or not to update grimoire collection before casting spells. type: bool default: false aliases: ["update_codex"] cache_valid_time: description: - - Time in seconds to invalidate grimoire collection on update - - especially useful for SCM and rsync grimoires - - makes sense only in pair with C(update_cache) + - Time in seconds to invalidate grimoire collection on update. + - Especially useful for SCM and rsync grimoires. + - Makes sense only in pair with O(update_cache). type: int default: 0 ''' diff --git a/plugins/modules/spectrum_device.py b/plugins/modules/spectrum_device.py index 5cfc076641..7cf7cf9150 100644 --- a/plugins/modules/spectrum_device.py +++ b/plugins/modules/spectrum_device.py @@ -9,7 +9,7 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' +DOCUMENTATION = r''' --- module: spectrum_device short_description: Creates/deletes devices in CA Spectrum @@ -36,7 +36,7 @@ options: type: str description: - SNMP community used for device discovery. - - Required when I(state=present). + - Required when O(state=present). required: true landscape: type: str @@ -46,8 +46,8 @@ options: state: type: str description: - - On C(present) creates the device when it does not exist. - - On C(absent) removes the device when it exists. + - On V(present) creates the device when it does not exist. + - On V(absent) removes the device when it exists. choices: ['present', 'absent'] default: 'present' url: @@ -55,7 +55,7 @@ options: aliases: [ oneclick_url ] required: true description: - - HTTP, HTTPS URL of the Oneclick server in the form C((http|https)://host.domain[:port]). + - HTTP, HTTPS URL of the Oneclick server in the form V((http|https\)://host.domain[:port]). url_username: type: str aliases: [ oneclick_user ] @@ -70,12 +70,12 @@ options: - Oneclick user password. use_proxy: description: - - if C(false), it will not use a proxy, even if one is defined in an environment variable on the target hosts. + - if V(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: description: - - If C(false), SSL certificates will not be validated. This should only be used + - If V(false), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. default: true type: bool diff --git a/plugins/modules/ssh_config.py b/plugins/modules/ssh_config.py index 672ac8c470..3e03ebc275 100644 --- a/plugins/modules/ssh_config.py +++ b/plugins/modules/ssh_config.py @@ -38,20 +38,20 @@ options: user: description: - Which user account this configuration file belongs to. - - If none given and I(ssh_config_file) is not specified, C(/etc/ssh/ssh_config) is used. + - If none given and O(ssh_config_file) is not specified, C(/etc/ssh/ssh_config) is used. - If a user is given, C(~/.ssh/config) is used. - - Mutually exclusive with I(ssh_config_file). + - Mutually exclusive with O(ssh_config_file). type: str group: description: - Which group this configuration file belongs to. - - If none given, I(user) is used. + - If none given, O(user) is used. type: str host: description: - The endpoint this configuration is valid for. - Can be an actual address on the internet or an alias that will - connect to the value of I(hostname). + connect to the value of O(hostname). required: true type: str hostname: @@ -70,7 +70,7 @@ options: description: - The path to an identity file (SSH private key) that will be used when connecting to this host. - - File need to exist and have mode C(0600) to be valid. + - File need to exist and have mode V(0600) to be valid. type: path user_known_hosts_file: description: @@ -84,12 +84,12 @@ options: proxycommand: description: - Sets the C(ProxyCommand) option. - - Mutually exclusive with I(proxyjump). + - Mutually exclusive with O(proxyjump). type: str proxyjump: description: - Sets the C(ProxyJump) option. - - Mutually exclusive with I(proxycommand). + - Mutually exclusive with O(proxycommand). type: str version_added: 6.5.0 forward_agent: @@ -100,8 +100,8 @@ options: ssh_config_file: description: - SSH config file. - - If I(user) and this option are not specified, C(/etc/ssh/ssh_config) is used. - - Mutually exclusive with I(user). + - If O(user) and this option are not specified, C(/etc/ssh/ssh_config) is used. + - Mutually exclusive with O(user). type: path host_key_algorithms: description: diff --git a/plugins/modules/stacki_host.py b/plugins/modules/stacki_host.py index e286bc9617..e7de5c5f11 100644 --- a/plugins/modules/stacki_host.py +++ b/plugins/modules/stacki_host.py @@ -30,13 +30,13 @@ options: type: str stacki_user: description: - - Username for authenticating with Stacki API, but if not specified, the environment variable C(stacki_user) is used instead. + - Username for authenticating with Stacki API, but if not specified, the environment variable E(stacki_user) is used instead. required: true type: str stacki_password: description: - Password for authenticating with Stacki API, but if not - specified, the environment variable C(stacki_password) is used instead. + specified, the environment variable E(stacki_password) is used instead. required: true type: str stacki_endpoint: @@ -61,7 +61,7 @@ options: type: str force_install: description: - - Set value to C(true) to force node into install state if it already exists in stacki. + - Set value to V(true) to force node into install state if it already exists in stacki. type: bool default: false state: @@ -73,20 +73,20 @@ options: appliance: description: - Applicance to be used in host creation. - - Required if I(state) is C(present) and host does not yet exist. + - Required if O(state=present) and host does not yet exist. type: str default: backend rack: description: - Rack to be used in host creation. - - Required if I(state) is C(present) and host does not yet exist. + - Required if O(state=present) and host does not yet exist. type: int default: 0 rank: description: - Rank to be used in host creation. - In Stacki terminology, the rank is the position of the machine in a rack. - - Required if I(state) is C(present) and host does not yet exist. + - Required if O(state=present) and host does not yet exist. type: int default: 0 network: diff --git a/plugins/modules/sudoers.py b/plugins/modules/sudoers.py index fd8289b1ca..f76f6ccc60 100644 --- a/plugins/modules/sudoers.py +++ b/plugins/modules/sudoers.py @@ -31,13 +31,13 @@ options: description: - The commands allowed by the sudoers rule. - Multiple can be added by passing a list of commands. - - Use C(ALL) for all commands. + - Use V(ALL) for all commands. type: list elements: str group: description: - The name of the group for the sudoers rule. - - This option cannot be used in conjunction with I(user). + - This option cannot be used in conjunction with O(user). type: str name: required: true @@ -83,13 +83,13 @@ options: user: description: - The name of the user for the sudoers rule. - - This option cannot be used in conjunction with I(group). + - This option cannot be used in conjunction with O(group). type: str validation: description: - - If C(absent), the sudoers rule will be added without validation. - - If C(detect) and visudo is available, then the sudoers rule will be validated by visudo. - - If C(required), visudo must be available to validate the sudoers rule. + - If V(absent), the sudoers rule will be added without validation. + - If V(detect) and visudo is available, then the sudoers rule will be validated by visudo. + - If V(required), visudo must be available to validate the sudoers rule. type: str default: detect choices: [ absent, detect, required ] diff --git a/plugins/modules/supervisorctl.py b/plugins/modules/supervisorctl.py index e9df16108a..4fffe9a143 100644 --- a/plugins/modules/supervisorctl.py +++ b/plugins/modules/supervisorctl.py @@ -27,9 +27,9 @@ options: type: str description: - The name of the supervisord program or group to manage. - - The name will be taken as group name when it ends with a colon I(:) + - The name will be taken as group name when it ends with a colon V(:). - Group support is only available in Ansible version 1.6 or later. - - If I(name=all), all programs and program groups will be managed. + - If O(name=all), all programs and program groups will be managed. required: true config: type: path @@ -62,9 +62,9 @@ options: description: - path to supervisorctl executable notes: - - When C(state) = I(present), the module will call C(supervisorctl reread) then C(supervisorctl add) if the program/group does not exist. - - When C(state) = I(restarted), the module will call C(supervisorctl update) then call C(supervisorctl restart). - - When C(state) = I(absent), the module will call C(supervisorctl reread) then C(supervisorctl remove) to remove the target program/group. + - When O(state=present), the module will call C(supervisorctl reread) then C(supervisorctl add) if the program/group does not exist. + - When O(state=restarted), the module will call C(supervisorctl update) then call C(supervisorctl restart). + - When O(state=absent), the module will call C(supervisorctl reread) then C(supervisorctl remove) to remove the target program/group. requirements: [ "supervisorctl" ] author: - "Matt Wright (@mattupstate)" diff --git a/plugins/modules/svr4pkg.py b/plugins/modules/svr4pkg.py index e8c410482b..825419493e 100644 --- a/plugins/modules/svr4pkg.py +++ b/plugins/modules/svr4pkg.py @@ -31,14 +31,14 @@ attributes: options: name: description: - - Package name, e.g. C(SUNWcsr) + - Package name, for example V(SUNWcsr). required: true type: str state: description: - - Whether to install (C(present)), or remove (C(absent)) a package. - - If the package is to be installed, then I(src) is required. + - Whether to install (V(present)), or remove (V(absent)) a package. + - If the package is to be installed, then O(src) is required. - The SVR4 package system doesn't provide an upgrade operation. You need to uninstall the old, then install the new package. required: true choices: ["present", "absent"] @@ -46,13 +46,13 @@ options: src: description: - - Specifies the location to install the package from. Required when I(state=present). - - "Can be any path acceptable to the C(pkgadd) command's C(-d) option. e.g.: C(somefile.pkg), C(/dir/with/pkgs), C(http:/server/mypkgs.pkg)." + - Specifies the location to install the package from. Required when O(state=present). + - "Can be any path acceptable to the C(pkgadd) command's C(-d) option. For example: V(somefile.pkg), V(/dir/with/pkgs), V(http:/server/mypkgs.pkg)." - If using a file or directory, they must already be accessible by the host. See the M(ansible.builtin.copy) module for a way to get them there. type: str proxy: description: - - HTTP[s] proxy to be used if I(src) is a URL. + - HTTP[s] proxy to be used if O(src) is a URL. type: str response_file: description: diff --git a/plugins/modules/swupd.py b/plugins/modules/swupd.py index efd7ca7c1f..16738c8cb8 100644 --- a/plugins/modules/swupd.py +++ b/plugins/modules/swupd.py @@ -50,8 +50,8 @@ options: type: str state: description: - - Indicates the desired (I)bundle state. C(present) ensures the bundle - is installed while C(absent) ensures the (I)bundle is not installed. + - Indicates the desired (I)bundle state. V(present) ensures the bundle + is installed while V(absent) ensures the (I)bundle is not installed. default: present choices: [present, absent] type: str @@ -62,7 +62,7 @@ options: default: false url: description: - - Overrides both I(contenturl) and I(versionurl). + - Overrides both O(contenturl) and O(versionurl). type: str verify: description: diff --git a/plugins/modules/sysrc.py b/plugins/modules/sysrc.py index 9652b629ab..76d6569e40 100644 --- a/plugins/modules/sysrc.py +++ b/plugins/modules/sysrc.py @@ -33,28 +33,28 @@ options: required: true value: description: - - The value to set when I(state=present). - - The value to add when I(state=value_present). - - The value to remove when I(state=value_absent). + - The value to set when O(state=present). + - The value to add when O(state=value_present). + - The value to remove when O(state=value_absent). type: str state: description: - - Use I(present) to add the variable. - - Use I(absent) to remove the variable. - - Use I(value_present) to add the value to the existing variable. - - Use I(value_absent) to remove the value from the existing variable. + - Use V(present) to add the variable. + - Use V(absent) to remove the variable. + - Use V(value_present) to add the value to the existing variable. + - Use V(value_absent) to remove the value from the existing variable. type: str default: "present" choices: [ absent, present, value_present, value_absent ] path: description: - - Path to file to use instead of C(/etc/rc.conf). + - Path to file to use instead of V(/etc/rc.conf). type: str default: "/etc/rc.conf" delim: description: - - Delimiter to be used instead of C( ). - - Only used when I(state=value_present) or I(state=value_absent). + - Delimiter to be used instead of V(" ") (space). + - Only used when O(state=value_present) or O(state=value_absent). default: " " type: str jail: @@ -62,7 +62,7 @@ options: - Name or ID of the jail to operate on. type: str notes: - - The C(name) cannot contain periods as sysrc does not support OID style names. + - The O(name) cannot contain periods as sysrc does not support OID style names. ''' EXAMPLES = r''' diff --git a/tests/sanity/ignore-2.11.txt b/tests/sanity/ignore-2.11.txt index 73a39c7f15..730c978bff 100644 --- a/tests/sanity/ignore-2.11.txt +++ b/tests/sanity/ignore-2.11.txt @@ -21,6 +21,7 @@ plugins/modules/parted.py validate-modules:parameter-state-invalid-choice plugins/modules/rax_files_objects.py use-argspec-type-path # module deprecated - removed in 9.0.0 plugins/modules/rax_files.py validate-modules:parameter-state-invalid-choice # module deprecated - removed in 9.0.0 plugins/modules/rax.py use-argspec-type-path # module deprecated - removed in 9.0.0 +plugins/modules/read_csv.py validate-modules:invalid-documentation plugins/modules/rhevm.py validate-modules:parameter-state-invalid-choice plugins/modules/xfconf.py validate-modules:return-syntax-error tests/integration/targets/django_manage/files/base_test/simple_project/p1/manage.py compile-2.6 # django generated code diff --git a/tests/sanity/ignore-2.12.txt b/tests/sanity/ignore-2.12.txt index 83fda1cbbc..801a80d592 100644 --- a/tests/sanity/ignore-2.12.txt +++ b/tests/sanity/ignore-2.12.txt @@ -16,5 +16,6 @@ plugins/modules/parted.py validate-modules:parameter-state-invalid-choice plugins/modules/rax_files_objects.py use-argspec-type-path # module deprecated - removed in 9.0.0 plugins/modules/rax_files.py validate-modules:parameter-state-invalid-choice # module deprecated - removed in 9.0.0 plugins/modules/rax.py use-argspec-type-path # module deprecated - removed in 9.0.0 +plugins/modules/read_csv.py validate-modules:invalid-documentation plugins/modules/rhevm.py validate-modules:parameter-state-invalid-choice plugins/modules/xfconf.py validate-modules:return-syntax-error diff --git a/tests/sanity/ignore-2.13.txt b/tests/sanity/ignore-2.13.txt index 83fda1cbbc..801a80d592 100644 --- a/tests/sanity/ignore-2.13.txt +++ b/tests/sanity/ignore-2.13.txt @@ -16,5 +16,6 @@ plugins/modules/parted.py validate-modules:parameter-state-invalid-choice plugins/modules/rax_files_objects.py use-argspec-type-path # module deprecated - removed in 9.0.0 plugins/modules/rax_files.py validate-modules:parameter-state-invalid-choice # module deprecated - removed in 9.0.0 plugins/modules/rax.py use-argspec-type-path # module deprecated - removed in 9.0.0 +plugins/modules/read_csv.py validate-modules:invalid-documentation plugins/modules/rhevm.py validate-modules:parameter-state-invalid-choice plugins/modules/xfconf.py validate-modules:return-syntax-error diff --git a/tests/sanity/ignore-2.14.txt b/tests/sanity/ignore-2.14.txt index f94c184eed..492d2faf17 100644 --- a/tests/sanity/ignore-2.14.txt +++ b/tests/sanity/ignore-2.14.txt @@ -17,6 +17,7 @@ plugins/modules/parted.py validate-modules:parameter-state-invalid-choice plugins/modules/rax_files_objects.py use-argspec-type-path # module deprecated - removed in 9.0.0 plugins/modules/rax_files.py validate-modules:parameter-state-invalid-choice # module deprecated - removed in 9.0.0 plugins/modules/rax.py use-argspec-type-path # module deprecated - removed in 9.0.0 +plugins/modules/read_csv.py validate-modules:invalid-documentation plugins/modules/rhevm.py validate-modules:parameter-state-invalid-choice plugins/modules/udm_user.py import-3.11 # Uses deprecated stdlib library 'crypt' plugins/modules/xfconf.py validate-modules:return-syntax-error