diff --git a/README.md b/README.md index c07ffa4..d8987fe 100755 --- a/README.md +++ b/README.md @@ -23,20 +23,20 @@ Modules for managing Equinix infrastructure. Name | Description | --- | ------------ | -[equinix.cloud.metal_bgp_session](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.0/docs/modules/metal_ssh_key.md)|Manage personal SSH keys in Equinix Metal| -[equinix.cloud.metal_vlan](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.4.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.4.0/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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.1/docs/modules/metal_ssh_key.md)|Manage personal SSH keys in Equinix Metal| +[equinix.cloud.metal_vlan](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.4.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.4.1/docs/modules/metal_vrf.md)|Manage a VRF resource in Equinix Metal| ### Info Modules @@ -45,23 +45,23 @@ 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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.0/docs/modules/metal_ssh_key_info.md)|Gather personal SSH keys| -[equinix.cloud.metal_vlan_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.4.0/docs/modules/metal_vlan_info.md)|Gather VLANs.| -[equinix.cloud.metal_vrf_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.4.0/docs/modules/metal_vrf_info.md)|Gather VRFs| +[equinix.cloud.metal_available_ips_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.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.4.1/docs/modules/metal_ssh_key_info.md)|Gather personal SSH keys| +[equinix.cloud.metal_vlan_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.4.1/docs/modules/metal_vlan_info.md)|Gather VLANs.| +[equinix.cloud.metal_vrf_info](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.4.1/docs/modules/metal_vrf_info.md)|Gather VRFs| ### Inventory Plugins @@ -70,7 +70,7 @@ Dynamically add Equinix infrastructure to an Ansible inventory. Name | --- | -[equinix.cloud.metal_device](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.4.0/docs/inventory/metal_device.md)| +[equinix.cloud.metal_device](https://github.com/equinix-labs/ansible-collection-equinix/blob/v0.4.1/docs/inventory/metal_device.md)| @@ -87,7 +87,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.4.0/requirements.txt +pip install -r https://raw.githubusercontent.com/equinix-labs/ansible-collection-equinix/v0.4.1/requirements.txt ``` ## Usage diff --git a/docs/inventory/metal_device.rst b/docs/inventory/metal_device.rst index 49179d9..89e811c 100644 --- a/docs/inventory/metal_device.rst +++ b/docs/inventory/metal_device.rst @@ -12,7 +12,7 @@ metal_device -- Equinix Metal Device inventory source Synopsis -------- -Reads device inventories from Equinix Metal. Uses YAML configuration file that ends with equinix.(yml|yaml). ansible\_host is set to first public IP address of the device. +Reads device inventories from Equinix Metal. Uses YAML configuration file that ends with equinix.(yml|yaml). ansible_host is set to first public IP address of the device. @@ -20,8 +20,8 @@ Requirements ------------ The below requirements are needed on the host that executes this module. -- python \>= 3 -- metal\_python \>= 0.0.1 +- python >= 3 +- metal_python >= 0.0.1 @@ -35,7 +35,7 @@ Parameters **metal_api_token (Required, type=str):** - \• Equinix Metal API token. Can also be specified via METAL\_AUTH\_TOKEN environment variable. + \• Equinix Metal API token. Can also be specified via METAL_AUTH_TOKEN environment variable. @@ -44,7 +44,7 @@ Parameters **strict (type=bool):** - \• If \ :literal:`yes`\ make invalid entries a fatal error, otherwise skip and continue. + \• If V(yes) make invalid entries a fatal error, otherwise skip and continue. \• Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default. @@ -80,13 +80,13 @@ Parameters **default_value (type=str):** \• The default value when the host variable's value is an empty string. - \• This option is mutually exclusive with \ :literal:`trailing\_separator`\ . + \• This option is mutually exclusive with O(keyed_groups[].trailing_separator). **trailing_separator (type=bool, default=True):** - \• Set this option to \ :emphasis:`False`\ to omit the \ :literal:`separator`\ after the host variable when the value is an empty string. + \• Set this option to V(False) to omit the O(keyed_groups[].separator) after the host variable when the value is an empty string. - \• This option is mutually exclusive with \ :literal:`default\_value`\ . + \• This option is mutually exclusive with O(keyed_groups[].default_value). @@ -95,11 +95,11 @@ Parameters **leading_separator (type=boolean, default=True):** - \• Use in conjunction with keyed\_groups. + \• Use in conjunction with keyed_groups. \• By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore. - \• This is because the default prefix is "" and the default separator is "\_". + \• This is because the default prefix is "" and the default separator is "_". \• Set this option to False to omit the leading underscore (or other separator) if no prefix is given. diff --git a/docs/modules/metal_connection.md b/docs/modules/metal_connection.md index 58cffde..ef7e433 100644 --- a/docs/modules/metal_connection.md +++ b/docs/modules/metal_connection.md @@ -62,7 +62,7 @@ Manage an Interconnection in Equinix Metal. You can use *connection_id* to looku | `tags` |
`list`
|
Optional
| Tags attached to the connection **(Updatable)** | | `type` |
`str`
|
Optional
| Connection type - dedicated or shared **(Choices: `dedicated`, `shared`)** | | `vlans` |
`list`
|
Optional
| Only used with shared connection. VLANs to attach. Pass one vlan for Primary/Single connection and two vlans for Redundant connection | -| `vrfs` |
`list`
|
Optional
| List of connection ports - primary (`ports[0]`) and secondary (`ports[1]`) | +| `vrfs` |
`list`
|
Optional
| Only used with shared connection. VRFs to attach. Pass one VRF for Primary/Single connection and two VRFs for Redundant connection | diff --git a/plugins/modules/metal_connection.py b/plugins/modules/metal_connection.py index bb8671a..74c2ac7 100755 --- a/plugins/modules/metal_connection.py +++ b/plugins/modules/metal_connection.py @@ -110,7 +110,8 @@ type: list vrfs: description: - - Only used with shared connection. VRFs to attach. Pass one VRF for Primary/Single connection and two VRFs for Redundant connection + - Only used with shared connection. VRFs to attach. Pass one VRF for Primary/Single + connection and two VRFs for Redundant connection elements: str required: false type: list diff --git a/version b/version index 60a2d3e..44bb5d1 100644 --- a/version +++ b/version @@ -1 +1 @@ -0.4.0 \ No newline at end of file +0.4.1 \ No newline at end of file