From 08b3ffdf8057f0a17dd2da68af346d6d4ea5c224 Mon Sep 17 00:00:00 2001 From: "equinix-labs@auto-commit-workflow" Date: Fri, 19 Jul 2024 15:07:54 +0000 Subject: [PATCH] ci: regenerate code for version 0.8.0 triggered by --- README.md | 72 +++++++++---------- docs/modules/metal_vlan.md | 10 ++- plugins/modules/metal_available_ips_info.py | 12 ++-- plugins/modules/metal_bgp_session.py | 12 ++-- plugins/modules/metal_bgp_session_info.py | 12 ++-- plugins/modules/metal_connection.py | 12 ++-- plugins/modules/metal_connection_info.py | 12 ++-- plugins/modules/metal_device.py | 12 ++-- plugins/modules/metal_device_info.py | 12 ++-- plugins/modules/metal_gateway.py | 12 ++-- plugins/modules/metal_gateway_info.py | 12 ++-- plugins/modules/metal_hardware_reservation.py | 12 ++-- .../metal_hardware_reservation_info.py | 12 ++-- plugins/modules/metal_ip_assignment.py | 12 ++-- plugins/modules/metal_ip_assignment_info.py | 12 ++-- plugins/modules/metal_metro_info.py | 12 ++-- .../modules/metal_operating_system_info.py | 12 ++-- plugins/modules/metal_organization.py | 12 ++-- plugins/modules/metal_organization_info.py | 12 ++-- plugins/modules/metal_plan_info.py | 12 ++-- plugins/modules/metal_project.py | 12 ++-- plugins/modules/metal_project_bgp_config.py | 12 ++-- plugins/modules/metal_project_info.py | 12 ++-- plugins/modules/metal_project_ssh_key.py | 12 ++-- plugins/modules/metal_project_ssh_key_info.py | 12 ++-- plugins/modules/metal_reserved_ip_block.py | 12 ++-- .../modules/metal_reserved_ip_block_info.py | 12 ++-- plugins/modules/metal_ssh_key.py | 12 ++-- plugins/modules/metal_ssh_key_info.py | 12 ++-- plugins/modules/metal_user_info.py | 12 ++-- plugins/modules/metal_virtual_circuit.py | 12 ++-- plugins/modules/metal_virtual_circuit_info.py | 12 ++-- plugins/modules/metal_vlan.py | 37 +++++----- plugins/modules/metal_vlan_info.py | 12 ++-- plugins/modules/metal_vrf.py | 12 ++-- plugins/modules/metal_vrf_info.py | 12 ++-- version | 2 +- 37 files changed, 261 insertions(+), 256 deletions(-) diff --git a/README.md b/README.md index 7f0b304..4df3802 100755 --- a/README.md +++ b/README.md @@ -23,21 +23,21 @@ Modules for managing Equinix infrastructure. Name | Description | --- | ------------ | -[equinix.cloud.metal_bgp_session](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_bgp_session.md)|Manage BGP sessions in Equinix Metal| -[equinix.cloud.metal_connection](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_connection.md)|Manage an Interconnection in Equinix Metal| -[equinix.cloud.metal_device](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_device.md)|Create, update, or delete Equinix Metal devices| -[equinix.cloud.metal_gateway](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_gateway.md)|Manage Metal Gateway in Equinix Metal| -[equinix.cloud.metal_hardware_reservation](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_hardware_reservation.md)|Lookup a single hardware_reservation by ID in Equinix Metal| -[equinix.cloud.metal_ip_assignment](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_ip_assignment.md)|Manage Equinix Metal IP assignments| -[equinix.cloud.metal_organization](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_organization.md)|Lookup a single organization by ID in Equinix Metal| -[equinix.cloud.metal_project](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_project.md)|Manage Projects in Equinix Metal| -[equinix.cloud.metal_project_bgp_config](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_project_bgp_config.md)|Manage BGP Config for Equinix Metal Project| -[equinix.cloud.metal_project_ssh_key](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_project_ssh_key.md)|Manage a project ssh key in Equinix Metal| -[equinix.cloud.metal_reserved_ip_block](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_reserved_ip_block.md)|Create/delete blocks of reserved IP addresses in a project.| -[equinix.cloud.metal_ssh_key](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_ssh_key.md)|Manage personal SSH keys in Equinix Metal| -[equinix.cloud.metal_virtual_circuit](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_virtual_circuit.md)|Manage a Virtual Circuit in Equinix Metal| -[equinix.cloud.metal_vlan](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_vlan.md)|Manage a VLAN resource in Equinix Metal| -[equinix.cloud.metal_vrf](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_vrf.md)|Manage a VRF resource in Equinix Metal| +[equinix.cloud.metal_bgp_session](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_bgp_session.md)|Manage BGP sessions in Equinix Metal| +[equinix.cloud.metal_connection](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_connection.md)|Manage an Interconnection in Equinix Metal| +[equinix.cloud.metal_device](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_device.md)|Create, update, or delete Equinix Metal devices| +[equinix.cloud.metal_gateway](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_gateway.md)|Manage Metal Gateway in Equinix Metal| +[equinix.cloud.metal_hardware_reservation](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_hardware_reservation.md)|Lookup a single hardware_reservation by ID in Equinix Metal| +[equinix.cloud.metal_ip_assignment](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_ip_assignment.md)|Manage Equinix Metal IP assignments| +[equinix.cloud.metal_organization](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_organization.md)|Lookup a single organization by ID in Equinix Metal| +[equinix.cloud.metal_project](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_project.md)|Manage Projects in Equinix Metal| +[equinix.cloud.metal_project_bgp_config](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_project_bgp_config.md)|Manage BGP Config for Equinix Metal Project| +[equinix.cloud.metal_project_ssh_key](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_project_ssh_key.md)|Manage a project ssh key in Equinix Metal| +[equinix.cloud.metal_reserved_ip_block](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_reserved_ip_block.md)|Create/delete blocks of reserved IP addresses in a project.| +[equinix.cloud.metal_ssh_key](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_ssh_key.md)|Manage personal SSH keys in Equinix Metal| +[equinix.cloud.metal_virtual_circuit](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_virtual_circuit.md)|Manage a Virtual Circuit in Equinix Metal| +[equinix.cloud.metal_vlan](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_vlan.md)|Manage a VLAN resource in Equinix Metal| +[equinix.cloud.metal_vrf](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_vrf.md)|Manage a VRF resource in Equinix Metal| ### Info Modules @@ -46,25 +46,25 @@ Modules for retrieving information about existing Equinix infrastructure. Name | Description | --- | ------------ | -[equinix.cloud.metal_available_ips_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_available_ips_info.md)|Get list of avialable IP addresses from a reserved IP block| -[equinix.cloud.metal_bgp_session_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_bgp_session_info.md)|Gather information BGP sessions in Equinix Metal| -[equinix.cloud.metal_connection_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_connection_info.md)|Gather information about Interconnections| -[equinix.cloud.metal_device_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_device_info.md)|Select list of Equinix Metal devices| -[equinix.cloud.metal_gateway_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_gateway_info.md)|Gather information about Metal Gateways| -[equinix.cloud.metal_hardware_reservation_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_hardware_reservation_info.md)|Gather information about Equinix Metal hardware_reservations| -[equinix.cloud.metal_ip_assignment_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_ip_assignment_info.md)|Gather IP address assignments for a device| -[equinix.cloud.metal_metro_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_metro_info.md)|Gather information about Equinix Metal metros| -[equinix.cloud.metal_operating_system_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_operating_system_info.md)|Gather information about Operating Systems available for devices in Equinix Metal| -[equinix.cloud.metal_organization_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_organization_info.md)|Gather information about Equinix Metal organizations| -[equinix.cloud.metal_plan_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_plan_info.md)|Gather information about Equinix Metal plans| -[equinix.cloud.metal_project_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_project_info.md)|Gather information about Equinix Metal projects| -[equinix.cloud.metal_project_ssh_key_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_project_ssh_key_info.md)|Gather project SSH keys.| -[equinix.cloud.metal_reserved_ip_block_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_reserved_ip_block_info.md)|Gather list of reserved IP blocks| -[equinix.cloud.metal_ssh_key_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_ssh_key_info.md)|Gather personal SSH keys| -[equinix.cloud.metal_user_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_user_info.md)|Gather information about the current user for Equinix Metal| -[equinix.cloud.metal_virtual_circuit_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_virtual_circuit_info.md)|Gather information about Equinix Metal Virtual Circuits| -[equinix.cloud.metal_vlan_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_vlan_info.md)|Gather VLANs.| -[equinix.cloud.metal_vrf_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/modules/metal_vrf_info.md)|Gather VRFs| +[equinix.cloud.metal_available_ips_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_available_ips_info.md)|Get list of avialable IP addresses from a reserved IP block| +[equinix.cloud.metal_bgp_session_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_bgp_session_info.md)|Gather information BGP sessions in Equinix Metal| +[equinix.cloud.metal_connection_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_connection_info.md)|Gather information about Interconnections| +[equinix.cloud.metal_device_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_device_info.md)|Select list of Equinix Metal devices| +[equinix.cloud.metal_gateway_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_gateway_info.md)|Gather information about Metal Gateways| +[equinix.cloud.metal_hardware_reservation_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_hardware_reservation_info.md)|Gather information about Equinix Metal hardware_reservations| +[equinix.cloud.metal_ip_assignment_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_ip_assignment_info.md)|Gather IP address assignments for a device| +[equinix.cloud.metal_metro_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_metro_info.md)|Gather information about Equinix Metal metros| +[equinix.cloud.metal_operating_system_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_operating_system_info.md)|Gather information about Operating Systems available for devices in Equinix Metal| +[equinix.cloud.metal_organization_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_organization_info.md)|Gather information about Equinix Metal organizations| +[equinix.cloud.metal_plan_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_plan_info.md)|Gather information about Equinix Metal plans| +[equinix.cloud.metal_project_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_project_info.md)|Gather information about Equinix Metal projects| +[equinix.cloud.metal_project_ssh_key_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_project_ssh_key_info.md)|Gather project SSH keys.| +[equinix.cloud.metal_reserved_ip_block_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_reserved_ip_block_info.md)|Gather list of reserved IP blocks| +[equinix.cloud.metal_ssh_key_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_ssh_key_info.md)|Gather personal SSH keys| +[equinix.cloud.metal_user_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_user_info.md)|Gather information about the current user for Equinix Metal| +[equinix.cloud.metal_virtual_circuit_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_virtual_circuit_info.md)|Gather information about Equinix Metal Virtual Circuits| +[equinix.cloud.metal_vlan_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_vlan_info.md)|Gather VLANs.| +[equinix.cloud.metal_vrf_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/modules/metal_vrf_info.md)|Gather VRFs| ### Inventory Plugins @@ -73,7 +73,7 @@ Dynamically add Equinix infrastructure to an Ansible inventory. Name | --- | -[equinix.cloud.metal_device](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.7.1/docs/inventory/metal_device.rst)| +[equinix.cloud.metal_device](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.8.0/docs/inventory/metal_device.rst)| @@ -90,7 +90,7 @@ The Python module dependencies are not installed by `ansible-galaxy`. They can be manually installed using pip: ```shell -pip install -r https://raw.githubusercontent.com/equinix-labs/ansible-collection-equinix/v0.7.1/requirements.txt +pip install -r https://raw.githubusercontent.com/equinix-labs/ansible-collection-equinix/v0.8.0/requirements.txt ``` ## Usage diff --git a/docs/modules/metal_vlan.md b/docs/modules/metal_vlan.md index 4bd2836..5e8d2c5 100644 --- a/docs/modules/metal_vlan.md +++ b/docs/modules/metal_vlan.md @@ -18,7 +18,9 @@ Manage the VLAN in Equinix Metal. You can use *id*, *vxlan* or *tags* to lookup metro: "se" vxlan: 1234 project_id: "778h50f7-75b6-4271-bc64-632b80f87de2" - tags: ["my_vlan", "se"] + tags: + - "my_vlan" + - "se" ``` @@ -47,7 +49,6 @@ Manage the VLAN in Equinix Metal. You can use *id*, *vxlan* or *tags* to lookup - ## Return Values @@ -60,7 +61,10 @@ Manage the VLAN in Equinix Metal. You can use *id*, *vxlan* or *tags* to lookup "id": "7624f0f7-75b6-4271-bc64-632b80f87de2", "metro": "se", "project_id": "778h50f7-75b6-4271-bc64-632b80f87de2", - "tags": ["my_vlan", "se"], + "tags": [ + "my_vlan", + "se" + ], "vxlan": 1234 } ``` diff --git a/plugins/modules/metal_available_ips_info.py b/plugins/modules/metal_available_ips_info.py index 8d1ee45..6c7f6cc 100644 --- a/plugins/modules/metal_available_ips_info.py +++ b/plugins/modules/metal_available_ips_info.py @@ -3,7 +3,7 @@ # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Get list of avialable IP addresses from a reserved IP block module: metal_available_ips_info @@ -21,15 +21,15 @@ type: str requirements: null short_description: Get list of avialable IP addresses from a reserved IP block -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" name: available addresses from reservation equinix.cloud.metal_available_ips_info: reserved_ip_block_id: '{{ ip_reservation.id }}' cidr: 32 register: available_ips -''' -RETURN = ''' +""" +RETURN = r""" available: description: Available IP addresses from the reservation. returned: always @@ -37,7 +37,7 @@ - available: - 147.75.71.192/32 type: dict -''' +""" from ansible.module_utils._text import to_native import traceback diff --git a/plugins/modules/metal_bgp_session.py b/plugins/modules/metal_bgp_session.py index 3d013b9..97fd8eb 100644 --- a/plugins/modules/metal_bgp_session.py +++ b/plugins/modules/metal_bgp_session.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and RETURN are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Manage BGP sessions in Equinix Metal.Create, update or delete BGP session. To look up an existing session, pass only the *id* attribute. @@ -35,8 +35,8 @@ type: str requirements: null short_description: Manage BGP sessions in Equinix Metal -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Start first test bgp session hosts: localhost tasks: @@ -50,8 +50,8 @@ - equinix.cloud.metal_bgp_session: id: 1273edef-39af-4df0-85bb-02a847a484d1 state: absent -''' -RETURN = ''' +""" +RETURN = r""" metal_bgp_session: description: The module object returned: always @@ -65,7 +65,7 @@ device_id: bfab58c0-0723-49aa-a64e-6caf1b8ea2e2 id: 277d4a7a-82dd-4e7c-bf79-8a1de6882982 type: dict -''' +""" # End of generated documentation diff --git a/plugins/modules/metal_bgp_session_info.py b/plugins/modules/metal_bgp_session_info.py index 9ee0660..516b6e2 100644 --- a/plugins/modules/metal_bgp_session_info.py +++ b/plugins/modules/metal_bgp_session_info.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and RETURN are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Gather information BGP sessions in Equinix Metal. You can fetch it by device ID or project ID. @@ -25,15 +25,15 @@ type: str requirements: null short_description: Gather information BGP sessions in Equinix Metal -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Gather information about all BGP sessions in a project hosts: localhost tasks: - equinix.cloud.metal_bgp_session_info: project_id: 2a5122b9-c323-4d5c-b53c-9ad3f54273e7 -''' -RETURN = ''' +""" +RETURN = r""" resources: description: Found resources returned: always @@ -43,7 +43,7 @@ device_id: b068984f-f7d9-43a2-aa45-de04dcf4fe06 id: 03912bd6-a158-47ad-8bc7-c93df338fe0d type: dict -''' +""" # End diff --git a/plugins/modules/metal_connection.py b/plugins/modules/metal_connection.py index b600824..47bb64b 100755 --- a/plugins/modules/metal_connection.py +++ b/plugins/modules/metal_connection.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and RETURN are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Manage an Interconnection in Equinix Metal. You can use *connection_id* to lookup the resource. If you want to create a new resource, you must provide *project_id*, @@ -117,8 +117,8 @@ type: list requirements: null short_description: Manage an Interconnection in Equinix Metal -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Create new connection hosts: localhost tasks: @@ -136,8 +136,8 @@ project_id: Bhf47603-7a09-4ca1-af67-4087c13ab5b6 name: new connection connection_id: 3113c6bf-b0e8-4985-8f35-3c987a0ed46e -''' -RETURN = ''' +""" +RETURN = r""" metal_resource: description: The module object returned: always @@ -149,7 +149,7 @@ speed: 50Mbps type: dedicated type: dict -''' +""" # End of generated documentation diff --git a/plugins/modules/metal_connection_info.py b/plugins/modules/metal_connection_info.py index e33385b..a94dd6e 100755 --- a/plugins/modules/metal_connection_info.py +++ b/plugins/modules/metal_connection_info.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and RETURN are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Gather information about Interconnections module: metal_connection_info @@ -29,15 +29,15 @@ type: str requirements: null short_description: Gather information about Interconnections -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Gather information about all connection in a project hosts: localhost tasks: - equinix.cloud.metal_connection_info: project_id: 2a5122b9-c323-4d5c-b53c-9ad3f54273e7 -''' -RETURN = ''' +""" +RETURN = r""" resources: description: Found resources returned: always @@ -50,7 +50,7 @@ speed: 50Mbps type: dedicated type: dict -''' +""" # End diff --git a/plugins/modules/metal_device.py b/plugins/modules/metal_device.py index 3202c77..279951c 100644 --- a/plugins/modules/metal_device.py +++ b/plugins/modules/metal_device.py @@ -5,7 +5,7 @@ from __future__ import absolute_import, division, print_function -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Create, update, or delete Equinix Metal devices module: metal_device @@ -237,8 +237,8 @@ type: str requirements: null short_description: Create, update, or delete Equinix Metal devices -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Create new device in a project hosts: localhost tasks: @@ -251,8 +251,8 @@ equinix.cloud.metal_device: id: eef49903-7a09-4ca1-af67-4087c29ab5b6 state: absent -''' -RETURN = ''' +""" +RETURN = r""" metal_device: description: The module object returned: always @@ -308,7 +308,7 @@ tags: [] userdata: '' type: dict -''' +""" from ansible.module_utils._text import to_native diff --git a/plugins/modules/metal_device_info.py b/plugins/modules/metal_device_info.py index 14a2a20..bc7b788 100644 --- a/plugins/modules/metal_device_info.py +++ b/plugins/modules/metal_device_info.py @@ -6,7 +6,7 @@ from __future__ import absolute_import, division, print_function __metaclass__ = type -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Select list of Equinix Metal devices module: metal_device_info @@ -29,8 +29,8 @@ type: str requirements: null short_description: Select list of Equinix Metal devices -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Gather information about all devices hosts: localhost tasks: @@ -51,8 +51,8 @@ - equinix.cloud.metal_device_info: project_id: 173d7f11-f7b9-433e-ac40-f1571a38037a hostname: webserver -''' -RETURN = ''' +""" +RETURN = r""" resources: description: List of devices returned: always @@ -156,7 +156,7 @@ tags: [] userdata: '' type: list -''' +""" from ansible.module_utils._text import to_native from ansible_specdoc.objects import SpecField, FieldType, SpecDocMeta, SpecReturnValue diff --git a/plugins/modules/metal_gateway.py b/plugins/modules/metal_gateway.py index a34ee14..0796606 100644 --- a/plugins/modules/metal_gateway.py +++ b/plugins/modules/metal_gateway.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and RETURN are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Manage Metal Gateway in Equinix Metal. You can use *id* or *ip_reservation_id* to lookup a Gateway. If you want to create new resource, you must provide *project_id*, @@ -50,8 +50,8 @@ type: str requirements: null short_description: Manage Metal Gateway in Equinix Metal -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Create new gateway with existing IP reservation hosts: localhost tasks: @@ -78,8 +78,8 @@ - equinix.cloud.metal_gateway: ip_reservation_id: a4cc87f9-e00f-48c2-9460-74aa60beb6b0 register: gateway -''' -RETURN = ''' +""" +RETURN = r""" metal_gateway: description: The module object returned: always @@ -98,7 +98,7 @@ project_id: 0491c16b-376d-4842-89d2-da3efead4991 virtual_network_id: f46ab2c8-1332-4f87-91e9-f3a6a81d9769 type: dict -''' +""" # End of generated documentation diff --git a/plugins/modules/metal_gateway_info.py b/plugins/modules/metal_gateway_info.py index d92d920..4aca4bc 100644 --- a/plugins/modules/metal_gateway_info.py +++ b/plugins/modules/metal_gateway_info.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and RETURN are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Gather information about Metal Gateways module: metal_gateway_info @@ -19,15 +19,15 @@ type: str requirements: null short_description: Gather information about Metal Gateways -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Gather information about all gateways in a project hosts: localhost tasks: - equinix.cloud.metal_gateway_info: project_id: 2a5122b9-c323-4d5c-b53c-9ad3f54273e7 -''' -RETURN = ''' +""" +RETURN = r""" resources: description: Found Metal Gateways returned: always @@ -45,7 +45,7 @@ project_id: f7a35065-2e41-4747-b3d1-400af0a3e0e8 virtual_network_id: 898972b3-7eb9-4ca2-b803-7b5d339bbea7 type: dict -''' +""" # End diff --git a/plugins/modules/metal_hardware_reservation.py b/plugins/modules/metal_hardware_reservation.py index b7305db..bde5b29 100644 --- a/plugins/modules/metal_hardware_reservation.py +++ b/plugins/modules/metal_hardware_reservation.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and RETURN are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Lookup a single hardware_reservation by ID in Equinix Metal. This resource only fetches a single hardware_reservation by resource ID. It doesn't allow to create @@ -26,8 +26,8 @@ type: str requirements: null short_description: Lookup a single hardware_reservation by ID in Equinix Metal -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Lookup a single hardware_reservation by id hosts: localhost tasks: @@ -49,8 +49,8 @@ equinix.cloud.metal_hardware_reservation: id: '{{ metal_hardware_reservation_id }}' project_id: '{{ hwres.project_id }}' -''' -RETURN = ''' +""" +RETURN = r""" metal_hardware_reservation: description: The module object returned: always @@ -64,7 +64,7 @@ spare: false switch_uuid: 00a5dbb7 type: dict -''' +""" # End of generated documentation diff --git a/plugins/modules/metal_hardware_reservation_info.py b/plugins/modules/metal_hardware_reservation_info.py index 84205e4..54d7652 100644 --- a/plugins/modules/metal_hardware_reservation_info.py +++ b/plugins/modules/metal_hardware_reservation_info.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and RETURN are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Gather information about Equinix Metal hardware_reservations module: metal_hardware_reservation_info @@ -19,15 +19,15 @@ type: str requirements: null short_description: Gather information about Equinix Metal hardware_reservations -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Gather information about all hardware_reservations in parent project hosts: localhost tasks: - equinix.cloud.metal_hardware_reservation_info: project_id: 2a5122b9-c323-4d5c-b53c-9ad3f54273e7 -''' -RETURN = ''' +""" +RETURN = r""" hardware_reservations: description: Found hardware reservations returned: always @@ -40,7 +40,7 @@ spare: false switch_uuid: 00a324b7 type: dict -''' +""" # End diff --git a/plugins/modules/metal_ip_assignment.py b/plugins/modules/metal_ip_assignment.py index ac297bd..74c19e2 100644 --- a/plugins/modules/metal_ip_assignment.py +++ b/plugins/modules/metal_ip_assignment.py @@ -3,7 +3,7 @@ # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Asign reserved IPs to Equinix Metal devices. module: metal_ip_assignment @@ -36,8 +36,8 @@ type: bool requirements: null short_description: Manage Equinix Metal IP assignments -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: request ip reservation equinix.cloud.metal_reserved_ip_block: type: public_ipv4 @@ -67,8 +67,8 @@ device_id: '{{ device.id }}' address: '{{ available_ips.available[0] }}' register: assignment -''' -RETURN = ''' +""" +RETURN = r""" metal_ip_assignment: description: The assignment object. returned: always @@ -85,7 +85,7 @@ network: 147.75.71.192 public: true type: dict -''' +""" from ansible.module_utils._text import to_native import traceback diff --git a/plugins/modules/metal_ip_assignment_info.py b/plugins/modules/metal_ip_assignment_info.py index 751b2cd..b5e9824 100644 --- a/plugins/modules/metal_ip_assignment_info.py +++ b/plugins/modules/metal_ip_assignment_info.py @@ -3,7 +3,7 @@ # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Gather IP address assignments for a device module: metal_ip_assignment_info @@ -16,14 +16,14 @@ type: str requirements: null short_description: Gather IP address assignments for a device -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: assignment info equinix.cloud.metal_ip_assignment_info: device_id: '{{ device.id }}' register: assignment_info -''' -RETURN = ''' +""" +RETURN = r""" resources: description: Found resources returned: always @@ -67,7 +67,7 @@ network: 10.70.50.128 public: false type: dict -''' +""" from ansible.module_utils._text import to_native import traceback diff --git a/plugins/modules/metal_metro_info.py b/plugins/modules/metal_metro_info.py index 144a64f..f725638 100644 --- a/plugins/modules/metal_metro_info.py +++ b/plugins/modules/metal_metro_info.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and RETURN are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Gather information about Equinix Metal metros module: metal_metro_info @@ -14,8 +14,8 @@ options: {} requirements: null short_description: Gather information about Equinix Metal metros -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Select all metros and filter american metros hosts: localhost tasks: @@ -26,8 +26,8 @@ set_fact: ametros: '{{ metros.resources | selectattr(''country'', ''equalto'', ''US'') | list }}' -''' -RETURN = ''' +""" +RETURN = r""" resources: description: Found metros returned: always @@ -49,7 +49,7 @@ id: d3d6b29f-042d-43b7-b3ce-0bf53d5754ca name: Dallas type: dict -''' +""" # End diff --git a/plugins/modules/metal_operating_system_info.py b/plugins/modules/metal_operating_system_info.py index 8145fd0..5fe0b63 100644 --- a/plugins/modules/metal_operating_system_info.py +++ b/plugins/modules/metal_operating_system_info.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and RETURN are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Gather information about Operating Systems available in Equinix Metal module: metal_operating_system_info @@ -15,8 +15,8 @@ requirements: null short_description: Gather information about Operating Systems available for devices in Equinix Metal -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Select all operating_systems and filter Ubuntu-based distros hosts: localhost tasks: @@ -27,8 +27,8 @@ set_fact: uoss: '{{ operating_systems.resources | selectattr(''distro'', ''equalto'', ''ubuntu'') | list }}' -''' -RETURN = ''' +""" +RETURN = r""" resources: description: Found Operating Systems returned: always @@ -64,7 +64,7 @@ slug: windows_2022 version: '2022' type: dict -''' +""" # End diff --git a/plugins/modules/metal_organization.py b/plugins/modules/metal_organization.py index 05853b2..af2c12d 100644 --- a/plugins/modules/metal_organization.py +++ b/plugins/modules/metal_organization.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and RETURN are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Lookup a single organization by ID in Equinix Metal. This resource only fetches a single organization by resource ID. It doesn't allow to create or update @@ -21,15 +21,15 @@ type: str requirements: null short_description: Lookup a single organization by ID in Equinix Metal -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Lookup a single organization by id hosts: localhost tasks: - equinix.cloud.metal_organization: id: 7624f0f7-75b6-4271-bc64-632b80f87de2 -''' -RETURN = ''' +""" +RETURN = r""" metal_organization: description: The module object returned: always @@ -47,7 +47,7 @@ - e9324234-6423-4232-8423-854234238106 website: '' type: dict -''' +""" # End of generated documentation diff --git a/plugins/modules/metal_organization_info.py b/plugins/modules/metal_organization_info.py index 32133f8..a56ed5f 100644 --- a/plugins/modules/metal_organization_info.py +++ b/plugins/modules/metal_organization_info.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and RETURN are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Gather information about Equinix Metal organizations module: metal_organization_info @@ -24,8 +24,8 @@ type: bool requirements: null short_description: Gather information about Equinix Metal organizations -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Gather information about all organizations hosts: localhost tasks: @@ -43,8 +43,8 @@ set_fact: ansible_orgs: '{{ organizations.resources | selectattr(''name'', ''match'', desired_name_substring) }}' -''' -RETURN = ''' +""" +RETURN = r""" resources: description: Found organizations returned: always @@ -57,7 +57,7 @@ - 635673f1-bce5-4a62-a47c-133342342349 website: '' type: dict -''' +""" # End diff --git a/plugins/modules/metal_plan_info.py b/plugins/modules/metal_plan_info.py index c053c26..ae76881 100644 --- a/plugins/modules/metal_plan_info.py +++ b/plugins/modules/metal_plan_info.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and RETURN are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Gather information about Equinix Metal plans module: metal_plan_info @@ -29,8 +29,8 @@ type: str requirements: null short_description: Gather information about Equinix Metal plans -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Gather information about all plans hosts: localhost tasks: @@ -51,8 +51,8 @@ tasks: - equinix.cloud.metal_plan_info: type: standard -''' -RETURN = ''' +""" +RETURN = r""" resources: description: Found resources returned: always @@ -73,7 +73,7 @@ pricing_month: null slug: a3.large.opt-m3a2 type: dict -''' +""" # End diff --git a/plugins/modules/metal_project.py b/plugins/modules/metal_project.py index a65c218..27fab7f 100644 --- a/plugins/modules/metal_project.py +++ b/plugins/modules/metal_project.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and METAL_PROJECT_ARGS are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Manage Projects in Equinix Metal. You can use *id* or *name* to lookup a project. If you want to create new project, you must provide *name*. @@ -47,9 +47,9 @@ type: str requirements: null short_description: Manage Projects in Equinix Metal -''' +""" -EXAMPLES = ''' +EXAMPLES = r""" - name: Create new project hosts: localhost tasks: @@ -73,9 +73,9 @@ - equinix.cloud.metal_project: name: newer project payment_method_id: abf49903-7a09-4ca1-af67-4087c29ab343 -''' +""" -RETURN = ''' +RETURN = r""" metal_project: description: The module object returned: always @@ -89,7 +89,7 @@ organization_id: 70c2f878-9f32-452e-8c69-ab15480e1d99 payment_method_id: 845b45a3-c565-47e5-b9b6-a86204a73d29 type: dict -''' +""" # End of generated documentation diff --git a/plugins/modules/metal_project_bgp_config.py b/plugins/modules/metal_project_bgp_config.py index 5ff5887..253be04 100644 --- a/plugins/modules/metal_project_bgp_config.py +++ b/plugins/modules/metal_project_bgp_config.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and METAL_PROJECT_ARGS are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: 'You can use this module to enable BGP Config for a project. To lookup BGP Config of an existing project, call the module only with `project_id`. ' @@ -41,8 +41,8 @@ type: str requirements: null short_description: Manage BGP Config for Equinix Metal Project -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Enable local BGP Config in Equinix Metal project hosts: localhost tasks: @@ -52,15 +52,15 @@ md5: null use_case: ansible test project_id: '{{ test_project.id }}' -''' -RETURN = ''' +""" +RETURN = r""" metal_project_bgp_config: description: The module object returned: always sample: - changed: true type: dict -''' +""" # End of generated documentation diff --git a/plugins/modules/metal_project_info.py b/plugins/modules/metal_project_info.py index 2723d0e..67a0ed7 100644 --- a/plugins/modules/metal_project_info.py +++ b/plugins/modules/metal_project_info.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and METAL_PROJECT_ARGS are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Gather information about Equinix Metal projects module: metal_project_info @@ -24,8 +24,8 @@ type: str requirements: null short_description: Gather information about Equinix Metal projects -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Gather information about all projects hosts: localhost tasks: @@ -35,8 +35,8 @@ tasks: - equinix.cloud.metal_project_info: organization_id: 2a5122b9-c323-4d5c-b53c-9ad3f54273e7 -''' -RETURN = ''' +""" +RETURN = r""" resources: description: Found resources returned: always @@ -49,7 +49,7 @@ organization_id: 70c2f878-9f32-452e-8c69-ab15480e1d99 payment_method_id: 845b45a3-c565-47e5-b9b6-a86204a73d29 type: dict -''' +""" # End diff --git a/plugins/modules/metal_project_ssh_key.py b/plugins/modules/metal_project_ssh_key.py index 71c12a8..46816bf 100644 --- a/plugins/modules/metal_project_ssh_key.py +++ b/plugins/modules/metal_project_ssh_key.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and RETURN are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Manage project ssh key in Equinix Metal. Read more about personal and project SSH keys in [Equinix Metal documentation](https://deploy.equinix.com/developers/docs/metal/accounts/ssh-keys/#personal-keys-vs-project-keys). @@ -37,8 +37,8 @@ type: str requirements: null short_description: Manage a project ssh key in Equinix Metal -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Create new project project ssh_key hosts: localhost tasks: @@ -53,8 +53,8 @@ - equinix.cloud.metal_project_ssh_key: id: eef49903-7a09-4ca1-af67-4087c29ab5b6 state: absent -''' -RETURN = ''' +""" +RETURN = r""" metal_project_ssh_key: description: The module object returned: always @@ -66,7 +66,7 @@ label: test_key project_id: b8c6c653-3c96-446e-987e-9c4d12f25353 type: dict -''' +""" # End of generated documentation diff --git a/plugins/modules/metal_project_ssh_key_info.py b/plugins/modules/metal_project_ssh_key_info.py index 157737a..78e177b 100644 --- a/plugins/modules/metal_project_ssh_key_info.py +++ b/plugins/modules/metal_project_ssh_key_info.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and RETURN are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Gather project SSH keys. Read more about project vs project SSH keys in [Equinix Metal documentation](https://metal.equinix.com/developers/docs/accounts/ssh-keys/#personal-keys-vs-project-keys). @@ -25,8 +25,8 @@ type: str requirements: null short_description: Gather project SSH keys. -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - set_fact: desired_name_substring: tkarasek - name: list project ssh keys @@ -36,8 +36,8 @@ set_fact: both_ssh_keys_listed: '{{ ssh_keys_listed.resources | selectattr(''label'', ''match'', desired_name_substring) }}' -''' -RETURN = ''' +""" +RETURN = r""" resources: description: Found resources returned: always @@ -54,7 +54,7 @@ label: ansible-integration-test-ssh_key-ztiapihf-ssh_key1_renamed project_id: b8c6c653-3c96-446e-987e-9c4d12f25353 type: dict -''' +""" # End diff --git a/plugins/modules/metal_reserved_ip_block.py b/plugins/modules/metal_reserved_ip_block.py index 00ab215..c7d5671 100644 --- a/plugins/modules/metal_reserved_ip_block.py +++ b/plugins/modules/metal_reserved_ip_block.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and METAL_PROJECT_ARGS are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: When a user provisions first device in a facility, Equinix Metal API automatically allocates IPv6/56 and private IPv4/25 blocks. The new device then @@ -77,8 +77,8 @@ type: str requirements: null short_description: Create/delete blocks of reserved IP addresses in a project. -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Create a new reserved IP block in metro "sv" hosts: localhost tasks: @@ -94,8 +94,8 @@ project_id: 2a5122b9-c323-4d5c-b53c-9ad3f54273e7 type: global_ipv4 quantity: 1 -''' -RETURN = ''' +""" +RETURN = r""" metal_reserved_ip_block: description: The module object returned: always @@ -117,7 +117,7 @@ - t2 type: public_ipv4 type: dict -''' +""" from ansible.module_utils._text import to_native import traceback diff --git a/plugins/modules/metal_reserved_ip_block_info.py b/plugins/modules/metal_reserved_ip_block_info.py index 81193fd..0b54792 100644 --- a/plugins/modules/metal_reserved_ip_block_info.py +++ b/plugins/modules/metal_reserved_ip_block_info.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and METAL_PROJECT_ARGS are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Gather list of reserved IP blocks matching the specified criteria module: metal_reserved_ip_block_info @@ -35,8 +35,8 @@ type: str requirements: null short_description: Gather list of reserved IP blocks -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Gather list of public_ipv4 reserved_ip_blocks in a project hosts: localhost tasks: @@ -50,8 +50,8 @@ type: public_ipv6 project_id: 2a5122b9-c323-4d5c-b53c-9ad3f54273e7 metro: ams -''' -RETURN = ''' +""" +RETURN = r""" resources: description: Found resources returned: always @@ -70,7 +70,7 @@ tags: [] type: public_ipv4 type: dict -''' +""" from ansible.module_utils._text import to_native from ansible_specdoc.objects import SpecField, FieldType, SpecDocMeta, SpecReturnValue diff --git a/plugins/modules/metal_ssh_key.py b/plugins/modules/metal_ssh_key.py index 957b7a1..eef2ac6 100644 --- a/plugins/modules/metal_ssh_key.py +++ b/plugins/modules/metal_ssh_key.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and METAL_ssh_key_ARGS are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Manage personal SSH keys in Equinix Metal. Read more about personal and project SSH keys in [Equinix Metal documentation](https://deploy.equinix.com/developers/docs/metal/accounts/ssh-keys/#personal-keys-vs-project-keys). @@ -32,8 +32,8 @@ type: str requirements: null short_description: Manage personal SSH keys in Equinix Metal -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Create new ssh_key hosts: localhost tasks: @@ -47,8 +47,8 @@ - equinix.cloud.metal_ssh_key: id: eef49903-7a09-4ca1-af67-4087c29ab5b6 state: absent -''' -RETURN = ''' +""" +RETURN = r""" metal_ssh_key: description: The module object returned: always @@ -59,7 +59,7 @@ tomk@xps label: fsdfsdf type: dict -''' +""" # End of generated documentation diff --git a/plugins/modules/metal_ssh_key_info.py b/plugins/modules/metal_ssh_key_info.py index 881eb94..1ef016c 100644 --- a/plugins/modules/metal_ssh_key_info.py +++ b/plugins/modules/metal_ssh_key_info.py @@ -3,7 +3,7 @@ # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Gather personal SSH keys. Read more about personal vs project SSH keys in [Equinix Metal documentation](https://metal.equinix.com/developers/docs/accounts/ssh-keys/#personal-keys-vs-project-keys). @@ -12,8 +12,8 @@ options: {} requirements: null short_description: Gather personal SSH keys -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - set_fact: desired_name_substring: tkarasek - name: list ssh_keys @@ -23,8 +23,8 @@ set_fact: both_ssh_keys_listed: '{{ ssh_keys_listed.resources | selectattr(''label'', ''match'', desired_name_substring) }}' -''' -RETURN = ''' +""" +RETURN = r""" resources: description: Found resources returned: always @@ -39,7 +39,7 @@ tomk@air label: ansible-integration-test-ssh_key-ztiapihf-ssh_key1_renamed type: dict -''' +""" from ansible.module_utils._text import to_native import traceback diff --git a/plugins/modules/metal_user_info.py b/plugins/modules/metal_user_info.py index 0e0a9e1..544e29a 100644 --- a/plugins/modules/metal_user_info.py +++ b/plugins/modules/metal_user_info.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and RETURN are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Gather information about the current user for Equinix Metal module: metal_user_info @@ -24,8 +24,8 @@ type: str requirements: null short_description: Gather information about the current user for Equinix Metal -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Gather information about the current current user hosts: localhost tasks: @@ -34,8 +34,8 @@ register: result - debug: var: result -''' -RETURN = ''' +""" +RETURN = r""" user: description: Information about the current user. returned: always @@ -60,7 +60,7 @@ two_factor_auth: '' updated_at: '2019-08-24T14:15:22Z' type: dict -''' +""" # End of generated documentation diff --git a/plugins/modules/metal_virtual_circuit.py b/plugins/modules/metal_virtual_circuit.py index 5c012fd..263e0ee 100644 --- a/plugins/modules/metal_virtual_circuit.py +++ b/plugins/modules/metal_virtual_circuit.py @@ -7,7 +7,7 @@ # DOCUMENTATION, EXAMPLES, and RETURN are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Manage a Virtual Circuit in Equinix Metal. You can use *id* or *name* to lookup the resource. If you want to create new resource, you must provide *name*. @@ -118,8 +118,8 @@ type: str requirements: null short_description: Manage a Virtual Circuit in Equinix Metal -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: create first VRF virtual circuit for test hosts: localhost tasks: @@ -132,8 +132,8 @@ project_id: 11e047e1-f51a-49c6-b5b2-1c7bfa4391e6 subnet: 192.168.151.126/31 vrf: 029c4219-04b7-4992-9fef-29ea7e2378a5 -''' -RETURN = ''' +""" +RETURN = r""" metal_virtual_circuit: description: The module object returned: always @@ -161,7 +161,7 @@ href: /metal/v1/vrfs/029c4219-04b7-4992-9fef-29ea7e2378a5 id: 029c4219-04b7-4992-9fef-29ea7e2378a5 type: dict -''' +""" # End of generated documentation diff --git a/plugins/modules/metal_virtual_circuit_info.py b/plugins/modules/metal_virtual_circuit_info.py index 90e5cab..47dd3f8 100644 --- a/plugins/modules/metal_virtual_circuit_info.py +++ b/plugins/modules/metal_virtual_circuit_info.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and METAL_PROJECT_ARGS are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Gather information about Equinix Metal Virtual Circuits module: metal_virtual_circuit_info @@ -24,15 +24,15 @@ type: str requirements: null short_description: Gather information about Equinix Metal Virtual Circuits -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Gather information about all projects in an organization hosts: localhost tasks: - equinix.cloud.metal_virtual_circuit_info: organization_id: 2a5122b9-c323-4d5c-b53c-9ad3f54273e7 -''' -RETURN = ''' +""" +RETURN = r""" resources: description: Found resources returned: always @@ -45,7 +45,7 @@ organization_id: 70c2f878-9f32-452e-8c69-ab15480e1d99 payment_method_id: 845b45a3-c565-47e5-b9b6-a86204a73d29 type: dict -''' +""" # End diff --git a/plugins/modules/metal_vlan.py b/plugins/modules/metal_vlan.py index 3da2f4b..7c1d220 100644 --- a/plugins/modules/metal_vlan.py +++ b/plugins/modules/metal_vlan.py @@ -6,10 +6,10 @@ # DOCUMENTATION, EXAMPLES, and RETURN are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) -description: Manage the VLAN in Equinix Metal. You can use *id*, *vxlan* or *tags* to lookup - the resource. If you want to create new resource, you must provide *metro*. +description: Manage the VLAN in Equinix Metal. You can use *id*, *vxlan* or *tags* + to lookup the resource. If you want to create new resource, you must provide *metro*. module: metal_vlan notes: [] options: @@ -33,20 +33,21 @@ - ID of parent project required: false type: str - vxlan: - description: - - VLAN ID, must be unique in metro - required: false - type: int tags: description: - Resource tags + elements: str required: false type: list + vxlan: + description: + - VLAN ID, must be unique in metro + required: false + type: int requirements: null short_description: Manage a VLAN resource in Equinix Metal -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Create new VLAN hosts: localhost tasks: @@ -56,10 +57,10 @@ vxlan: 1234 project_id: 778h50f7-75b6-4271-bc64-632b80f87de2 tags: - - "my_vlan" - - "se" -''' -RETURN = ''' + - my_vlan + - se +""" +RETURN = r""" metal_vlan: description: The module object returned: always @@ -69,12 +70,12 @@ id: 7624f0f7-75b6-4271-bc64-632b80f87de2 metro: se project_id: 778h50f7-75b6-4271-bc64-632b80f87de2 + tags: + - my_vlan + - se vxlan: 1234 - tags: - - "my_vlan" - - "se" type: dict -''' +""" # End of generated documentation diff --git a/plugins/modules/metal_vlan_info.py b/plugins/modules/metal_vlan_info.py index f15c2ab..4f5d60e 100644 --- a/plugins/modules/metal_vlan_info.py +++ b/plugins/modules/metal_vlan_info.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and RETURN are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Gather information about Equinix Metal VLAN resources module: metal_vlan_info @@ -19,13 +19,13 @@ type: str requirements: null short_description: Gather VLANs. -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: list vlans equinix.cloud.metal_vlan_info: null register: listed_vlan -''' -RETURN = ''' +""" +RETURN = r""" resources: description: Found resources returned: always @@ -35,7 +35,7 @@ metro: se vxlan: 1234 type: dict -''' +""" # End diff --git a/plugins/modules/metal_vrf.py b/plugins/modules/metal_vrf.py index d9df074..9268455 100644 --- a/plugins/modules/metal_vrf.py +++ b/plugins/modules/metal_vrf.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and RETURN are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Create a VRF in a metro, with IP ranges that you want the VRF to route and forward. @@ -53,8 +53,8 @@ type: str requirements: null short_description: Manage a VRF resource in Equinix Metal -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Create new Equinix Metal VRF hosts: localhost tasks: @@ -67,8 +67,8 @@ - 192.168.100.0/25 - 192.168.200.0/25 project_id: your_project_id_here -''' -RETURN = ''' +""" +RETURN = r""" metal_vrf: description: The module object returned: always @@ -86,7 +86,7 @@ name: ansible-integration-test-vrf-6yww6pyz project_id: 9934e474-04a1-46a3-842b-5f3dc0ed0eba type: dict -''' +""" # End of generated documentation diff --git a/plugins/modules/metal_vrf_info.py b/plugins/modules/metal_vrf_info.py index 56a3ce5..45bfb93 100644 --- a/plugins/modules/metal_vrf_info.py +++ b/plugins/modules/metal_vrf_info.py @@ -6,7 +6,7 @@ # DOCUMENTATION, EXAMPLES, and RETURN are generated by # ansible_specdoc. Do not edit them directly. -DOCUMENTATION = ''' +DOCUMENTATION = r""" author: Equinix DevRel Team (@equinix) description: Gather information about Equinix VRFs module: metal_vrf_info @@ -24,8 +24,8 @@ type: str requirements: null short_description: Gather VRFs -''' -EXAMPLES = ''' +""" +EXAMPLES = r""" - name: Gather information about VRFs in a project hosts: localhost tasks: @@ -37,8 +37,8 @@ - equinix.cloud.metal_vrf_info: project_id: 2a5122b9-c323-4d5c-b53c-9ad3f54273e7 vrf_id: f421024d-c1e6-4886-a64d-5b2515696200 -''' -RETURN = ''' +""" +RETURN = r""" resources: description: Found resources returned: always @@ -55,7 +55,7 @@ name: ansible-integration-test-vrf-nw6dgvh5 project_id: 06aea391-fd87-4cc7-9f4b-76f9e38fd4a4 type: dict -''' +""" # End diff --git a/version b/version index 7deb86f..8adc70f 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.7.1 \ No newline at end of file +0.8.0 \ No newline at end of file