Get an Existing Section, Including Rules

Returns firewall section information with rules for a section identifier.
When invoked on a section with a large number of rules, this API is supported
only at low rates of invocation (not more than 4-5 times per minute). The
typical latency of this API with about 1024 rules is about 4-5 seconds. This
API should not be invoked with large payloads at automation speeds. More than
50 rules with a large number rule references is not supported.

Instead, to read firewall rules, use:
GET /api/v1/firewall/sections/<section-id>/rules with the appropriate
page_size.

Request:

Method:

POST

URI Path(s):

/api/v1/firewall/sections/<section-id>?action=list_with_rules

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

POST https://<nsx-mgr>/api/v1/firewall/sections/65a60890-6f48-418d-a7d5-5aaf65fc4e5b?action=list_with_rules

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

FirewallSectionRuleList+

FirewallSectionRuleList (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config 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.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
applied_tos	AppliedTo List List of objects where the rules in this section will be enforced. This will take precedence over rule level appliedTo.	array of ResourceReference	Maximum items: 128
autoplumbed	Tells if a section is auto-plumbed or not This flag indicates whether it is an auto-plumbed section that is associated to a LogicalRouter. Auto-plumbed sections are system owned and cannot be updated via the API.	boolean	Readonly Default: "False"
category	Section category Category from policy framework.	string	Readonly
comments	Section lock/unlock comments Comments for section lock/unlock.	string	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enforced_on	Firewall Section Enforcement type This attribute represents enforcement point of firewall section. For example, firewall section enforced on logical port with attachment type bridge endpoint will have 'BRIDGEENDPOINT' value, firewall section enforced on logical router will have 'LOGICALROUTER' value and rest have 'VIF' value.	string	Readonly
firewall_schedule	Firewall Schedule Reference Reference of the firewall schedule during which this section will be valid.	ResourceReference
id	Unique identifier of this resource	string	Sortable
is_default	Default section flag It is a boolean flag which reflects whether a distributed service section is default section or not. Each Layer 3 and Layer 2 section will have at least and at most one default section.	boolean	Readonly
lock_modified_by	Lock modified by user ID of the user who last modified the lock for the section.	string	Readonly
lock_modified_time	Section locked/unlocked time Section locked/unlocked time in epoch milliseconds.	EpochMsTimestamp	Readonly
locked	Section Locked Section is locked/unlocked.	boolean	Readonly Default: "False"
priority	Section priority Priority of current section with respect to other sections. In case the field is empty, the list section api should be used to get section priority.	integer	Readonly
resource_type	Must be set to the value FirewallSectionRuleList	string
rule_count	Rule count Number of rules in this section.	integer	Readonly
rules	List of the firewall rules List of firewall rules in the section. Only homogenous rules are supported.	array of FirewallRule	Required Maximum items: 1000
section_type	Section Type Type of the rules which a section can contain. Only homogeneous sections are supported.	string	Required Enum: LAYER2, LAYER3, L3REDIRECT, IDS
stateful	Stateful nature of the distributed service rules in the section. Stateful or Stateless nature of distributed service section is enforced on all rules inside the section. Layer3 sections can be stateful or stateless. Layer2 sections can only be stateless.	boolean	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
tcp_strict	TCP Strict If TCP strict is enabled on a section and a packet matches rule in it, the following check will be performed. If the packet does not belong to an existing session, the kernel will check to see if the SYN flag of the packet is set. If it is not, then it will drop the packet.	boolean	Default: "False"

Example Response:

{ "resource_type": "FirewallSectionRuleList", "description": "protects app VMs", "id": "65a60890-6f48-418d-a7d5-5aaf65fc4e5b", "display_name": "app-firewall", "section_type": "LAYER3", "is_default": false, "stateful": true, "rule_count": 1, "rules": [ { "id": "1932288", "display_name": "block ftp", "notes": "", "destinations_excluded": false, "services": [ { "service": { "resource_type": "ALGTypeNSService", "destination_ports": [ "21" ], "source_ports": [], "alg": "FTP" } } ], "ip_protocol": "IPV4_IPV6", "rule_tag": "", "logged": false, "action": "REJECT", "sources_excluded": false, "disabled": false, "direction": "IN_OUT", "_revision": 1 } ], "locked": true, "comments": "Locked the section", "lock_modified_by": "admin", "lock_modified_time": "1445912484445", "_last_modified_user": "admin", "_last_modified_time": 1445912484450, "_revision": 1 }

Get an Existing Section, Including Rules

Request:

Example Request:

Successful Response:

FirewallSectionRuleList (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: