EdgeBgpNeighbor
A BGP neighbor configuration.
Properties
The IP address of the BGP neighbor. Both IPv4 and IPv6 formats are supported.
The remote AS number of a BGP neighbor in ASPLAIN format.
A flag indicating whether AllowAS-in is enabled or not. This specifies whether BGP neighbors can receive routes with same AS.
Specifies the time interval (in seconds) before declaring a peer dead.
The unique id of this BGP neighbor. On updates, the id is required for the object, while for create a new id will be generated. This id is not a VCD URN.
Specifies route filtering configuration for the BGP neighbor in IN direction. It is the reference to the prefix list, indicating which routes to filter for IN direction. Not specifying a value will be treated as “no IN route filters”.
Specifies IP address type based filtering in each direction. Setting the value to ‘DISABLED’ will disable address family based filtering.
Possible values are: IPV4 , IPV6 , DISABLED
Specifies the time interval (in seconds) between keep alive messages sent to peer.
Describes Graceful Restart configuration Modes for BGP configuration on an edge gateway. HELPER_ONLY mode is the ability for a BGP speaker to indicate its ability to preserve forwarding state during BGP restart. GRACEFUL_RESTART mode is the ability of a BGP speaker to advertise its restart to its peers.
- DISABLE - Both graceful restart and helper modes are disabled.
- HELPER_ONLY - Only helper mode is enabled.
- GRACEFUL_AND_HELPER - Both graceful restart and helper modes are enabled.
Possible values are: DISABLE , HELPER_ONLY , GRACEFUL_AND_HELPER
Password for BGP neighbor authentication. Empty string ("") clears existing password. Not specifying a value will be treated as “no password”.
Specifies route filtering configuration for the BGP neighbor in OUT direction. It is the reference to the prefix list, indicating which routes to filter for OUT direction. Not specifying a value will be treated as “no OUT route filters”.
Specifies the BFD configuration for failure detection. Not specifying a value results in default bahavior.
This property describes the current version of the entity. To prevent clients from overwriting each other’s changes, update operations must include the version which can be obtained by issuing a GET operation. If the version number on an update call is missing, the operation will be rejected. This is only needed on update calls.
JSON Example
{
"neighborAddress": "10.22.1.100",
"remoteASNumber": "65546"
}
Vendor Extensions
x-vcloud-property-annotations:
allowASIn:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
bfd:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
gracefulRestartMode:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
holdDownTimer:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
id:
x-vcloud-constraints:
- constraint: ReadOnly
- constraint: NonSearchable
- constraint: NonSortable
inRoutesFilterRef:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
ipAddressTypeFiltering:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
keepAliveTimer:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
neighborAddress:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
- args:
- arg: IPV4_IP
- arg: IPV6_IP
constraint: NetworkAddress
neighborPassword:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
x-vcloud-password: true
outRoutesFilterRef:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
remoteASNumber:
x-vcloud-constraints:
- constraint: NonSearchable
- constraint: NonSortable
Availability
Property Of
EdgeBgpNeighbors
Parameter To
Update BGP Neighbor
Create BGP Neighbor
Returned By
Get BGP Neighbor
