Get Rules

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

Use the following Policy API -
GET /policy/api/v1/infra/domains/<domain-id>/security-policies/<security-policy-id>

Request

URI

GET

https://nsxmanager.your.domain/api/v1/firewall/sections/{section-id}/rules

COPY

Path Parameters

string

section-id

Required

section-id

Query Parameters

string

applied_tos

Optional

AppliedTo's referenced by this section or section's Distributed Service Rules .

string

context_profiles

Optional

Limits results to sections having rules with specific Context Profiles.

string

cursor

Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

boolean

deep_search

Optional

Constraints: default: false

Toggle to search with direct or indirect references.

string

destinations

Optional

Destinations referenced by this section's Distributed Service Rules .

string

extended_sources

Optional

Limits results to sections having rules with specific Extended Sources.

string

filter_type

Optional

Constraints: default: FILTER

Filter type

Possible values are : FILTER, SEARCH,

string

included_fields

Optional

Comma separated list of fields that should be included in query result

integer

page_size

Optional

Constraints: minimum: 0 maximum: 1000 default: 1000

Maximum number of results to return in this page (server may return fewer)

boolean

search_invalid_references

Optional

Constraints: default: false

Return invalid references in results.

string

services

Optional

NSService referenced by this section's Distributed Service Rules .

boolean

sort_ascending

Optional

sort_ascending

string

sort_by

Optional

Field by which records are sorted

string

sources

Optional

Sources referenced by this section's Distributed Service Rules .

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

Returns FirewallRuleListResult of type(s) application/json

This response body class contains all of the following: InlineFirewallRuleListResult1

{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {},
    "cursor": "string",
    "result_count": 0,
    "sort_ascending": false,
    "sort_by": "string",
    "results": [
        {
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_schema": "string",
            "_self": {},
            "_revision": 0,
            "_owner": {},
            "description": "string",
            "display_name": "string",
            "id": "string",
            "resource_type": "string",
            "action": "string",
            "applied_tos": [
                {
                    "is_valid": false,
                    "target_display_name": "string",
                    "target_id": "string",
                    "target_type": "string"
                }
            ],
            "destinations": [
                {
                    "is_valid": false,
                    "target_display_name": "string",
                    "target_id": "string",
                    "target_type": "string"
                }
            ],
            "destinations_excluded": false,
            "direction": "string",
            "disabled": false,
            "ip_protocol": "string",
            "is_default": false,
            "logged": false,
            "notes": "string",
            "priority": 0,
            "rule_tag": "string",
            "sources": [
                {
                    "is_valid": false,
                    "target_display_name": "string",
                    "target_id": "string",
                    "target_type": "string"
                }
            ],
            "sources_excluded": false,
            "context_profiles": [
                {
                    "is_valid": false,
                    "target_display_name": "string",
                    "target_id": "string",
                    "target_type": "string"
                }
            ],
            "extended_sources": [
                {
                    "is_valid": false,
                    "target_display_name": "string",
                    "target_id": "string",
                    "target_type": "string"
                }
            ],
            "section_id": "string",
            "services": [
                {
                    "is_valid": false,
                    "target_display_name": "string",
                    "target_id": "string",
                    "target_type": "string",
                    "service": {
                        "resource_type": "string"
                    }
                }
            ]
        }
    ]
}

400

Returns BadRequest of type(s) application/json