List All Firewall Sections

List all firewall section in paginated form. A default page size is limited
to 1000 firewall sections. By default list of section is filtered by LAYER3
type.

Request:

Method:

GET

URI Path(s):

/api/v1/firewall/sections

Request Headers:

n/a

Query Parameters:

FirewallSectionFilterParameters+

FirewallSectionFilterParameters (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
context_profiles	Limits results to sections having rules with specific Context Profiles. The context profile value in Firewall Rules (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
deep_search	Toggle to search with direct or indirect references. This parameter allows firewall API to search and filter results when references in appliedtos are either directly used in rule/section or indirectly in another container which is used in rule/section. Currently param support is only for LogicalPort. Ignores search_invalid_references to reduce heavy check.	boolean	Default: "False"
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
enforced_on	Limit result to sections having a specific kind of enforcement point Used to filter out results based on enforcement point of the section. If this parameter is BRIDGEENDPOINT, then return firewall sections enfored on logical port with attachment type bridgeendpoint. For LOGICALROUTER, then firewall sections enforced on Logical Router are returned. For VIF, other firewall sections are returned. Other values are not supported.	AttachmentTypeQueryString
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
extended_sources	Limits results to sections having rules with specific Extended Sources. The extended source value in Firewall 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"
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
locked	Limit results to sections which are locked/unlocked Used to filter out locked or unlocked sections.	boolean
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
search_invalid_references	Return invalid references in results. Used in conjunction with filter_type to find invalid i.e. non nonexistent references in given criteria (sources, destinations, extended sources, services, context profiles, applied_tos).	boolean	Default: "False"
search_scope	Limit result to sections of a specific enforcement point This parameter can be used to limit the search scope to certain firewalls. It can be the value of an appliedTo of a bridge port firewall or an edge firewal. Results will include sections only from that bridge port firewall or edge firewall. For example, if the identifier of a bridge port is given, the search result will only contain the sections of that bridge port firewall. If the identifier of logical router is given, the search result will only contain the sections of that edge firewall.	string
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
type	Section Type Section Type with values layer2 or layer3	string	Enum: LAYER2, LAYER3 Default: "LAYER3"

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/firewall/sections

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

FirewallSectionListResult+

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 firewall sections. The list has to be homogenous.	array of FirewallSection	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-70728153642eFirewallSection", "sort_by": "position", "result_count": 2, "results": [ { "resource_type": "FirewallSection", "description": "protects app VMs", "id": "65a60890-6f48-418d-a7d5-5aaf65fc4e5b", "display_name": "app-firewall", "section_type": "LAYER3", "applied_tos": [ { "target_display_name": "app-switch", "is_valid": true, "target_type": "LogicalSwitch", "target_id": "1d9fb5cb-0344-4d7f-899a-afd93276899f" } ], "is_default": false, "stateful": true, "rule_count": 0, "locked": true, "comments": "Locked the section", "lock_modified_by": "admin", "lock_modified_time": "14458940331000", "_last_modified_user": "admin", "_system_owned": false, "_last_modified_time": 1445894033107, "_create_user": "admin", "_create_time": 1445894033107, "_revision": 0 }, { "resource_type": "FirewallSection", "id": "16a93c39-5822-469e-b0be-70728153642e", "display_name": "Default Layer3 Section", "section_type": "LAYER3", "is_default": true, "stateful": true, "rule_count": 1, "locked": true, "comments": "Locked the section", "lock_modified_by": "admin", "lock_modified_time": "1445888985070", "_last_modified_user": "system", "_system_owned": false, "_last_modified_time": 1445888985075, "_create_user": "system", "_create_time": 1445888985075, "_revision": 0 } ] }

List All Firewall Sections

Request:

FirewallSectionFilterParameters (schema)

Example Request:

Successful Response:

FirewallSectionListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: