# equinix\_fabric\_service\_token (Resource) Fabric V4 API compatible resource allows creation and management of [Equinix Fabric Service Token](https://docs.equinix.com/fabric/service-tokens/create-z-side-token). Additional documentation: * Getting Started: * API: ## Example Usage[​](#example-usage "Direct link to 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 = "" } 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 = "" } 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 = "" } } } } 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 = "" } interface { type = "NETWORK" } } } } notifications { type = "ALL" emails = ["example@equinix.com"] } } ``` ## Schema[​](#schema "Direct link to Schema") ### Required[​](#required "Direct link to 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](#nestedblock--notifications)) * `service_token_connection` (Block Set, Min: 1) Service Token Connection Type Information (see [below for nested schema](#nestedblock--service_token_connection)) * `type` (String) Service Token Type; VC\_TOKEN,EPL\_TOKEN ### Optional[​](#optional "Direct link to 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](#nestedblock--project)) * `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) ### Read-Only[​](#read-only "Direct link to Read-Only") * `account` (Set of Object) Customer account information that is associated with this service token (see [below for nested schema](#nestedatt--account)) * `change_log` (Set of Object) Captures connection lifecycle change information (see [below for nested schema](#nestedatt--change_log)) * `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`[​](#nested-schema-for-notifications "Direct link to 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`[​](#nested-schema-for-service_token_connection "Direct link to 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](#nestedblock--service_token_connection--a_side)) * `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](#nestedblock--service_token_connection--z_side)) Read-Only: * `uuid` (String) Equinix-assigned connection identifier []() ### Nested Schema for `service_token_connection.a_side`[​](#nested-schema-for-service_token_connectiona_side "Direct link to nested-schema-for-service_token_connectiona_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](#nestedblock--service_token_connection--a_side--access_point_selectors)) []() ### Nested Schema for `service_token_connection.a_side.access_point_selectors`[​](#nested-schema-for-service_token_connectiona_sideaccess_point_selectors "Direct link to nested-schema-for-service_token_connectiona_sideaccess_point_selectors") Optional: * `interface` (Block Set, Max: 1) Virtual Device Interface Configuration (see [below for nested schema](#nestedblock--service_token_connection--a_side--access_point_selectors--interface)) * `link_protocol` (Block Set, Max: 1) Link protocol Configuration (see [below for nested schema](#nestedblock--service_token_connection--a_side--access_point_selectors--link_protocol)) * `network` (Block Set, Max: 1) Network Configuration (see [below for nested schema](#nestedblock--service_token_connection--a_side--access_point_selectors--network)) * `port` (Block Set, Max: 1) Port Configuration (see [below for nested schema](#nestedblock--service_token_connection--a_side--access_point_selectors--port)) * `type` (String) Type of Access point; COLO, VD, NETWORK * `virtual_device` (Block Set, Max: 1) Virtual Device Configuration (see [below for nested schema](#nestedblock--service_token_connection--a_side--access_point_selectors--virtual_device)) []() ### Nested Schema for `service_token_connection.a_side.access_point_selectors.interface`[​](#nested-schema-for-service_token_connectiona_sideaccess_point_selectorsinterface "Direct link to nested-schema-for-service_token_connectiona_sideaccess_point_selectorsinterface") Required: * `type` (String) Interface type Read-Only: * `id` (Number) id * `uuid` (String) Equinix-assigned interface identifier []() ### Nested Schema for `service_token_connection.a_side.access_point_selectors.link_protocol`[​](#nested-schema-for-service_token_connectiona_sideaccess_point_selectorslink_protocol "Direct link to nested-schema-for-service_token_connectiona_sideaccess_point_selectorslink_protocol") 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`[​](#nested-schema-for-service_token_connectiona_sideaccess_point_selectorsnetwork "Direct link to nested-schema-for-service_token_connectiona_sideaccess_point_selectorsnetwork") Required: * `uuid` (String) Equinix-assigned Network identifier Read-Only: * `href` (String) Unique Resource Identifier * `location` (Set of Object) Location (see [below for nested schema](#nestedatt--service_token_connection--a_side--access_point_selectors--network--location)) * `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`[​](#nested-schema-for-service_token_connectiona_sideaccess_point_selectorsnetworklocation "Direct link to nested-schema-for-service_token_connectiona_sideaccess_point_selectorsnetworklocation") Read-Only: * `ibx` (String) * `metro_code` (String) * `metro_name` (String) * `region` (String) []() ### Nested Schema for `service_token_connection.a_side.access_point_selectors.port`[​](#nested-schema-for-service_token_connectiona_sideaccess_point_selectorsport "Direct link to nested-schema-for-service_token_connectiona_sideaccess_point_selectorsport") 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](#nestedatt--service_token_connection--a_side--access_point_selectors--port--location)) * `port_name` (String) Port Name * `priority` (String) Port Priority []() ### Nested Schema for `service_token_connection.a_side.access_point_selectors.port.location`[​](#nested-schema-for-service_token_connectiona_sideaccess_point_selectorsportlocation "Direct link to nested-schema-for-service_token_connectiona_sideaccess_point_selectorsportlocation") 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`[​](#nested-schema-for-service_token_connectiona_sideaccess_point_selectorsvirtual_device "Direct link to nested-schema-for-service_token_connectiona_sideaccess_point_selectorsvirtual_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`[​](#nested-schema-for-service_token_connectionz_side "Direct link to nested-schema-for-service_token_connectionz_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](#nestedblock--service_token_connection--z_side--access_point_selectors)) []() ### Nested Schema for `service_token_connection.z_side.access_point_selectors`[​](#nested-schema-for-service_token_connectionz_sideaccess_point_selectors "Direct link to nested-schema-for-service_token_connectionz_sideaccess_point_selectors") Optional: * `interface` (Block Set, Max: 1) Virtual Device Interface Configuration (see [below for nested schema](#nestedblock--service_token_connection--z_side--access_point_selectors--interface)) * `link_protocol` (Block Set, Max: 1) Link protocol Configuration (see [below for nested schema](#nestedblock--service_token_connection--z_side--access_point_selectors--link_protocol)) * `network` (Block Set, Max: 1) Network Configuration (see [below for nested schema](#nestedblock--service_token_connection--z_side--access_point_selectors--network)) * `port` (Block Set, Max: 1) Port Configuration (see [below for nested schema](#nestedblock--service_token_connection--z_side--access_point_selectors--port)) * `type` (String) Type of Access point; COLO, VD, NETWORK * `virtual_device` (Block Set, Max: 1) Virtual Device Configuration (see [below for nested schema](#nestedblock--service_token_connection--z_side--access_point_selectors--virtual_device)) []() ### Nested Schema for `service_token_connection.z_side.access_point_selectors.interface`[​](#nested-schema-for-service_token_connectionz_sideaccess_point_selectorsinterface "Direct link to nested-schema-for-service_token_connectionz_sideaccess_point_selectorsinterface") Required: * `type` (String) Interface type Read-Only: * `id` (Number) id * `uuid` (String) Equinix-assigned interface identifier []() ### Nested Schema for `service_token_connection.z_side.access_point_selectors.link_protocol`[​](#nested-schema-for-service_token_connectionz_sideaccess_point_selectorslink_protocol "Direct link to nested-schema-for-service_token_connectionz_sideaccess_point_selectorslink_protocol") 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`[​](#nested-schema-for-service_token_connectionz_sideaccess_point_selectorsnetwork "Direct link to nested-schema-for-service_token_connectionz_sideaccess_point_selectorsnetwork") Required: * `uuid` (String) Equinix-assigned Network identifier Read-Only: * `href` (String) Unique Resource Identifier * `location` (Set of Object) Location (see [below for nested schema](#nestedatt--service_token_connection--z_side--access_point_selectors--network--location)) * `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`[​](#nested-schema-for-service_token_connectionz_sideaccess_point_selectorsnetworklocation "Direct link to nested-schema-for-service_token_connectionz_sideaccess_point_selectorsnetworklocation") Read-Only: * `ibx` (String) * `metro_code` (String) * `metro_name` (String) * `region` (String) []() ### Nested Schema for `service_token_connection.z_side.access_point_selectors.port`[​](#nested-schema-for-service_token_connectionz_sideaccess_point_selectorsport "Direct link to nested-schema-for-service_token_connectionz_sideaccess_point_selectorsport") 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](#nestedatt--service_token_connection--z_side--access_point_selectors--port--location)) * `port_name` (String) Port Name * `priority` (String) Port Priority []() ### Nested Schema for `service_token_connection.z_side.access_point_selectors.port.location`[​](#nested-schema-for-service_token_connectionz_sideaccess_point_selectorsportlocation "Direct link to nested-schema-for-service_token_connectionz_sideaccess_point_selectorsportlocation") 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`[​](#nested-schema-for-service_token_connectionz_sideaccess_point_selectorsvirtual_device "Direct link to nested-schema-for-service_token_connectionz_sideaccess_point_selectorsvirtual_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`[​](#nested-schema-for-project "Direct link to nested-schema-for-project") Optional: * `project_id` (String) Project Id Read-Only: * `href` (String) Unique Resource URL []() ### Nested Schema for `timeouts`[​](#nested-schema-for-timeouts "Direct link to nested-schema-for-timeouts") Optional: * `create` (String) * `delete` (String) * `read` (String) * `update` (String) []() ### Nested Schema for `account`[​](#nested-schema-for-account "Direct link to 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`[​](#nested-schema-for-change_log "Direct link to 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)