Get Section | NSX-T Data Center REST API

Get Section

Get an Existing Section

Request

URI

GET

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

COPY

Path Parameters

string

section-id

Required

section-id

Authentication

This operation uses the following authentication methods.

basicAuth

Responses

200

Success

Returns FirewallSection of type(s) application/json

{
    "_self": {
        "rel": "string"
    },
    "stateful": false,
    "_system_owned": false,
    "display_name": "string",
    "description": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ],
    "section_type": "string",
    "applied_tos": [
        {
            "target_display_name": "string",
            "is_valid": false,
            "target_id": "string",
            "target_type": "string"
        }
    ],
    "rule_count": 0,
    "_schema": "string",
    "is_default": false,
    "_create_time": 0,
    "_create_user": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_revision": 0,
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "id": "string",
    "resource_type": "string"
}

SelfResourceLink

_self

Optional

_self

boolean

stateful

Required

Stateful or Stateless nature of firewall section is enforced on all rules inside the section. Layer3 sections can be stateful or stateless. Layer2 sections can only be stateless.

boolean

_system_owned

Optional

Indicates system owned resource

string

display_name

Optional

Defaults to ID if not set

string

description

Optional

description

array of Tag

tags

string

section_type

Required

Type of the rules which a section can contain. Only homogeneous sections are supported.

Possible values are : LAYER2, LAYER3,

array of ResourceReference

applied_tos

Optional

List of objects where the rules in this section will be enforced. This will take precedence over rule level appliedTo.

integer As int64 As int64

rule_count

Optional

Number of rules in this section.

string

_schema

Optional

_schema

boolean

is_default

Optional

It is a boolean flag which reflects whether a firewall section is default section or not. Each Layer 3 and Layer 2 section will have at least and at most one default section.

integer As int64 As int64

_create_time

Optional

Timestamp of resource creation

string

_create_user

Optional

ID of the user who created this resource

array of ResourceLink

_links

Optional

The server will populate this field when returing the resource. Ignored on PUT and POST.

integer As int64 As int64

_revision

Optional

The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.

integer As int64 As int64

_last_modified_time

Optional

Timestamp of last modification

string

_last_modified_user

Optional

ID of the user who last modified this resource

string

Optional

string

resource_type

Required

The type of this resource.

default

Unexpected error

Returns ApiError of type(s) application/json

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

string

module_name

Optional

module_name

string

error_message

Optional

error_message

integer As int64 As int64

error_code

Optional

error_code

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Services Operations

Add Dne Rule In Section

POST

Add Dne Rules In Section

POST

Add Dne Section

POST

Add Dne Section With Rules

Add Section With Rules

POST

Check Member If Exists

Create Dhcp Static Binding

POST

Create Metadata Proxy

Delete Dhcp Static Binding

DELETE

Delete Dne Key Manager

DELETE

Delete Dne Key Policy

Delete Metadata Proxy