BgpRoutingConfig (schema)

BGP routing config

Contains BGP routing configuration.
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
children subtree for this type within policy tree

subtree for this type within policy tree containing nested elements.
array of ChildPolicyConfigResource
(Abstract type: pass one of the following concrete types)
ChildBgpNeighborConfig
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
ecmp Flag to enable ECMP

Flag to enable ECMP.
boolean
enabled Flag to enable BGP configuration

Flag to enable BGP configuration. Disabling will stop feature and
BGP peering.
boolean
graceful_restart Flag to enable graceful restart

Flag to enable graceful restart. This field is deprecated, please use
graceful_restart_config parameter for graceful restart configuration.
If both parameters are set and consistent with each other
(i.e. graceful_restart=false and graceful_restart_mode=HELPER_ONLY OR
graceful_restart=true and graceful_restart_mode=GR_AND_HELPER)
then this is allowed, but if inconsistent with each other then this
is not allowed and validation error will be thrown.
boolean Deprecated
graceful_restart_config BGP Graceful Restart Configuration

Configuration field to hold BGP Restart mode and timer.
BgpGracefulRestartConfig
id Unique identifier of this resource string Sortable
inter_sr_ibgp Enable inter SR IBGP configuration

Flag to enable inter SR IBGP configuration.
When not specified, inter SR IBGP is automatically enabled if Tier-0
is created in ACTIVE_ACTIVE ha_mode.
boolean
local_as_num BGP AS number in ASPLAIN/ASDOT Format

Specify BGP AS number for Tier-0 to advertize to BGP peers.
AS number can be specified in ASPLAIN (e.g., "65546") or
ASDOT (e.g., "1.10") format. Empty string disables BGP feature.
It is required by normal tier0 but not required in vrf tier0.
string
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"
multipath_relax Flag to enable BGP multipath relax option

Flag to enable BGP multipath relax option.
boolean
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
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
resource_type Must be set to the value BgpRoutingConfig string
route_aggregations List of routes to be aggregated

List of routes to be aggregated.
array of RouteAggregationEntry Maximum items: 1000
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