Update a specific BGP community list from a logical router

Update a specific BGP community list from a Logical Router

Request:

Method:

PUT

URI Path(s):

/api/v1/logical-routers/<logical-router-id>/routing/bgp/community-lists/<community-list-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

BGPCommunityList+

BGPCommunityList (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
communities	BGP community list Array of BGP communities	array of string	Required
community_type	BGP community type BGP community type. It has two types as NormalBGPCommunity BGP normal community which includes well-known community name as well as community value in range from [1-4294967295] or value in aa:nn format(aa/nn range from 1-65535). LargeBGPCommunity BGP large community which includes community value in aa:bb:nn format where aa, bb, nn are unsigned integers in the range [1-4294967295].	string	Enum: NormalBGPCommunity, LargeBGPCommunity Default: "NormalBGPCommunity"
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
id	Unique identifier of this resource	string	Sortable
logical_router_id	Logical router id	string	Readonly
resource_type	Must be set to the value BGPCommunityList	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

PUT https://<nsx-mgr>/api/v1/logical-routers/7a62a0c5-1ea1-4b25-9d43-dce1c0fa4b8c/routing/bgp/community-lists/640912b0-4820-46f0-b7c2-7a9e2cb57505 { "_revision": 1, "communities": ["10:50","10:52"], "community_type": "NormalBGPCommunity" }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

BGPCommunityList+

BGPCommunityList (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
communities	BGP community list Array of BGP communities	array of string	Required
community_type	BGP community type BGP community type. It has two types as NormalBGPCommunity BGP normal community which includes well-known community name as well as community value in range from [1-4294967295] or value in aa:nn format(aa/nn range from 1-65535). LargeBGPCommunity BGP large community which includes community value in aa:bb:nn format where aa, bb, nn are unsigned integers in the range [1-4294967295].	string	Enum: NormalBGPCommunity, LargeBGPCommunity Default: "NormalBGPCommunity"
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
id	Unique identifier of this resource	string	Sortable
logical_router_id	Logical router id	string	Readonly
resource_type	Must be set to the value BGPCommunityList	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "id": "640912b0-4820-46f0-b7c2-7a9e2cb57505", "resource_type": "BGPCommunityList", "communities": ["10:50","10:52"], "community_type": "NormalBGPCommunity", "_last_modified_user": "admin", "_last_modified_time": 1433949148014, "_create_time": 1433949148014, "_create_user": "admin", "_revision": 2 }

Update a specific BGP community list from a logical router

Request:

BGPCommunityList (schema)

Example Request:

Successful Response:

BGPCommunityList (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: