| _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. Note that
this type is applicable to be used in Hierarchical API only.
|
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 |
| enabled |
Flag to enable/disable BGP peering.
Flag to enable/disable BGP peering. Disabling will stop the BGP peering.
True - indicates enable BGP peering,
False - indicates disable BGP peering.
Default is True.
|
boolean |
Default: "True" |
| 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 |
| neighbor_local_as_config |
Local as configuration for BGP Neighbor
Configuration field to hold the Local AS config for BGP Neighbor
|
BgpNeighborLocalAsConfig |
|
| origin_site_id |
A unique identifier assigned by the system for knowing which site owns an object
This is a UUID generated by the system for knowing which site owns an object.
This is used in NSX+.
|
string |
Readonly |
| 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" |
| owner_id |
A unique identifier assigned by the system for the ownership of an object
This is a UUID generated by the system for knowing who owns this object.
This is used in NSX+.
|
string |
Readonly |
| 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.
|
secure_string |
Minimum length: 0
Maximum length: 32 |
| path |
Absolute path of this object
Absolute path of this object |
string |
Readonly |
| realization_id |
A unique identifier assigned by the system for realizing intent
This is a UUID generated by the system for realizing the entity object.
In most cases this should be same as 'unique_id' of the entity. However,
in some cases this can be different because of entities have migrated their
unique identifier to NSX Policy intent objects later in the timeline and did
not use unique_id for realization. Realization id is helpful for users to
debug data path to correlate the configuration with corresponding intent.
|
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 |
| remote_path |
Path of the object on the remote end.
This is the path of the object on the local managers when queried on the NSX+ service,
and path of the object on NSX+ service when queried from the local managers.
|
string |
Readonly |
| 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 or VTI 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
entities 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 |