implements metal connection, info and integration tests

README.md

@@ -1,5 +1,5 @@
 # Equinix Ansible Collection
-[![Ansible Galaxy](https://img.shields.io/badge/galaxy-equinix.cloud-660198.svg?style=flat)](https://galaxy.ansible.com/equinix/cloud/)
+[![Ansible Galaxy](https://img.shields.io/badge/galaxy-equinix.cloud-660198.svg?style=flat)](https://galaxy.ansible.com/equinix/cloud/) 
 ![Tests](https://img.shields.io/github/actions/workflow/status/equinix-labs/ansible-collection-equinix/integration-tests.yml?branch=main)
 
 The Ansible Collection Equinix contains various plugins for managing Equinix services.
@@ -21,6 +21,7 @@ Modules for managing Equinix infrastructure.
 
 Name | Description |
 --- | ------------ |
+[equinix.cloud.metal_connection](./docs/modules/metal_connection.md)|Manage an Interconnection in Equinix Metal|
 [equinix.cloud.metal_device](./docs/modules/metal_device.md)|Create, update, or delete Equinix Metal devices|
 [equinix.cloud.metal_hardware_reservation](./docs/modules/metal_hardware_reservation.md)|Lookup a single hardware_reservation by ID in Equinix Metal|
 [equinix.cloud.metal_ip_assignment](./docs/modules/metal_ip_assignment.md)|Manage Equinix Metal IP assignments|
@@ -29,18 +30,17 @@ Name | Description |
 [equinix.cloud.metal_project_ssh_key](./docs/modules/metal_project_ssh_key.md)|Manage a project ssh key in Equinix Metal|
 [equinix.cloud.metal_reserved_ip_block](./docs/modules/metal_reserved_ip_block.md)|Create/delete blocks of reserved IP addresses in a project.|
 [equinix.cloud.metal_ssh_key](./docs/modules/metal_ssh_key.md)|Manage personal SSH keys in Equinix Metal|
-[equinix.cloud.metal_project_ssh_key](./docs/modules/metal_project_ssh_key.md)|Manage project SSH keys in Equinix Metal|
 [equinix.cloud.metal_vlan](./docs/modules/metal_vlan.md)|Manage a VLAN resource in Equinix Metal|
 
 
-
 ### Info Modules
 
 Modules for retrieving information about existing Equinix infrastructure.
 
 Name | Description |
 --- | ------------ |
 [equinix.cloud.metal_available_ips_info](./docs/modules/metal_available_ips_info.md)|Get list of avialable IP addresses from a reserved IP block|
+[equinix.cloud.metal_connection_info](./docs/modules/metal_connection_info.md)|Gather information about Interconnections|
 [equinix.cloud.metal_device_info](./docs/modules/metal_device_info.md)|Select list of Equinix Metal devices|
 [equinix.cloud.metal_hardware_reservation_info](./docs/modules/metal_hardware_reservation_info.md)|Gather information about Equinix Metal hardware_reservations|
 [equinix.cloud.metal_ip_assignment_info](./docs/modules/metal_ip_assignment_info.md)|Gather IP address assignments for a device|
@@ -50,8 +50,6 @@ Name | Description |
 [equinix.cloud.metal_project_info](./docs/modules/metal_project_info.md)|Gather information about Equinix Metal projects|
 [equinix.cloud.metal_project_ssh_key_info](./docs/modules/metal_project_ssh_key_info.md)|Gather project SSH keys.|
 [equinix.cloud.metal_reserved_ip_block_info](./docs/modules/metal_reserved_ip_block_info.md)|Gather list of reserved IP blocks|
-[equinix.cloud.metal_ssh_key_info](./docs/modules/metal_ssh_key_info.md)|Gather personal SSH keys|list project SSH keys
-[equinix.cloud.metal_project_ssh_key_info](./docs/modules/metal_project_ssh_key_info.md)|Gather project SSH keys|
 [equinix.cloud.metal_ssh_key_info](./docs/modules/metal_ssh_key_info.md)|Gather personal SSH keys|
 [equinix.cloud.metal_vlan_info](./docs/modules/metal_vlan_info.md)|Gather VLANs.|
 

docs/modules/metal_connection.md

@@ -0,0 +1,90 @@
+# metal_connection
+
+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*, *name*, *type*, *redundancy*, and *speed*.
+
+
+- [Examples](#examples)
+- [Parameters](#parameters)
+- [Return Values](#return-values)
+
+## Examples
+
+```yaml
+- name: Create new connection
+  hosts: localhost
+  tasks:
+  - equinix.cloud.metal_connection:
+      project_id: "Bhf47603-7a09-4ca1-af67-4087c13ab5b6"
+      name: "new connection"
+      type: "dedicated"
+      redundancy: "primary"
+      speed: "50Mbps"
+      metro: "am"
+
+```
+
+```yaml
+- name: Fetch the connection
+  hosts: localhost
+  tasks:
+  - equinix.cloud.metal_connection:
+        project_id: "Bhf47603-7a09-4ca1-af67-4087c13ab5b6"
+        name: "new connection"
+        connection_id: "3113c6bf-b0e8-4985-8f35-3c987a0ed46e"
+
+```
+
+
+
+
+
+
+
+
+
+
+## Parameters
+
+| Field     | Type | Required | Description                                                                  |
+|-----------|------|----------|------------------------------------------------------------------------------|
+| `id` | <center>`str`</center> | <center>Optional</center> | UUID of the connection.   |
+| `connection_id` | <center>`str`</center> | <center>Optional</center> | UUID of the connection, used for GET.   |
+| `project_id` | <center>`str`</center> | <center>Optional</center> | ID of the project where the connection is scoped to. Required for shared connections.   |
+| `organization_id` | <center>`str`</center> | <center>Optional</center> | ID of the organization where the connection is scoped to. Used with dedicated connections   |
+| `contact_email` | <center>`str`</center> | <center>Optional</center> | Email of the person to contact for inquiries.  **(Updatable)** |
+| `description` | <center>`str`</center> | <center>Optional</center> | Description of the connection.  **(Updatable)** |
+| `metro` | <center>`str`</center> | <center>Optional</center> | Metro where the connection will be created   |
+| `mode` | <center>`str`</center> | <center>Optional</center> | Mode for connections in IBX facilities with the dedicated type - standard or tunnel  **(Choices: `standard`, `tunnel`; Updatable)** |
+| `name` | <center>`str`</center> | <center>Optional</center> | Name of the connection resource  **(Updatable)** |
+| `redundancy` | <center>`str`</center> | <center>Optional</center> | Connection redundancy - redundant or primary  **(Choices: `redundant`, `primary`; Updatable)** |
+| `service_token_type` | <center>`str`</center> | <center>Optional</center> | Only used with shared connection. Type of service token to use for the connection, a_side or z_side  **(Choices: `a_side`, `z_side`)** |
+| `speed` | <center>`str`</center> | <center>Optional</center> | Port speed. Required for a_side connections. Allowed values are ['50Mbps', '200Mbps', '500Mbps', '1Gbps', '2Gbps', '5Gbps', '10Gbps']   |
+| `tags` | <center>`list`</center> | <center>Optional</center> | Tags attached to the connection  **(Updatable)** |
+| `type` | <center>`str`</center> | <center>Optional</center> | Connection type - dedicated or shared  **(Choices: `dedicated`, `shared`)** |
+| `vlans` | <center>`list`</center> | <center>Optional</center> | Only used with shared connection. VLANs to attach. Pass one vlan for Primary/Single connection and two vlans for Redundant connection   |
+| `vrfs` | <center>`list`</center> | <center>Optional</center> | List of connection ports - primary (`ports[0]`) and secondary (`ports[1]`)   |
+
+
+
+
+
+
+## Return Values
+
+- `metal_resource` - The module object
+
+    - Sample Response:
+        ```json
+
+        {
+            "project_id": "Bhf47603-7a09-4ca1-af67-4087c13ab5b6"
+            "name": "new connection"
+            "type": "dedicated"
+            "redundancy": "primary"
+            "speed": "50Mbps"
+            "metro": "am"
+        }
+
+        ```
+
+

docs/modules/metal_connection_info.md

@@ -0,0 +1,64 @@
+# metal_connection_info
+
+Gather information about Interconnections
+
+
+- [Examples](#examples)
+- [Parameters](#parameters)
+- [Return Values](#return-values)
+
+## Examples
+
+```yaml
+- name: Gather information about all connection in a project
+  hosts: localhost
+  tasks:
+      - equinix.cloud.metal_connection_info:
+          project_id: "2a5122b9-c323-4d5c-b53c-9ad3f54273e7"
+
+```
+
+
+
+
+
+
+
+
+
+
+## Parameters
+
+| Field     | Type | Required | Description                                                                  |
+|-----------|------|----------|------------------------------------------------------------------------------|
+| `name` | <center>`str`</center> | <center>Optional</center> | Filter connections on substring in name attribute.   |
+| `project_id` | <center>`str`</center> | <center>Optional</center> | ID of the project where the connection is scoped to.   |
+| `organization_id` | <center>`str`</center> | <center>Optional</center> | ID of the organization where the connection is scoped to.   |
+
+
+
+
+
+
+## Return Values
+
+- `resources` - Found resources
+
+    - Sample Response:
+        ```json
+
+
+        [
+          {
+            "id": "31d3ae8b-bd5a-41f3-a420-055211345cc7",
+            "name": "my_test_connection",
+            "project_id": "845b45a3-c565-47e5-b9b6-a86204a73d29",
+            "type": "dedicated",
+            "redundancy": "primary",
+            "speed": "50Mbps",
+            "metro": "am",
+          }
+        ]
+        ```
+
+

docs/modules/metal_project_ssh_key.md

@@ -1,6 +1,6 @@
 # metal_project_ssh_key
 
-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). You can use *id* or *label* to lookup a project SSH key. If you want to create new resource, you must provide *name*, *public_key* and *project_id*.
+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). You can use *id* or *label* to lookup a project SSH key. If you want to create new resource, you must provide *label*, *key* and *project_id*.
 
 
 - [Examples](#examples)
@@ -14,9 +14,9 @@ Manage project ssh key in Equinix Metal. Read more about personal and project SS
   hosts: localhost
   tasks:
   - equinix.cloud.metal_project_ssh_key:
-      name: "test_key"
-      public_key: "ssh-dss AAAAB3NzaC1kc3MAAACBAPLEVntPO3L7VUbEwWZ2ErkQJ3KJ8o9kFXJrPcpvVfdNag4jIhQDqbtAUgUy6BclhhbfH9l5nlGTprrpEFkxm/GL91qJUX6xrPkDMjMqx2wSKa4YraReOrCOfkqqEkC3o3G/gYSuvTzLgp2rmPiflypftZyzNM4JZT8jDwFGotJhAAAAFQDPk43bayONtUxjkAcOf+6zP1qb6QAAAIBZHHH0tIlth5ot+Xa/EYuB/M4qh77EkrWUbER0Kki7suskw/ffdKQ0y/v+ZhoAHtBU7BeE3HmP98Vrha1i4cOU+A7DCqV+lK/a+5LoEpua0M2M+VzNSGluYuV4qGpAOxNh3mxUi2R7yXxheN1oks1ROJ/bqkF4BJQXU9Nv49GkZgAAAIByWcsFeOitvzyDaNJOZzEHv9fqGuj0L3maRVWb6O47HGzlMzniIy8WjL2dfgm2/ek+NxVR/yFnYTKDPr6+0uqSD/cb4eHaFbIj7v+k7H8hA1Ioz+duJ1ONAjn6KwneXxOXu15bYIR49P7Go0s9jCdSAP/r9NE5TnE3yiRiQzgEzw== tomk@node"
-      project_id: "local.project_id"
+      label: "test_key"
+      key: "ssh-dss AAAAB3NzaC1kc3MAAACBAPLEVntPO3L7VUbEwWZ2ErkQJ3KJ8o9kFXJrPcpvVfdNag4jIhQDqbtAUgUy6BclhhbfH9l5nlGTprrpEFkxm/GL91qJUX6xrPkDMjMqx2wSKa4YraReOrCOfkqqEkC3o3G/gYSuvTzLgp2rmPiflypftZyzNM4JZT8jDwFGotJhAAAAFQDPk43bayONtUxjkAcOf+6zP1qb6QAAAIBZHHH0tIlth5ot+Xa/EYuB/M4qh77EkrWUbER0Kki7suskw/ffdKQ0y/v+ZhoAHtBU7BeE3HmP98Vrha1i4cOU+A7DCqV+lK/a+5LoEpua0M2M+VzNSGluYuV4qGpAOxNh3mxUi2R7yXxheN1oks1ROJ/bqkF4BJQXU9Nv49GkZgAAAIByWcsFeOitvzyDaNJOZzEHv9fqGuj0L3maRVWb6O47HGzlMzniIy8WjL2dfgm2/ek+NxVR/yFnYTKDPr6+0uqSD/cb4eHaFbIj7v+k7H8hA1Ioz+duJ1ONAjn6KwneXxOXu15bYIR49P7Go0s9jCdSAP/r9NE5TnE3yiRiQzgEzw== tomk@node"
+      project_id: "b8c6c653-3c96-446e-987e-9c4d12f25353"
 
 ```
 
@@ -44,8 +44,8 @@ Manage project ssh key in Equinix Metal. Read more about personal and project SS
 | Field     | Type | Required | Description                                                                  |
 |-----------|------|----------|------------------------------------------------------------------------------|
 | `id` | <center>`str`</center> | <center>Optional</center> | UUID of the ssh_key.   |
-| `name` | <center>`str`</center> | <center>Optional</center> | The name of the ssh_key.  **(Updatable)** |
-| `public_key` | <center>`str`</center> | <center>Optional</center> | The public key of the project ssh_key.  **(Updatable)** |
+| `label` | <center>`str`</center> | <center>Optional</center> | The name of the ssh_key.  **(Updatable)** |
+| `key` | <center>`str`</center> | <center>Optional</center> | The public key of the project ssh_key.  **(Updatable)** |
 | `project_id` | <center>`str`</center> | <center>Optional</center> | The ID of parent project.  **(Updatable)** |
 
 
@@ -63,9 +63,9 @@ Manage project ssh key in Equinix Metal. Read more about personal and project SS
         {
           "fingerprint": "98:9c:35:ed:f9:75:5b:52:e2:70:50:22:ea:77:5b:b6",
           "id": "eef49903-7a09-4ca1-af67-4087c29ab5b6",
-          "public_key": "ssh-dss AAAAB3NzaC1kc3MAAACBAPLEVntPO3L7VUbEwWZ2ErkQJ3KJ8o9kFXJrPcpvVfdNag4jIhQDqbtAUgUy6BclhhbfH9l5nlGTprrpEFkxm/GL91qJUX6xrPkDMjMqx2wSKa4YraReOrCOfkqqEkC3o3G/gYSuvTzLgp2rmPiflypftZyzNM4JZT8jDwFGotJhAAAAFQDPk43bayONtUxjkAcOf+6zP1qb6QAAAIBZHHH0tIlth5ot+Xa/EYuB/M4qh77EkrWUbER0Kki7suskw/ffdKQ0y/v+ZhoAHtBU7BeE3HmP98Vrha1i4cOU+A7DCqV+lK/a+5LoEpua0M2M+VzNSGluYuV4qGpAOxNh3mxUi2R7yXxheN1oks1ROJ/bqkF4BJQXU9Nv49GkZgAAAIByWcsFeOitvzyDaNJOZzEHv9fqGuj0L3maRVWb6O47HGzlMzniIy8WjL2dfgm2/ek+NxVR/yFnYTKDPr6+0uqSD/cb4eHaFbIj7v+k7H8hA1Ioz+duJ1ONAjn6KwneXxOXu15bYIR49P7Go0s9jCdSAP/r9NE5TnE3yiRiQzgEzw== tomk@xps",
-          "name": "test_key",
-          "project_id": "local.project_id"
+          "key": "ssh-dss AAAAB4NzaC1kc3MAAACBAPLEVntPO3L7VUbEwWZ2ErkQJ3KJ8o9kFXJrPcpvVfdNag4jIhQDqbtAUgUy6BclhhbfH9l5nlGTprrpEFkxm/GL91qJUX6xrPkDMjMqx2wSKa4YraReOrCOfkqqEkC3o3G/gYSuvTzLgp2rmPiflypftZyzNM4JZT8jDwFGotJhAAAAFQDPk43bayONtUxjkAcOf+6zP1qb6QAAAIBZHHH0tIlth5ot+Xa/EYuB/M4qh77EkrWUbER0Kki7suskw/ffdKQ0y/v+ZhoAHtBU7BeE3HmP98Vrha1i4cOU+A7DCqV+lK/a+5LoEpua0M2M+VzNSGluYuV4qGpAOxNh3mxUi2R7yXxheN1oks1ROJ/bqkF4BJQXU9Nv49GkZgAAAIByWcsFeOitvzyDaNJOZzEHv9fqGuj0L3maRVWb6O47HGzlMzniIy8WjL2dfgm2/ek+NxVR/yFnYTKDPr6+0uqSD/cb4eHaFbIj7v+k7H8hA1Ioz+duJ1ONAjn6KwneXxOXu15bYIR49P7Go0s9jCdSAP/r9NE5TnE3yiRiQzgEzw== tomk@xps",
+          "label": "test_key",
+          "project_id": "b8c6c653-3c96-446e-987e-9c4d12f25353"
         }
 
         ```

docs/modules/metal_project_ssh_key_info.md

@@ -20,7 +20,7 @@ Gather project SSH keys. Read more about project vs project SSH keys in [Equinix
 
 - name: filter found ssh keys
   set_fact:
-    both_ssh_keys_listed: "{{ ssh_keys_listed.resources | selectattr('name', 'match', desired_name_substring) }}"
+    both_ssh_keys_listed: "{{ ssh_keys_listed.resources | selectattr('label', 'match', desired_name_substring) }}"
 
 ```
 
@@ -37,7 +37,8 @@ Gather project SSH keys. Read more about project vs project SSH keys in [Equinix
 
 | Field     | Type | Required | Description                                                                  |
 |-----------|------|----------|------------------------------------------------------------------------------|
-| `name` | <center>`str`</center> | <center>**Required**</center> | Name to search for in existing keys.   |
+| `label` | <center>`str`</center> | <center>Optional</center> | Name to search for in existing keys.   |
+| `project_id` | <center>`str`</center> | <center>Optional</center> | Name of the project for listing project keys.   |
 
 
 
@@ -57,14 +58,14 @@ Gather project SSH keys. Read more about project vs project SSH keys in [Equinix
                 "id": "6edfcbc2-17e5-4221-9eac-2f40dbe60daf",
                 "key": "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAt5gwVMhwcCrxyxpMEKwiS0xgit3PIIEgVXt6SQHc8eONq0mYJJ5TOBNTnySqXd9RtSv/Jbf5Aq9BzBGWeoZ6sZfKwh984Ip35StJtjXtyIOlY3skovndtupBIwlGXgX/WQzyLr+G/+Yu9/nhdxQi801PDZnDvKoeomM0rMD29nV+m0ud+GrtsAt6VFul2PxqpypZ1TYviyED6IKo7rgQsQDkE9QHcNdfT1FZWiJbfP7o8TIurQJcAXg+MtLoc8rKKcxFMeZ9FSydgtTC7nP1h558RtECGWiUgaBPI7TpBmcdMtbEfAiBoGT17GWnT8qmy2u5xnEKPD9Qft4w4fjfpw==",
                 "label": "tkarasek",
-                "project_id": local.project_id
+                "project_id": b8c6c653-3c96-446e-987e-9c4d12f25353
             },
             {
                 "fingerprint": "ba:70:af:b3:0f:0e:7f:e5:eb:97:e2:27:b1:f5:6f:94",
                 "id": "d00c596d-b42a-44a7-ac14-e299b85e73d3",
                 "key": "ssh-dss AAAAB3NzaC1kc3MAAACBAOpXVtmc0Bla98bt0o5/Zj7sb4mHIukgVFZu7F32R3VK1cEKB4rEE8uS0oLS/qMRLue45TWVJwRMYGlPjt3p/VyraelxoyJZLuITIsqa5hBc9w0oTlB5Bmbkn16umW96WCaWEoq/aitpocbRChTiP5biI6FyQTQlIHDaYzBDOi11AAAAFQDUXy7cmuzphDpJSYYTiudiUhVokwAAAIEAyUQ9m8qL/1HPkFe6jbXAvtSSmW27F4c+G2xR5HizaHQzXgBOxPcsOsY17KTU+Ddbg+OF9soWNwSpm9pyVjVmNGqH3S8R1pwvuJF/O2Asy1m6wpWhbPw8JdEBW7WHoptBpfuzJoS2LOzJUEmUu4Eb+xS237KG1d1BVny/49KAoH0AAACBAJKBSsm9Xey0fUN6vYtTQgoYeGxxj/LqAIAOs/TpCxZDntly860y/SzHYai8x48k4t7whENY1CJ41fpMcPlz8xIsrNP3326Wbr0ExwOIvJKAVN1YLYqF8NXWzaVrjo5WbSeI8PiWTYemvLAujVxZssIrApTZBhp55nnwge6K1zTG tomk@air",
                 "label": "ansible-integration-test-ssh_key-ztiapihf-ssh_key1_renamed",
-                "project_id": local.project_id
+                "project_id": b8c6c653-3c96-446e-987e-9c4d12f25353
             }
         ]
 

docs/modules/metal_vlan.md

@@ -34,11 +34,11 @@ Manage the VLAN in Equinix Metal. You can use *id* or *vxlan* to lookup the reso
 
 | Field     | Type | Required | Description                                                                  |
 |-----------|------|----------|------------------------------------------------------------------------------|
-| `id` | <center>`str`</center> | <center>Optional</center> | ID of parent project"   |
-| `project_id` | <center>`str`</center> | <center>Optional</center> | ID of parent project"   |
-| `description` | <center>`str`</center> | <center>Optional</center> | Description of the VLAN  **(Updatable)** |
-| `metro` | <center>`str`</center> | <center>Optional</center> | Metro in which to create the VLAN  **(Updatable)** |
-| `vxlan` | <center>`int`</center> | <center>Optional</center> | VLAN ID, must be unique in metro  **(Updatable)** |
+| `id` | <center>`str`</center> | <center>Optional</center> | UUID of vlan   |
+| `project_id` | <center>`str`</center> | <center>Optional</center> | ID of parent project   |
+| `description` | <center>`str`</center> | <center>Optional</center> | Description of the VLAN   |
+| `metro` | <center>`str`</center> | <center>Optional</center> | Metro in which to create the VLAN   |
+| `vxlan` | <center>`int`</center> | <center>Optional</center> | VLAN ID, must be unique in metro   |
 
 
 

docs/modules/metal_vlan_info.md

@@ -48,7 +48,7 @@ Gather information about Equinix Metal VLAN resources
             "vxlan": 1234,
             "metro": "se",
             "id": "845b45a3-c565-47e5-b9b6-a86204a73d29",
-            "description": "My VLAN."
+            "description": "My VLAN"
           }
         ]
         ```