BgpConfig (schema)

BGP configuration for logical router

BGP configuration for Tier0 logical router. We create BGP configuration
while creation of Tier0 logical router.
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
as_num 4 Byte ASN in ASPLAIN/ASDOT Format

For VRF logical router, the as_num from parent logical router will be effective.
string
as_number Autonomous System Number

This is a deprecated property, Please use 'as_num' instead. For VRF logical router, the as_number from parent logical router will be effective.
integer Deprecated
Minimum: 1
Maximum: 4294967296
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 outbound ECMP

While creation of BGP config this flag will be set to true
User can change this value while updating BGP config. If this property
is not specified in the payload, the default value will be considered
as true.
boolean Default: "True"
enabled Flag to enable this configuration

While creation of BGP config this flag will be set to
- true for Tier0 logical router with Active-Active high-availability
mode
- false for Tier0 logical router with Active-Standby high-availanility
mode.
User can change this value while updating the config. If this
property is not specified in the payload, the default value will be
considered as false irrespective of the high-availability mode.
boolean Default: "False"
graceful_restart Flag to enable graceful restart

Flag to enable graceful restart. This field is deprecated, kindly 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. For VRF logical router,
the settings from parent logical router will be effective.
boolean Deprecated
graceful_restart_config BGP Graceful Restart configuration

Configuration parameters for BGP Graceful Restart functionality.
It has graceful_restart_mode and graceful_restart_timer parameters.
For VRF logical router, the settings from parent logical router will be effective.
GracefulRestartConfig
id Unique identifier of this resource string Sortable
inter_sr_ibgp Inter SR IBGP configuration InterSRRoutingConfig
logical_router_id Logical router id string Readonly
multipath_relax Flag to enable BGP multipath relax option.

For TIER0 logical router, default is true. For VRF logical router, the settings from parent logical router will be effective.
boolean
resource_type Must be set to the value BgpConfig string
route_aggregation List of routes to be aggregated array of BgpRouteAggregation Minimum items: 0
Maximum items: 1000
tags Opaque identifiers meaningful to the API user array of Tag Maximum items: 30