Getting Information About Your DirectLink Interfaces

You can get information about one or more of your DirectLink interfaces.

You can use the connection-id parameter to describe only virtual interfaces associated with a specified DirectLink connection, or the virtual-interface-id parameter to describe a specified virtual interface.

Getting Information About Your DirectLink Interfaces Using Cockpit v2

See the DirectLink Interfaces dashboard.

Getting Information About Your DirectLink Interfaces Using OSC CLI

The ReadDirectLinkInterfaces command lists one or more of your DirectLink interfaces.

Request sample
$ osc-cli api ReadDirectLinkInterfaces --profile "default" \
    --Filters '{
        "DirectLinkInterfaceIds": ["dxvif-12345678"]
      }'

This command contains the following attributes that you need to specify:

  • DryRun: (optional) If true, checks whether you have the required permissions to perform the action.

  • Filters: (optional) One or more filters.

    • DirectLinkIds: (optional) The IDs of the DirectLinks.

    • DirectLinkInterfaceIds: (optional) The IDs of the DirectLink interfaces.

  • NextPageToken: (optional) The token to request the next page of results. Each token refers to a specific page.

  • ResultsPerPage: (optional) The maximum number of logs returned in a single response (between 1 and 1000, both included). By default, 100.

The ReadDirectLinkInterfaces command returns the following elements:

  • DirectLinkInterfaces: Information about one or more DirectLink interfaces.

    • AccountId: The account ID of the owner of the DirectLink interface.

    • BgpAsn: The BGP (Border Gateway Protocol) ASN (Autonomous System Number) on the customer’s side of the DirectLink interface.

    • BgpKey: The BGP authentication key.

    • ClientPrivateIp: The IP on the customer’s side of the DirectLink interface.

    • DirectLinkId: The ID of the DirectLink.

    • DirectLinkInterfaceId: The ID of the DirectLink interface.

    • DirectLinkInterfaceName: The name of the DirectLink interface.

    • InterfaceType: The type of the DirectLink interface (always private).

    • Location: The datacenter where the DirectLink interface is located.

    • Mtu: The maximum transmission unit (MTU) of the DirectLink interface, in bytes (always 1500).

    • OutscalePrivateIp: The IP on the OUTSCALE side of the DirectLink interface.

    • State: The state of the DirectLink interface (pending | available | deleting | deleted | confirming | rejected | expired).

    • VirtualGatewayId: The ID of the target virtual gateway.

    • Vlan: The VLAN number associated with the DirectLink interface.

  • NextPageToken: The token to request the next page of results. Each token refers to a specific page.

  • ResponseContext: Information about the context of the response.

    • RequestId: The ID of the request.

Result sample
{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "DirectLinkInterfaces": [
    {
      "Vlan": 101,
      "OutscalePrivateIp": "172.16.0.4/30",
      "DirectLinkInterfaceId": "dxvif-12345678",
      "BgpAsn": 65000,
      "AccountId": "123456789012",
      "ClientPrivateIp": "172.16.0.5/30",
      "VirtualGatewayId": "vgw-12345678",
      "DirectLinkInterfaceName": "MyDirectLinkInterface",
      "DirectLinkId": "dxcon-12345678",
      "Mtu": 1500,
      "State": "available",
      "InterfaceType": "private",
      "Location": "PAR1"
    }
  ]
}

Getting Information About Your DirectLink Interfaces Using oapi-cli

The ReadDirectLinkInterfaces command lists one or more of your DirectLink interfaces.

Request sample
$ oapi-cli --profile "default" ReadDirectLinkInterfaces \
    --Filters '{
        "DirectLinkInterfaceIds": ["dxvif-12345678"]
      }'

This command contains the following attributes that you need to specify:

  • DryRun: (optional) If true, checks whether you have the required permissions to perform the action.

  • Filters: (optional) One or more filters.

    • DirectLinkIds: (optional) The IDs of the DirectLinks.

    • DirectLinkInterfaceIds: (optional) The IDs of the DirectLink interfaces.

  • NextPageToken: (optional) The token to request the next page of results. Each token refers to a specific page.

  • ResultsPerPage: (optional) The maximum number of logs returned in a single response (between 1 and 1000, both included). By default, 100.

