Skip to main content

equinix_fabric_service_token (Resource)

Fabric V4 API compatible resource allows creation and management of Equinix Fabric Service Token.

Additional documentation:

Example Usage​

Aside Port Service Token

resource "equinix_fabric_service_token" "test" {
  type                 = "VC_TOKEN"
  description          = "Aside COLO Service Token"
  expiration_date_time = "2025-01-18T06:43:49.981Z"
  service_token_connection {
    type = "EVPL_VC"
    bandwidth_limit = 1000
    a_side {
      access_point_selectors{
        type = "COLO"
        port {
          uuid = "<port_uuid>"
        }
        link_protocol {
          type = "DOT1Q"
          vlan_tag = "2987"
        }
      }
    }
  }
  notifications {
    type   = "ALL"
    emails = ["example@equinix.com", "test1@equinix.com"]
  }
}

Zside Port Service Token

resource "equinix_fabric_service_token" "test"{
  type                 = "VC_TOKEN"
  description          = "Zside COLO Service Token"
  expiration_date_time = "2025-01-18T06:43:49.981Z"
  service_token_connection {
    type = "EVPL_VC"
    supported_bandwidths = [50, 200, 10000]
    z_side {
      access_point_selectors{
        type = "COLO"
        port {
          uuid = "<port_uuid>"
        }
        link_protocol {
          type = "DOT1Q"
          vlan_tag = "2087"
        }
      }
    }
  }
  notifications {
    type   = "ALL"
    emails = ["example@equinix.com", "test1@equinix.com"]
  }
}

Zside Network Service Token

resource "equinix_fabric_service_token" "test" {
  type                 = "VC_TOKEN"
  description          = "Zside Network Service Token"
  expiration_date_time = "2025-01-18T06:43:49.986Z"
  service_token_connection {
    type                 = "EVPL_VC"
    supported_bandwidths = [50, 200, 10000]
    z_side {
      access_point_selectors {
        type = "NETWORK"
        network {
          uuid = "<network_uuid>"
        }
      }
    }
  }
  notifications {
    type   = "ALL"
    emails = ["example@equinix.com"]
  }
}

Zside Virtual Device Service Token

resource "equinix_fabric_service_token" "test" {
  type                 = "VC_TOKEN"
  description          = "Zside VD Service Token"
  expiration_date_time = "2025-01-18T06:43:49.986Z"
  service_token_connection {
    type                 = "EVPL_VC"
    supported_bandwidths = [50, 200, 10000]
    z_side {
      access_point_selectors {
        type = "VD"
        virtual_device {
          type = "EDGE"
          uuid = "<device_uuid>"
        }
        interface {
          type = "NETWORK"
        }
      }
    }
  }
  notifications {
    type   = "ALL"
    emails = ["example@equinix.com"]
  }
}

Schema​

Required​

  • expiration_date_time (String) Expiration date and time of the service token; 2020-11-06T07:00:00Z
  • notifications (Block Set, Min: 1) Preferences for notifications on Service Token configuration or status changes (see below for nested schema)
  • service_token_connection (Block Set, Min: 1) Service Token Connection Type Information (see below for nested schema)
  • type (String) Service Token Type; VC_TOKEN,EPL_TOKEN

Optional​

  • description (String) Optional Description to the Service Token you will be creating
  • name (String) Name of the Service Token
  • project (Block Set, Max: 1) Project information (see below for nested schema)
  • timeouts (Block, Optional) (see below for nested schema)

Read-Only​

  • account (Set of Object) Customer account information that is associated with this service token (see below for nested schema)
  • change_log (Set of Object) Captures connection lifecycle change information (see below for nested schema)
  • href (String) An absolute URL that is the subject of the link's context.
  • id (String) The ID of this resource.
  • issuer_side (String) Information about token side; ASIDE, ZSIDE
  • state (String) Service token state; ACTIVE, INACTIVE, EXPIRED, DELETED
  • uuid (String) Equinix-assigned service token identifier

Nested Schema for notifications​

Required:

  • emails (List of String) Array of contact emails
  • type (String) Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS

Optional:

  • send_interval (String) Send interval

Nested Schema for service_token_connection​

Optional:

  • a_side (Block Set) A-Side Connection link protocol,virtual device or network configuration (see below for nested schema)
  • allow_custom_bandwidth (Boolean) Allow custom bandwidth value
  • allow_remote_connection (Boolean) Authorization to connect remotely
  • bandwidth_limit (Number) Connection bandwidth limit in Mbps
  • supported_bandwidths (List of Number) List of permitted bandwidths'; For Port-based Service Tokens, the maximum allowable bandwidth is 50 Gbps, while for Virtual Device-based Service Tokens, it is limited to 10 Gbps
  • type (String) Type of Connection supported by Service Token you will create; EVPL_VC, EVPLAN_VC, EPLAN_VC, IPWAN_VC
  • z_side (Block Set) Z-Side Connection link protocol,virtual device or network configuration (see below for nested schema)

Read-Only:

  • uuid (String) Equinix-assigned connection identifier

Nested Schema for service_token_connection.a_side​

Required:

  • access_point_selectors (Block List, Min: 1) List of criteria for selecting network access points with optimal efficiency, security, compatibility, and availability (see below for nested schema)

Nested Schema for service_token_connection.a_side.access_point_selectors​

Optional:

Nested Schema for service_token_connection.a_side.access_point_selectors.interface​

Required:

  • type (String) Interface type

Read-Only:

  • id (Number) id
  • uuid (String) Equinix-assigned interface identifier

