1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicySecurityPolicy
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

nsxt.PolicySecurityPolicy

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

    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.
    DisplayName string
    Display name of the resource.
    Comments string
    Comments for security policy lock/unlock.
    Context PolicySecurityPolicyContext
    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 to default.
    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.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicySecurityPolicyId string
    ID of the Security Policy.
    Rules List<PolicySecurityPolicyRule>
    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.
    SequenceNumber 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.
    Tags List<PolicySecurityPolicyTag>
    A list of scope + tag pairs to associate with this policy.
    TcpStrict 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.
    DisplayName string
    Display name of the resource.
    Comments string
    Comments for security policy lock/unlock.
    Context PolicySecurityPolicyContextArgs
    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 to default.
    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.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicySecurityPolicyId string
    ID of the Security Policy.
    Rules []PolicySecurityPolicyRuleTypeArgs
    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.
    SequenceNumber 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.
    Tags []PolicySecurityPolicyTagArgs
    A list of scope + tag pairs to associate with this policy.
    TcpStrict 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.
    displayName String
    Display name of the resource.
    comments String
    Comments for security policy lock/unlock.
    context PolicySecurityPolicyContext
    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 to default.
    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.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policySecurityPolicyId String
    ID of the Security Policy.
    rules List<PolicySecurityPolicyRule>
    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.
    sequenceNumber 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.
    tags List<PolicySecurityPolicyTag>
    A list of scope + tag pairs to associate with this policy.
    tcpStrict 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.
    displayName string
    Display name of the resource.
    comments string
    Comments for security policy lock/unlock.
    context PolicySecurityPolicyContext
    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 to default.
    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.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policySecurityPolicyId string
    ID of the Security Policy.
    rules PolicySecurityPolicyRule[]
    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.
    sequenceNumber 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.
    tags PolicySecurityPolicyTag[]
    A list of scope + tag pairs to associate with this policy.
    tcpStrict 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 PolicySecurityPolicyContextArgs
    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 to default.
    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_policy_id str
    ID of the Security Policy.
    rules Sequence[PolicySecurityPolicyRuleArgs]
    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.
    tags Sequence[PolicySecurityPolicyTagArgs]
    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.
    displayName 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 to default.
    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.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policySecurityPolicyId String
    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.
    sequenceNumber 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.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this policy.
    tcpStrict 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:

    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the policy resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the policy resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX path of the policy resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id string
    The provider-assigned unique ID for this managed resource.
    path string
    The NSX path of the policy resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id str
    The provider-assigned unique ID for this managed resource.
    path str
    The NSX path of the policy resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX path of the policy resource.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

    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.
    The following state arguments are supported:
    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 PolicySecurityPolicyContext
    The context which the object belongs to
    Description string
    Description of the resource.
    DisplayName 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 to default.
    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.
    NsxId 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.
    PolicySecurityPolicyId string
    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<PolicySecurityPolicyRule>
    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.
    SequenceNumber 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.
    Tags List<PolicySecurityPolicyTag>
    A list of scope + tag pairs to associate with this policy.
    TcpStrict 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 PolicySecurityPolicyContextArgs
    The context which the object belongs to
    Description string
    Description of the resource.
    DisplayName 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 to default.
    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.
    NsxId 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.
    PolicySecurityPolicyId string
    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 []PolicySecurityPolicyRuleTypeArgs
    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.
    SequenceNumber 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.
    Tags []PolicySecurityPolicyTagArgs
    A list of scope + tag pairs to associate with this policy.
    TcpStrict 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 PolicySecurityPolicyContext
    The context which the object belongs to
    description String
    Description of the resource.
    displayName 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 to default.
    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.
    nsxId 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.
    policySecurityPolicyId String
    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<PolicySecurityPolicyRule>
    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.
    sequenceNumber 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.
    tags List<PolicySecurityPolicyTag>
    A list of scope + tag pairs to associate with this policy.
    tcpStrict 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 PolicySecurityPolicyContext
    The context which the object belongs to
    description string
    Description of the resource.
    displayName 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 to default.
    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.
    nsxId 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.
    policySecurityPolicyId string
    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 PolicySecurityPolicyRule[]
    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.
    sequenceNumber 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.
    tags PolicySecurityPolicyTag[]
    A list of scope + tag pairs to associate with this policy.
    tcpStrict 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 PolicySecurityPolicyContextArgs
    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 to default.
    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_policy_id str
    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[PolicySecurityPolicyRuleArgs]
    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.
    tags Sequence[PolicySecurityPolicyTagArgs]
    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.
    displayName 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 to default.
    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.
    nsxId 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.
    policySecurityPolicyId String
    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.
    sequenceNumber 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.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this policy.
    tcpStrict Boolean
    Ensures that a 3 way TCP handshake is done before the data packets are sent. Default is false.

    Supporting Types

    PolicySecurityPolicyContext, PolicySecurityPolicyContextArgs

    ProjectId string
    The ID of the project which the object belongs to
    ProjectId string
    The ID of the project which the object belongs to
    projectId String
    The ID of the project which the object belongs to
    projectId string
    The ID of the project which the object belongs to
    project_id str
    The ID of the project which the object belongs to
    projectId String
    The ID of the project which the object belongs to

    PolicySecurityPolicyRule, PolicySecurityPolicyRuleArgs

    DisplayName string
    Display name of the resource.
    Action string
    Rule action, one of ALLOW, DROP, REJECT and JUMP_TO_APPLICATION. Default is ALLOW. JUMP_TO_APPLICATION is only applicable in Environment category.
    Description string
    Description of the resource.
    DestinationGroups 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".
    DestinationsExcluded bool
    A boolean value indicating negation of destination groups.
    Direction string
    Traffic direction, one of IN, OUT or IN_OUT. Default is IN_OUT.
    Disabled bool
    Flag to disable this rule. Default is false.
    IpVersion string
    Version of IP protocol, one of NONE, IPV4, IPV6, IPV4_IPV6. Default is IPV4_IPV6. For Ethernet category rules, use NONE value.
    LogLabel 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.
    NsxId 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.
    RuleId 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.
    SequenceNumber 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.
    ServiceEntries PolicySecurityPolicyRuleServiceEntries
    Set of explicit protocol/port service definition
    Services List<string>
    Set of service paths to match.
    SourceGroups 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".
    SourcesExcluded bool
    A boolean value indicating negation of source groups.
    Tags List<PolicySecurityPolicyRuleTag>
    A list of scope + tag pairs to associate with this Rule.
    DisplayName string
    Display name of the resource.
    Action string
    Rule action, one of ALLOW, DROP, REJECT and JUMP_TO_APPLICATION. Default is ALLOW. JUMP_TO_APPLICATION is only applicable in Environment category.
    Description string
    Description of the resource.
    DestinationGroups []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".
    DestinationsExcluded bool
    A boolean value indicating negation of destination groups.
    Direction string
    Traffic direction, one of IN, OUT or IN_OUT. Default is IN_OUT.
    Disabled bool
    Flag to disable this rule. Default is false.
    IpVersion string
    Version of IP protocol, one of NONE, IPV4, IPV6, IPV4_IPV6. Default is IPV4_IPV6. For Ethernet category rules, use NONE value.
    LogLabel 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.
    NsxId 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.
    RuleId 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.
    SequenceNumber 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.
    ServiceEntries PolicySecurityPolicyRuleServiceEntries
    Set of explicit protocol/port service definition
    Services []string
    Set of service paths to match.
    SourceGroups []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".
    SourcesExcluded bool
    A boolean value indicating negation of source groups.
    Tags []PolicySecurityPolicyRuleTag
    A list of scope + tag pairs to associate with this Rule.
    displayName String
    Display name of the resource.
    action String
    Rule action, one of ALLOW, DROP, REJECT and JUMP_TO_APPLICATION. Default is ALLOW. JUMP_TO_APPLICATION is only applicable in Environment category.
    description String
    Description of the resource.
    destinationGroups 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".
    destinationsExcluded Boolean
    A boolean value indicating negation of destination groups.
    direction String
    Traffic direction, one of IN, OUT or IN_OUT. Default is IN_OUT.
    disabled Boolean
    Flag to disable this rule. Default is false.
    ipVersion String
    Version of IP protocol, one of NONE, IPV4, IPV6, IPV4_IPV6. Default is IPV4_IPV6. For Ethernet category rules, use NONE value.
    logLabel 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.
    nsxId 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.
    ruleId 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.
    sequenceNumber 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.
    serviceEntries PolicySecurityPolicyRuleServiceEntries
    Set of explicit protocol/port service definition
    services List<String>
    Set of service paths to match.
    sourceGroups 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".
    sourcesExcluded Boolean
    A boolean value indicating negation of source groups.
    tags List<PolicySecurityPolicyRuleTag>
    A list of scope + tag pairs to associate with this Rule.
    displayName string
    Display name of the resource.
    action string
    Rule action, one of ALLOW, DROP, REJECT and JUMP_TO_APPLICATION. Default is ALLOW. JUMP_TO_APPLICATION is only applicable in Environment category.
    description string
    Description of the resource.
    destinationGroups 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".
    destinationsExcluded boolean
    A boolean value indicating negation of destination groups.
    direction string
    Traffic direction, one of IN, OUT or IN_OUT. Default is IN_OUT.
    disabled boolean
    Flag to disable this rule. Default is false.
    ipVersion string
    Version of IP protocol, one of NONE, IPV4, IPV6, IPV4_IPV6. Default is IPV4_IPV6. For Ethernet category rules, use NONE value.
    logLabel 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.
    nsxId 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.
    ruleId 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.
    sequenceNumber 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.
    serviceEntries PolicySecurityPolicyRuleServiceEntries
    Set of explicit protocol/port service definition
    services string[]
    Set of service paths to match.
    sourceGroups 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".
    sourcesExcluded boolean
    A boolean value indicating negation of source groups.
    tags PolicySecurityPolicyRuleTag[]
    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 and JUMP_TO_APPLICATION. Default is ALLOW. JUMP_TO_APPLICATION is only applicable in Environment 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 or IN_OUT. Default is IN_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 is IPV4_IPV6. For Ethernet category rules, use NONE 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 PolicySecurityPolicyRuleServiceEntries
    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.
    tags Sequence[PolicySecurityPolicyRuleTag]
    A list of scope + tag pairs to associate with this Rule.
    displayName String
    Display name of the resource.
    action String
    Rule action, one of ALLOW, DROP, REJECT and JUMP_TO_APPLICATION. Default is ALLOW. JUMP_TO_APPLICATION is only applicable in Environment category.
    description String
    Description of the resource.
    destinationGroups 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".
    destinationsExcluded Boolean
    A boolean value indicating negation of destination groups.
    direction String
    Traffic direction, one of IN, OUT or IN_OUT. Default is IN_OUT.
    disabled Boolean
    Flag to disable this rule. Default is false.
    ipVersion String
    Version of IP protocol, one of NONE, IPV4, IPV6, IPV4_IPV6. Default is IPV4_IPV6. For Ethernet category rules, use NONE value.
    logLabel 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.
    nsxId 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.
    ruleId 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.
    sequenceNumber 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.
    serviceEntries Property Map
    Set of explicit protocol/port service definition
    services List<String>
    Set of service paths to match.
    sourceGroups 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".
    sourcesExcluded Boolean
    A boolean value indicating negation of source groups.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this Rule.

    PolicySecurityPolicyRuleServiceEntries, PolicySecurityPolicyRuleServiceEntriesArgs

    algorithmEntries List<Property Map>
    Set of Algorithm type service entries
    etherTypeEntries List<Property Map>
    Set of Ether type service entries
    icmpEntries List<Property Map>
    Set of ICMP type service entries
    igmpEntries List<Property Map>
    Set of IGMP type service entries
    ipProtocolEntries List<Property Map>
    Set of IP Protocol type service entries
    l4PortSetEntries List<Property Map>
    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
    DestinationPort string
    a single destination port
    Description string
    Description of the resource.
    DisplayName string
    Display name of the service entry
    SourcePorts 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
    DestinationPort string
    a single destination port
    Description string
    Description of the resource.
    DisplayName string
    Display name of the service entry
    SourcePorts []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
    destinationPort String
    a single destination port
    description String
    Description of the resource.
    displayName String
    Display name of the service entry
    sourcePorts 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
    destinationPort string
    a single destination port
    description string
    Description of the resource.
    displayName string
    Display name of the service entry
    sourcePorts 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
    destinationPort String
    a single destination port
    description String
    Description of the resource.
    displayName String
    Display name of the service entry
    sourcePorts List<String>
    Set of source ports/ranges

    PolicySecurityPolicyRuleServiceEntriesEtherTypeEntry, PolicySecurityPolicyRuleServiceEntriesEtherTypeEntryArgs

    EtherType double
    Type of the encapsulated protocol
    Description string
    Description of the resource.
    DisplayName string
    Display name of the service entry
    EtherType float64
    Type of the encapsulated protocol
    Description string
    Description of the resource.
    DisplayName string
    Display name of the service entry
    etherType Double
    Type of the encapsulated protocol
    description String
    Description of the resource.
    displayName String
    Display name of the service entry
    etherType number
    Type of the encapsulated protocol
    description string
    Description of the resource.
    displayName 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
    etherType Number
    Type of the encapsulated protocol
    description String
    Description of the resource.
    displayName String
    Display name of the service entry

    PolicySecurityPolicyRuleServiceEntriesIcmpEntry, PolicySecurityPolicyRuleServiceEntriesIcmpEntryArgs

    Protocol string
    Version of ICMP protocol: ICMPv4 or ICMPv6
    Description string
    Description of the resource.
    DisplayName string
    Display name of the service entry
    IcmpCode string
    ICMP message code
    IcmpType string
    ICMP message type
    Protocol string
    Version of ICMP protocol: ICMPv4 or ICMPv6
    Description string
    Description of the resource.
    DisplayName string
    Display name of the service entry
    IcmpCode string
    ICMP message code
    IcmpType string
    ICMP message type
    protocol String
    Version of ICMP protocol: ICMPv4 or ICMPv6
    description String
    Description of the resource.
    displayName String
    Display name of the service entry
    icmpCode String
    ICMP message code
    icmpType String
    ICMP message type
    protocol string
    Version of ICMP protocol: ICMPv4 or ICMPv6
    description string
    Description of the resource.
    displayName string
    Display name of the service entry
    icmpCode string
    ICMP message code
    icmpType string
    ICMP message type
    protocol str
    Version of ICMP protocol: ICMPv4 or ICMPv6
    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 or ICMPv6
    description String
    Description of the resource.
    displayName String
    Display name of the service entry
    icmpCode String
    ICMP message code
    icmpType String
    ICMP message type

    PolicySecurityPolicyRuleServiceEntriesIgmpEntry, PolicySecurityPolicyRuleServiceEntriesIgmpEntryArgs

    Description string
    Description of the resource.
    DisplayName string
    Display name of the service entry
    Description string
    Description of the resource.
    DisplayName string
    Display name of the service entry
    description String
    Description of the resource.
    displayName String
    Display name of the service entry
    description string
    Description of the resource.
    displayName 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.
    displayName String
    Display name of the service entry

    PolicySecurityPolicyRuleServiceEntriesIpProtocolEntry, PolicySecurityPolicyRuleServiceEntriesIpProtocolEntryArgs

    Protocol double
    IP protocol number
    Description string
    Description of the resource.
    DisplayName string
    Display name of the service entry
    Protocol float64
    IP protocol number
    Description string
    Description of the resource.
    DisplayName string
    Display name of the service entry
    protocol Double
    IP protocol number
    description String
    Description of the resource.
    displayName String
    Display name of the service entry
    protocol number
    IP protocol number
    description string
    Description of the resource.
    displayName 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.
    displayName String
    Display name of the service entry

    PolicySecurityPolicyRuleServiceEntriesL4PortSetEntry, PolicySecurityPolicyRuleServiceEntriesL4PortSetEntryArgs

    Protocol string
    L4 protocol: TCP or UDP
    Description string
    Description of the resource.
    DestinationPorts List<string>
    Set of destination ports
    DisplayName string
    Display name of the service entry
    SourcePorts List<string>
    Set of source ports
    Protocol string
    L4 protocol: TCP or UDP
    Description string
    Description of the resource.
    DestinationPorts []string
    Set of destination ports
    DisplayName string
    Display name of the service entry
    SourcePorts []string
    Set of source ports
    protocol String
    L4 protocol: TCP or UDP
    description String
    Description of the resource.
    destinationPorts List<String>
    Set of destination ports
    displayName String
    Display name of the service entry
    sourcePorts List<String>
    Set of source ports
    protocol string
    L4 protocol: TCP or UDP
    description string
    Description of the resource.
    destinationPorts string[]
    Set of destination ports
    displayName string
    Display name of the service entry
    sourcePorts string[]
    Set of source ports
    protocol str
    L4 protocol: TCP or UDP
    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 or UDP
    description String
    Description of the resource.
    destinationPorts List<String>
    Set of destination ports
    displayName String
    Display name of the service entry
    sourcePorts List<String>
    Set of source ports

    PolicySecurityPolicyRuleTag, PolicySecurityPolicyRuleTagArgs

    Scope string
    Set of policy object paths where the rule is applied.
    Tag string
    A list of scope + tag pairs to associate with this policy.
    Scope string
    Set of policy object paths where the rule is applied.
    Tag string
    A list of scope + tag pairs to associate with this policy.
    scope String
    Set of policy object paths where the rule is applied.
    tag String
    A list of scope + tag pairs to associate with this policy.
    scope string
    Set of policy object paths where the rule is applied.
    tag string
    A list of scope + tag pairs to associate with this policy.
    scope str
    Set of policy object paths where the rule is applied.
    tag str
    A list of scope + tag pairs to associate with this policy.
    scope String
    Set of policy object paths where the rule is applied.
    tag String
    A list of scope + tag pairs to associate with this policy.

    PolicySecurityPolicyTag, PolicySecurityPolicyTagArgs

    Scope string
    The list of policy object paths where the rules in this policy will get applied.
    Tag string
    A list of scope + tag pairs to associate with this policy.
    Scope string
    The list of policy object paths where the rules in this policy will get applied.
    Tag string
    A list of scope + tag pairs to associate with this policy.
    scope String
    The list of policy object paths where the rules in this policy will get applied.
    tag String
    A list of scope + tag pairs to associate with this policy.
    scope string
    The list of policy object paths where the rules in this policy will get applied.
    tag string
    A list of scope + tag pairs to associate with this policy.
    scope str
    The list of policy object paths where the rules in this policy will get applied.
    tag str
    A list of scope + tag pairs to associate with this policy.
    scope String
    The list of policy object paths where the rules in this policy will get applied.
    tag String
    A list of scope + tag pairs to associate with this policy.

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    nsxt logo
    nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware