Get Group Related Dfw Rules

Get DFW rules and policies related to a group

Returns DFW rules organized by parent security policies for the specified NSX group. Each result entry is a security policy containing its list of related DFW rules.

Notes:

start_time is required. Either site_id or site_ids must also be provided.
relationship_type: CONTAINS (default) returns rules whose applied-to scope either explicitly references the group or is unset (ANY), and whose source or destination scope either explicitly references the group, is unset (ANY), or contains an IP range that covers the group's member compute IPs. This includes globally-scoped rules that apply to all workloads.
relationship_type: EFFECTIVE_MEMBERS returns rules affecting individual VMs within the group rather than the group directly.
When both policy-level and rule-level applied-to are set, the policy-level applied-to takes precedence.
filters accepts up to 300 filter entries.
Obtain group-id from the group topology graph returned by POST /visualization/topology/groups-flow-topology, where each node represents a group.
The group-id is the NSX realization UUID of the group, not its policy path or display name.
To see flow records for this group, use POST /visualization/flow-analysis/groups/{group-id}/flow-details.

Request

URI

POST

https://{api_host}/intelligence/visualization/security-analysis/groups/{group-id}/related-dfw-rules

COPY

Path Parameters

string

group-id

Required

The NSX group realization ID. Obtain valid IDs from POST /visualization/topology/groups-flow-topology, where each node in the topology graph represents a group and carries its ID.

Request Body

Wrapper request for GroupIdRelatedDfwRules with restricted filter keys

VizGroupIdRelatedDfwRulesRequest of type(s) application/json

Required

This request body class requires all of the following: VizTimeIntervalListSiteRequest , InlineVizGroupIdRelatedDfwRulesRequest1

{
    "start_time": 0,
    "page_size": 10000,
    "site_id": "17f7c7e5-7f8c-490a-97e9-b9c9193c45e1"
}

Authentication

This operation uses the following authentication methods.

Responses

200

success

Returns RelatedDfwRuleListResult of type(s) application/json

This response body class contains all of the following: VizTimeIntervalListResult , InlineRelatedDfwRuleListResult1

{
    "offset": 0,
    "number_of_results": 10,
    "total_result_count": 10,
    "total_pages": 1,
    "time_interval": {
        "start_time": 0,
        "end_time": 1782178627104
    },
    "results": [
        {
            "site_id": "17f7c7e5-7f8c-490a-97e9-b9c9193c45e1",
            "policy_path": "/infra/domains/default/security-policies/default-layer2-section",
            "related_rules": [
                {
                    "policy_path": "/infra/domains/default/security-policies/default-layer2-section/rules/default-layer2-rule"
                }
            ]
        }
    ]
}

400

Bad Request

Returns BadRequest of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

401

Unauthorized

Returns Unauthorized of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

403

Forbidden

Returns Forbidden of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

412

Precondition Failed

Returns PreconditionFailed of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

428

Precondition Required

Returns PreconditionRequired of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

429

Too Many Requests

Returns TooManyRequests of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

default

Error

Returns Error of type(s) application/json

{
    "error_code": 0,
    "module_name": "string",
    "error_message": "string"
}

integer

error_code

Required

HTTP Status or Application error code.

string

module_name

Optional

Module where the error happened.

string

error_message

Required

Message describing the error.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/intelligence/visualization/security-analysis/groups/{group-id}/related-dfw-rules

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Security Explorer Operations

POST

Get App Flow Details