[{"label":"Latest (v1.0)","version":"latest"}]



category Optional

  • Distributed Firewall - Policy framework provides five pre-defined categories for classifying a security policy. They are “Ethernet”,“Emergency”, “Infrastructure” “Environment” and “Application”. There is a pre-determined order in which the policy framework manages the priority of these security policies. Ethernet category is for supporting layer 2 firewall rules. The other four categories are applicable for layer 3 rules. Amongst them, the Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories.
  • Edge Firewall - Policy Framework for Edge Firewall provides six pre-defined categories “Emergency”, “SystemRules”, “SharedPreRules”, “LocalGatewayRules”, “AutoServiceRules” and “Default”, in order of priority of rules. All categories are allowed for Gatetway Policies that belong to ‘default’ Domain. However, for user created domains, category is restricted to “SharedPreRules” or “LocalGatewayRules” only. Also, the users can add/modify/delete rules from only the “SharedPreRules” and “LocalGatewayRules” categories. If user doesn’t specify the category then defaulted to “Rules”. System generated category is used by NSX created rules, for example BFD rules. Autoplumbed category used by NSX verticals to autoplumb data path rules. Finally, “Default” category is the placeholder default rules with lowest in the order of priority.

comments Optional

Comments for security policy lock/unlock.

lock_modified_by Optional

ID of the user who last modified the lock for the secruity policy.

integer as int64
lock_modified_time Optional

SecurityPolicy locked/unlocked time in epoch milliseconds.

locked Optional

Indicates whether a security policy should be locked. If the security policy is locked by a user, then no other user would be able to modify this security policy. Once the user releases the lock, other users can update this security policy.

array of string
scope Optional

The list of group paths where the rules in this policy will get applied. This scope will take precedence over rule level scope. Supported only for security policies.

integer as int32
sequence_number Optional

This field is used to resolve conflicts between security policies across domains. In order to change the sequence number of a policy one can fire a POST request on the policy entity with a query parameter action=revise The sequence number field will reflect the value of the computed sequence number upon execution of the above mentioned POST request. For scenarios where the administrator is using a template to update several security policies, the only way to set the sequence number is to explicitly specify the sequence number for each security policy. If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple policies with the same sequence number then their order is not deterministic. If a specific order of policies is desired, then one has to specify unique sequence numbers or use the POST request on the policy entity with a query parameter action=revise to let the framework assign a sequence number

stateful Optional

Stateful or Stateless nature of security policy is enforced on all rules in this security policy. When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Layer3 security policies can be stateful or stateless. By default, they are stateful. Layer2 security policies can only be stateless.

tcp_strict Optional

Ensures that a 3 way TCP handshake is done before the data packets are sent. tcp_strict=true is supported only for stateful security policies.

JSON Example

	"category": "string",
	"comments": "string",
	"lock_modified_by": "string",
	"lock_modified_time": 0,
	"locked": false,
	"scope": [
	"sequence_number": 0,
	"stateful": false,
	"tcp_strict": false

Vendor Extensions

This class contains the following vendor extensions defined in the spec:
x-vmw-nsx-module: Policy
[{"label":"Latest (v1.0)","version":"latest"}]
Used By



Was this page helpful?