NSX-T Data Center REST API
FirewallListRequestParameters (schema)
Parameters to filter list of sections/rules.
Pagination and Filtering parameters to get only a subset of sections/rules.
| 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 | |
| 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" |
| included_fields | Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs. |
string | |
| 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" |
| 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 |