List All PBR Sections

List all PBR section in paginated form. A default page size is limited
to 1000 PBR sections.

Request:

Method:

GET

URI Path(s):

/api/v1/pbr/sections

Request Headers:

n/a

Query Parameters:

PBRSectionFilterParameters+

PBRSectionFilterParameters (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
exclude_applied_to_type	Limit result to sections not having a specific AppliedTo type Used to filter out sections not having a specified AppliedTo target type. This parameter cannot be used along with include_applied_to_type parameter. Section filter only takes a single value for this param.	DSAppliedToType
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"
include_applied_to_type	Limit result to sections having a specific AppliedTo type Used to filter out results based on target type of a section's AppliedTo. Only sections with matching target type in its applied to will be returned. This parameter cannot be used along with exclude_applied_to_type parameter.Section filter only takes a single value for this param.	DSAppliedToType
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

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PBRSectionListResult+

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	Section list List of the PBR sections.	array of PBRSection	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": "003616a93c39-5822-469e-b0be-70728153642ePBRSection", "sort_by": "position", "result_count": 2, "results": [ { "resource_type": "PBRSection", "description": "Distributed access to cloud services VPC vpc-5b4cf63d", "id": "65a60890-6f48-418d-a7d5-5aaf65fc4e5b", "display_name": "DS-PBR-vpc-5b4cf63d", "rule_count": 0, "_last_modified_user": "system", "_system_owned": true, "_last_modified_time": 1445894033107, "_create_user": "system", "_create_time": 1445894033107, "_revision": 0 }, { "resource_type": "PBRSection", "id": "16a93c39-5822-469e-b0be-70728153642e", "display_name": "DS-PBR-vpc-c003b7a6", "rule_count": 1, "_last_modified_user": "system", "_system_owned": true, "_last_modified_time": 1445888985075, "_create_user": "system", "_create_time": 1445888985075, "_revision": 0 } ] }

List All PBR Sections

Request:

PBRSectionFilterParameters (schema)

Example Request:

Successful Response:

PBRSectionListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: