Update the Advertisement Rules on a Logical Router

Modifies the advertisement rules on the specified logical
router. The PUT request must include all the rules with the networks parameter. Modifiable
parameters are networks, display_name, and description. Set the rules list to empty to delete/clear all rules.

Request:

Method:

PUT

URI Path(s):

/api/v1/logical-routers/<logical-router-id>/routing/advertisement/rules

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

AdvertiseRuleList+

AdvertiseRuleList (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
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 AdvertiseRuleList	string
rules	List of advertisement rules	array of AdvertiseRule	Minimum items: 0 Default: "[]"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

PUT https://<nsx-mgr>/api/v1/logical-routers/77c6a05e-5602-46bc-a511-62da18fa0afe/routing/advertisement/rules { "resource_type": "AdvertiseRuleList", "id": "77c6a05e-5602-46bc-a511-62da18fa0afe", "display_name": "77c6a05e-5602-46bc-a511-62da18fa0afe", "rules": [ { "description":"Advertise all East routes", "display_name":"East routes", "networks": [ "10.0.1.0/24", "10.0.2.0/24", "10.0.3.0/24" ], "rule_filter": { "prefix_operator": "GE", "match_route_types": ["ANY"] } } ], "_create_time": 1456445680356, "_last_modified_user": "admin", "_system_owned": false, "_last_modified_time": 1456445680356, "_create_user": "admin", "_revision": 0 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

AdvertiseRuleList+

AdvertiseRuleList (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
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 AdvertiseRuleList	string
rules	List of advertisement rules	array of AdvertiseRule	Minimum items: 0 Default: "[]"
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "resource_type": "AdvertiseRuleList", "id": "77c6a05e-5602-46bc-a511-62da18fa0afe", "display_name": "77c6a05e-5602-46bc-a511-62da18fa0afe", "rules": [ { "description": "Advertise all East routes", "networks": [ "10.0.1.0/24", "10.0.2.0/24", "10.0.3.0/24" ], "display_name": "East routes", "action": "ALLOW", "rule_filter": { "prefix_operator": "GE", "match_route_types": ["ANY"] } } ], "_last_modified_user": "admin", "_last_modified_time": 1457392997168, "_revision": 1 }

Update the Advertisement Rules on a Logical Router

Request:

AdvertiseRuleList (schema)

Example Request:

Successful Response:

AdvertiseRuleList (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: