nsxt.PolicySecurityPolicy
Explore with Pulumi AI
Create PolicySecurityPolicy Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PolicySecurityPolicy(name: string, args: PolicySecurityPolicyArgs, opts?: CustomResourceOptions);
@overload
def PolicySecurityPolicy(resource_name: str,
args: PolicySecurityPolicyArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PolicySecurityPolicy(resource_name: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
category: Optional[str] = None,
locked: Optional[bool] = None,
description: Optional[str] = None,
context: Optional[PolicySecurityPolicyContextArgs] = None,
domain: Optional[str] = None,
comments: Optional[str] = None,
nsx_id: Optional[str] = None,
policy_security_policy_id: Optional[str] = None,
rules: Optional[Sequence[PolicySecurityPolicyRuleArgs]] = None,
scopes: Optional[Sequence[str]] = None,
sequence_number: Optional[float] = None,
stateful: Optional[bool] = None,
tags: Optional[Sequence[PolicySecurityPolicyTagArgs]] = None,
tcp_strict: Optional[bool] = None)
func NewPolicySecurityPolicy(ctx *Context, name string, args PolicySecurityPolicyArgs, opts ...ResourceOption) (*PolicySecurityPolicy, error)
public PolicySecurityPolicy(string name, PolicySecurityPolicyArgs args, CustomResourceOptions? opts = null)
public PolicySecurityPolicy(String name, PolicySecurityPolicyArgs args)
public PolicySecurityPolicy(String name, PolicySecurityPolicyArgs args, CustomResourceOptions options)
type: nsxt:PolicySecurityPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args PolicySecurityPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args PolicySecurityPolicyArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PolicySecurityPolicyArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PolicySecurityPolicyArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PolicySecurityPolicyArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var policySecurityPolicyResource = new Nsxt.PolicySecurityPolicy("policySecurityPolicyResource", new()
{
DisplayName = "string",
Category = "string",
Locked = false,
Description = "string",
Context = new Nsxt.Inputs.PolicySecurityPolicyContextArgs
{
ProjectId = "string",
},
Domain = "string",
Comments = "string",
NsxId = "string",
PolicySecurityPolicyId = "string",
Rules = new[]
{
new Nsxt.Inputs.PolicySecurityPolicyRuleArgs
{
DisplayName = "string",
Notes = "string",
Path = "string",
DestinationsExcluded = false,
Direction = "string",
Disabled = false,
Description = "string",
IpVersion = "string",
LogLabel = "string",
Logged = false,
Profiles = new[]
{
"string",
},
DestinationGroups = new[]
{
"string",
},
NsxId = "string",
Action = "string",
Revision = 0,
RuleId = 0,
Scopes = new[]
{
"string",
},
SequenceNumber = 0,
ServiceEntries = new Nsxt.Inputs.PolicySecurityPolicyRuleServiceEntriesArgs
{
AlgorithmEntries = new[]
{
new Nsxt.Inputs.PolicySecurityPolicyRuleServiceEntriesAlgorithmEntryArgs
{
Algorithm = "string",
DestinationPort = "string",
Description = "string",
DisplayName = "string",
SourcePorts = new[]
{
"string",
},
},
},
EtherTypeEntries = new[]
{
new Nsxt.Inputs.PolicySecurityPolicyRuleServiceEntriesEtherTypeEntryArgs
{
EtherType = 0,
Description = "string",
DisplayName = "string",
},
},
IcmpEntries = new[]
{
new Nsxt.Inputs.PolicySecurityPolicyRuleServiceEntriesIcmpEntryArgs
{
Protocol = "string",
Description = "string",
DisplayName = "string",
IcmpCode = "string",
IcmpType = "string",
},
},
IgmpEntries = new[]
{
new Nsxt.Inputs.PolicySecurityPolicyRuleServiceEntriesIgmpEntryArgs
{
Description = "string",
DisplayName = "string",
},
},
IpProtocolEntries = new[]
{
new Nsxt.Inputs.PolicySecurityPolicyRuleServiceEntriesIpProtocolEntryArgs
{
Protocol = 0,
Description = "string",
DisplayName = "string",
},
},
L4PortSetEntries = new[]
{
new Nsxt.Inputs.PolicySecurityPolicyRuleServiceEntriesL4PortSetEntryArgs
{
Protocol = "string",
Description = "string",
DestinationPorts = new[]
{
"string",
},
DisplayName = "string",
SourcePorts = new[]
{
"string",
},
},
},
},
Services = new[]
{
"string",
},
SourceGroups = new[]
{
"string",
},
SourcesExcluded = false,
Tags = new[]
{
new Nsxt.Inputs.PolicySecurityPolicyRuleTagArgs
{
Scope = "string",
Tag = "string",
},
},
},
},
Scopes = new[]
{
"string",
},
SequenceNumber = 0,
Stateful = false,
Tags = new[]
{
new Nsxt.Inputs.PolicySecurityPolicyTagArgs
{
Scope = "string",
Tag = "string",
},
},
TcpStrict = false,
});
example, err := nsxt.NewPolicySecurityPolicy(ctx, "policySecurityPolicyResource", &nsxt.PolicySecurityPolicyArgs{
DisplayName: pulumi.String("string"),
Category: pulumi.String("string"),
Locked: pulumi.Bool(false),
Description: pulumi.String("string"),
Context: &nsxt.PolicySecurityPolicyContextArgs{
ProjectId: pulumi.String("string"),
},
Domain: pulumi.String("string"),
Comments: pulumi.String("string"),
NsxId: pulumi.String("string"),
PolicySecurityPolicyId: pulumi.String("string"),
Rules: nsxt.PolicySecurityPolicyRuleTypeArray{
&nsxt.PolicySecurityPolicyRuleTypeArgs{
DisplayName: pulumi.String("string"),
Notes: pulumi.String("string"),
Path: pulumi.String("string"),
DestinationsExcluded: pulumi.Bool(false),
Direction: pulumi.String("string"),
Disabled: pulumi.Bool(false),
Description: pulumi.String("string"),
IpVersion: pulumi.String("string"),
LogLabel: pulumi.String("string"),
Logged: pulumi.Bool(false),
Profiles: pulumi.StringArray{
pulumi.String("string"),
},
DestinationGroups: pulumi.StringArray{
pulumi.String("string"),
},
NsxId: pulumi.String("string"),
Action: pulumi.String("string"),
Revision: pulumi.Float64(0),
RuleId: pulumi.Float64(0),
Scopes: pulumi.StringArray{
pulumi.String("string"),
},
SequenceNumber: pulumi.Float64(0),
ServiceEntries: &nsxt.PolicySecurityPolicyRuleServiceEntriesArgs{
AlgorithmEntries: nsxt.PolicySecurityPolicyRuleServiceEntriesAlgorithmEntryArray{
&nsxt.PolicySecurityPolicyRuleServiceEntriesAlgorithmEntryArgs{
Algorithm: pulumi.String("string"),
DestinationPort: pulumi.String("string"),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
SourcePorts: pulumi.StringArray{
pulumi.String("string"),
},
},
},
EtherTypeEntries: nsxt.PolicySecurityPolicyRuleServiceEntriesEtherTypeEntryArray{
&nsxt.PolicySecurityPolicyRuleServiceEntriesEtherTypeEntryArgs{
EtherType: pulumi.Float64(0),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
},
},
IcmpEntries: nsxt.PolicySecurityPolicyRuleServiceEntriesIcmpEntryArray{
&nsxt.PolicySecurityPolicyRuleServiceEntriesIcmpEntryArgs{
Protocol: pulumi.String("string"),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
IcmpCode: pulumi.String("string"),
IcmpType: pulumi.String("string"),
},
},
IgmpEntries: nsxt.PolicySecurityPolicyRuleServiceEntriesIgmpEntryArray{
&nsxt.PolicySecurityPolicyRuleServiceEntriesIgmpEntryArgs{
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
},
},
IpProtocolEntries: nsxt.PolicySecurityPolicyRuleServiceEntriesIpProtocolEntryArray{
&nsxt.PolicySecurityPolicyRuleServiceEntriesIpProtocolEntryArgs{
Protocol: pulumi.Float64(0),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
},
},
L4PortSetEntries: nsxt.PolicySecurityPolicyRuleServiceEntriesL4PortSetEntryArray{
&nsxt.PolicySecurityPolicyRuleServiceEntriesL4PortSetEntryArgs{
Protocol: pulumi.String("string"),
Description: pulumi.String("string"),
DestinationPorts: pulumi.StringArray{
pulumi.String("string"),
},
DisplayName: pulumi.String("string"),
SourcePorts: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
Services: pulumi.StringArray{
pulumi.String("string"),
},
SourceGroups: pulumi.StringArray{
pulumi.String("string"),
},
SourcesExcluded: pulumi.Bool(false),
Tags: nsxt.PolicySecurityPolicyRuleTagArray{
&nsxt.PolicySecurityPolicyRuleTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
},
},
Scopes: pulumi.StringArray{
pulumi.String("string"),
},
SequenceNumber: pulumi.Float64(0),
Stateful: pulumi.Bool(false),
Tags: nsxt.PolicySecurityPolicyTagArray{
&nsxt.PolicySecurityPolicyTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
TcpStrict: pulumi.Bool(false),
})
var policySecurityPolicyResource = new PolicySecurityPolicy("policySecurityPolicyResource", PolicySecurityPolicyArgs.builder()
.displayName("string")
.category("string")
.locked(false)
.description("string")
.context(PolicySecurityPolicyContextArgs.builder()
.projectId("string")
.build())
.domain("string")
.comments("string")
.nsxId("string")
.policySecurityPolicyId("string")
.rules(PolicySecurityPolicyRuleArgs.builder()
.displayName("string")
.notes("string")
.path("string")
.destinationsExcluded(false)
.direction("string")
.disabled(false)
.description("string")
.ipVersion("string")
.logLabel("string")
.logged(false)
.profiles("string")
.destinationGroups("string")
.nsxId("string")
.action("string")
.revision(0)
.ruleId(0)
.scopes("string")
.sequenceNumber(0)
.serviceEntries(PolicySecurityPolicyRuleServiceEntriesArgs.builder()
.algorithmEntries(PolicySecurityPolicyRuleServiceEntriesAlgorithmEntryArgs.builder()
.algorithm("string")
.destinationPort("string")
.description("string")
.displayName("string")
.sourcePorts("string")
.build())
.etherTypeEntries(PolicySecurityPolicyRuleServiceEntriesEtherTypeEntryArgs.builder()
.etherType(0)
.description("string")
.displayName("string")
.build())
.icmpEntries(PolicySecurityPolicyRuleServiceEntriesIcmpEntryArgs.builder()
.protocol("string")
.description("string")
.displayName("string")
.icmpCode("string")
.icmpType("string")
.build())
.igmpEntries(PolicySecurityPolicyRuleServiceEntriesIgmpEntryArgs.builder()
.description("string")
.displayName("string")
.build())
.ipProtocolEntries(PolicySecurityPolicyRuleServiceEntriesIpProtocolEntryArgs.builder()
.protocol(0)
.description("string")
.displayName("string")
.build())
.l4PortSetEntries(PolicySecurityPolicyRuleServiceEntriesL4PortSetEntryArgs.builder()
.protocol("string")
.description("string")
.destinationPorts("string")
.displayName("string")
.sourcePorts("string")
.build())
.build())
.services("string")
.sourceGroups("string")
.sourcesExcluded(false)
.tags(PolicySecurityPolicyRuleTagArgs.builder()
.scope("string")
.tag("string")
.build())
.build())
.scopes("string")
.sequenceNumber(0)
.stateful(false)
.tags(PolicySecurityPolicyTagArgs.builder()
.scope("string")
.tag("string")
.build())
.tcpStrict(false)
.build());
policy_security_policy_resource = nsxt.PolicySecurityPolicy("policySecurityPolicyResource",
display_name="string",
category="string",
locked=False,
description="string",
context={
"project_id": "string",
},
domain="string",
comments="string",
nsx_id="string",
policy_security_policy_id="string",
rules=[{
"display_name": "string",
"notes": "string",
"path": "string",
"destinations_excluded": False,
"direction": "string",
"disabled": False,
"description": "string",
"ip_version": "string",
"log_label": "string",
"logged": False,
"profiles": ["string"],
"destination_groups": ["string"],
"nsx_id": "string",
"action": "string",
"revision": 0,
"rule_id": 0,
"scopes": ["string"],
"sequence_number": 0,
"service_entries": {
"algorithm_entries": [{
"algorithm": "string",
"destination_port": "string",
"description": "string",
"display_name": "string",
"source_ports": ["string"],
}],
"ether_type_entries": [{
"ether_type": 0,
"description": "string",
"display_name": "string",
}],
"icmp_entries": [{
"protocol": "string",
"description": "string",
"display_name": "string",
"icmp_code": "string",
"icmp_type": "string",
}],
"igmp_entries": [{
"description": "string",
"display_name": "string",
}],
"ip_protocol_entries": [{
"protocol": 0,
"description": "string",
"display_name": "string",
}],
"l4_port_set_entries": [{
"protocol": "string",
"description": "string",
"destination_ports": ["string"],
"display_name": "string",
"source_ports": ["string"],
}],
},
"services": ["string"],
"source_groups": ["string"],
"sources_excluded": False,
"tags": [{
"scope": "string",
"tag": "string",
}],
}],
scopes=["string"],
sequence_number=0,
stateful=False,
tags=[{
"scope": "string",
"tag": "string",
}],
tcp_strict=False)
const policySecurityPolicyResource = new nsxt.PolicySecurityPolicy("policySecurityPolicyResource", {
displayName: "string",
category: "string",
locked: false,
description: "string",
context: {
projectId: "string",
},
domain: "string",
comments: "string",
nsxId: "string",
policySecurityPolicyId: "string",
rules: [{
displayName: "string",
notes: "string",
path: "string",
destinationsExcluded: false,
direction: "string",
disabled: false,
description: "string",
ipVersion: "string",
logLabel: "string",
logged: false,
profiles: ["string"],
destinationGroups: ["string"],
nsxId: "string",
action: "string",
revision: 0,
ruleId: 0,
scopes: ["string"],
sequenceNumber: 0,
serviceEntries: {
algorithmEntries: [{
algorithm: "string",
destinationPort: "string",
description: "string",
displayName: "string",
sourcePorts: ["string"],
}],
etherTypeEntries: [{
etherType: 0,
description: "string",
displayName: "string",
}],
icmpEntries: [{
protocol: "string",
description: "string",
displayName: "string",
icmpCode: "string",
icmpType: "string",
}],
igmpEntries: [{
description: "string",
displayName: "string",
}],
ipProtocolEntries: [{
protocol: 0,
description: "string",
displayName: "string",
}],
l4PortSetEntries: [{
protocol: "string",
description: "string",
destinationPorts: ["string"],
displayName: "string",
sourcePorts: ["string"],
}],
},
services: ["string"],
sourceGroups: ["string"],
sourcesExcluded: false,
tags: [{
scope: "string",
tag: "string",
}],
}],
scopes: ["string"],
sequenceNumber: 0,
stateful: false,
tags: [{
scope: "string",
tag: "string",
}],
tcpStrict: false,
});
type: nsxt:PolicySecurityPolicy
properties:
category: string
comments: string
context:
projectId: string
description: string
displayName: string
domain: string
locked: false
nsxId: string
policySecurityPolicyId: string
rules:
- action: string
description: string
destinationGroups:
- string
destinationsExcluded: false
direction: string
disabled: false
displayName: string
ipVersion: string
logLabel: string
logged: false
notes: string
nsxId: string
path: string
profiles:
- string
revision: 0
ruleId: 0
scopes:
- string
sequenceNumber: 0
serviceEntries:
algorithmEntries:
- algorithm: string
description: string
destinationPort: string
displayName: string
sourcePorts:
- string
etherTypeEntries:
- description: string
displayName: string
etherType: 0
icmpEntries:
- description: string
displayName: string
icmpCode: string
icmpType: string
protocol: string
igmpEntries:
- description: string
displayName: string
ipProtocolEntries:
- description: string
displayName: string
protocol: 0
l4PortSetEntries:
- description: string
destinationPorts:
- string
displayName: string
protocol: string
sourcePorts:
- string
services:
- string
sourceGroups:
- string
sourcesExcluded: false
tags:
- scope: string
tag: string
scopes:
- string
sequenceNumber: 0
stateful: false
tags:
- scope: string
tag: string
tcpStrict: false
PolicySecurityPolicy Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The PolicySecurityPolicy resource accepts the following input properties:
- Category string
- Category of this policy. For local manager must be one of
Ethernet
,Emergency
,Infrastructure
,Environment
,Application
. For global manager must be one of:Infrastructure
,Environment
,Application
. - Display
Name string - Display name of the resource.
- Comments string
- Comments for security policy lock/unlock.
- Context
Policy
Security Policy Context - The context which the object belongs to
- Description string
- Description of the resource.
- Domain string
- The domain to use for the resource. This domain must already exist. For VMware Cloud on AWS use
cgw
. For Global Manager, please use site id for this field. If not specified, this field is default todefault
. - Locked bool
- Indicates whether a security policy should be locked. If locked by a user, no other user would be able to modify this policy.
- Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Policy
Security stringPolicy Id - ID of the Security Policy.
- Rules
List<Policy
Security Policy Rule> - A repeatable block to specify rules for the Security Policy. Each rule includes the following fields:
- Scopes List<string>
- The list of policy object paths where the rules in this policy will get applied.
- Sequence
Number double - This field is used to resolve conflicts between security policies across domains.
- Stateful bool
- If true, state of the network connects are tracked and a stateful packet inspection is performed. Default is true.
- List<Policy
Security Policy Tag> - A list of scope + tag pairs to associate with this policy.
- Tcp
Strict bool - Ensures that a 3 way TCP handshake is done before the data packets are sent. Default is false.
- Category string
- Category of this policy. For local manager must be one of
Ethernet
,Emergency
,Infrastructure
,Environment
,Application
. For global manager must be one of:Infrastructure
,Environment
,Application
. - Display
Name string - Display name of the resource.
- Comments string
- Comments for security policy lock/unlock.
- Context
Policy
Security Policy Context Args - The context which the object belongs to
- Description string
- Description of the resource.
- Domain string
- The domain to use for the resource. This domain must already exist. For VMware Cloud on AWS use
cgw
. For Global Manager, please use site id for this field. If not specified, this field is default todefault
. - Locked bool
- Indicates whether a security policy should be locked. If locked by a user, no other user would be able to modify this policy.
- Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Policy
Security stringPolicy Id - ID of the Security Policy.
- Rules
[]Policy
Security Policy Rule Type Args - A repeatable block to specify rules for the Security Policy. Each rule includes the following fields:
- Scopes []string
- The list of policy object paths where the rules in this policy will get applied.
- Sequence
Number float64 - This field is used to resolve conflicts between security policies across domains.
- Stateful bool
- If true, state of the network connects are tracked and a stateful packet inspection is performed. Default is true.
- []Policy
Security Policy Tag Args - A list of scope + tag pairs to associate with this policy.
- Tcp
Strict bool - Ensures that a 3 way TCP handshake is done before the data packets are sent. Default is false.
- category String
- Category of this policy. For local manager must be one of
Ethernet
,Emergency
,Infrastructure
,Environment
,Application
. For global manager must be one of:Infrastructure
,Environment
,Application
. - display
Name String - Display name of the resource.
- comments String
- Comments for security policy lock/unlock.
- context
Policy
Security Policy Context - The context which the object belongs to
- description String
- Description of the resource.
- domain String
- The domain to use for the resource. This domain must already exist. For VMware Cloud on AWS use
cgw
. For Global Manager, please use site id for this field. If not specified, this field is default todefault
. - locked Boolean
- Indicates whether a security policy should be locked. If locked by a user, no other user would be able to modify this policy.
- nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy
Security StringPolicy Id - ID of the Security Policy.
- rules
List<Policy
Security Policy Rule> - A repeatable block to specify rules for the Security Policy. Each rule includes the following fields:
- scopes List<String>
- The list of policy object paths where the rules in this policy will get applied.
- sequence
Number Double - This field is used to resolve conflicts between security policies across domains.
- stateful Boolean
- If true, state of the network connects are tracked and a stateful packet inspection is performed. Default is true.
- List<Policy
Security Policy Tag> - A list of scope + tag pairs to associate with this policy.
- tcp
Strict Boolean - Ensures that a 3 way TCP handshake is done before the data packets are sent. Default is false.
- category string
- Category of this policy. For local manager must be one of
Ethernet
,Emergency
,Infrastructure
,Environment
,Application
. For global manager must be one of:Infrastructure
,Environment
,Application
. - display
Name string - Display name of the resource.
- comments string
- Comments for security policy lock/unlock.
- context
Policy
Security Policy Context - The context which the object belongs to
- description string
- Description of the resource.
- domain string
- The domain to use for the resource. This domain must already exist. For VMware Cloud on AWS use
cgw
. For Global Manager, please use site id for this field. If not specified, this field is default todefault
. - locked boolean
- Indicates whether a security policy should be locked. If locked by a user, no other user would be able to modify this policy.
- nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy
Security stringPolicy Id - ID of the Security Policy.
- rules
Policy
Security Policy Rule[] - A repeatable block to specify rules for the Security Policy. Each rule includes the following fields:
- scopes string[]
- The list of policy object paths where the rules in this policy will get applied.
- sequence
Number number - This field is used to resolve conflicts between security policies across domains.
- stateful boolean
- If true, state of the network connects are tracked and a stateful packet inspection is performed. Default is true.
- Policy
Security Policy Tag[] - A list of scope + tag pairs to associate with this policy.
- tcp
Strict boolean - Ensures that a 3 way TCP handshake is done before the data packets are sent. Default is false.
- category str
- Category of this policy. For local manager must be one of
Ethernet
,Emergency
,Infrastructure
,Environment
,Application
. For global manager must be one of:Infrastructure
,Environment
,Application
. - display_
name str - Display name of the resource.
- comments str
- Comments for security policy lock/unlock.
- context
Policy
Security Policy Context Args - The context which the object belongs to
- description str
- Description of the resource.
- domain str
- The domain to use for the resource. This domain must already exist. For VMware Cloud on AWS use
cgw
. For Global Manager, please use site id for this field. If not specified, this field is default todefault
. - locked bool
- Indicates whether a security policy should be locked. If locked by a user, no other user would be able to modify this policy.
- nsx_
id str - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy_
security_ strpolicy_ id - ID of the Security Policy.
- rules
Sequence[Policy
Security Policy Rule Args] - A repeatable block to specify rules for the Security Policy. Each rule includes the following fields:
- scopes Sequence[str]
- The list of policy object paths where the rules in this policy will get applied.
- sequence_
number float - This field is used to resolve conflicts between security policies across domains.
- stateful bool
- If true, state of the network connects are tracked and a stateful packet inspection is performed. Default is true.
- Sequence[Policy
Security Policy Tag Args] - A list of scope + tag pairs to associate with this policy.
- tcp_
strict bool - Ensures that a 3 way TCP handshake is done before the data packets are sent. Default is false.
- category String
- Category of this policy. For local manager must be one of
Ethernet
,Emergency
,Infrastructure
,Environment
,Application
. For global manager must be one of:Infrastructure
,Environment
,Application
. - display
Name String - Display name of the resource.
- comments String
- Comments for security policy lock/unlock.
- context Property Map
- The context which the object belongs to
- description String
- Description of the resource.
- domain String
- The domain to use for the resource. This domain must already exist. For VMware Cloud on AWS use
cgw
. For Global Manager, please use site id for this field. If not specified, this field is default todefault
. - locked Boolean
- Indicates whether a security policy should be locked. If locked by a user, no other user would be able to modify this policy.
- nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- policy
Security StringPolicy Id - ID of the Security Policy.
- rules List<Property Map>
- A repeatable block to specify rules for the Security Policy. Each rule includes the following fields:
- scopes List<String>
- The list of policy object paths where the rules in this policy will get applied.
- sequence
Number Number - This field is used to resolve conflicts between security policies across domains.
- stateful Boolean
- If true, state of the network connects are tracked and a stateful packet inspection is performed. Default is true.
- List<Property Map>
- A list of scope + tag pairs to associate with this policy.
- tcp
Strict Boolean - Ensures that a 3 way TCP handshake is done before the data packets are sent. Default is false.
Outputs
All input properties are implicitly available as output properties. Additionally, the PolicySecurityPolicy resource produces the following output properties:
Look up Existing PolicySecurityPolicy Resource
Get an existing PolicySecurityPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: PolicySecurityPolicyState, opts?: CustomResourceOptions): PolicySecurityPolicy
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
category: Optional[str] = None,
comments: Optional[str] = None,
context: Optional[PolicySecurityPolicyContextArgs] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
domain: Optional[str] = None,
locked: Optional[bool] = None,
nsx_id: Optional[str] = None,
path: Optional[str] = None,
policy_security_policy_id: Optional[str] = None,
revision: Optional[float] = None,
rules: Optional[Sequence[PolicySecurityPolicyRuleArgs]] = None,
scopes: Optional[Sequence[str]] = None,
sequence_number: Optional[float] = None,
stateful: Optional[bool] = None,
tags: Optional[Sequence[PolicySecurityPolicyTagArgs]] = None,
tcp_strict: Optional[bool] = None) -> PolicySecurityPolicy
func GetPolicySecurityPolicy(ctx *Context, name string, id IDInput, state *PolicySecurityPolicyState, opts ...ResourceOption) (*PolicySecurityPolicy, error)
public static PolicySecurityPolicy Get(string name, Input<string> id, PolicySecurityPolicyState? state, CustomResourceOptions? opts = null)
public static PolicySecurityPolicy get(String name, Output<String> id, PolicySecurityPolicyState state, CustomResourceOptions options)
resources: _: type: nsxt:PolicySecurityPolicy get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Category string
- Category of this policy. For local manager must be one of
Ethernet
,Emergency
,Infrastructure
,Environment
,Application
. For global manager must be one of:Infrastructure
,Environment
,Application
. - Comments string
- Comments for security policy lock/unlock.
- Context
Policy
Security Policy Context - The context which the object belongs to
- Description string
- Description of the resource.
- Display
Name string - Display name of the resource.
- Domain string
- The domain to use for the resource. This domain must already exist. For VMware Cloud on AWS use
cgw
. For Global Manager, please use site id for this field. If not specified, this field is default todefault
. - Locked bool
- Indicates whether a security policy should be locked. If locked by a user, no other user would be able to modify this policy.
- Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Path string
- The NSX path of the policy resource.
- Policy
Security stringPolicy Id - ID of the Security Policy.
- Revision double
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- Rules
List<Policy
Security Policy Rule> - A repeatable block to specify rules for the Security Policy. Each rule includes the following fields:
- Scopes List<string>
- The list of policy object paths where the rules in this policy will get applied.
- Sequence
Number double - This field is used to resolve conflicts between security policies across domains.
- Stateful bool
- If true, state of the network connects are tracked and a stateful packet inspection is performed. Default is true.
- List<Policy
Security Policy Tag> - A list of scope + tag pairs to associate with this policy.
- Tcp
Strict bool - Ensures that a 3 way TCP handshake is done before the data packets are sent. Default is false.
- Category string
- Category of this policy. For local manager must be one of
Ethernet
,Emergency
,Infrastructure
,Environment
,Application
. For global manager must be one of:Infrastructure
,Environment
,Application
. - Comments string
- Comments for security policy lock/unlock.
- Context
Policy
Security Policy Context Args - The context which the object belongs to
- Description string
- Description of the resource.
- Display
Name string - Display name of the resource.
- Domain string
- The domain to use for the resource. This domain must already exist. For VMware Cloud on AWS use
cgw
. For Global Manager, please use site id for this field. If not specified, this field is default todefault
. - Locked bool
- Indicates whether a security policy should be locked. If locked by a user, no other user would be able to modify this policy.
- Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Path string
- The NSX path of the policy resource.
- Policy
Security stringPolicy Id - ID of the Security Policy.
- Revision float64
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- Rules
[]Policy
Security Policy Rule Type Args - A repeatable block to specify rules for the Security Policy. Each rule includes the following fields:
- Scopes []string
- The list of policy object paths where the rules in this policy will get applied.
- Sequence
Number float64 - This field is used to resolve conflicts between security policies across domains.
- Stateful bool
- If true, state of the network connects are tracked and a stateful packet inspection is performed. Default is true.
- []Policy
Security Policy Tag Args - A list of scope + tag pairs to associate with this policy.
- Tcp
Strict bool - Ensures that a 3 way TCP handshake is done before the data packets are sent. Default is false.
- category String
- Category of this policy. For local manager must be one of
Ethernet
,Emergency
,Infrastructure
,Environment
,Application
. For global manager must be one of:Infrastructure
,Environment
,Application
. - comments String
- Comments for security policy lock/unlock.
- context
Policy
Security Policy Context - The context which the object belongs to
- description String
- Description of the resource.
- display
Name String - Display name of the resource.
- domain String
- The domain to use for the resource. This domain must already exist. For VMware Cloud on AWS use
cgw
. For Global Manager, please use site id for this field. If not specified, this field is default todefault
. - locked Boolean
- Indicates whether a security policy should be locked. If locked by a user, no other user would be able to modify this policy.
- nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path String
- The NSX path of the policy resource.
- policy
Security StringPolicy Id - ID of the Security Policy.
- revision Double
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- rules
List<Policy
Security Policy Rule> - A repeatable block to specify rules for the Security Policy. Each rule includes the following fields:
- scopes List<String>
- The list of policy object paths where the rules in this policy will get applied.
- sequence
Number Double - This field is used to resolve conflicts between security policies across domains.
- stateful Boolean
- If true, state of the network connects are tracked and a stateful packet inspection is performed. Default is true.
- List<Policy
Security Policy Tag> - A list of scope + tag pairs to associate with this policy.
- tcp
Strict Boolean - Ensures that a 3 way TCP handshake is done before the data packets are sent. Default is false.
- category string
- Category of this policy. For local manager must be one of
Ethernet
,Emergency
,Infrastructure
,Environment
,Application
. For global manager must be one of:Infrastructure
,Environment
,Application
. - comments string
- Comments for security policy lock/unlock.
- context
Policy
Security Policy Context - The context which the object belongs to
- description string
- Description of the resource.
- display
Name string - Display name of the resource.
- domain string
- The domain to use for the resource. This domain must already exist. For VMware Cloud on AWS use
cgw
. For Global Manager, please use site id for this field. If not specified, this field is default todefault
. - locked boolean
- Indicates whether a security policy should be locked. If locked by a user, no other user would be able to modify this policy.
- nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path string
- The NSX path of the policy resource.
- policy
Security stringPolicy Id - ID of the Security Policy.
- revision number
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- rules
Policy
Security Policy Rule[] - A repeatable block to specify rules for the Security Policy. Each rule includes the following fields:
- scopes string[]
- The list of policy object paths where the rules in this policy will get applied.
- sequence
Number number - This field is used to resolve conflicts between security policies across domains.
- stateful boolean
- If true, state of the network connects are tracked and a stateful packet inspection is performed. Default is true.
- Policy
Security Policy Tag[] - A list of scope + tag pairs to associate with this policy.
- tcp
Strict boolean - Ensures that a 3 way TCP handshake is done before the data packets are sent. Default is false.
- category str
- Category of this policy. For local manager must be one of
Ethernet
,Emergency
,Infrastructure
,Environment
,Application
. For global manager must be one of:Infrastructure
,Environment
,Application
. - comments str
- Comments for security policy lock/unlock.
- context
Policy
Security Policy Context Args - The context which the object belongs to
- description str
- Description of the resource.
- display_
name str - Display name of the resource.
- domain str
- The domain to use for the resource. This domain must already exist. For VMware Cloud on AWS use
cgw
. For Global Manager, please use site id for this field. If not specified, this field is default todefault
. - locked bool
- Indicates whether a security policy should be locked. If locked by a user, no other user would be able to modify this policy.
- nsx_
id str - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path str
- The NSX path of the policy resource.
- policy_
security_ strpolicy_ id - ID of the Security Policy.
- revision float
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- rules
Sequence[Policy
Security Policy Rule Args] - A repeatable block to specify rules for the Security Policy. Each rule includes the following fields:
- scopes Sequence[str]
- The list of policy object paths where the rules in this policy will get applied.
- sequence_
number float - This field is used to resolve conflicts between security policies across domains.
- stateful bool
- If true, state of the network connects are tracked and a stateful packet inspection is performed. Default is true.
- Sequence[Policy
Security Policy Tag Args] - A list of scope + tag pairs to associate with this policy.
- tcp_
strict bool - Ensures that a 3 way TCP handshake is done before the data packets are sent. Default is false.
- category String
- Category of this policy. For local manager must be one of
Ethernet
,Emergency
,Infrastructure
,Environment
,Application
. For global manager must be one of:Infrastructure
,Environment
,Application
. - comments String
- Comments for security policy lock/unlock.
- context Property Map
- The context which the object belongs to
- description String
- Description of the resource.
- display
Name String - Display name of the resource.
- domain String
- The domain to use for the resource. This domain must already exist. For VMware Cloud on AWS use
cgw
. For Global Manager, please use site id for this field. If not specified, this field is default todefault
. - locked Boolean
- Indicates whether a security policy should be locked. If locked by a user, no other user would be able to modify this policy.
- nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path String
- The NSX path of the policy resource.
- policy
Security StringPolicy Id - ID of the Security Policy.
- revision Number
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- rules List<Property Map>
- A repeatable block to specify rules for the Security Policy. Each rule includes the following fields:
- scopes List<String>
- The list of policy object paths where the rules in this policy will get applied.
- sequence
Number Number - This field is used to resolve conflicts between security policies across domains.
- stateful Boolean
- If true, state of the network connects are tracked and a stateful packet inspection is performed. Default is true.
- List<Property Map>
- A list of scope + tag pairs to associate with this policy.
- tcp
Strict Boolean - Ensures that a 3 way TCP handshake is done before the data packets are sent. Default is false.
Supporting Types
PolicySecurityPolicyContext, PolicySecurityPolicyContextArgs
- Project
Id string - The ID of the project which the object belongs to
- Project
Id string - The ID of the project which the object belongs to
- project
Id String - The ID of the project which the object belongs to
- project
Id string - The ID of the project which the object belongs to
- project_
id str - The ID of the project which the object belongs to
- project
Id String - The ID of the project which the object belongs to
PolicySecurityPolicyRule, PolicySecurityPolicyRuleArgs
- Display
Name string - Display name of the resource.
- Action string
- Rule action, one of
ALLOW
,DROP
,REJECT
andJUMP_TO_APPLICATION
. Default isALLOW
.JUMP_TO_APPLICATION
is only applicable inEnvironment
category. - Description string
- Description of the resource.
- Destination
Groups List<string> - Set of group paths that serve as the destination for this rule. IPs, IP ranges, or CIDRs may also be used starting in NSX-T 3.0. An empty set can be used to specify "Any".
- Destinations
Excluded bool - A boolean value indicating negation of destination groups.
- Direction string
- Traffic direction, one of
IN
,OUT
orIN_OUT
. Default isIN_OUT
. - Disabled bool
- Flag to disable this rule. Default is false.
- Ip
Version string - Version of IP protocol, one of
NONE
,IPV4
,IPV6
,IPV4_IPV6
. Default isIPV4_IPV6
. ForEthernet
category rules, useNONE
value. - Log
Label string - Additional information (string) which will be propagated to the rule syslog.
- Logged bool
- Flag to enable packet logging. Default is false.
- Notes string
- Additional notes on changes.
- Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Path string
- The NSX path of the policy resource.
- Profiles List<string>
- Set of profile paths relevant for this rule.
- Revision double
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- Rule
Id double - Unique positive number that is assigned by the system and is useful for debugging.
- Scopes List<string>
- Set of policy object paths where the rule is applied.
- Sequence
Number double - It is recommended not to specify sequence number for rules, and rely on provider to auto-assign them. If you choose to specify sequence numbers, you must make sure the numbers are consistent with order of the rules in configuration. Please note that sequence numbers should start with 1 and not 0. To avoid confusion, either specify sequence numbers in all rules, or none at all.
- Service
Entries PolicySecurity Policy Rule Service Entries - Set of explicit protocol/port service definition
- Services List<string>
- Set of service paths to match.
- Source
Groups List<string> - Set of group paths that serve as the source for this rule. IPs, IP ranges, or CIDRs may also be used starting in NSX-T 3.0. An empty set can be used to specify "Any".
- Sources
Excluded bool - A boolean value indicating negation of source groups.
- List<Policy
Security Policy Rule Tag> - A list of scope + tag pairs to associate with this Rule.
- Display
Name string - Display name of the resource.
- Action string
- Rule action, one of
ALLOW
,DROP
,REJECT
andJUMP_TO_APPLICATION
. Default isALLOW
.JUMP_TO_APPLICATION
is only applicable inEnvironment
category. - Description string
- Description of the resource.
- Destination
Groups []string - Set of group paths that serve as the destination for this rule. IPs, IP ranges, or CIDRs may also be used starting in NSX-T 3.0. An empty set can be used to specify "Any".
- Destinations
Excluded bool - A boolean value indicating negation of destination groups.
- Direction string
- Traffic direction, one of
IN
,OUT
orIN_OUT
. Default isIN_OUT
. - Disabled bool
- Flag to disable this rule. Default is false.
- Ip
Version string - Version of IP protocol, one of
NONE
,IPV4
,IPV6
,IPV4_IPV6
. Default isIPV4_IPV6
. ForEthernet
category rules, useNONE
value. - Log
Label string - Additional information (string) which will be propagated to the rule syslog.
- Logged bool
- Flag to enable packet logging. Default is false.
- Notes string
- Additional notes on changes.
- Nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- Path string
- The NSX path of the policy resource.
- Profiles []string
- Set of profile paths relevant for this rule.
- Revision float64
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- Rule
Id float64 - Unique positive number that is assigned by the system and is useful for debugging.
- Scopes []string
- Set of policy object paths where the rule is applied.
- Sequence
Number float64 - It is recommended not to specify sequence number for rules, and rely on provider to auto-assign them. If you choose to specify sequence numbers, you must make sure the numbers are consistent with order of the rules in configuration. Please note that sequence numbers should start with 1 and not 0. To avoid confusion, either specify sequence numbers in all rules, or none at all.
- Service
Entries PolicySecurity Policy Rule Service Entries - Set of explicit protocol/port service definition
- Services []string
- Set of service paths to match.
- Source
Groups []string - Set of group paths that serve as the source for this rule. IPs, IP ranges, or CIDRs may also be used starting in NSX-T 3.0. An empty set can be used to specify "Any".
- Sources
Excluded bool - A boolean value indicating negation of source groups.
- []Policy
Security Policy Rule Tag - A list of scope + tag pairs to associate with this Rule.
- display
Name String - Display name of the resource.
- action String
- Rule action, one of
ALLOW
,DROP
,REJECT
andJUMP_TO_APPLICATION
. Default isALLOW
.JUMP_TO_APPLICATION
is only applicable inEnvironment
category. - description String
- Description of the resource.
- destination
Groups List<String> - Set of group paths that serve as the destination for this rule. IPs, IP ranges, or CIDRs may also be used starting in NSX-T 3.0. An empty set can be used to specify "Any".
- destinations
Excluded Boolean - A boolean value indicating negation of destination groups.
- direction String
- Traffic direction, one of
IN
,OUT
orIN_OUT
. Default isIN_OUT
. - disabled Boolean
- Flag to disable this rule. Default is false.
- ip
Version String - Version of IP protocol, one of
NONE
,IPV4
,IPV6
,IPV4_IPV6
. Default isIPV4_IPV6
. ForEthernet
category rules, useNONE
value. - log
Label String - Additional information (string) which will be propagated to the rule syslog.
- logged Boolean
- Flag to enable packet logging. Default is false.
- notes String
- Additional notes on changes.
- nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path String
- The NSX path of the policy resource.
- profiles List<String>
- Set of profile paths relevant for this rule.
- revision Double
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- rule
Id Double - Unique positive number that is assigned by the system and is useful for debugging.
- scopes List<String>
- Set of policy object paths where the rule is applied.
- sequence
Number Double - It is recommended not to specify sequence number for rules, and rely on provider to auto-assign them. If you choose to specify sequence numbers, you must make sure the numbers are consistent with order of the rules in configuration. Please note that sequence numbers should start with 1 and not 0. To avoid confusion, either specify sequence numbers in all rules, or none at all.
- service
Entries PolicySecurity Policy Rule Service Entries - Set of explicit protocol/port service definition
- services List<String>
- Set of service paths to match.
- source
Groups List<String> - Set of group paths that serve as the source for this rule. IPs, IP ranges, or CIDRs may also be used starting in NSX-T 3.0. An empty set can be used to specify "Any".
- sources
Excluded Boolean - A boolean value indicating negation of source groups.
- List<Policy
Security Policy Rule Tag> - A list of scope + tag pairs to associate with this Rule.
- display
Name string - Display name of the resource.
- action string
- Rule action, one of
ALLOW
,DROP
,REJECT
andJUMP_TO_APPLICATION
. Default isALLOW
.JUMP_TO_APPLICATION
is only applicable inEnvironment
category. - description string
- Description of the resource.
- destination
Groups string[] - Set of group paths that serve as the destination for this rule. IPs, IP ranges, or CIDRs may also be used starting in NSX-T 3.0. An empty set can be used to specify "Any".
- destinations
Excluded boolean - A boolean value indicating negation of destination groups.
- direction string
- Traffic direction, one of
IN
,OUT
orIN_OUT
. Default isIN_OUT
. - disabled boolean
- Flag to disable this rule. Default is false.
- ip
Version string - Version of IP protocol, one of
NONE
,IPV4
,IPV6
,IPV4_IPV6
. Default isIPV4_IPV6
. ForEthernet
category rules, useNONE
value. - log
Label string - Additional information (string) which will be propagated to the rule syslog.
- logged boolean
- Flag to enable packet logging. Default is false.
- notes string
- Additional notes on changes.
- nsx
Id string - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path string
- The NSX path of the policy resource.
- profiles string[]
- Set of profile paths relevant for this rule.
- revision number
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- rule
Id number - Unique positive number that is assigned by the system and is useful for debugging.
- scopes string[]
- Set of policy object paths where the rule is applied.
- sequence
Number number - It is recommended not to specify sequence number for rules, and rely on provider to auto-assign them. If you choose to specify sequence numbers, you must make sure the numbers are consistent with order of the rules in configuration. Please note that sequence numbers should start with 1 and not 0. To avoid confusion, either specify sequence numbers in all rules, or none at all.
- service
Entries PolicySecurity Policy Rule Service Entries - Set of explicit protocol/port service definition
- services string[]
- Set of service paths to match.
- source
Groups string[] - Set of group paths that serve as the source for this rule. IPs, IP ranges, or CIDRs may also be used starting in NSX-T 3.0. An empty set can be used to specify "Any".
- sources
Excluded boolean - A boolean value indicating negation of source groups.
- Policy
Security Policy Rule Tag[] - A list of scope + tag pairs to associate with this Rule.
- display_
name str - Display name of the resource.
- action str
- Rule action, one of
ALLOW
,DROP
,REJECT
andJUMP_TO_APPLICATION
. Default isALLOW
.JUMP_TO_APPLICATION
is only applicable inEnvironment
category. - description str
- Description of the resource.
- destination_
groups Sequence[str] - Set of group paths that serve as the destination for this rule. IPs, IP ranges, or CIDRs may also be used starting in NSX-T 3.0. An empty set can be used to specify "Any".
- destinations_
excluded bool - A boolean value indicating negation of destination groups.
- direction str
- Traffic direction, one of
IN
,OUT
orIN_OUT
. Default isIN_OUT
. - disabled bool
- Flag to disable this rule. Default is false.
- ip_
version str - Version of IP protocol, one of
NONE
,IPV4
,IPV6
,IPV4_IPV6
. Default isIPV4_IPV6
. ForEthernet
category rules, useNONE
value. - log_
label str - Additional information (string) which will be propagated to the rule syslog.
- logged bool
- Flag to enable packet logging. Default is false.
- notes str
- Additional notes on changes.
- nsx_
id str - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path str
- The NSX path of the policy resource.
- profiles Sequence[str]
- Set of profile paths relevant for this rule.
- revision float
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- rule_
id float - Unique positive number that is assigned by the system and is useful for debugging.
- scopes Sequence[str]
- Set of policy object paths where the rule is applied.
- sequence_
number float - It is recommended not to specify sequence number for rules, and rely on provider to auto-assign them. If you choose to specify sequence numbers, you must make sure the numbers are consistent with order of the rules in configuration. Please note that sequence numbers should start with 1 and not 0. To avoid confusion, either specify sequence numbers in all rules, or none at all.
- service_
entries PolicySecurity Policy Rule Service Entries - Set of explicit protocol/port service definition
- services Sequence[str]
- Set of service paths to match.
- source_
groups Sequence[str] - Set of group paths that serve as the source for this rule. IPs, IP ranges, or CIDRs may also be used starting in NSX-T 3.0. An empty set can be used to specify "Any".
- sources_
excluded bool - A boolean value indicating negation of source groups.
- Sequence[Policy
Security Policy Rule Tag] - A list of scope + tag pairs to associate with this Rule.
- display
Name String - Display name of the resource.
- action String
- Rule action, one of
ALLOW
,DROP
,REJECT
andJUMP_TO_APPLICATION
. Default isALLOW
.JUMP_TO_APPLICATION
is only applicable inEnvironment
category. - description String
- Description of the resource.
- destination
Groups List<String> - Set of group paths that serve as the destination for this rule. IPs, IP ranges, or CIDRs may also be used starting in NSX-T 3.0. An empty set can be used to specify "Any".
- destinations
Excluded Boolean - A boolean value indicating negation of destination groups.
- direction String
- Traffic direction, one of
IN
,OUT
orIN_OUT
. Default isIN_OUT
. - disabled Boolean
- Flag to disable this rule. Default is false.
- ip
Version String - Version of IP protocol, one of
NONE
,IPV4
,IPV6
,IPV4_IPV6
. Default isIPV4_IPV6
. ForEthernet
category rules, useNONE
value. - log
Label String - Additional information (string) which will be propagated to the rule syslog.
- logged Boolean
- Flag to enable packet logging. Default is false.
- notes String
- Additional notes on changes.
- nsx
Id String - The NSX ID of this resource. If set, this ID will be used to create the resource.
- path String
- The NSX path of the policy resource.
- profiles List<String>
- Set of profile paths relevant for this rule.
- revision Number
- Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
- rule
Id Number - Unique positive number that is assigned by the system and is useful for debugging.
- scopes List<String>
- Set of policy object paths where the rule is applied.
- sequence
Number Number - It is recommended not to specify sequence number for rules, and rely on provider to auto-assign them. If you choose to specify sequence numbers, you must make sure the numbers are consistent with order of the rules in configuration. Please note that sequence numbers should start with 1 and not 0. To avoid confusion, either specify sequence numbers in all rules, or none at all.
- service
Entries Property Map - Set of explicit protocol/port service definition
- services List<String>
- Set of service paths to match.
- source
Groups List<String> - Set of group paths that serve as the source for this rule. IPs, IP ranges, or CIDRs may also be used starting in NSX-T 3.0. An empty set can be used to specify "Any".
- sources
Excluded Boolean - A boolean value indicating negation of source groups.
- List<Property Map>
- A list of scope + tag pairs to associate with this Rule.
PolicySecurityPolicyRuleServiceEntries, PolicySecurityPolicyRuleServiceEntriesArgs
- Algorithm
Entries List<PolicySecurity Policy Rule Service Entries Algorithm Entry> - Set of Algorithm type service entries
- Ether
Type List<PolicyEntries Security Policy Rule Service Entries Ether Type Entry> - Set of Ether type service entries
- Icmp
Entries List<PolicySecurity Policy Rule Service Entries Icmp Entry> - Set of ICMP type service entries
- Igmp
Entries List<PolicySecurity Policy Rule Service Entries Igmp Entry> - Set of IGMP type service entries
- Ip
Protocol List<PolicyEntries Security Policy Rule Service Entries Ip Protocol Entry> - Set of IP Protocol type service entries
- L4Port
Set List<PolicyEntries Security Policy Rule Service Entries L4Port Set Entry> - Set of L4 ports set service entries
- Algorithm
Entries []PolicySecurity Policy Rule Service Entries Algorithm Entry - Set of Algorithm type service entries
- Ether
Type []PolicyEntries Security Policy Rule Service Entries Ether Type Entry - Set of Ether type service entries
- Icmp
Entries []PolicySecurity Policy Rule Service Entries Icmp Entry - Set of ICMP type service entries
- Igmp
Entries []PolicySecurity Policy Rule Service Entries Igmp Entry - Set of IGMP type service entries
- Ip
Protocol []PolicyEntries Security Policy Rule Service Entries Ip Protocol Entry - Set of IP Protocol type service entries
- L4Port
Set []PolicyEntries Security Policy Rule Service Entries L4Port Set Entry - Set of L4 ports set service entries
- algorithm
Entries List<PolicySecurity Policy Rule Service Entries Algorithm Entry> - Set of Algorithm type service entries
- ether
Type List<PolicyEntries Security Policy Rule Service Entries Ether Type Entry> - Set of Ether type service entries
- icmp
Entries List<PolicySecurity Policy Rule Service Entries Icmp Entry> - Set of ICMP type service entries
- igmp
Entries List<PolicySecurity Policy Rule Service Entries Igmp Entry> - Set of IGMP type service entries
- ip
Protocol List<PolicyEntries Security Policy Rule Service Entries Ip Protocol Entry> - Set of IP Protocol type service entries
- l4Port
Set List<PolicyEntries Security Policy Rule Service Entries L4Port Set Entry> - Set of L4 ports set service entries
- algorithm
Entries PolicySecurity Policy Rule Service Entries Algorithm Entry[] - Set of Algorithm type service entries
- ether
Type PolicyEntries Security Policy Rule Service Entries Ether Type Entry[] - Set of Ether type service entries
- icmp
Entries PolicySecurity Policy Rule Service Entries Icmp Entry[] - Set of ICMP type service entries
- igmp
Entries PolicySecurity Policy Rule Service Entries Igmp Entry[] - Set of IGMP type service entries
- ip
Protocol PolicyEntries Security Policy Rule Service Entries Ip Protocol Entry[] - Set of IP Protocol type service entries
- l4Port
Set PolicyEntries Security Policy Rule Service Entries L4Port Set Entry[] - Set of L4 ports set service entries
- algorithm_
entries Sequence[PolicySecurity Policy Rule Service Entries Algorithm Entry] - Set of Algorithm type service entries
- ether_
type_ Sequence[Policyentries Security Policy Rule Service Entries Ether Type Entry] - Set of Ether type service entries
- icmp_
entries Sequence[PolicySecurity Policy Rule Service Entries Icmp Entry] - Set of ICMP type service entries
- igmp_
entries Sequence[PolicySecurity Policy Rule Service Entries Igmp Entry] - Set of IGMP type service entries
- ip_
protocol_ Sequence[Policyentries Security Policy Rule Service Entries Ip Protocol Entry] - Set of IP Protocol type service entries
- l4_
port_ Sequence[Policyset_ entries Security Policy Rule Service Entries L4Port Set Entry] - Set of L4 ports set service entries
- algorithm
Entries List<Property Map> - Set of Algorithm type service entries
- ether
Type List<Property Map>Entries - Set of Ether type service entries
- icmp
Entries List<Property Map> - Set of ICMP type service entries
- igmp
Entries List<Property Map> - Set of IGMP type service entries
- ip
Protocol List<Property Map>Entries - Set of IP Protocol type service entries
- l4Port
Set List<Property Map>Entries - Set of L4 ports set service entries
PolicySecurityPolicyRuleServiceEntriesAlgorithmEntry, PolicySecurityPolicyRuleServiceEntriesAlgorithmEntryArgs
- Algorithm string
- Algorithm: one of
ORACLE_TNS
,FTP
,SUN_RPC_TCP
,SUN_RPC_UDP
,MS_RPC_TCP
,MS_RPC_UDP
,NBNS_BROADCAST
(Deprecated),NBDG_BROADCAST
(Deprecated),TFTP
- Destination
Port string - a single destination port
- Description string
- Description of the resource.
- Display
Name string - Display name of the service entry
- Source
Ports List<string> - Set of source ports/ranges
- Algorithm string
- Algorithm: one of
ORACLE_TNS
,FTP
,SUN_RPC_TCP
,SUN_RPC_UDP
,MS_RPC_TCP
,MS_RPC_UDP
,NBNS_BROADCAST
(Deprecated),NBDG_BROADCAST
(Deprecated),TFTP
- Destination
Port string - a single destination port
- Description string
- Description of the resource.
- Display
Name string - Display name of the service entry
- Source
Ports []string - Set of source ports/ranges
- algorithm String
- Algorithm: one of
ORACLE_TNS
,FTP
,SUN_RPC_TCP
,SUN_RPC_UDP
,MS_RPC_TCP
,MS_RPC_UDP
,NBNS_BROADCAST
(Deprecated),NBDG_BROADCAST
(Deprecated),TFTP
- destination
Port String - a single destination port
- description String
- Description of the resource.
- display
Name String - Display name of the service entry
- source
Ports List<String> - Set of source ports/ranges
- algorithm string
- Algorithm: one of
ORACLE_TNS
,FTP
,SUN_RPC_TCP
,SUN_RPC_UDP
,MS_RPC_TCP
,MS_RPC_UDP
,NBNS_BROADCAST
(Deprecated),NBDG_BROADCAST
(Deprecated),TFTP
- destination
Port string - a single destination port
- description string
- Description of the resource.
- display
Name string - Display name of the service entry
- source
Ports string[] - Set of source ports/ranges
- algorithm str
- Algorithm: one of
ORACLE_TNS
,FTP
,SUN_RPC_TCP
,SUN_RPC_UDP
,MS_RPC_TCP
,MS_RPC_UDP
,NBNS_BROADCAST
(Deprecated),NBDG_BROADCAST
(Deprecated),TFTP
- destination_
port str - a single destination port
- description str
- Description of the resource.
- display_
name str - Display name of the service entry
- source_
ports Sequence[str] - Set of source ports/ranges
- algorithm String
- Algorithm: one of
ORACLE_TNS
,FTP
,SUN_RPC_TCP
,SUN_RPC_UDP
,MS_RPC_TCP
,MS_RPC_UDP
,NBNS_BROADCAST
(Deprecated),NBDG_BROADCAST
(Deprecated),TFTP
- destination
Port String - a single destination port
- description String
- Description of the resource.
- display
Name String - Display name of the service entry
- source
Ports List<String> - Set of source ports/ranges
PolicySecurityPolicyRuleServiceEntriesEtherTypeEntry, PolicySecurityPolicyRuleServiceEntriesEtherTypeEntryArgs
- Ether
Type double - Type of the encapsulated protocol
- Description string
- Description of the resource.
- Display
Name string - Display name of the service entry
- Ether
Type float64 - Type of the encapsulated protocol
- Description string
- Description of the resource.
- Display
Name string - Display name of the service entry
- ether
Type Double - Type of the encapsulated protocol
- description String
- Description of the resource.
- display
Name String - Display name of the service entry
- ether
Type number - Type of the encapsulated protocol
- description string
- Description of the resource.
- display
Name string - Display name of the service entry
- ether_
type float - Type of the encapsulated protocol
- description str
- Description of the resource.
- display_
name str - Display name of the service entry
- ether
Type Number - Type of the encapsulated protocol
- description String
- Description of the resource.
- display
Name String - Display name of the service entry
PolicySecurityPolicyRuleServiceEntriesIcmpEntry, PolicySecurityPolicyRuleServiceEntriesIcmpEntryArgs
- Protocol string
- Version of ICMP protocol:
ICMPv4
orICMPv6
- Description string
- Description of the resource.
- Display
Name string - Display name of the service entry
- Icmp
Code string - ICMP message code
- Icmp
Type string - ICMP message type
- Protocol string
- Version of ICMP protocol:
ICMPv4
orICMPv6
- Description string
- Description of the resource.
- Display
Name string - Display name of the service entry
- Icmp
Code string - ICMP message code
- Icmp
Type string - ICMP message type
- protocol String
- Version of ICMP protocol:
ICMPv4
orICMPv6
- description String
- Description of the resource.
- display
Name String - Display name of the service entry
- icmp
Code String - ICMP message code
- icmp
Type String - ICMP message type
- protocol string
- Version of ICMP protocol:
ICMPv4
orICMPv6
- description string
- Description of the resource.
- display
Name string - Display name of the service entry
- icmp
Code string - ICMP message code
- icmp
Type string - ICMP message type
- protocol str
- Version of ICMP protocol:
ICMPv4
orICMPv6
- description str
- Description of the resource.
- display_
name str - Display name of the service entry
- icmp_
code str - ICMP message code
- icmp_
type str - ICMP message type
- protocol String
- Version of ICMP protocol:
ICMPv4
orICMPv6
- description String
- Description of the resource.
- display
Name String - Display name of the service entry
- icmp
Code String - ICMP message code
- icmp
Type String - ICMP message type
PolicySecurityPolicyRuleServiceEntriesIgmpEntry, PolicySecurityPolicyRuleServiceEntriesIgmpEntryArgs
- Description string
- Description of the resource.
- Display
Name string - Display name of the service entry
- Description string
- Description of the resource.
- Display
Name string - Display name of the service entry
- description String
- Description of the resource.
- display
Name String - Display name of the service entry
- description string
- Description of the resource.
- display
Name string - Display name of the service entry
- description str
- Description of the resource.
- display_
name str - Display name of the service entry
- description String
- Description of the resource.
- display
Name String - Display name of the service entry
PolicySecurityPolicyRuleServiceEntriesIpProtocolEntry, PolicySecurityPolicyRuleServiceEntriesIpProtocolEntryArgs
- Protocol double
- IP protocol number
- Description string
- Description of the resource.
- Display
Name string - Display name of the service entry
- Protocol float64
- IP protocol number
- Description string
- Description of the resource.
- Display
Name string - Display name of the service entry
- protocol Double
- IP protocol number
- description String
- Description of the resource.
- display
Name String - Display name of the service entry
- protocol number
- IP protocol number
- description string
- Description of the resource.
- display
Name string - Display name of the service entry
- protocol float
- IP protocol number
- description str
- Description of the resource.
- display_
name str - Display name of the service entry
- protocol Number
- IP protocol number
- description String
- Description of the resource.
- display
Name String - Display name of the service entry
PolicySecurityPolicyRuleServiceEntriesL4PortSetEntry, PolicySecurityPolicyRuleServiceEntriesL4PortSetEntryArgs
- Protocol string
- L4 protocol:
TCP
orUDP
- Description string
- Description of the resource.
- Destination
Ports List<string> - Set of destination ports
- Display
Name string - Display name of the service entry
- Source
Ports List<string> - Set of source ports
- Protocol string
- L4 protocol:
TCP
orUDP
- Description string
- Description of the resource.
- Destination
Ports []string - Set of destination ports
- Display
Name string - Display name of the service entry
- Source
Ports []string - Set of source ports
- protocol String
- L4 protocol:
TCP
orUDP
- description String
- Description of the resource.
- destination
Ports List<String> - Set of destination ports
- display
Name String - Display name of the service entry
- source
Ports List<String> - Set of source ports
- protocol string
- L4 protocol:
TCP
orUDP
- description string
- Description of the resource.
- destination
Ports string[] - Set of destination ports
- display
Name string - Display name of the service entry
- source
Ports string[] - Set of source ports
- protocol str
- L4 protocol:
TCP
orUDP
- description str
- Description of the resource.
- destination_
ports Sequence[str] - Set of destination ports
- display_
name str - Display name of the service entry
- source_
ports Sequence[str] - Set of source ports
- protocol String
- L4 protocol:
TCP
orUDP
- description String
- Description of the resource.
- destination
Ports List<String> - Set of destination ports
- display
Name String - Display name of the service entry
- source
Ports List<String> - Set of source ports
PolicySecurityPolicyRuleTag, PolicySecurityPolicyRuleTagArgs
PolicySecurityPolicyTag, PolicySecurityPolicyTagArgs
Package Details
- Repository
- nsxt vmware/terraform-provider-nsxt
- License
- Notes
- This Pulumi package is based on the
nsxt
Terraform Provider.