Create or update a BGP neighbor config

If BGP neighbor config with the neighbor-id is not already present, create a new
neighbor config. If it already exists, replace the BGP neighbor config with this object.

Request:

Method:

PATCH

URI Path(s):

/policy/api/v1/infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>
/policy/api/v1/global-infra/tier-0s/<tier-0-id>/locale-services/<locale-service-id>/bgp/neighbors/<neighbor-id>

Request Headers:

n/a

Query Parameters:

OverrideRequestParameters+

Name	Description	Type	Notes
override	Locally override the global object If true, the global resource can be over written locally. This means that there will be a local only resource in place of the global resource that can reflect local specific settings and values. The global object will continue to exist but will not be used for any configuration until this local object is removed. When the object is overridden the Global resource continues to exist unmodified, while the overridden object is created with all of the user specified values. The Global resource may be updated in the background, however, the overridden object may only be updated by the user. Once the user removes the overridden copy, the Global resource will then resume being used in the configuration.	boolean	Default: "False"

Request Body:

BgpNeighborConfig+

BgpNeighborConfig (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
allow_as_in	Flag to enable allowas_in option for BGP neighbor	boolean	Default: "False"
bfd	BFD configuration for failure detection BFD configuration for failure detection. BFD is enabled with default values when not configured.	BgpBfdConfig
children	subtree for this type within policy tree subtree for this type within policy tree containing nested elements.	array of ChildPolicyConfigResource Children are not allowed for this type
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
graceful_restart_mode	BGP Graceful Restart Configuration Mode If mode is DISABLE, then graceful restart and helper modes are disabled. If mode is GR_AND_HELPER, then both graceful restart and helper modes are enabled. If mode is HELPER_ONLY, then helper mode is enabled. 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.	string	Enum: DISABLE, GR_AND_HELPER, HELPER_ONLY
hold_down_time	Wait time in seconds before declaring peer dead Wait time in seconds before declaring peer dead.	int	Minimum: 1 Maximum: 65535 Default: "180"
id	Unique identifier of this resource	string	Sortable
in_route_filters	Prefix-list or route map path for IN direction Specify path of prefix-list or route map to filter routes for IN direction. This property is deprecated, use route_filtering instead. Specifying different values for both properties will result in error.	array of string	Deprecated Maximum items: 1
keep_alive_time	Interval between keep alive messages sent to peer Interval (in seconds) between keep alive messages sent to peer.	int	Minimum: 1 Maximum: 65535 Default: "60"
marked_for_delete	Indicates whether the intent object is marked for deletion Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects.	boolean	Readonly Default: "False"
maximum_hop_limit	Maximum number of hops allowed to reach BGP neighbor Maximum number of hops allowed to reach BGP neighbor.	int	Minimum: 1 Maximum: 255 Default: "1"
neighbor_address	Neighbor IP Address	IPAddress	Required
out_route_filters	Prefix-list or route map path for OUT direction Specify path of prefix-list or route map to filter routes for OUT direction. When not specified, a built-in prefix-list named 'prefixlist-out-default' is automatically applied. This property is deprecated, use route_filtering instead. Specifying different values for both properties will result in error.	array of string	Deprecated Maximum items: 1
overridden	Indicates whether this object is the overridden intent object Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties.	boolean	Readonly Default: "False"
parent_path	Path of its parent Path of its parent	string	Readonly
password	Password Specify password for BGP neighbor authentication. Empty string ("") clears existing password.	string	Minimum length: 0 Maximum length: 20
path	Absolute path of this object Absolute path of this object	string	Readonly
relative_path	Relative path of this object Path relative from its parent	string	Readonly
remote_as_num	4 Byte ASN of the neighbor in ASPLAIN Format	string	Required
resource_type	Must be set to the value BgpNeighborConfig	string
route_filtering	Enable address families and route filtering in each direction Enable address families and route filtering in each direction.	array of BgpRouteFiltering	Maximum items: 2
source_addresses	Source IP Addresses for BGP peering Source addresses should belong to Tier0 external or loopback interface IP Addresses . BGP peering is formed from all these addresses. This property is mandatory when maximum_hop_limit is greater than 1.	array of IPAddress	Maximum items: 8
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
unique_id	A unique identifier assigned by the system This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites.	string	Readonly

Example Request:

PATCH https://<policy-mgr>/policy/api/v1/infra/tier-0s/vmc_prv/locale-services/default/bgp/neighbors/peer1 { "neighbor_address": "1.2.3.4", "remote_as_num": "12", "password":"test", "in_route_filters": [ "/infra/tier-0s/vmc/prefix-lists/plist-1" ], "keep_alive_time": 60, "graceful_restart_mode" : "DISABLE", "bfd": { "multiplier": 4, "interval": 5000 } }

Successful Response:

Response Code:

200 OK

Response Headers:

n/a

Response Body:

n/a

Example Response:

200 OK

Required Permissions:

crud

Feature:

policy_t0

Create or update a BGP neighbor config

Request:

OverrideRequestParameters (schema)

BgpNeighborConfig (schema)

Example Request:

Successful Response:

Example Response:

Required Permissions:

Feature:

Additional Errors: