[ aws . directconnect ]

describe-router-configuration

Description

Details about the router.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-router-configuration
--virtual-interface-id <value>
[--router-type-identifier <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--virtual-interface-id (string)

The ID of the virtual interface.

--router-type-identifier (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

customerRouterConfig -> (string)

The customer router configuration.

router -> (structure)

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)

The name of the virtual interface assigned by the customer network.