> ## Documentation Index
> The index for all IBM Cloud docs is at: https://cloud.ibm.com/docs/llms.txt
> Use these files to discover more information as needed.

# IBM Cloud Direct Link

The IBM Cloud Direct Link solution is designed to seamlessly connect your on-premises resources to your cloud resources. Leverage the docs, CLI, and API reference to plan for, provision, and manage your direct links.

## Get started

- [Getting started with IBM Cloud Direct Link](https://cloud.ibm.com/docs/dl?topic=dl-get-started-with-ibm-cloud-dl&format=markdown)
- [About IBM Cloud Direct Link](https://cloud.ibm.com/docs/dl?topic=dl-dl-about&format=markdown)
- [Locations and providers](https://cloud.ibm.com/docs/dl?topic=dl-locations&format=markdown)
- Deployment considerations
   - [Models for diversity in Direct Link](https://cloud.ibm.com/docs/dl?topic=dl-models-for-diversity-and-redundancy-in-direct-link&format=markdown)
   - [Planning for deployment](https://cloud.ibm.com/docs/dl?topic=dl-dl-planning-considerations&format=markdown)
   - [Alternatives for your Direct Link Connect deployment](https://cloud.ibm.com/docs/dl?topic=dl-alternatives-for-your-ibm-cloud-direct-link-deployment&format=markdown)
   - [Filtering routes by using Transit Gateway prefix filtering](https://cloud.ibm.com/docs/dl?topic=dl-prefix-filtering&format=markdown)
   - [Comparing Layer-2 and Layer-3 connections for Direct Link](https://cloud.ibm.com/docs/dl?topic=dl-comparing-layer-2-layer-3&format=markdown)
- Related links
   - [Getting started with Direct Link on Classic](https://cloud.ibm.com/docs/direct-link?topic=direct-link-get-started-with-ibm-cloud-direct-link&format=markdown)
   - [Getting started with Virtual Private Cloud (VPC)](https://cloud.ibm.com/docs/vpc?topic=vpc-getting-started&format=markdown)
   - [Accessing VPEs from an on-premises network using Direct Link or from another VPC by using Transit Gateway](https://cloud.ibm.com/docs/dl?topic=dl-end-to-end-private-connectivity-vpe&format=markdown)
   - [Interconnecting your VPC using IBM Cloud offerings](https://cloud.ibm.com/docs/dl?topic=dl-interconnectivity&format=markdown)
- [Release notes for Direct Link](https://cloud.ibm.com/docs/dl?topic=dl-direct-link-release-notes&format=markdown)
- [Migrating Direct Link MACsec CAKs and MD5 keys from HPCS to Secrets Manager](https://cloud.ibm.com/docs/dl?topic=dl-hpcs-migration&format=markdown)

## Tutorials

- Interconnectivity
   - [Bring Your Own IP Address](https://cloud.ibm.com/docs/dl?topic=dl-byoip&format=markdown)

## How to

- Ordering IBM Cloud Direct Link Dedicated
   - [Ordering IBM Cloud Direct Link Dedicated](https://cloud.ibm.com/docs/dl?topic=dl-how-to-order-ibm-cloud-dl-dedicated&format=markdown)
   - [Prerequisites for the Direct Link Dedicated MACsec feature](https://cloud.ibm.com/docs/dl?topic=dl-macsec-prerequisites&format=markdown)
   - [Completing the connection](https://cloud.ibm.com/docs/dl?topic=dl-complete-connection-dedicated&format=markdown)
- Ordering IBM Cloud Direct Link Connect
   - [Ordering IBM Cloud Direct Link Connect](https://cloud.ibm.com/docs/dl?topic=dl-how-to-order-ibm-cloud-dl-connect&format=markdown)
   - Partner-specific instructions
      - [AT&T NetBond for Cloud ordering considerations](https://cloud.ibm.com/docs/dl?topic=dl-netbond&format=markdown)
      - [AT&T NetBond Essentials using Equinix Fabric ordering considerations](https://cloud.ibm.com/docs/dl?topic=dl-att-netbond-essentials&format=markdown)
      - [CenturyLink Dynamic Connections ordering considerations](https://cloud.ibm.com/docs/dl?topic=dl-clink&format=markdown)
      - [Cologix ordering considerations](https://cloud.ibm.com/docs/dl?topic=dl-cologix-instructions&format=markdown)
      - [Console Connect ordering considerations](https://cloud.ibm.com/docs/dl?topic=dl-console-connect-ordering&format=markdown)
      - [DE-CIX ordering considerations](https://cloud.ibm.com/docs/dl?topic=dl-de-cix&format=markdown)
      - [Digital Realty ordering considerations](https://cloud.ibm.com/docs/dl?topic=dl-digital-realty&format=markdown)
      - [Equinix ordering considerations](https://cloud.ibm.com/docs/dl?topic=dl-equinix&format=markdown)
      - [Megaport ordering considerations](https://cloud.ibm.com/docs/dl?topic=dl-megaport&format=markdown)
      - [Verizon SCI ordering considerations](https://cloud.ibm.com/docs/dl?topic=dl-verizon-sci&format=markdown)
      - [Verizon SCI using Equinix Fabric ordering considerations](https://cloud.ibm.com/docs/dl?topic=dl-verizon-sci-equinix&format=markdown)
      - [Accepting provider-created connections](https://cloud.ibm.com/docs/dl?topic=dl-accepting-provider-created-connection&format=markdown)
- [Managing IAM access for IBM Cloud Direct Link](https://cloud.ibm.com/docs/dl?topic=dl-iam&format=markdown)
- Managing direct links
   - [Adding virtual connections to a direct link](https://cloud.ibm.com/docs/dl?topic=dl-add-virtual-connection&format=markdown)
   - [Adding a cross-account (VPC only) connection](https://cloud.ibm.com/docs/dl?topic=dl-cross-account-virtual-connection-vpc&format=markdown)
   - [Updating the network connection type](https://cloud.ibm.com/docs/dl?topic=dl-virtual-connection-types&format=markdown)
   - [Updating a direct link](https://cloud.ibm.com/docs/dl?topic=dl-update-dl-gateway&format=markdown)
   - [Activating, deactivating, and updating VLAN tagging](https://cloud.ibm.com/docs/dl?topic=dl-activate-vlan-tagging&format=markdown)
   - [Activating and deactivating BGP MD5 authentication](https://cloud.ibm.com/docs/dl?topic=dl-enable-disable-md5&format=markdown)
   - [Creating base64-encoded encryption keys](https://cloud.ibm.com/docs/dl?topic=dl-create-encryption-keys&format=markdown)
   - [Activating and deactivating Bidirectional Forwarding Detection (BFD)](https://cloud.ibm.com/docs/dl?topic=dl-activate-deactivate-bfd&format=markdown)
   - [Prepending an AS path to influence route priority](https://cloud.ibm.com/docs/dl?topic=dl-prepend-as-paths&format=markdown)
   - [Generating a direct link route report](https://cloud.ibm.com/docs/dl?topic=dl-generate-route-reports&format=markdown)
   - [Upgrading the bandwidth of your Direct Link Dedicated connection](https://cloud.ibm.com/docs/dl?topic=dl-dl-connection&format=markdown)
   - [Viewing the details of a direct link](https://cloud.ibm.com/docs/dl?topic=dl-viewing-details&format=markdown)
   - [Rotating CAKs for Direct Link Dedicated with MACsec](https://cloud.ibm.com/docs/dl?topic=dl-macsec-cak-rotation&format=markdown)
- Setting up route filters
   - [About route filtering](https://cloud.ibm.com/docs/dl?topic=dl-filter-routes&format=markdown)
   - [Configuring route filters](https://cloud.ibm.com/docs/dl?topic=dl-configure-route-filters&format=markdown)
   - [Route filtering examples](https://cloud.ibm.com/docs/dl?topic=dl-route-filtering-examples&format=markdown)
   - [Filtering routes by using Transit Gateway prefix filtering](https://cloud.ibm.com/docs/dl?topic=dl-prefix-filtering-transit&format=markdown)
- [Setting up BGP Message Digest 5 (MD5) authentication keys](https://cloud.ibm.com/docs/dl?topic=dl-dl-md5&format=markdown)
- [Setting up Bidirectional Forwarding Detection (BFD)](https://cloud.ibm.com/docs/dl?topic=dl-dl-bfd&format=markdown)
- [Deleting a direct link](https://cloud.ibm.com/docs/dl?topic=dl-delete-direct-link&format=markdown)
- [Setting up Terraform for Direct Link](https://cloud.ibm.com/docs/dl?topic=dl-terraform-setup-dl&format=markdown)
- Enhancing security
   - [Securing your data in Direct Link](https://cloud.ibm.com/docs/dl?topic=dl-mng-data&format=markdown)
   - [Protecting resources with context-based restrictions](https://cloud.ibm.com/docs/dl?topic=dl-cbr&format=markdown)
   - Privately connecting to Direct Link
      - [Using virtual private endpoints for VPC to privately connect to Direct Link](https://cloud.ibm.com/docs/dl?topic=dl-vpe-connection&format=markdown)
- Observability
   - [Activity tracking events for IBM Cloud Direct Link](https://cloud.ibm.com/docs/dl?topic=dl-at_events&format=markdown)
   - [Monitoring Direct Link](https://cloud.ibm.com/docs/dl?topic=dl-monitoring&format=markdown)
- Direct Link hazardous change remediation
   - [Preparing for Direct Link changes to advertised service network routes](https://cloud.ibm.com/docs/dl?topic=dl-notification-dl-tgw&format=markdown)

## Reference

- API reference
   - [Direct Link API](https://{DomainName}/docs/apis/direct_link)
   - [Direct Link Provider API](https://{DomainName}/docs/apis/direct_link_provider_api)
   - [Direct Link API change log](https://cloud.ibm.com/docs/dl?topic=dl-direct-link-api-changelog&format=markdown)
   - [Setting up your API environment](https://cloud.ibm.com/docs/dl?topic=dl-set-up-environment&format=markdown)
- CLI reference
   - [Direct Link CLI](https://cloud.ibm.com/docs/dl?topic=dl-dl-cli&format=markdown)
   - [Direct Link CLI change log](https://cloud.ibm.com/docs/dl?topic=dl-direct-link-cli-change-log&format=markdown)
- [Terraform reference](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/dl_gateway)
- [Feature comparison between Direct Link versions](https://cloud.ibm.com/docs/dl?topic=dl-dl-comparison-classic&format=markdown)
- [Location comparison between Direct Link versions](https://cloud.ibm.com/docs/dl?topic=dl-dl-comparison-locations&format=markdown)
- [Understanding latency](https://cloud.ibm.com/docs/dl?topic=dl-understanding-latency&format=markdown)
- [Virtual routing and forwarding on IBM Cloud](https://cloud.ibm.com/docs/dl?topic=dl-overview-of-virtual-routing-and-forwarding-vrf-on-ibm-cloud&format=markdown)
- [Converting to virtual routing and forwarding](https://cloud.ibm.com/docs/dl?topic=dl-what-happens-during-the-account-conversion-process&format=markdown)
- [Direct Link prerequisites](https://cloud.ibm.com/docs/dl?topic=dl-ibm-cloud-dl-prerequisites&format=markdown)
- [Completion notice example](https://cloud.ibm.com/docs/dl?topic=dl-completion-notice-example&format=markdown)
- [Understanding your responsibilities when using IBM Cloud Direct Link](https://cloud.ibm.com/docs/dl?topic=dl-dl-responsibilities&format=markdown)
- [Service dependency map for IBM Cloud Direct Link Services](https://cloud.ibm.com/docs/dl?topic=dl-service-dependencies&format=markdown)
- [Understanding high availability and disaster recovery for IBM Cloud Direct Link](https://cloud.ibm.com/docs/dl?topic=dl-ha-dr-dl&format=markdown)
- [Understanding data portability for Direct Link](https://cloud.ibm.com/docs/dl?topic=dl-data-portability&format=markdown)
- [Related resources](https://cloud.ibm.com/docs/dl?topic=dl-related-resources&format=markdown)

## Help

- [Known issues and limitations](https://cloud.ibm.com/docs/dl?topic=dl-known-limitations&format=markdown)
- [Guidelines and restrictions for Direct Link Dedicated with MACsec](https://cloud.ibm.com/docs/dl?topic=dl-limitations-macsec&format=markdown)
- [Getting help and support for Direct Link](https://cloud.ibm.com/docs/dl?topic=dl-help-and-support&format=markdown)
- [FAQ](https://cloud.ibm.com/docs/dl?topic=dl-faqs&format=markdown)
- Troubleshooting
   - [The connection is down after scheduled Direct Link maintenance. What can be done?](https://cloud.ibm.com/docs/dl?topic=dl-troubleshoot-connection-down-after-scheduled-maintenance&format=markdown)
   - [How do I troubleshoot a Direct Link Dedicated connection during activation?](https://cloud.ibm.com/docs/dl?topic=dl-troubleshoot-level-1&format=markdown)
   - [Why isn't the BGP peering session established?](https://cloud.ibm.com/docs/dl?topic=dl-troubleshoot-bgp-not-up&format=markdown)
   - [Why isn't my gateway showing Provisioned status yet?](https://cloud.ibm.com/docs/dl?topic=dl-troubleshoot-not-in-provisioned-state&format=markdown)
   - [Why is my Direct Link instance suspended?](https://cloud.ibm.com/docs/dl?topic=dl-troubleshoot-instance-suspended&format=markdown)
   - [If my Direct Link is established, why can't I connect to my VPC virtual server instance?](https://cloud.ibm.com/docs/dl?topic=dl-troubleshoot-unable-connect-vsi&format=markdown)
   - [Why is my direct link failing when I configure a BGP MD5 authentication key?](https://cloud.ibm.com/docs/dl?topic=dl-troubleshoot-md5-configuration&format=markdown)
   - [Why is my direct link failing when I configure MACsec CAKs?](https://cloud.ibm.com/docs/dl?topic=dl-troubleshoot-macsec-caks&format=markdown)