The ReadDirectLinkInterfaces command returns the following elements:

  • DirectLinkInterfaces: Information about one or more DirectLink interfaces.

    • AccountId: The account ID of the owner of the DirectLink interface.

    • BgpAsn: The BGP (Border Gateway Protocol) ASN (Autonomous System Number) on the customer’s side of the DirectLink interface.

    • BgpKey: The BGP authentication key.

    • ClientPrivateIp: The IP on the customer’s side of the DirectLink interface.

    • DirectLinkId: The ID of the DirectLink.

    • DirectLinkInterfaceId: The ID of the DirectLink interface.

    • DirectLinkInterfaceName: The name of the DirectLink interface.

    • InterfaceType: The type of the DirectLink interface (always private).

    • Location: The datacenter where the DirectLink interface is located.

    • Mtu: The maximum transmission unit (MTU) of the DirectLink interface, in bytes (always 1500).

    • OutscalePrivateIp: The IP on the OUTSCALE side of the DirectLink interface.

    • State: The state of the DirectLink interface (pending | available | deleting | deleted | confirming | rejected | expired).

    • VirtualGatewayId: The ID of the target virtual gateway.

    • Vlan: The VLAN number associated with the DirectLink interface.

  • NextPageToken: The token to request the next page of results. Each token refers to a specific page.

  • ResponseContext: Information about the context of the response.

    • RequestId: The ID of the request.

Result sample
{
  "ResponseContext": {
    "RequestId": "0475ca1e-d0c5-441d-712a-da55a4175157"
  },
  "DirectLinkInterfaces": [
    {
      "Vlan": 101,
      "OutscalePrivateIp": "172.16.0.4/30",
      "DirectLinkInterfaceId": "dxvif-12345678",
      "BgpAsn": 65000,
      "AccountId": "123456789012",
      "ClientPrivateIp": "172.16.0.5/30",
      "VirtualGatewayId": "vgw-12345678",
      "DirectLinkInterfaceName": "MyDirectLinkInterface",
      "DirectLinkId": "dxcon-12345678",
      "Mtu": 1500,
      "State": "available",
      "InterfaceType": "private",
      "Location": "PAR1"
    }
  ]
}

Getting Information About Your Private Virtual Interfaces Using AWS CLI

Before you begin: Install and configure AWS CLI. For more information, see Installing and Configuring AWS CLI.

To get information about one or more of your private virtual interfaces, use the describe-virtual-interfaces command following this syntax:

Request sample
$ aws directconnect describe-virtual-interfaces \
    --profile YOUR_PROFILE \
    --connection-id dxcon-12345678 \
    --virtual-interface-id NOT_SPECIFIED \
    --endpoint https://directlink.eu-west-2.outscale.com

This command contains the following attributes that you need to specify:

  • (optional) profile: The named profile you want to use, created when configuring AWS CLI. For more information, see Installing and Configuring AWS CLI.

  • (optional) connection-id: The ID of a connection.

  • (optional) virtual-interface-id: The ID of a private virtual interface.

  • endpoint: The endpoint corresponding to the Region you want to send the request to. For more information, see Installing and Configuring AWS CLI.

The describe-virtual-interfaces command returns the following elements:

  • virtualInterfaces: Information about one or more private virtual interfaces. This element contains the following information:

    • virtualInterfaceState: The state of the virtual interface. For more information, see About DirectLink.

    • asn: The autonomous system number (ASN) for the Border Gateway Protocol (BGP) configuration on the customer side of the virtual interface.

    • vlan: The VLAN number associated with the virtual interface.

    • customerAddress: The IP on the customer side of the virtual interface.

    • ownerAccount: The account ID of the owner of the virtual interface.

    • connectionId: The ID of the connection.

    • virtualGatewayId: The target virtual private gateway.

    • authKey: The BGP authentication key.

    • location: The datacenter where the virtual interface is located.

    • amazonAddress: The IP on the OUTSCALE side of the virtual interface.

    • virtualInterfaceType: The type of the virtual interface (always private).

    • virtualInterfaceName: The name of the virtual interface.

Result sample
 {
    "virtualInterfaces": [
        {
            "virtualInterfaceState": "available",
            "asn": 65000,
            "vlan": 101,
            "customerAddress": "192.100.1.0/30",
            "ownerAccount": "12345678",
            "connectionId": "dxcon-aa00bb11cc22",
            "virtualGatewayId": "vgw-dd33ee44ff55",
            "virtualInterfaceId": "dxvif-gg66hh77ii88",
            "authKey": "asdf65sample",
            "location": "PAR1",
            "amazonAddress": "192.100.1.1/30",
            "virtualInterfaceType": "private",
            "virtualInterfaceName": "PrivateVirtualInterface"
        }
    ]
}

Related Pages

Corresponding API Methods

AWS™ and Amazon Web Services™ are trademarks of Amazon Technologies, Inc or its affiliates in the United States and/or other countries.

Export to PDF