Read an Existing Rule

Return existing PBR rule information in a PBR section.

Request:

Method:

GET

URI Path(s):

/api/v1/pbr/sections/<section-id>/rules/<rule-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/pbr/sections/16a93c39-5822-469e-b0be-70728153642e/rules/111616

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PBRRule+

PBRRule (schema)

Name	Description	Type	Notes
_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
_owner	Owner of this resource	OwnerResourceLink	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
action	Action Action enforced on the packets which matches the PBR rule.	string	Required Enum: ROUTE_TO_UNDERLAY_NAT, ROUTE_TO_OVERLAY_NAT, ROUTE_TO_UNDERLAY, ROUTE_TO_OVERLAY, ROUTE_FROM_OVERLAY, ROUTE_FROM_UNDERLAY
applied_tos	AppliedTo List List of object where rule will be enforced. field overrides this one. Null will be treated as any.	array of ResourceReference	Maximum items: 128
description	Description of this resource	string	Maximum length: 1024 Sortable
destinations	Destination List List of the destinations. Null will be treated as any.	array of ResourceReference	Maximum items: 128
disabled	Rule enable/disable flag Flag to disable rule. Disabled will only be persisted but never provisioned/realized.	boolean	Default: "False"
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	Identifier of the resource	string	Readonly
logged	Enable logging flag Flag to enable packet logging. Default is disabled.	boolean	Default: "False"
notes	Notes User notes specific to the rule.	string	Maximum length: 2048
resource_type	Must be set to the value PBRRule	string
rule_tag	Tag User level field which will be printed in CLI and packet logs.	string	Maximum length: 32
services	Service List List of the services. Null will be treated as any.	array of PBRService	Maximum items: 128
sources	Source List List of sources. Null will be treated as any.	array of ResourceReference	Maximum items: 128

Example Response:

{ "id": "111616", "display_name": "PBR-RDS-vpc-5b4cf63d", "destinations": [ { "target_display_name": "RDS-vpc-5b4cf63d", "is_valid": true, "target_type": "IPSet", "target_id": "96ebbc9f-6eae-4009-b709-532820dbba2a" } ], "logged": false, "action": "ROUTE_TO_UNDERLAY_NAT", "disabled": false, "_revision": 3 }

Read an Existing Rule

Request:

Example Request:

Successful Response:

PBRRule (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: