3.1.5.17.2.2 bgpPeers
The bgpPeers resource configures BGP peers of the VirtualGateways resource.
The peer is identified by resourceId and asNumber.
A Virtual Routing and Forwarding (VRF) context can be specified on devices that support VRF. The routeMapIn and routeMapOut properties can specify a policy map that controls the route updates that are associated with the BGP peer.
It is invoked through the following URI.
-
https://<url>/networking/v1/VirtualGateways/{grandParentResourceId}/bgpRouters/ {parentResourceId}/bgpPeers/{resourceId}
url: The address or name of the REST server of the Network Controller.
grandParentResourceId: the identifier for the specific ancestor of the ancestor resource within the resource type. See section 2.2.3.1 for more details.
parentResourceId: the identifier for the specific ancestor resource within the resource type. See section 2.2.3.3 for more details.
resourceId: the identifier for the specific descendant resource within the resource type. See section 2.2.3.4 for more details.
Note The server MAY support additional versions, v1 or later, in the URI.
The following HTTP methods can be performed on this resource.
|
HTTP method |
Section |
Description |
|---|---|---|
|
PUT |
Create or update a bgpPeers resource. |
|
|
GET |
Get a bgpPeers resource. |
|
|
GET ALL |
List all bgpPeers resources in the Network Controller. |
|
|
DELETE |
Deletes a bgpPeers resource. |
The following property elements are valid.
|
Element name |
Type |
Description |
|---|---|---|
|
etag |
Read-only |
Specified in Common JSON Elements, section 2.2.2. |
|
provisioningState |
Read-only |
Specified in Common JSON Elements, section 2.2.2. |
|
resourceId |
Read-only |
Indicates identifier of BGP peer. |
|
asNumber |
Read-only |
Indicates the ASN number of the BGP Peer. |
|
extAsNumber |
Read/write |
Indicates extended ASN number of the BGP Peer in XX.YY format. |
|
peerIpAddress |
Read/write |
IP address of the peer. |
|
connectionState |
Read-only |
Status of BGP peering for this peer. Possible values are Connected and Disconnected. |
|
statistics |
Read-only |
Provides statistics for this peer. |
|
statistics.tcpConnectionEstablished |
Read-only |
Timestamp of TCP connection establishment for BGP. |
|
statistics.tcpConnectionClosed |
Read-only |
Timestamp when the TCP connection was closed. |
|
statistics.openMessageStats |
Read-only |
Stats for open messages. |
|
statistics.openMessageStats.lastsent |
Read-only |
Last sent timestamp. |
|
statistics.openMessageStats.lastReceived |
Read-only |
Last received timestamp. |
|
statistics.openMessageStats.sentCount |
Read-only |
Sent count. |
|
statistics.openMessageStats.receivedCount |
Read-only |
Received count. |
|
statistics.notificationMessageStats |
Read-only |
Stats for notification messages. |
|
statistics.notificationMessageStats.sentCount |
Read-only |
Sent count. |
|
statistics.notificationMessageStats.receivedCount |
Read-only |
Received count. |
|
statistics.keepAliveMessageStats |
Read-only |
Stats for keepalive messages. |
|
statistics.keepAliveMessageStats.lastSent |
Read-only |
Last sent timestamp. |
|
statistics.keepAliveMessageStats.lastReceived |
Read-only |
Last received timestamp. |
|
statistics.keepAliveMessageStats.sentCount |
Read-only |
Sent count. |
|
statistics.keepAliveMessageStats.receivedCount |
Read-only |
Received count. |
|
statistics.routeRefreshMessageStats |
Read-only |
Stats for route refresh messages. |
|
statistics.routeRefreshMessageStats.sentCount |
Read-only |
Sent count. |
|
statistics.routeRefreshMessageStats.receivedCount |
Read-only |
Received count. |
|
statistics.updateMessageStats |
Read-only |
Stats for update messages. |
|
statistics.updateMessageStats.lastReceived |
Read-only |
Last received timestamp. |
|
statistics.updateMessageStats.sentCount |
Read-only |
Sent count. |
|
statistics.updateMessageStats.receivedCount |
Read-only |
Received count. |
|
statistics.ipv4Route |
Read-only |
Stats for IPv4 routes. |
|
statistics.ipv4Route.updateSentCount |
Read-only |
Route update sent count. |
|
statistics.ipv4Route.updateReceivedCount |
Read-only |
Route update received count. |
|
statistics.ipv4Route.withdrawlSentCount |
Read-only |
Route withdrawal sent count. |
|
statistics.ipv4Route.withdrawlReceivedCount |
Read-only |
Route withdrawal received count. |
|
statistics.ipv6Route |
Read-only |
Stats for IPv6 routes. |
|
statistics.ipv6Route.updateSentCount |
Read-only |
Route update sent count. |
|
statistics.ipv6Route.updateReceivedCount |
Read-only |
Route update received count. |
|
statistics.ipv6Route.withdrawlSentCount |
Read-only |
Route withdrawal sent count. |
|
statistics.ipv6Route.withdrawlReceivedCount |
Read-only |
Route withdrawal received count. |
|
Statistics.lastUpdated |
Read-only |
Time stamp when the stats were last updated. |
|
policyMapOut |
Read/write |
Reference to the policy map object that is used to filter the routing updates sent to the peer. |
|
policyMapIn |
Read/write |
Reference to the policy map object that is used to filter routing updates received from the peer. |
|
isGenerated |
Read-only |
This flag is set to TRUE for internal BGP (iBGP) peers. |
|
configurationState |
Optional |
See configurationState in section 2.2.4. More details are given in the section for the GET operation section 3.1.5.17.2.2.1.2. |