Get All the Rules for a Section

Return all PBR rule(s) information for a given PBR section.

Request:

Method:

GET

URI Path(s):

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

Request Headers:

n/a

Query Parameters:

PBRListRequestParameters+

PBRListRequestParameters (schema)

Name	Description	Type	Notes
applied_tos	AppliedTo's referenced by this section or section's Distributed Service Rules . Where the Distributed Service Rules are applied.(used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
destinations	Destinations referenced by this section's Distributed Service Rules . The destination value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.	string
filter_type	Filter type Filter type defines matching criteria to qualify a rule in result. Type 'FILTER' will ensure all criterias (sources, destinations, services, extended sources, context profiles, appliedtos) are matched. Type 'SEARCH' will match any of the given criteria.	string	Enum: FILTER, SEARCH Default: "FILTER"
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
services	NSService referenced by this section's Distributed Service Rules . Specifying this returns the Rules where this NSServiceElement is used (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.	string
sort_ascending		boolean
sort_by	Field by which records are sorted	string
sources	Sources referenced by this section's Distributed Service Rules . The source value in Distributed Service Rules (used for filtering the list). Single value is supported in current release. Multiple Comma delmited values may be supported in future releases.	string

Request Body:

n/a

Example Request:

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

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PBRRuleListResult+

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
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	PBR rule list result PBR rule list result with pagination support.	array of PBRRule	Required Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "cursor": "003600000000-0000-0000-0000-0000000000022305843009213694015", "sort_by": "priority", "result_count": 2, "results": [ { "id": "1430528", "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": 0 }, { "id": "1430529", "display_name": "PBR-S3-vpc-5b4cf63d", "sources": [ { "target_display_name": "S3", "is_valid": true, "target_type": "IPSet", "target_id": "abcbbc9f-6eae-4009-b709-532820dbba2a" } ], "logged": false, "action": "ROUTE_TO_UNDERLAY_NAT", "disabled": false, "_revision": 0 } ], }

Get All the Rules for a Section

Request:

PBRListRequestParameters (schema)

Example Request:

Successful Response:

PBRRuleListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: