Skip to content

Commit

Permalink
ci: regenerate code for version 0.8.0 triggered by
Browse files Browse the repository at this point in the history
  • Loading branch information
equinix-labs@auto-commit-workflow committed Jul 19, 2024
1 parent 6f1ee4b commit 08b3ffd
Show file tree
Hide file tree
Showing 37 changed files with 261 additions and 256 deletions.
72 changes: 36 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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)|


<!--end collection content-->
Expand All @@ -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
Expand Down
10 changes: 7 additions & 3 deletions docs/modules/metal_vlan.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"

```

Expand Down Expand Up @@ -47,7 +49,6 @@ Manage the VLAN in Equinix Metal. You can use *id*, *vxlan* or *tags* to lookup




## Return Values


Expand All @@ -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
}
```
Expand Down
12 changes: 6 additions & 6 deletions plugins/modules/metal_available_ips_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -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) <[email protected]>
description: Get list of avialable IP addresses from a reserved IP block
module: metal_available_ips_info
Expand All @@ -21,23 +21,23 @@
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
sample:
- available:
- 147.75.71.192/32
type: dict
'''
"""

from ansible.module_utils._text import to_native
import traceback
Expand Down
12 changes: 6 additions & 6 deletions plugins/modules/metal_bgp_session.py
Original file line number Diff line number Diff line change
Expand Up @@ -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) <[email protected]>
description: Manage BGP sessions in Equinix Metal.Create, update or delete BGP session.
To look up an existing session, pass only the *id* attribute.
Expand Down Expand Up @@ -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:
Expand All @@ -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
Expand All @@ -65,7 +65,7 @@
device_id: bfab58c0-0723-49aa-a64e-6caf1b8ea2e2
id: 277d4a7a-82dd-4e7c-bf79-8a1de6882982
type: dict
'''
"""

# End of generated documentation

Expand Down
12 changes: 6 additions & 6 deletions plugins/modules/metal_bgp_session_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -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) <[email protected]>
description: Gather information BGP sessions in Equinix Metal. You can fetch it by
device ID or project ID.
Expand All @@ -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
Expand All @@ -43,7 +43,7 @@
device_id: b068984f-f7d9-43a2-aa45-de04dcf4fe06
id: 03912bd6-a158-47ad-8bc7-c93df338fe0d
type: dict
'''
"""

# End

Expand Down
12 changes: 6 additions & 6 deletions plugins/modules/metal_connection.py
Original file line number Diff line number Diff line change
Expand Up @@ -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) <[email protected]>
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*,
Expand Down Expand Up @@ -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:
Expand All @@ -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
Expand All @@ -149,7 +149,7 @@
speed: 50Mbps
type: dedicated
type: dict
'''
"""

# End of generated documentation

Expand Down
12 changes: 6 additions & 6 deletions plugins/modules/metal_connection_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -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) <[email protected]>
description: Gather information about Interconnections
module: metal_connection_info
Expand All @@ -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
Expand All @@ -50,7 +50,7 @@
speed: 50Mbps
type: dedicated
type: dict
'''
"""

# End

Expand Down
12 changes: 6 additions & 6 deletions plugins/modules/metal_device.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

from __future__ import absolute_import, division, print_function

DOCUMENTATION = '''
DOCUMENTATION = r"""
author: Equinix DevRel Team (@equinix) <[email protected]>
description: Create, update, or delete Equinix Metal devices
module: metal_device
Expand Down Expand Up @@ -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:
Expand All @@ -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
Expand Down Expand Up @@ -308,7 +308,7 @@
tags: []
userdata: ''
type: dict
'''
"""


from ansible.module_utils._text import to_native
Expand Down
Loading

0 comments on commit 08b3ffd

Please sign in to comment.