BGPPeer

Information about a BGP peer.

addressFamily

The address family for the BGP peer.

Type: String

Valid Values: ipv4 | ipv6

Required: No

amazonAddress

The IP address assigned to the Amazon interface.

Type: String

Required: No

asn

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

Type: Integer

Required: No

authKey

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

Type: String

Required: No

awsDeviceV2

The Direct Connect endpoint that terminates the BGP peer.

Type: String

Required: No

awsLogicalDeviceId

The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

Type: String

Required: No

bgpPeerId

The ID of the BGP peer.

Type: String

Required: No

bgpPeerState

The state of the BGP peer. The following are the possible values:

verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
pending: The BGP peer is created, and remains in this state until it is ready to be established.
available: The BGP peer is ready to be established.
deleting: The BGP peer is being deleted.
deleted: The BGP peer is deleted and cannot be established.

Type: String

Valid Values: verifying | pending | available | deleting | deleted

Required: No

bgpStatus

The status of the BGP peer. The following are the possible values:

up: The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
down: The BGP peer is down.
unknown: The BGP peer status is not available.

Type: String

Valid Values: up | down | unknown

Required: No

customerAddress

The IP address assigned to the customer interface.

Type: String

Required: No

BGPPeer

Contents

See Also