Create BGP Routing

Required	Parameter Name	Type	Description
required	tier-0-id	string	Not available
required	locale-service-id	string	Not available

{
    "_create_time": 0,
    "_create_user": "string",
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_protection": "string",
    "_revision": 0,
    "_schema": "string",
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_system_owned": false,
    "children": [
        {
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_protection": "string",
            "_revision": 0,
            "_schema": "string",
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "marked_for_delete": false,
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ]
        }
    ],
    "description": "string",
    "display_name": "string",
    "ecmp": false,
    "enabled": false,
    "graceful_restart": false,
    "graceful_restart_config": {
        "mode": "string",
        "timer": {
            "restart_timer": 0,
            "stale_route_timer": 0
        }
    },
    "id": "string",
    "inter_sr_ibgp": false,
    "local_as_num": "string",
    "marked_for_delete": false,
    "multipath_relax": false,
    "parent_path": "string",
    "path": "string",
    "relative_path": "string",
    "resource_type": "string",
    "route_aggregations": [
        {
            "prefix": "string",
            "summary_only": false
        }
    ],
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ]
}

Required	Property Name	Type	Description
optional	_create_time	integer	Timestamp of resource creation
optional	_create_user	string	ID of the user who created this resource
optional	_last_modified_time	integer	Timestamp of last modification
optional	_last_modified_user	string	ID of the user who last modified this resource
optional	_links	array of ResourceLink	The server will populate this field when returing the resource. Ignored on PUT and POST.
optional	_protection	string	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.
optional	_revision	integer	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.
optional	_schema	string	Schema for this resource
optional	_self	SelfResourceLink	Link to this resource
optional	_system_owned	boolean	Indicates system owned resource
optional	children	array of ChildPolicyConfigResource	subtree for this type within policy tree containing nested elements.
optional	description	string	Description of this resource
optional	display_name	string	Defaults to ID if not set
optional	ecmp	boolean	Flag to enable ECMP.
optional	enabled	boolean	Flag to enable BGP configuration. Disabling will stop feature and BGP peering.
optional	graceful_restart	boolean	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.
optional	graceful_restart_config	BgpGracefulRestartConfig	Configuration field to hold BGP Restart mode and timer.
optional	id	string	Unique identifier of this resource
optional	inter_sr_ibgp	boolean	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.
optional	local_as_num	string	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.
optional	marked_for_delete	boolean	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.
optional	multipath_relax	boolean	Flag to enable BGP multipath relax option.
optional	parent_path	string	Path of its parent
optional	path	string	Absolute path of this object
optional	relative_path	string	Path relative from its parent
optional	resource_type	string	The type of this resource.
optional	route_aggregations	array of RouteAggregationEntry	List of routes to be aggregated.
optional	tags	array of Tag	Opaque identifiers meaningful to the API user

Response

Response Body

200 OK returns BgpRoutingConfig

{
    "_create_time": 0,
    "_create_user": "string",
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_protection": "string",
    "_revision": 0,
    "_schema": "string",
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_system_owned": false,
    "children": [
        {
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_protection": "string",
            "_revision": 0,
            "_schema": "string",
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "id": "string",
            "marked_for_delete": false,
            "resource_type": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ]
        }
    ],
    "description": "string",
    "display_name": "string",
    "ecmp": false,
    "enabled": false,
    "graceful_restart": false,
    "graceful_restart_config": {
        "mode": "string",
        "timer": {
            "restart_timer": 0,
            "stale_route_timer": 0
        }
    },
    "id": "string",
    "inter_sr_ibgp": false,
    "local_as_num": "string",
    "marked_for_delete": false,
    "multipath_relax": false,
    "parent_path": "string",
    "path": "string",
    "relative_path": "string",
    "resource_type": "string",
    "route_aggregations": [
        {
            "prefix": "string",
            "summary_only": false
        }
    ],
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ]
}

Property Name	Type	Description
_create_time	integer	Timestamp of resource creation
_create_user	string	ID of the user who created this resource
_last_modified_time	integer	Timestamp of last modification
_last_modified_user	string	ID of the user who last modified this resource
_links	array of ResourceLink	The server will populate this field when returing the resource. Ignored on PUT and POST.
_protection	string	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.
_revision	integer	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.
_schema	string	Schema for this resource
_self	SelfResourceLink	Link to this resource
_system_owned	boolean	Indicates system owned resource
children	array of ChildPolicyConfigResource	subtree for this type within policy tree containing nested elements.
description	string	Description of this resource
display_name	string	Defaults to ID if not set
ecmp	boolean	Flag to enable ECMP.
enabled	boolean	Flag to enable BGP configuration. Disabling will stop feature and BGP peering.
graceful_restart	boolean	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.
graceful_restart_config	BgpGracefulRestartConfig	Configuration field to hold BGP Restart mode and timer.
id	string	Unique identifier of this resource
inter_sr_ibgp	boolean	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.
local_as_num	string	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.
marked_for_delete	boolean	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.
multipath_relax	boolean	Flag to enable BGP multipath relax option.
parent_path	string	Path of its parent
path	string	Absolute path of this object
relative_path	string	Path relative from its parent
resource_type	string	The type of this resource.
route_aggregations	array of RouteAggregationEntry	List of routes to be aggregated.
tags	array of Tag	Opaque identifiers meaningful to the API user

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"_create_time":0,"_create_user":"string","_last_modified_time":0,"_last_modified_user":"string","_links":[{"action":"string","href":"string","rel":"string"}],"_protection":"string","_revision":0,"_schema":"string","_self":{"action":"string","href":"string","rel":"string"},"_system_owned":false,"children":[{"_create_time":0,"_create_user":"string","_last_modified_time":0,"_last_modified_user":"string","_links":[{"action":"string","href":"string","rel":"string"}],"_protection":"string","_revision":0,"_schema":"string","_self":{"action":"string","href":"string","rel":"string"},"_system_owned":false,"description":"string","display_name":"string","id":"string","marked_for_delete":false,"resource_type":"string","tags":[{"scope":"string","tag":"string"}]}],"description":"string","display_name":"string","ecmp":false,"enabled":false,"graceful_restart":false,"graceful_restart_config":{"mode":"string","timer":{"restart_timer":0,"stale_route_timer":0}},"id":"string","inter_sr_ibgp":false,"local_as_num":"string","marked_for_delete":false,"multipath_relax":false,"parent_path":"string","path":"string","relative_path":"string","resource_type":"string","route_aggregations":[{"prefix":"string","summary_only":false}],"tags":[{"scope":"string","tag":"string"}]}' https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/locale-services/{locale-service-id}/bgp

Errors

Code	Returns	Description
403	Forbidden	The server understood the request, but is refusing to fulfill it.
404	Nothing	The requested resource could not be found but may be available again in the future.
412	PreconditionFailed	Not available
500	InternalServerError	The server encountered an unexpected condition which prevented it from fulfilling the request.
503	ServiceUnavailable	The server is currently unavailable (because it is overloaded or down for maintenance).
400	BadRequest	The request cannot be fulfilled due to bad syntax.

Locale Services BGP Operations

put

Create BGP Neighbor Config

put

Create BGP Routing

delete

Delete BGP Neighbor Config

get

Get BGP Neighbor Advertised Routes

get

Get BGP Neighbor Advertised Routes CSV

get

Get BGP Neighbor Config

get

Get BGP Neighbor Routes

get

Get BGP Neighbor Routes CSV

get

Get BGP Routing

get

List BGP Neighbor Configs

patch

Update BGP Neighbor Config

patch

Update BGP Routing

Create BGP Routing

On This Page

Request

URL

Path Parameters

Request Body

Response

Response Body

cURL Command

Errors

On This Page

Locale Services BGP Operations

Was this page helpful?