DirectConnect / Client / describe_router_configuration

describe_router_configuration#

DirectConnect.Client.describe_router_configuration(**kwargs)#

Details about the router.

See also: AWS API Documentation

Request Syntax

response = client.describe_router_configuration(
    virtualInterfaceId='string',
    routerTypeIdentifier='string'
)
Parameters:

  • virtualInterfaceId (string) –

    [REQUIRED]

    The ID of the virtual interface.

  • routerTypeIdentifier (string) – Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124.

Return type:

dict

Returns:

Response Syntax

{
    'customerRouterConfig': 'string',
    'router': {
        'vendor': 'string',
        'platform': 'string',
        'software': 'string',
        'xsltTemplateName': 'string',
        'xsltTemplateNameForMacSec': 'string',
        'routerTypeIdentifier': 'string'
    },
    'virtualInterfaceId': 'string',
    'virtualInterfaceName': 'string'
}

Response Structure

  • (dict) –

    • customerRouterConfig (string) –

      The customer router configuration.

    • router (dict) –

      The details about the router.

      • vendor (string) –

        The vendor for the virtual interface’s router.

      • platform (string) –

        The virtual interface router platform.

      • software (string) –

        The router software.

      • xsltTemplateName (string) –

        The template for the virtual interface’s router.

      • xsltTemplateNameForMacSec (string) –

        The MAC Security (MACsec) template for the virtual interface’s router.

      • routerTypeIdentifier (string) –

        Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124.

    • virtualInterfaceId (string) –

      The ID assigned to the virtual interface.

    • virtualInterfaceName (string) –

      Provides the details about a virtual interface’s router.

Exceptions

  • DirectConnect.Client.exceptions.DirectConnectServerException

  • DirectConnect.Client.exceptions.DirectConnectClientException