fix:updating documentation for NIMf connection example in Metal Conne…

…ction Resource
equinix · Jul 18, 2024 · 8d8dfed · 8d8dfed
1 parent 112d6eb
commit 8d8dfed
Show file tree

Hide file tree

Showing 3 changed files with 198 additions and 3 deletions.
diff --git a/docs/data-sources/metal_connection.md b/docs/data-sources/metal_connection.md
@@ -56,3 +56,4 @@ In addition to all arguments above, the following attributes are exported:
   * `link_status` - Port link status.
   * `virtual_circuit_ids` - List of IDs of virtual cicruits attached to this port.
 * `token` - (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the [equinix_fabric_connection](../resources/fabric_connection.md) resource or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard). If your organization already has connection service tokens enabled, use `service_tokens` instead.
+* `authorization_code` - Fabric Authorization Code to configure the NIMF connection in Equinix Fabric with the [equinix_fabric_connection](../resources/fabric_connection.md) resource or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard).
diff --git a/docs/resources/fabric_connection.md b/docs/resources/fabric_connection.md
@@ -663,6 +663,74 @@ resource "equinix_fabric_connection" "epl" {
 }
 ```
 
+NIMF Metal to AWS EVPL_VC Connection
+
+```terraform
+resource "equinix_fabric_connection" "metal2aws" {
+  name = "ConnectionName"
+  type = "EVPLAN_VC"
+  notifications {
+    type   = "ALL"
+    emails = ["[email protected]", "[email protected]"]
+  }
+  bandwidth = 50
+  order {
+    purchase_order_number = "1-323292"
+  }
+  a_side {
+    access_point {
+      type               = "METAL_NETWORK"
+      authentication_key = "<metal_authorization_code>"
+    }
+  }
+  z_side {
+    access_point {
+      type = "SP"
+      authentication_key = "<aws_account_id>"
+      seller_region = "us-west-1"
+      profile {
+        type = "L2_PROFILE"
+        uuid = "<service_profile_uuid>"
+      }
+      location {
+        metro_code = "SV"
+      }
+    }
+  }
+}
+```
+
+NIMF Fabric Cloud Router to Metal IP_VC Connection
+
+```terraform
+resource "equinix_fabric_connection" "fcr2metal" {
+  name = "ConnectionName"
+  type = "IP_VC"
+  notifications {
+    type   = "ALL"
+    emails = ["[email protected]", "[email protected]"]
+  }
+  bandwidth = 50
+  order {
+    purchase_order_number = "1-323292"
+  }
+  a_side {
+    access_point {
+      type = "CLOUD_ROUTER"
+      router {
+        uuid = "<cloud_router_uuid>"
+      }
+    }
+  }
+  z_side {
+    access_point {
+      type               = "METAL_NETWORK"
+      authentication_key = "<metal_authorization_code>"
+    }
+  }
+}
+```
+
 ### Notes:
 
 Port to IBM Connections could be modified from IBM Service Provider Side by using parameters passed to additional_info field:
@@ -726,7 +794,7 @@ Optional:
 
 Optional:
 
-- `authentication_key` (String) Authentication key for provider based connections
+- `authentication_key` (String) Authentication key for provider based or Metal NIMF connections
 - `gateway` (Block Set, Max: 1, Deprecated) **Deprecated** `gateway` Use `router` attribute instead (see [below for nested schema](#nestedblock--a_side--access_point--gateway))
 - `interface` (Block Set, Max: 1) Virtual device interface (see [below for nested schema](#nestedblock--a_side--access_point--interface))
 - `link_protocol` (Block Set, Max: 1) Connection link protocol (see [below for nested schema](#nestedblock--a_side--access_point--link_protocol))
@@ -738,7 +806,7 @@ Optional:
 - `provider_connection_id` (String) Provider assigned Connection Id
 - `router` (Block Set, Max: 1) Cloud Router access point information that replaces `gateway` (see [below for nested schema](#nestedblock--a_side--access_point--router))
 - `seller_region` (String) Access point seller region
-- `type` (String) Access point type - COLO, VD, VG, SP, IGW, SUBNET, CLOUD_ROUTER, NETWORK
+- `type` (String) Access point type - COLO, VD, VG, SP, IGW, SUBNET, CLOUD_ROUTER, NETWORK, METAL_NETWORK
 - `virtual_device` (Block Set, Max: 1) Virtual device (see [below for nested schema](#nestedblock--a_side--access_point--virtual_device))
 
 Read-Only:
@@ -969,7 +1037,7 @@ Optional:
 - `provider_connection_id` (String) Provider assigned Connection Id
 - `router` (Block Set, Max: 1) Cloud Router access point information that replaces `gateway` (see [below for nested schema](#nestedblock--z_side--access_point--router))
 - `seller_region` (String) Access point seller region
-- `type` (String) Access point type - COLO, VD, VG, SP, IGW, SUBNET, CLOUD_ROUTER, NETWORK
+- `type` (String) Access point type - COLO, VD, VG, SP, IGW, SUBNET, CLOUD_ROUTER, NETWORK, METAL_NETWORK
 - `virtual_device` (Block Set, Max: 1) Virtual device (see [below for nested schema](#nestedblock--z_side--access_point--virtual_device))
 
 Read-Only:

diff --git a/docs/resources/metal_connection.md b/docs/resources/metal_connection.md
@@ -128,6 +128,131 @@ resource "equinix_fabric_connection" "example" {
 }
 ```
 
+### Shared Connection with authorization_code Non-redundant NIMF connection from Equinix Metal to a Cloud Service Provider via Equinix Fabric Port
+
+```terraform
+resource "equinix_metal_vlan" "example1" {
+    project_id      = local.my_project_id
+    metro           = "SV"
+}
+
+resource "equinix_metal_connection" "example" {
+    name            = "tf-port-to-metal-legacy"
+    project_id      = local.my_project_id
+    metro           = "SV"
+    redundancy      = "redundant"
+    type            = "shared"
+    contact_email   = "[email protected]"
+    vlans              = [
+      equinix_metal_vlan.example1.vxlan,
+      equinix_metal_vlan.example2.vxlan
+    ]
+}
+
+data "equinix_fabric_service_profiles" "zside" {
+  count = var.zside_ap_type == "SP" ? 1 : 0
+  filter {
+    property = "/name"
+    operator = "="
+    values   = ["AWS Direct Connect"]
+  }
+}
+
+resource "equinix_fabric_connection" "example" {
+  name = "tf-NIMF-metal-2-aws-legacy"
+  type = "EVPL_VC"
+  notifications {
+    type   = "ALL"
+    emails = "[email protected]"
+  }
+  project {
+      project_id = local.fabric_project_id
+  }
+  bandwidth       = "200"
+  order {
+    purchase_order_number = "1-323292"
+  }
+  a_side {
+    access_point {
+      type               = "METAL_NETWORK"
+      authentication_key = equinix_metal_connection.metal-connection.authorization_code
+    }
+  }
+  z_side {
+    access_point {
+      type               = "SP"
+      authentication_key = local.aws_account_id
+      seller_region      = "us-west-1"
+      profile {
+        type = "L2_PROFILE"
+        uuid = data.equinix_fabric_service_profiles.zside[0].id
+      }
+      location {
+        metro_code ="SV"
+      }
+    }
+  }
+}
+```
+
+### Shared Connection with authorization_code Non-redundant NIMF connection from Equinix Fabric Cloud Router to Equinix Metal
+
+```terraform
+resource "equinix_metal_vlan" "example1" {
+    project_id      = local.my_project_id
+    metro           = "SV"
+}
+
+resource "equinix_metal_connection" "example" {
+    name            = "tf-port-to-metal-legacy"
+    project_id      = local.my_project_id
+    metro           = "SV"
+    redundancy      = "redundant"
+    type            = "shared"
+    contact_email   = "[email protected]"
+    vlans              = [
+      equinix_metal_vlan.example1.vxlan,
+      equinix_metal_vlan.example2.vxlan
+    ]
+}
+
+resource "equinix_fabric_connection" "example" {
+  name = "tf-NIMF-metal-2-aws-legacy"
+  type = "EVPL_VC"
+  notifications {
+    type   = "ALL"
+    emails = "[email protected]"
+  }
+  project {
+      project_id = local.fabric_project_id
+  }
+  bandwidth       = "200"
+  order {
+    purchase_order_number = "1-323292"
+  }
+  a_side {
+    access_point {
+      type               = "METAL_NETWORK"
+      authentication_key = equinix_metal_connection.metal-connection.authorization_code
+    }
+  }
+  z_side {
+    access_point {
+      type               = "SP"
+      authentication_key = local.aws_account_id
+      seller_region      = "us-west-1"
+      profile {
+        type = "L2_PROFILE"
+        uuid = data.equinix_fabric_service_profiles.zside[0].id
+      }
+      location {
+        metro_code ="SV"
+      }
+    }
+  }
+}
+```
+
 ## Argument Reference
 
 The following arguments are supported:
@@ -155,3 +280,4 @@ In addition to all arguments above, the following attributes are exported:
 * `ports` - List of connection ports - primary (`ports[0]`) and secondary (`ports[1]`). Schema of port is described in documentation of the [equinix_metal_connection datasource](../data-sources/metal_connection.md).
 * `service_tokens` - List of connection service tokens with attributes required to configure the connection in Equinix Fabric with the [equinix_fabric_connection](./fabric_connection.md) resource or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard). Scehma of service_token is described in documentation of the [equinix_metal_connection datasource](../data-sources/metal_connection.md).
 * `token` - (Deprecated) Fabric Token required to configure the connection in Equinix Fabric with the [equinix_fabric_connection](./fabric_connection.md) resource or from the [Equinix Fabric Portal](https://fabric.equinix.com/dashboard). If your organization already has connection service tokens enabled, use `service_tokens` instead.
+* `authorization_code` - Fabric Authorization code to configure the NIMF connection with Cloud Service Provider through Equinix Fabric with the [equinix_fabric_connection](./fabric_connection.md) resource from the [Equinix Developer Portal](https://developer.equinix.com/dev-docs/fabric/getting-started/fabric-v4-apis/connect-metal-to-amazon-web-services).