Optional:

  • type (String) Type of the link protocol - UNTAGGED, DOT1Q, QINQ, EVPN_VXLAN
  • vlan_c_tag (Number) Vlan Customer Tag information, vlanCTag value specified for QINQ connections
  • vlan_s_tag (Number) Vlan Provider Tag information, vlanSTag value specified for QINQ connections
  • vlan_tag (Number) Vlan Tag information, vlanTag value specified for DOT1Q connections

Nested Schema for service_token_connection.a_side.access_point_selectors.network​

Required:

  • uuid (String) Equinix-assigned Network identifier

Read-Only:

  • href (String) Unique Resource Identifier
  • location (Set of Object) Location (see below for nested schema)
  • name (String) Network Name
  • scope (String) Scope of Network
  • type (String) Type of Network

Nested Schema for service_token_connection.a_side.access_point_selectors.network.location​

Read-Only:

  • ibx (String)
  • metro_code (String)
  • metro_name (String)
  • region (String)

Nested Schema for service_token_connection.a_side.access_point_selectors.port​

Required:

  • uuid (String) Equinix-assigned Port identifier

Optional:

  • type (String) Type of Port

Read-Only:

  • account_name (String) Account Name
  • bandwidth (Number) Port Bandwidth
  • cvp_id (Number) Customer virtual port Id
  • encapsulation_protocol_type (String) Port Encapsulation
  • href (String) Unique Resource Identifier
  • location (Set of Object) Port Location (see below for nested schema)
  • port_name (String) Port Name
  • priority (String) Port Priority

Nested Schema for service_token_connection.a_side.access_point_selectors.port.location​

Read-Only:

  • ibx (String)
  • metro_code (String)
  • metro_name (String)
  • region (String)

Nested Schema for service_token_connection.a_side.access_point_selectors.virtual_device​

Required:

  • uuid (String) Equinix-assigned Virtual Device identifier

Optional:

  • type (String) Virtual Device type

Read-Only:

  • cluster (String) Virtual Device Cluster Information
  • href (String) Unique Resource Identifier
  • name (String) Customer-assigned Virtual Device Name

Nested Schema for service_token_connection.z_side​

Required:

  • access_point_selectors (Block List, Min: 1) List of criteria for selecting network access points with optimal efficiency, security, compatibility, and availability (see below for nested schema)

Nested Schema for service_token_connection.z_side.access_point_selectors​

Optional:

Nested Schema for service_token_connection.z_side.access_point_selectors.interface​

Required:

  • type (String) Interface type

Read-Only:

  • id (Number) id
  • uuid (String) Equinix-assigned interface identifier

Optional:

  • type (String) Type of the link protocol - UNTAGGED, DOT1Q, QINQ, EVPN_VXLAN
  • vlan_c_tag (Number) Vlan Customer Tag information, vlanCTag value specified for QINQ connections
  • vlan_s_tag (Number) Vlan Provider Tag information, vlanSTag value specified for QINQ connections
  • vlan_tag (Number) Vlan Tag information, vlanTag value specified for DOT1Q connections

Nested Schema for service_token_connection.z_side.access_point_selectors.network​

Required:

  • uuid (String) Equinix-assigned Network identifier

Read-Only:

  • href (String) Unique Resource Identifier
  • location (Set of Object) Location (see below for nested schema)
  • name (String) Network Name
  • scope (String) Scope of Network
  • type (String) Type of Network

Nested Schema for service_token_connection.z_side.access_point_selectors.network.location​

Read-Only:

  • ibx (String)
  • metro_code (String)
  • metro_name (String)
  • region (String)

Nested Schema for service_token_connection.z_side.access_point_selectors.port​

Required:

  • uuid (String) Equinix-assigned Port identifier

Optional:

  • type (String) Type of Port

Read-Only:

  • account_name (String) Account Name
  • bandwidth (Number) Port Bandwidth
  • cvp_id (Number) Customer virtual port Id
  • encapsulation_protocol_type (String) Port Encapsulation
  • href (String) Unique Resource Identifier
  • location (Set of Object) Port Location (see below for nested schema)
  • port_name (String) Port Name
  • priority (String) Port Priority

Nested Schema for service_token_connection.z_side.access_point_selectors.port.location​

Read-Only:

  • ibx (String)
  • metro_code (String)
  • metro_name (String)
  • region (String)

Nested Schema for service_token_connection.z_side.access_point_selectors.virtual_device​

Required:

  • uuid (String) Equinix-assigned Virtual Device identifier

Optional:

  • type (String) Virtual Device type

Read-Only:

  • cluster (String) Virtual Device Cluster Information
  • href (String) Unique Resource Identifier
  • name (String) Customer-assigned Virtual Device Name

Nested Schema for project​

Optional:

  • project_id (String) Project Id

Read-Only:

  • href (String) Unique Resource URL

Nested Schema for timeouts​

Optional:

  • create (String)
  • delete (String)
  • read (String)
  • update (String)

Nested Schema for account​

Read-Only:

  • account_name (String)
  • account_number (Number)
  • global_cust_id (String)
  • global_org_id (String)
  • global_organization_name (String)
  • org_id (Number)
  • organization_name (String)
  • ucm_id (String)

Nested Schema for change_log​

Read-Only:

  • created_by (String)
  • created_by_email (String)
  • created_by_full_name (String)
  • created_date_time (String)
  • deleted_by (String)
  • deleted_by_email (String)
  • deleted_by_full_name (String)
  • deleted_date_time (String)
  • updated_by (String)
  • updated_by_email (String)
  • updated_by_full_name (String)
  • updated_date_time (String)
Was this page helpful?