From e32515889b47b74f83b2e0753f842bb44f50132f Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Sun, 12 Jan 2025 12:13:38 +0000 Subject: [PATCH] [PR #9526/d325cfc3 backport][stable-10] o*: style adjustments (#9566) o*: style adjustments (#9526) * o*: style adjustments * apply recommendations from review * Update plugins/modules/one_vm.py * fix example * adjustment from review * Update plugins/modules/one_vm.py Co-authored-by: Felix Fontein --------- Co-authored-by: Felix Fontein (cherry picked from commit d325cfc3437e080c63b544afd5ddd9339a209f9f) Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com> --- plugins/modules/ocapi_command.py | 3 +- plugins/modules/ocapi_info.py | 7 ++- plugins/modules/oci_vcn.py | 20 +++--- plugins/modules/office_365_connector_card.py | 11 ++-- plugins/modules/ohai.py | 4 +- plugins/modules/one_host.py | 3 +- plugins/modules/one_image.py | 6 +- plugins/modules/one_image_info.py | 12 ++-- plugins/modules/one_service.py | 24 +++---- plugins/modules/one_template.py | 13 ++-- plugins/modules/one_vm.py | 62 ++++++++++--------- plugins/modules/one_vnet.py | 17 ++--- plugins/modules/oneandone_firewall_policy.py | 12 ++-- plugins/modules/oneandone_load_balancer.py | 18 +++--- .../modules/oneandone_monitoring_policy.py | 9 +-- plugins/modules/oneandone_server.py | 25 ++++---- plugins/modules/onepassword_info.py | 20 +++--- plugins/modules/oneview_datacenter_info.py | 2 +- plugins/modules/oneview_enclosure_info.py | 9 +-- .../modules/oneview_ethernet_network_info.py | 4 +- .../oneview_logical_interconnect_group.py | 2 +- plugins/modules/oneview_network_set_info.py | 4 +- plugins/modules/oneview_san_manager.py | 3 +- plugins/modules/open_iscsi.py | 7 ++- plugins/modules/openbsd_pkg.py | 12 ++-- plugins/modules/opendj_backendprop.py | 20 +++--- plugins/modules/openwrt_init.py | 5 +- plugins/modules/opkg.py | 7 ++- plugins/modules/osx_defaults.py | 5 +- plugins/modules/ovh_ip_failover.py | 17 ++--- .../modules/ovh_ip_loadbalancing_backend.py | 6 +- 31 files changed, 196 insertions(+), 173 deletions(-) diff --git a/plugins/modules/ocapi_command.py b/plugins/modules/ocapi_command.py index 001d113ca3..39269c99cb 100644 --- a/plugins/modules/ocapi_command.py +++ b/plugins/modules/ocapi_command.py @@ -154,7 +154,8 @@ msg: sample: "Action was successful" jobUri: - description: URI to use to monitor status of the operation. Returned for async commands such as Firmware Update, Firmware Activate. + description: URI to use to monitor status of the operation. Returned for async commands such as Firmware Update, Firmware + Activate. returned: when supported type: str sample: "https://ioma.wdc.com/Storage/Devices/openflex-data24-usalp03020qb0003/Jobs/FirmwareUpdate/" diff --git a/plugins/modules/ocapi_info.py b/plugins/modules/ocapi_info.py index f2d708965c..f4a216a47d 100644 --- a/plugins/modules/ocapi_info.py +++ b/plugins/modules/ocapi_info.py @@ -93,7 +93,8 @@ operationStatus: sample: "Activate needed" operationStatusId: - description: Integer value of status (corresponds to operationStatus). Applies to O(command=JobStatus). See OCAPI documentation for details. + description: Integer value of status (corresponds to operationStatus). Applies to O(command=JobStatus). See OCAPI documentation + for details. returned: when supported type: int sample: 65540 @@ -106,8 +107,8 @@ operationHealth: operationHealthId: description: >- - Integer value for health of the operation (corresponds to RV(operationHealth)). Applies to O(command=JobStatus). See OCAPI documentation for - details. + Integer value for health of the operation (corresponds to RV(operationHealth)). Applies to O(command=JobStatus). See OCAPI + documentation for details. returned: when supported type: str sample: "OK" diff --git a/plugins/modules/oci_vcn.py b/plugins/modules/oci_vcn.py index 9503698fd7..47d38137ea 100644 --- a/plugins/modules/oci_vcn.py +++ b/plugins/modules/oci_vcn.py @@ -12,8 +12,8 @@ DOCUMENTATION = r""" module: oci_vcn short_description: Manage Virtual Cloud Networks(VCN) in OCI description: - - This module allows the user to create, delete and update virtual cloud networks(VCNs) in OCI. The complete Oracle Cloud Infrastructure Ansible - Modules can be downloaded from U(https://github.com/oracle/oci-ansible-modules/releases). + - This module allows the user to create, delete and update virtual cloud networks(VCNs) in OCI. The complete Oracle Cloud + Infrastructure Ansible Modules can be downloaded from U(https://github.com/oracle/oci-ansible-modules/releases). attributes: check_mode: support: none @@ -25,18 +25,18 @@ options: type: str required: false compartment_id: - description: The OCID of the compartment to contain the VCN. Required when creating a VCN with O(state=present). This option is mutually exclusive - with O(vcn_id). + description: The OCID of the compartment to contain the VCN. Required when creating a VCN with O(state=present). This + option is mutually exclusive with O(vcn_id). type: str display_name: description: A user-friendly name. Does not have to be unique, and it is changeable. type: str aliases: ['name'] dns_label: - description: A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet's DNS label to form a fully qualified domain - name (FQDN) for each VNIC within this subnet (for example, V(bminstance-1.subnet123.vcn1.oraclevcn.com)). Not required to be unique, but it is - a best practice to set unique DNS labels for VCNs in your tenancy. Must be an alphanumeric string that begins with a letter. The value cannot - be changed. + description: A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet's DNS label to form a fully + qualified domain name (FQDN) for each VNIC within this subnet (for example, V(bminstance-1.subnet123.vcn1.oraclevcn.com)). + Not required to be unique, but it is a best practice to set unique DNS labels for VCNs in your tenancy. Must be an alphanumeric + string that begins with a letter. The value cannot be changed. type: str state: description: Create or update a VCN with O(state=present). Use O(state=absent) to delete a VCN. @@ -44,8 +44,8 @@ options: default: present choices: ['present', 'absent'] vcn_id: - description: The OCID of the VCN. Required when deleting a VCN with O(state=absent) or updating a VCN with O(state=present). This option is - mutually exclusive with O(compartment_id). + description: The OCID of the VCN. Required when deleting a VCN with O(state=absent) or updating a VCN with O(state=present). + This option is mutually exclusive with O(compartment_id). type: str aliases: ['id'] author: "Rohit Chaware (@rohitChaware)" diff --git a/plugins/modules/office_365_connector_card.py b/plugins/modules/office_365_connector_card.py index 949fdcdce4..8ff82fecc1 100644 --- a/plugins/modules/office_365_connector_card.py +++ b/plugins/modules/office_365_connector_card.py @@ -13,7 +13,8 @@ module: office_365_connector_card short_description: Use webhooks to create Connector Card messages within an Office 365 group description: - Creates Connector Card messages through Office 365 Connectors. - - See U(https://learn.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-reference#connector-card-for-microsoft-365-groups). + - See + U(https://learn.microsoft.com/en-us/microsoftteams/platform/task-modules-and-cards/cards/cards-reference#connector-card-for-microsoft-365-groups). author: "Marc Sensenich (@marc-sensenich)" notes: - This module is not idempotent, therefore if the same task is run twice there will be two Connector Cards created. @@ -74,8 +75,8 @@ EXAMPLES = r""" webhook: https://outlook.office.com/webhook/GUID/IncomingWebhook/GUID/GUID summary: This is the summary property title: This is the **card's title** property - text: This is the **card's text** property. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut - labore et dolore magna aliqua. + text: This is the **card's text** property. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod + tempor incididunt ut labore et dolore magna aliqua. color: E81123 sections: - title: This is the **section's title** property @@ -86,8 +87,8 @@ EXAMPLES = r""" hero_image: image: http://connectorsdemo.azurewebsites.net/images/WIN12_Scene_01.jpg title: This is the image's alternate text - text: This is the section's text property. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt - ut labore et dolore magna aliqua. + text: This is the section's text property. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod + tempor incididunt ut labore et dolore magna aliqua. facts: - name: This is a fact name value: This is a fact value diff --git a/plugins/modules/ohai.py b/plugins/modules/ohai.py index 9a182e99a5..32b14b2e81 100644 --- a/plugins/modules/ohai.py +++ b/plugins/modules/ohai.py @@ -13,8 +13,8 @@ DOCUMENTATION = r""" module: ohai short_description: Returns inventory data from I(Ohai) description: - - Similar to the M(community.general.facter) module, this runs the I(Ohai) discovery program (U(https://docs.chef.io/ohai.html)) on the remote - host and returns JSON inventory data. I(Ohai) data is a bit more verbose and nested than I(facter). + - Similar to the M(community.general.facter) module, this runs the I(Ohai) discovery program (U(https://docs.chef.io/ohai.html)) + on the remote host and returns JSON inventory data. I(Ohai) data is a bit more verbose and nested than I(facter). extends_documentation_fragment: - community.general.attributes attributes: diff --git a/plugins/modules/one_host.py b/plugins/modules/one_host.py index 8e7e4b92ad..8246172c90 100644 --- a/plugins/modules/one_host.py +++ b/plugins/modules/one_host.py @@ -56,7 +56,8 @@ options: type: str vmm_mad_name: description: - - The name of the virtual machine manager mad name, this values are taken from the oned.conf with the tag name VM_MAD (name). + - The name of the virtual machine manager mad name, this values are taken from the oned.conf with the tag name VM_MAD + (name). default: kvm type: str cluster_id: diff --git a/plugins/modules/one_image.py b/plugins/modules/one_image.py index 399cfadec8..e5ffb68b4f 100644 --- a/plugins/modules/one_image.py +++ b/plugins/modules/one_image.py @@ -157,7 +157,7 @@ EXAMPLES = r""" RETURN = r""" id: - description: Image id. + description: Image ID. type: int returned: when O(state=present), O(state=cloned), or O(state=renamed) sample: 153 @@ -167,7 +167,7 @@ name: returned: when O(state=present), O(state=cloned), or O(state=renamed) sample: app1 group_id: - description: Image's group id. + description: Image's group ID. type: int returned: when O(state=present), O(state=cloned), or O(state=renamed) sample: 1 @@ -177,7 +177,7 @@ group_name: returned: when O(state=present), O(state=cloned), or O(state=renamed) sample: one-users owner_id: - description: Image's owner id. + description: Image's owner ID. type: int returned: when O(state=present), O(state=cloned), or O(state=renamed) sample: 143 diff --git a/plugins/modules/one_image_info.py b/plugins/modules/one_image_info.py index af47e16bdb..7e5def76fb 100644 --- a/plugins/modules/one_image_info.py +++ b/plugins/modules/one_image_info.py @@ -22,7 +22,7 @@ extends_documentation_fragment: options: ids: description: - - A list of images ids whose facts you want to gather. + - A list of images IDs whose facts you want to gather. - Module can use integers too. aliases: ['id'] type: list @@ -30,8 +30,8 @@ options: name: description: - A O(name) of the image whose facts will be gathered. - - If the O(name) begins with V(~) the O(name) will be used as regex pattern, - which restricts the list of images (whose facts will be returned) whose names match specified regex. + - If the O(name) begins with V(~) the O(name) will be used as regex pattern, which restricts the list of images (whose + facts will be returned) whose names match specified regex. - Also, if the O(name) begins with V(~*) case-insensitive matching will be performed. - See examples for more details. type: str @@ -84,7 +84,7 @@ images: returned: success contains: id: - description: The image's id. + description: The image's ID. type: int sample: 153 name: @@ -92,7 +92,7 @@ images: type: str sample: app1 group_id: - description: The image's group id. + description: The image's group ID. type: int sample: 1 group_name: @@ -100,7 +100,7 @@ images: type: str sample: one-users owner_id: - description: The image's owner id. + description: The image's owner ID. type: int sample: 143 owner_name: diff --git a/plugins/modules/one_service.py b/plugins/modules/one_service.py index b9146eca2a..8244e0ca5a 100644 --- a/plugins/modules/one_service.py +++ b/plugins/modules/one_service.py @@ -29,13 +29,13 @@ options: type: str api_username: description: - - Name of the user to login into the OpenNebula OneFlow API server. If not set then the value of the E(ONEFLOW_USERNAME) environment variable - is used. + - Name of the user to login into the OpenNebula OneFlow API server. If not set then the value of the E(ONEFLOW_USERNAME) + environment variable is used. type: str api_password: description: - - Password of the user to login into OpenNebula OneFlow API server. If not set then the value of the E(ONEFLOW_PASSWORD) environment variable - is used. + - Password of the user to login into OpenNebula OneFlow API server. If not set then the value of the E(ONEFLOW_PASSWORD) + environment variable is used. type: str template_name: description: @@ -55,8 +55,8 @@ options: type: str unique: description: - - Setting O(unique=true) will make sure that there is only one service instance running with a name set with O(service_name) when instantiating - a service from a template specified with O(template_id) or O(template_name). Check examples below. + - Setting O(unique=true) will make sure that there is only one service instance running with a name set with O(service_name) + when instantiating a service from a template specified with O(template_id) or O(template_name). Check examples below. type: bool default: false state: @@ -68,8 +68,8 @@ options: type: str mode: description: - - Set permission mode of a service instance in octet format, for example V(0600) to give owner C(use) and C(manage) and nothing to group - and others. + - Set permission mode of a service instance in octet format, for example V(0600) to give owner C(use) and C(manage) + and nothing to group and others. type: str owner_id: description: @@ -184,7 +184,7 @@ EXAMPLES = r""" RETURN = r""" service_id: - description: Service id. + description: Service ID. type: int returned: success sample: 153 @@ -194,7 +194,7 @@ service_name: returned: success sample: app1 group_id: - description: Service's group id. + description: Service's group ID. type: int returned: success sample: 1 @@ -204,7 +204,7 @@ group_name: returned: success sample: one-users owner_id: - description: Service's owner id. + description: Service's owner ID. type: int returned: success sample: 143 @@ -224,7 +224,7 @@ mode: returned: success sample: 660 roles: - description: List of dictionaries of roles, each role is described by name, cardinality, state and nodes ids. + description: List of dictionaries of roles, each role is described by name, cardinality, state and nodes IDs. type: list returned: success sample: diff --git a/plugins/modules/one_template.py b/plugins/modules/one_template.py index 28f4f14cd3..fd2e18dc5e 100644 --- a/plugins/modules/one_template.py +++ b/plugins/modules/one_template.py @@ -25,7 +25,8 @@ attributes: check_mode: support: partial details: - - Note that check mode always returns C(changed=true) for existing templates, even if the template would not actually change. + - Note that check mode always returns C(changed=true) for existing templates, even if the template would not actually + change. diff_mode: support: none @@ -36,8 +37,8 @@ options: type: int name: description: - - A O(name) of the template you would like to manage. - If a template with the given name does not exist it will be created, otherwise it will be managed by this module. + - A O(name) of the template you would like to manage. If a template with the given name does not exist it will be created, + otherwise it will be managed by this module. type: str template: description: @@ -110,7 +111,7 @@ EXAMPLES = r""" RETURN = r""" id: - description: Template id. + description: Template ID. type: int returned: when O(state=present) sample: 153 @@ -124,7 +125,7 @@ template: type: dict returned: when O(state=present) group_id: - description: Template's group id. + description: Template's group ID. type: int returned: when O(state=present) sample: 1 @@ -134,7 +135,7 @@ group_name: returned: when O(state=present) sample: one-users owner_id: - description: Template's owner id. + description: Template's owner ID. type: int returned: when O(state=present) sample: 143 diff --git a/plugins/modules/one_vm.py b/plugins/modules/one_vm.py index 10e4b324ee..0b6d27aae9 100644 --- a/plugins/modules/one_vm.py +++ b/plugins/modules/one_vm.py @@ -32,12 +32,14 @@ options: type: str api_username: description: - - Name of the user to login into the OpenNebula RPC server. If not set then the value of the E(ONE_USERNAME) environment variable is used. + - Name of the user to login into the OpenNebula RPC server. If not set then the value of the E(ONE_USERNAME) environment + variable is used. type: str api_password: description: - - Password of the user to login into OpenNebula RPC server. If not set then the value of the E(ONE_PASSWORD) environment variable is used. - if both O(api_username) or O(api_password) are not set, then it will try authenticate with ONE auth file. Default path is "~/.one/one_auth". + - Password of the user to login into OpenNebula RPC server. If not set then the value of the E(ONE_PASSWORD) environment + variable is used. if both O(api_username) or O(api_password) are not set, then it will try authenticate with ONE auth + file. Default path is C(~/.one/one_auth). - Set environment variable E(ONE_AUTH) to override this path. type: str template_name: @@ -55,7 +57,7 @@ options: type: bool instance_ids: description: - - 'A list of instance ids used for states: V(absent), V(running), V(rebooted), V(poweredoff).' + - 'A list of instance IDs used for states: V(absent), V(running), V(rebooted), V(poweredoff).' aliases: ['ids'] type: list elements: int @@ -76,9 +78,9 @@ options: type: bool wait: description: - - Wait for the instance to reach its desired state before returning. Keep in mind if you are waiting for instance to be in running state - it does not mean that you will be able to SSH on that machine only that boot process have started on that instance, see 'wait_for' example - for details. + - Wait for the instance to reach its desired state before returning. Keep in mind if you are waiting for instance to + be in running state it does not mean that you will be able to SSH on that machine only that boot process have started + on that instance. See the example using the M(ansible.builtin.wait_for) module for details. default: true type: bool wait_timeout: @@ -104,13 +106,14 @@ options: elements: str count_attributes: description: - - A dictionary of key/value attributes that can only be used with O(exact_count) to determine how many nodes based on a specific attributes - criteria should be deployed. This can be expressed in multiple ways and is shown in the EXAMPLES section. + - A dictionary of key/value attributes that can only be used with O(exact_count) to determine how many nodes based on + a specific attributes criteria should be deployed. This can be expressed in multiple ways and is shown in the EXAMPLES + section. type: dict count_labels: description: - - A list of labels that can only be used with O(exact_count) to determine how many nodes based on a specific labels criteria should be deployed. - This can be expressed in multiple ways and is shown in the EXAMPLES section. + - A list of labels that can only be used with O(exact_count) to determine how many nodes based on a specific labels + criteria should be deployed. This can be expressed in multiple ways and is shown in the EXAMPLES section. type: list elements: str count: @@ -120,13 +123,14 @@ options: type: int exact_count: description: - - Indicates how many instances that match O(count_attributes) and O(count_labels) parameters should be deployed. Instances are either created - or terminated based on this value. + - Indicates how many instances that match O(count_attributes) and O(count_labels) parameters should be deployed. Instances + are either created or terminated based on this value. - B(NOTE:) Instances with the least IDs will be terminated first. type: int mode: description: - - Set permission mode of the instance in octet format, for example V(0600) to give owner C(use) and C(manage) and nothing to group and others. + - Set permission mode of the instance in octet format, for example V(0600) to give owner C(use) and C(manage) and nothing + to group and others. type: str owner_id: description: @@ -165,8 +169,8 @@ options: - Creates an image from a VM disk. - It is a dictionary where you have to specify C(name) of the new image. - Optionally you can specify C(disk_id) of the disk you want to save. By default C(disk_id) is 0. - - B(NOTE:) This operation will only be performed on the first VM (if more than one VM ID is passed) and the VM has to be in the C(poweredoff) - state. + - B(NOTE:) This operation will only be performed on the first VM (if more than one VM ID is passed) and the VM has to + be in the C(poweredoff) state. - Also this operation will fail if an image with specified C(name) already exists. type: dict persistent: @@ -338,8 +342,9 @@ EXAMPLES = r""" register: vm - name: Wait for SSH to come up - ansible.builtin.wait_for_connection: - delegate_to: '{{ vm.instances[0].networks[0].ip }}' + ansible.builtin.wait_for: + port: 22 + host: '{{ vm.instances[0].networks[0].ip }}' - name: Terminate VMs by ids community.general.one_vm: @@ -427,7 +432,7 @@ EXAMPLES = r""" RETURN = r""" instances_ids: - description: A list of instances ids whose state is changed or which are fetched with O(instance_ids) option. + description: A list of instances IDs whose state is changed or which are fetched with O(instance_ids) option. type: list returned: success sample: [1234, 1235] @@ -437,7 +442,7 @@ instances: returned: success contains: vm_id: - description: Vm id. + description: Vm ID. type: int sample: 153 vm_name: @@ -445,11 +450,11 @@ instances: type: str sample: foo template_id: - description: Vm's template id. + description: Vm's template ID. type: int sample: 153 group_id: - description: Vm's group id. + description: Vm's group ID. type: int sample: 1 group_name: @@ -457,7 +462,7 @@ instances: type: str sample: one-users owner_id: - description: Vm's owner id. + description: Vm's owner ID. type: int sample: 143 owner_name: @@ -540,12 +545,13 @@ instances: } tagged_instances: description: - - A list of instances info based on a specific attributes and/or labels that are specified with O(count_attributes) and O(count_labels) options. + - A list of instances info based on a specific attributes and/or labels that are specified with O(count_attributes) and + O(count_labels) options. type: complex returned: success contains: vm_id: - description: Vm id. + description: Vm ID. type: int sample: 153 vm_name: @@ -553,11 +559,11 @@ tagged_instances: type: str sample: foo template_id: - description: Vm's template id. + description: Vm's template ID. type: int sample: 153 group_id: - description: Vm's group id. + description: Vm's group ID. type: int sample: 1 group_name: @@ -565,7 +571,7 @@ tagged_instances: type: str sample: one-users owner_id: - description: Vm's user id. + description: Vm's user ID. type: int sample: 143 owner_name: diff --git a/plugins/modules/one_vnet.py b/plugins/modules/one_vnet.py index baafc39fbb..b8cb0c6559 100644 --- a/plugins/modules/one_vnet.py +++ b/plugins/modules/one_vnet.py @@ -22,7 +22,8 @@ attributes: check_mode: support: partial details: - - Note that check mode always returns C(changed=true) for existing networks, even if the network would not actually change. + - Note that check mode always returns C(changed=true) for existing networks, even if the network would not actually + change. diff_mode: support: none options: @@ -33,8 +34,8 @@ options: type: int name: description: - - A O(name) of the network you would like to manage. If a network with the given name does not exist it will be created, otherwise it will - be managed by this module. + - A O(name) of the network you would like to manage. If a network with the given name does not exist it will be created, + otherwise it will be managed by this module. type: str template: description: @@ -89,7 +90,7 @@ EXAMPLES = r""" RETURN = r""" id: - description: The network id. + description: The network ID. type: int returned: when O(state=present) sample: 153 @@ -116,12 +117,12 @@ user_id: returned: when O(state=present) sample: 1 user_name: - description: The network's user id. + description: The network's user ID. type: str returned: when O(state=present) sample: oneadmin group_id: - description: The network's group id. + description: The network's group ID. type: int returned: when O(state=present) sample: 1 @@ -131,7 +132,7 @@ group_name: returned: when O(state=present) sample: one-users owner_id: - description: The network's owner id. + description: The network's owner ID. type: int returned: when O(state=present) sample: 143 @@ -207,7 +208,7 @@ bridge_type: returned: when O(state=present) sample: linux parent_network_id: - description: The network's parent network id. + description: The network's parent network ID. type: int returned: when O(state=present) sample: 1 diff --git a/plugins/modules/oneandone_firewall_policy.py b/plugins/modules/oneandone_firewall_policy.py index 72ed4e5594..743694cf90 100644 --- a/plugins/modules/oneandone_firewall_policy.py +++ b/plugins/modules/oneandone_firewall_policy.py @@ -46,8 +46,8 @@ options: type: str rules: description: - - A list of rules that will be set for the firewall policy. Each rule must contain protocol parameter, in addition to three optional parameters - (port_from, port_to, and source). + - A list of rules that will be set for the firewall policy. Each rule must contain protocol parameter, in addition to + three optional parameters (port_from, port_to, and source). type: list elements: dict default: [] @@ -60,22 +60,22 @@ options: default: [] remove_server_ips: description: - - A list of server IP ids to be unassigned from a firewall policy. Used in combination with update state. + - A list of server IP IDs to be unassigned from a firewall policy. Used in combination with update state. type: list elements: str required: false default: [] add_rules: description: - - A list of rules that will be added to an existing firewall policy. It is syntax is the same as the one used for rules parameter. Used - in combination with update state. + - A list of rules that will be added to an existing firewall policy. It is syntax is the same as the one used for rules + parameter. Used in combination with update state. type: list elements: dict required: false default: [] remove_rules: description: - - A list of rule ids that will be removed from an existing firewall policy. Used in combination with update state. + - A list of rule IDs that will be removed from an existing firewall policy. Used in combination with update state. type: list elements: str required: false diff --git a/plugins/modules/oneandone_load_balancer.py b/plugins/modules/oneandone_load_balancer.py index 45ed6157fa..cb915e4efa 100644 --- a/plugins/modules/oneandone_load_balancer.py +++ b/plugins/modules/oneandone_load_balancer.py @@ -42,7 +42,7 @@ options: required: false name: description: - - Load balancer name used with present state. Used as identifier (id or name) when used with absent state. maxLength=128. + - Load balancer name used with present state. Used as identifier (ID or name) when used with absent state. maxLength=128. type: str health_check_test: description: @@ -55,7 +55,7 @@ options: type: str health_check_path: description: - - Url to call for checking. Required for HTTP health check. maxLength=1000. + - URL to call for checking. Required for HTTP health check. maxLength=1000. type: str required: false health_check_parse: @@ -85,8 +85,8 @@ options: required: false rules: description: - - A list of rule objects that will be set for the load balancer. Each rule must contain protocol, port_balancer, and port_server parameters, - in addition to source parameter, which is optional. + - A list of rule objects that will be set for the load balancer. Each rule must contain protocol, port_balancer, and + port_server parameters, in addition to source parameter, which is optional. type: list elements: dict default: [] @@ -97,29 +97,29 @@ options: required: false add_server_ips: description: - - A list of server identifiers (id or name) to be assigned to a load balancer. Used in combination with update state. + - A list of server identifiers (id or name) to be assigned to a load balancer. Used in combination with O(state=update). type: list elements: str required: false default: [] remove_server_ips: description: - - A list of server IP ids to be unassigned from a load balancer. Used in combination with update state. + - A list of server IP IDs to be unassigned from a load balancer. Used in combination with O(state=update). type: list elements: str required: false default: [] add_rules: description: - - A list of rules that will be added to an existing load balancer. It is syntax is the same as the one used for rules parameter. Used in - combination with update state. + - A list of rules that will be added to an existing load balancer. It is syntax is the same as the one used for rules + parameter. Used in combination with O(state=update). type: list elements: dict required: false default: [] remove_rules: description: - - A list of rule ids that will be removed from an existing load balancer. Used in combination with update state. + - A list of rule IDs that will be removed from an existing load balancer. Used in combination with O(state=update). type: list elements: str required: false diff --git a/plugins/modules/oneandone_monitoring_policy.py b/plugins/modules/oneandone_monitoring_policy.py index 0ba653b414..a0aa17611e 100644 --- a/plugins/modules/oneandone_monitoring_policy.py +++ b/plugins/modules/oneandone_monitoring_policy.py @@ -11,7 +11,8 @@ DOCUMENTATION = r""" module: oneandone_monitoring_policy short_description: Configure 1&1 monitoring policy description: - - Create, remove, update monitoring policies (and add/remove ports, processes, and servers). This module has a dependency on 1and1 >= 1.0. + - Create, remove, update monitoring policies (and add/remove ports, processes, and servers). This module has a dependency + on 1and1 >= 1.0. extends_documentation_fragment: - community.general.attributes attributes: @@ -59,9 +60,9 @@ options: required: false thresholds: description: - - Monitoring policy thresholds. Each of the suboptions have warning and critical, which both have alert and value suboptions. Warning is - used to set limits for warning alerts, critical is used to set critical alerts. alert enables alert, and value is used to advise when - the value is exceeded. + - Monitoring policy thresholds. Each of the suboptions have warning and critical, which both have alert and value suboptions. + Warning is used to set limits for warning alerts, critical is used to set critical alerts. alert enables alert, and + value is used to advise when the value is exceeded. type: list elements: dict default: [] diff --git a/plugins/modules/oneandone_server.py b/plugins/modules/oneandone_server.py index e24ed4f69d..ae9198c7d0 100644 --- a/plugins/modules/oneandone_server.py +++ b/plugins/modules/oneandone_server.py @@ -11,8 +11,8 @@ DOCUMENTATION = r""" module: oneandone_server short_description: Create, destroy, start, stop, and reboot a 1&1 Host server description: - - Create, destroy, update, start, stop, and reboot a 1&1 Host server. When the server is created it can optionally wait for it to be 'running' - before returning. + - Create, destroy, update, start, stop, and reboot a 1&1 Host server. When the server is created it can optionally wait + for it to be 'running' before returning. extends_documentation_fragment: - community.general.attributes attributes: @@ -55,25 +55,26 @@ options: type: str fixed_instance_size: description: - - The instance size name or ID of the server. It is required only for 'present' state, and it is mutually exclusive with vcore, cores_per_processor, - ram, and hdds parameters. + - The instance size name or ID of the server. It is required only for 'present' state, and it is mutually exclusive + with vcore, cores_per_processor, ram, and hdds parameters. - 'The available choices are: V(S), V(M), V(L), V(XL), V(XXL), V(3XL), V(4XL), V(5XL).' type: str vcore: description: - - The total number of processors. It must be provided with cores_per_processor, ram, and hdds parameters. + - The total number of processors. It must be provided with O(cores_per_processor), O(ram), and O(hdds) parameters. type: int cores_per_processor: description: - - The number of cores per processor. It must be provided with vcore, ram, and hdds parameters. + - The number of cores per processor. It must be provided with O(vcore), O(ram), and O(hdds) parameters. type: int ram: description: - - The amount of RAM memory. It must be provided with with vcore, cores_per_processor, and hdds parameters. + - The amount of RAM memory. It must be provided with with O(vcore), O(cores_per_processor), and O(hdds) parameters. type: float hdds: description: - - A list of hard disks with nested "size" and "is_main" properties. It must be provided with vcore, cores_per_processor, and ram parameters. + - A list of hard disks with nested O(ignore:hdds[].size) and O(ignore:hdds[].is_main) properties. It must be provided with O(vcore), + O(cores_per_processor), and O(ram) parameters. type: list elements: dict private_network: @@ -113,8 +114,8 @@ options: choices: ["cloud", "baremetal", "k8s_node"] wait: description: - - Wait for the server to be in state 'running' before returning. Also used for delete operation (set to V(false) if you do not want to wait - for each individual server to be deleted before moving on with other tasks). + - Wait for the server to be in state 'running' before returning. Also used for delete operation (set to V(false) if + you do not want to wait for each individual server to be deleted before moving on with other tasks). type: bool default: true wait_timeout: @@ -129,8 +130,8 @@ options: default: 5 auto_increment: description: - - When creating multiple servers at once, whether to differentiate hostnames by appending a count after them or substituting the count where - there is a %02d or %03d in the hostname string. + - When creating multiple servers at once, whether to differentiate hostnames by appending a count after them or substituting + the count where there is a %02d or %03d in the hostname string. type: bool default: true diff --git a/plugins/modules/onepassword_info.py b/plugins/modules/onepassword_info.py index c49dd15e17..00fa847c07 100644 --- a/plugins/modules/onepassword_info.py +++ b/plugins/modules/onepassword_info.py @@ -46,24 +46,27 @@ options: field: type: str description: - - The name of the field to search for within this item (optional, defaults to V(password), or V(document) if the item has an attachment). + - The name of the field to search for within this item (optional, defaults to V(password), or V(document) if the + item has an attachment). section: type: str description: - - The name of a section within this item containing the specified field (optional, will search all sections if not specified). + - The name of a section within this item containing the specified field (optional, will search all sections if not + specified). vault: type: str description: - - The name of the particular 1Password vault to search, useful if your 1Password user has access to multiple vaults (optional). + - The name of the particular 1Password vault to search, useful if your 1Password user has access to multiple vaults + (optional). required: true auto_login: type: dict description: - - A dictionary containing authentication details. If this is set, M(community.general.onepassword_info) will attempt to sign in to 1Password - automatically. + - A dictionary containing authentication details. If this is set, M(community.general.onepassword_info) will attempt + to sign in to 1Password automatically. - Without this option, you must have already logged in using the 1Password CLI before running Ansible. - - It is B(highly) recommended to store 1Password credentials in an Ansible Vault. Ensure that the key used to encrypt the Ansible Vault - is equal to or greater in strength than the 1Password master password. + - It is B(highly) recommended to store 1Password credentials in an Ansible Vault. Ensure that the key used to encrypt + the Ansible Vault is equal to or greater in strength than the 1Password master password. suboptions: subdomain: type: str @@ -141,7 +144,8 @@ RETURN = r""" # One or more dictionaries for each matching item from 1Password, along with the appropriate fields. # This shows the response you would expect to receive from the third example documented above. onepassword: - description: Dictionary of each 1password item matching the given search terms, shows what would be returned from the third example above. + description: Dictionary of each 1password item matching the given search terms, shows what would be returned from the third + example above. returned: success type: dict sample: diff --git a/plugins/modules/oneview_datacenter_info.py b/plugins/modules/oneview_datacenter_info.py index 831bd59f61..1ca33023db 100644 --- a/plugins/modules/oneview_datacenter_info.py +++ b/plugins/modules/oneview_datacenter_info.py @@ -30,7 +30,7 @@ options: type: str options: description: - - "Retrieve additional information. Options available: V(visualContent)." + - 'Retrieve additional information. Options available: V(visualContent).' type: list elements: str diff --git a/plugins/modules/oneview_enclosure_info.py b/plugins/modules/oneview_enclosure_info.py index 21feee769b..05992ee501 100644 --- a/plugins/modules/oneview_enclosure_info.py +++ b/plugins/modules/oneview_enclosure_info.py @@ -30,8 +30,8 @@ options: type: str options: description: - - 'List with options to gather additional information about an Enclosure and related resources. Options allowed: V(script), V(environmentalConfiguration), - and V(utilization). For the option V(utilization), you can provide specific parameters.' + - 'List with options to gather additional information about an Enclosure and related resources. Options allowed: V(script), + V(environmentalConfiguration), and V(utilization). For the option V(utilization), you can provide specific parameters.' type: list elements: raw @@ -122,11 +122,12 @@ EXAMPLES = r""" ansible.builtin.debug: msg: "{{ result.enclosure_utilization }}" -- name: "Gather information about an Enclosure with temperature data at a resolution of one sample per day, between two specified dates" +- name: "Gather information about an Enclosure with temperature data at a resolution of one sample per day, between two + specified dates" community.general.oneview_enclosure_info: name: Test-Enclosure options: - - utilization: # optional + - utilization: # optional fields: AmbientTemperature filter: - startDate=2016-07-01T14:29:42.000Z diff --git a/plugins/modules/oneview_ethernet_network_info.py b/plugins/modules/oneview_ethernet_network_info.py index 6eb4f46a19..c1c0a327fe 100644 --- a/plugins/modules/oneview_ethernet_network_info.py +++ b/plugins/modules/oneview_ethernet_network_info.py @@ -29,8 +29,8 @@ options: type: str options: description: - - 'List with options to gather additional information about an Ethernet Network and related resources. Options allowed: V(associatedProfiles) - and V(associatedUplinkGroups).' + - 'List with options to gather additional information about an Ethernet Network and related resources. Options allowed: + V(associatedProfiles) and V(associatedUplinkGroups).' type: list elements: str extends_documentation_fragment: diff --git a/plugins/modules/oneview_logical_interconnect_group.py b/plugins/modules/oneview_logical_interconnect_group.py index 866dabc6b8..a45224cb31 100644 --- a/plugins/modules/oneview_logical_interconnect_group.py +++ b/plugins/modules/oneview_logical_interconnect_group.py @@ -63,7 +63,7 @@ EXAMPLES = r""" - relativeValue: 1 type: Enclosure permittedInterconnectTypeName: HP VC Flex-10/10D Module - # Alternatively you can inform permittedInterconnectTypeUri + # Alternatively you can inform permittedInterconnectTypeUri delegate_to: localhost - name: Ensure that the Logical Interconnect Group has the specified scopes diff --git a/plugins/modules/oneview_network_set_info.py b/plugins/modules/oneview_network_set_info.py index f3a4ace3da..51e7d0b510 100644 --- a/plugins/modules/oneview_network_set_info.py +++ b/plugins/modules/oneview_network_set_info.py @@ -30,8 +30,8 @@ options: options: description: - - 'List with options to gather information about Network Set. Option allowed: V(withoutEthernet). The option V(withoutEthernet) retrieves - the list of network_sets excluding Ethernet networks.' + - 'List with options to gather information about Network Set. Option allowed: V(withoutEthernet). The option V(withoutEthernet) + retrieves the list of network_sets excluding Ethernet networks.' type: list elements: str diff --git a/plugins/modules/oneview_san_manager.py b/plugins/modules/oneview_san_manager.py index 8c03bda463..23732cdaaf 100644 --- a/plugins/modules/oneview_san_manager.py +++ b/plugins/modules/oneview_san_manager.py @@ -29,8 +29,7 @@ options: - Indicates the desired state for the Uplink Set resource. - V(present) ensures data properties are compliant with OneView. - V(absent) removes the resource from OneView, if it exists. - - V(connection_information_set) updates the connection information for the SAN Manager. - This operation is non-idempotent. + - V(connection_information_set) updates the connection information for the SAN Manager. This operation is non-idempotent. type: str default: present choices: [present, absent, connection_information_set] diff --git a/plugins/modules/open_iscsi.py b/plugins/modules/open_iscsi.py index 15e20a241a..defb0a072b 100644 --- a/plugins/modules/open_iscsi.py +++ b/plugins/modules/open_iscsi.py @@ -14,7 +14,8 @@ author: - Serge van Ginderachter (@srvg) short_description: Manage iSCSI targets with Open-iSCSI description: - - Discover targets on given portal, (dis)connect targets, mark targets to manually or auto start, return device nodes of connected targets. + - Discover targets on given portal, (dis)connect targets, mark targets to manually or auto start, return device nodes of + connected targets. requirements: - open_iscsi library and tools (iscsiadm) extends_documentation_fragment: @@ -82,8 +83,8 @@ options: discover: description: - Whether the list of target nodes on the portal should be (re)discovered and added to the persistent iSCSI database. - - Keep in mind that C(iscsiadm) discovery resets configuration, like C(node.startup) to manual, hence combined with O(auto_node_startup=true) - will always return a changed state. + - Keep in mind that C(iscsiadm) discovery resets configuration, like C(node.startup) to manual, hence combined with + O(auto_node_startup=true) will always return a changed state. type: bool default: false show_nodes: diff --git a/plugins/modules/openbsd_pkg.py b/plugins/modules/openbsd_pkg.py index 385fdb9870..b9a541cc44 100644 --- a/plugins/modules/openbsd_pkg.py +++ b/plugins/modules/openbsd_pkg.py @@ -44,8 +44,8 @@ options: type: str build: description: - - Build the package from source instead of downloading and installing a binary. Requires that the port source tree is already installed. - Automatically builds and installs the C(sqlports) package, if it is not already installed. + - Build the package from source instead of downloading and installing a binary. Requires that the port source tree is + already installed. Automatically builds and installs the C(sqlports) package, if it is not already installed. - Mutually exclusive with O(snapshot). type: bool default: false @@ -63,8 +63,8 @@ options: type: path clean: description: - - When updating or removing packages, delete the extra configuration file(s) in the old packages which are annotated with @extra in the - packaging-list. + - When updating or removing packages, delete the extra configuration file(s) in the old packages which are annotated + with C(@extra) in the packaging-list. type: bool default: false quick: @@ -73,8 +73,8 @@ options: type: bool default: false notes: - - When used with a C(loop:) each package will be processed individually, it is much more efficient to pass the list directly to the O(name) - option. + - When used with a C(loop:) each package will be processed individually, it is much more efficient to pass the list directly + to the O(name) option. """ EXAMPLES = r""" diff --git a/plugins/modules/opendj_backendprop.py b/plugins/modules/opendj_backendprop.py index 7b48587faf..cd55a39d51 100644 --- a/plugins/modules/opendj_backendprop.py +++ b/plugins/modules/opendj_backendprop.py @@ -81,16 +81,16 @@ options: type: str """ -EXAMPLES = """ - - name: Add or update OpenDJ backend properties - opendj_backendprop: - hostname: localhost - port: 4444 - username: "cn=Directory Manager" - password: password - backend: userRoot - name: index-entry-limit - value: 5000 +EXAMPLES = r""" +- name: Add or update OpenDJ backend properties + opendj_backendprop: + hostname: localhost + port: 4444 + username: "cn=Directory Manager" + password: password + backend: userRoot + name: index-entry-limit + value: 5000 """ RETURN = r""" diff --git a/plugins/modules/openwrt_init.py b/plugins/modules/openwrt_init.py index aa708f08f8..bf5ce2b76a 100644 --- a/plugins/modules/openwrt_init.py +++ b/plugins/modules/openwrt_init.py @@ -43,8 +43,9 @@ options: pattern: type: str description: - - If the service does not respond to the 'running' command, name a substring to look for as would be found in the output of the C(ps) command - as a stand-in for a 'running' result. If the string is found, the service will be assumed to be running. + - If the service does not respond to the 'running' command, name a substring to look for as would be found in the output + of the C(ps) command as a stand-in for a 'running' result. If the string is found, the service will be assumed to + be running. notes: - One option other than O(name) is required. requirements: diff --git a/plugins/modules/opkg.py b/plugins/modules/opkg.py index 40c48f3800..4c2fe74949 100644 --- a/plugins/modules/opkg.py +++ b/plugins/modules/opkg.py @@ -28,8 +28,8 @@ options: name: description: - Name of package(s) to install/remove. - - C(NAME=VERSION) syntax is also supported to install a package in a certain version. See the examples. This only works on Yocto based Linux - distributions (opkg>=0.3.2) and not for OpenWrt. This is supported since community.general 6.2.0. + - V(NAME=VERSION) syntax is also supported to install a package in a certain version. See the examples. This only works + on Yocto based Linux distributions (opkg>=0.3.2) and not for OpenWrt. This is supported since community.general 6.2.0. aliases: [pkg] required: true type: list @@ -43,7 +43,8 @@ options: force: description: - The C(opkg --force) parameter used. - - State V("") is deprecated and will be removed in community.general 12.0.0. Please omit the parameter O(force) to obtain the same behavior. + - State V("") is deprecated and will be removed in community.general 12.0.0. Please omit the parameter O(force) to obtain + the same behavior. choices: - "" - "depends" diff --git a/plugins/modules/osx_defaults.py b/plugins/modules/osx_defaults.py index 1cc541377c..75bd03b4ad 100644 --- a/plugins/modules/osx_defaults.py +++ b/plugins/modules/osx_defaults.py @@ -18,8 +18,9 @@ author: short_description: Manage macOS user defaults description: - This module allows users to read, write, and delete macOS user defaults from Ansible scripts. - - MacOS applications and other programs use the defaults system to record user preferences and other information that must be maintained when - the applications are not running (such as default font for new documents, or the position of an Info panel). + - MacOS applications and other programs use the defaults system to record user preferences and other information that must + be maintained when the applications are not running (such as default font for new documents, or the position of an Info + panel). extends_documentation_fragment: - community.general.attributes attributes: diff --git a/plugins/modules/ovh_ip_failover.py b/plugins/modules/ovh_ip_failover.py index 4d6071cc18..0734e985f7 100644 --- a/plugins/modules/ovh_ip_failover.py +++ b/plugins/modules/ovh_ip_failover.py @@ -13,12 +13,12 @@ DOCUMENTATION = r""" module: ovh_ip_failover short_description: Manage OVH IP failover address description: - - Manage OVH (French European hosting provider) IP Failover Address. For now, this module can only be used to move an IP failover (or failover - block) between services. + - Manage OVH (French European hosting provider) IP Failover Address. For now, this module can only be used to move an IP + failover (or failover block) between services. author: "Pascal HERAUD (@pascalheraud)" notes: - - Uses the python OVH API U(https://github.com/ovh/python-ovh). You have to create an application (a key and secret) with a consumer key as - described into U(https://docs.ovh.com/gb/en/customer/first-steps-with-ovh-api/). + - Uses the Python OVH API U(https://github.com/ovh/python-ovh). You have to create an application (a key and secret) with + a consumer key as described into U(https://docs.ovh.com/gb/en/customer/first-steps-with-ovh-api/). requirements: - ovh >= 0.4.8 extends_documentation_fragment: @@ -49,14 +49,15 @@ options: default: true type: bool description: - - If true, the module will wait for the IP address to be moved. If false, exit without waiting. The taskId will be returned in module output. + - If true, the module will wait for the IP address to be moved. If false, exit without waiting. The taskId will be returned + in module output. wait_task_completion: required: false default: 0 description: - - If not 0, the module will wait for this task id to be completed. Use O(wait_task_completion) if you want to wait for completion of a previously - executed task with O(wait_completion=false). You can execute this module repeatedly on a list of failover IPs using O(wait_completion=false) - (see examples). + - If not 0, the module will wait for this task ID to be completed. Use O(wait_task_completion) if you want to wait for + completion of a previously executed task with O(wait_completion=false). You can execute this module repeatedly on + a list of failover IPs using O(wait_completion=false) (see examples). type: int application_key: required: true diff --git a/plugins/modules/ovh_ip_loadbalancing_backend.py b/plugins/modules/ovh_ip_loadbalancing_backend.py index 174ebffa22..cefb9231bd 100644 --- a/plugins/modules/ovh_ip_loadbalancing_backend.py +++ b/plugins/modules/ovh_ip_loadbalancing_backend.py @@ -16,10 +16,10 @@ description: - Manage OVH (French European hosting provider) LoadBalancing IP backends. author: Pascal Heraud (@pascalheraud) notes: - - Uses the Python OVH API U(https://github.com/ovh/python-ovh). You have to create an application (a key and secret) with a consumer key as - described into U(https://docs.ovh.com/gb/en/customer/first-steps-with-ovh-api/). + - Uses the Python OVH API U(https://github.com/ovh/python-ovh). You have to create an application (a key and secret) with + a consumer key as described into U(https://docs.ovh.com/gb/en/customer/first-steps-with-ovh-api/). requirements: - - ovh > 0.3.5 + - ovh > 0.3.5 extends_documentation_fragment: - community.general.attributes attributes: