implements metal connection, info and integration tests

README.md

@@ -21,6 +21,7 @@ Modules for managing Equinix infrastructure.
 
 Name | Description |
 --- | ------------ |
+[equinix.cloud.metal_connection](./docs/modules/metal_connection.md)|Manage a 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|
@@ -41,6 +42,7 @@ 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 connection|
 [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|

docs/modules/metal_connection.md

@@ -0,0 +1,77 @@
+# metal_connection
+
+Manage the interconnection in Equinix Metal. You can use *id* or *name* to lookup the resource. If you want to create 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"
+
+```
+
+
+
+
+
+
+
+
+
+
+## Parameters
+
+| Field     | Type | Required | Description                                                                  |
+|-----------|------|----------|------------------------------------------------------------------------------|
+| `id` | <center>`str`</center> | <center>Optional</center> | UUID of the connection.   |
+| `project_id` | <center>`str`</center> | <center>Optional</center> | UUID of the project this connection belongs to.   |
+| `contact_email` | <center>`str`</center> | <center>Optional</center> | Email for the person to contact for inquires.  **(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  **(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  **(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   |
+| `speed` | <center>`int`</center> | <center>Optional</center> | Port speed. Required for a_side connections. Allowed values are ['50Mbps', '200Mbps', '500Mbps', '1Gbps', '2Gbps', '5Gbps', '10Gbps']   |
+| `tags` | <center>`int`</center> | <center>Optional</center> | Tags attached to the connection  **(Updatable)** |
+| `type` | <center>`int`</center> | <center>Optional</center> | Connection type - dedicated or 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,63 @@
+# metal_connection_info
+
+Gather information about Interconnections
+
+
+- [Examples](#examples)
+- [Parameters](#parameters)
+- [Return Values](#return-values)
+
+## Examples
+
+```yaml
+- name: Gather information about all connection in parent 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> | UUID of parent project containing the connection.   |
+
+
+
+
+
+
+## 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",
+          }
+        ]
+        ```
+
+

plugins/module_utils/metal/api_routes.py

@@ -59,6 +59,9 @@ def get_routes(mpc):
         ("metal_vlan", action.GET): spec_types.Specs(
             equinix_metal.VLANsApi(mpc).get_virtual_network,
         ),
+        ("metal_connection", action.GET): spec_types.Specs(
+            equinix_metal.InterconnectionsApi(mpc).get_interconnection,
+        ),
 
         # LISTERS
         ('metal_project_device', action.LIST): spec_types.Specs(
@@ -113,6 +116,10 @@ def get_routes(mpc):
             equinix_metal.VLANsApi(mpc).find_virtual_networks,
             {'id': 'project_id'},
         ),
+        ('metal_connection', action.LIST): spec_types.Specs(
+            equinix_metal.InterconnectionsApi(mpc).project_list_interconnections,
+            {'id': 'project_id'},
+        ),
 
         # DELETERS
         ('metal_device', action.DELETE): spec_types.Specs(
@@ -133,6 +140,9 @@ def get_routes(mpc):
         ('metal_vlan', action.DELETE): spec_types.Specs(
             equinix_metal.VLANsApi(mpc).delete_virtual_network,
         ),
+        ('metal_connection', action.DELETE): spec_types.Specs(
+            equinix_metal.InterconnectionsApi(mpc).delete_interconnection,
+        ),
 
         # CREATORS
         ('metal_device', action.CREATE): spec_types.Specs(
@@ -175,6 +185,11 @@ def get_routes(mpc):
             {'id': 'project_id'},
             equinix_metal.VirtualNetworkCreateInput,
         ),
+        ('metal_connection', action.CREATE): spec_types.Specs(
+            equinix_metal.InterconnectionsApi(mpc).create_project_interconnection,
+            {'id': 'project_id'},
+            equinix_metal.InterconnectionCreateInput,
+        ),
 
         # UPDATERS
         ('metal_device', action.UPDATE): spec_types.Specs(
@@ -197,4 +212,9 @@ def get_routes(mpc):
             {},
             equinix_metal.SSHKeyInput,
         ),
+        ('metal_connection', action.UPDATE): spec_types.Specs(
+            equinix_metal.InterconnectionsApi(mpc).update_interconnection,
+            {},
+            equinix_metal.InterconnectionUpdateInput,
+        ),
     }

plugins/module_utils/metal/metal_api.py

@@ -137,7 +137,8 @@ def extract_ids_from_projects_hrefs(resource: dict):
     'operating_systems',
     'hardware_reservations',
     'organizations',
-    'virtual_networks'
+    'virtual_networks',
+    'interconnections',
 ]
 
 
@@ -200,6 +201,22 @@ def get_assignment_address(resource: dict):
 }
 
 
+METAL_CONNECTION_RESPONSE_ATTRIBUTE_MAP = {
+    'id': 'id',
+    'name': 'name',
+    'metro': 'metro',
+    'contact_email': 'contact_email',
+    'description': optional_str('description'),
+    'mode': 'mode',
+    'redundancy': 'redundancy',
+    'tags': 'tags',
+    'type': 'type',
+    'ports': 'ports',
+    'requested_by': 'requested_by',
+    'status': 'status',
+}
+
+
 def get_attribute_mapper(resource_type):
     """
     Returns attribute mapper for the given resource type.
@@ -211,6 +228,7 @@ def get_attribute_mapper(resource_type):
     ssh_key_resources = set(['metal_ssh_key', 'metal_project_ssh_key'])
     hardware_reservation_resources = set(['metal_project_hardware_reservation', 'metal_hardware_reservation'])
     vlan_resources = set(["metal_vlan"])
+    connection_resources = set(['metal_connection'])
     if resource_type in device_resources:
         return METAL_DEVICE_RESPONSE_ATTRIBUTE_MAP
     elif resource_type in project_resources:
@@ -227,6 +245,8 @@ def get_attribute_mapper(resource_type):
         return METAL_METRO_RESPONSE_ATTRIBUTE_MAP
     elif resource_type in hardware_reservation_resources:
         return METAL_HARDWARE_RESERVATION_RESPONSE_ATTRIBUTE_MAP
+    elif resource_type in connection_resources:
+        return METAL_CONNECTION_RESPONSE_ATTRIBUTE_MAP
     elif resource_type == 'metal_organization':
         return METAL_ORGANIZATION_RESPONSE_ATTRIBUTE_MAP
     elif resource_type in vlan_resources: