3.1.5.17.2 bgpRouters

The bgpRouters resource contains the configuration needed for the BGP router in the virtual gateway to connect to BGP routers outside the virtual network in order to exchange routing information.

It is invoked through the following URI.

 https://<url>/networking/v1/VirtualGateways/{parentResourceId}/bgpRouters/{resourceId}

url: The address or name of the REST server of the Network Controller.

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, besides v1 in the URI.

The following HTTP methods can be performed on this resource.

HTTP method

Section

Description

PUT

3.1.5.17.2.1.1

Create or update a bgpRouters resource.

GET

3.1.5.17.2.1.2

Get a bgpRouters resource.

GET ALL

3.1.5.17.2.1.3

List all bgpRouters resources in the Network Controller.

DELETE

3.1.5.17.2.1.4

Deletes a bgpRouters 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.

isEnabled

Reserved for future use.

requireIGPSync

Read/write

If this is set to TRUE, BGP will not advertise a route before all routers in an Autonomous System (AS) learn about the route via IGP. BGP waits until IGP propagates the route within the AS and then advertises it to external peers.

extAsNumber

Read/write

Extended (4-byte) ASN of the local BGP Router in XX.YY format.

routerId

Read/write

Indicates Router ID.

routerIP

Read/write

Indicates an array of IP addresses to which BGP peering can be established.

isGenerated

Read-only

If this BGP router is automatically enabled, without making any REST calls then isGenerated is set to TRUE.

bgpPeers

Read/write

Collection array of BGP peers associated with the bgpRouters resource. See section 3.1.5.17.2.2 for details.

configurationState

Optional

Read-only

Indicates the last known running state of this router.

See specification in section 2.2.4.

More details are given in the section for the GET operation section 3.1.5.17.2.1.2.