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

nsxt.PolicyService

Explore with Pulumi AI

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

    Create PolicyService Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PolicyService(name: string, args: PolicyServiceArgs, opts?: CustomResourceOptions);
    @overload
    def PolicyService(resource_name: str,
                      args: PolicyServiceArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def PolicyService(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      display_name: Optional[str] = None,
                      igmp_entries: Optional[Sequence[PolicyServiceIgmpEntryArgs]] = None,
                      description: Optional[str] = None,
                      context: Optional[PolicyServiceContextArgs] = None,
                      ether_type_entries: Optional[Sequence[PolicyServiceEtherTypeEntryArgs]] = None,
                      icmp_entries: Optional[Sequence[PolicyServiceIcmpEntryArgs]] = None,
                      algorithm_entries: Optional[Sequence[PolicyServiceAlgorithmEntryArgs]] = None,
                      ip_protocol_entries: Optional[Sequence[PolicyServiceIpProtocolEntryArgs]] = None,
                      l4_port_set_entries: Optional[Sequence[PolicyServiceL4PortSetEntryArgs]] = None,
                      nested_service_entries: Optional[Sequence[PolicyServiceNestedServiceEntryArgs]] = None,
                      nsx_id: Optional[str] = None,
                      policy_service_id: Optional[str] = None,
                      tags: Optional[Sequence[PolicyServiceTagArgs]] = None)
    func NewPolicyService(ctx *Context, name string, args PolicyServiceArgs, opts ...ResourceOption) (*PolicyService, error)
    public PolicyService(string name, PolicyServiceArgs args, CustomResourceOptions? opts = null)
    public PolicyService(String name, PolicyServiceArgs args)
    public PolicyService(String name, PolicyServiceArgs args, CustomResourceOptions options)
    
    type: nsxt:PolicyService
    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 PolicyServiceArgs
    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 PolicyServiceArgs
    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 PolicyServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyServiceArgs
    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 policyServiceResource = new Nsxt.PolicyService("policyServiceResource", new()
    {
        DisplayName = "string",
        IgmpEntries = new[]
        {
            new Nsxt.Inputs.PolicyServiceIgmpEntryArgs
            {
                Description = "string",
                DisplayName = "string",
            },
        },
        Description = "string",
        Context = new Nsxt.Inputs.PolicyServiceContextArgs
        {
            ProjectId = "string",
        },
        EtherTypeEntries = new[]
        {
            new Nsxt.Inputs.PolicyServiceEtherTypeEntryArgs
            {
                EtherType = 0,
                Description = "string",
                DisplayName = "string",
            },
        },
        IcmpEntries = new[]
        {
            new Nsxt.Inputs.PolicyServiceIcmpEntryArgs
            {
                Protocol = "string",
                Description = "string",
                DisplayName = "string",
                IcmpCode = "string",
                IcmpType = "string",
            },
        },
        AlgorithmEntries = new[]
        {
            new Nsxt.Inputs.PolicyServiceAlgorithmEntryArgs
            {
                Algorithm = "string",
                DestinationPort = "string",
                Description = "string",
                DisplayName = "string",
                SourcePorts = new[]
                {
                    "string",
                },
            },
        },
        IpProtocolEntries = new[]
        {
            new Nsxt.Inputs.PolicyServiceIpProtocolEntryArgs
            {
                Protocol = 0,
                Description = "string",
                DisplayName = "string",
            },
        },
        L4PortSetEntries = new[]
        {
            new Nsxt.Inputs.PolicyServiceL4PortSetEntryArgs
            {
                Protocol = "string",
                Description = "string",
                DestinationPorts = new[]
                {
                    "string",
                },
                DisplayName = "string",
                SourcePorts = new[]
                {
                    "string",
                },
            },
        },
        NestedServiceEntries = new[]
        {
            new Nsxt.Inputs.PolicyServiceNestedServiceEntryArgs
            {
                NestedServicePath = "string",
                Description = "string",
                DisplayName = "string",
            },
        },
        NsxId = "string",
        PolicyServiceId = "string",
        Tags = new[]
        {
            new Nsxt.Inputs.PolicyServiceTagArgs
            {
                Scope = "string",
                Tag = "string",
            },
        },
    });
    
    example, err := nsxt.NewPolicyService(ctx, "policyServiceResource", &nsxt.PolicyServiceArgs{
    	DisplayName: pulumi.String("string"),
    	IgmpEntries: nsxt.PolicyServiceIgmpEntryArray{
    		&nsxt.PolicyServiceIgmpEntryArgs{
    			Description: pulumi.String("string"),
    			DisplayName: pulumi.String("string"),
    		},
    	},
    	Description: pulumi.String("string"),
    	Context: &nsxt.PolicyServiceContextArgs{
    		ProjectId: pulumi.String("string"),
    	},
    	EtherTypeEntries: nsxt.PolicyServiceEtherTypeEntryArray{
    		&nsxt.PolicyServiceEtherTypeEntryArgs{
    			EtherType:   pulumi.Float64(0),
    			Description: pulumi.String("string"),
    			DisplayName: pulumi.String("string"),
    		},
    	},
    	IcmpEntries: nsxt.PolicyServiceIcmpEntryArray{
    		&nsxt.PolicyServiceIcmpEntryArgs{
    			Protocol:    pulumi.String("string"),
    			Description: pulumi.String("string"),
    			DisplayName: pulumi.String("string"),
    			IcmpCode:    pulumi.String("string"),
    			IcmpType:    pulumi.String("string"),
    		},
    	},
    	AlgorithmEntries: nsxt.PolicyServiceAlgorithmEntryArray{
    		&nsxt.PolicyServiceAlgorithmEntryArgs{
    			Algorithm:       pulumi.String("string"),
    			DestinationPort: pulumi.String("string"),
    			Description:     pulumi.String("string"),
    			DisplayName:     pulumi.String("string"),
    			SourcePorts: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    	},
    	IpProtocolEntries: nsxt.PolicyServiceIpProtocolEntryArray{
    		&nsxt.PolicyServiceIpProtocolEntryArgs{
    			Protocol:    pulumi.Float64(0),
    			Description: pulumi.String("string"),
    			DisplayName: pulumi.String("string"),
    		},
    	},
    	L4PortSetEntries: nsxt.PolicyServiceL4PortSetEntryArray{
    		&nsxt.PolicyServiceL4PortSetEntryArgs{
    			Protocol:    pulumi.String("string"),
    			Description: pulumi.String("string"),
    			DestinationPorts: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			DisplayName: pulumi.String("string"),
    			SourcePorts: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    	},
    	NestedServiceEntries: nsxt.PolicyServiceNestedServiceEntryArray{
    		&nsxt.PolicyServiceNestedServiceEntryArgs{
    			NestedServicePath: pulumi.String("string"),
    			Description:       pulumi.String("string"),
    			DisplayName:       pulumi.String("string"),
    		},
    	},
    	NsxId:           pulumi.String("string"),
    	PolicyServiceId: pulumi.String("string"),
    	Tags: nsxt.PolicyServiceTagArray{
    		&nsxt.PolicyServiceTagArgs{
    			Scope: pulumi.String("string"),
    			Tag:   pulumi.String("string"),
    		},
    	},
    })
    
    var policyServiceResource = new PolicyService("policyServiceResource", PolicyServiceArgs.builder()
        .displayName("string")
        .igmpEntries(PolicyServiceIgmpEntryArgs.builder()
            .description("string")
            .displayName("string")
            .build())
        .description("string")
        .context(PolicyServiceContextArgs.builder()
            .projectId("string")
            .build())
        .etherTypeEntries(PolicyServiceEtherTypeEntryArgs.builder()
            .etherType(0)
            .description("string")
            .displayName("string")
            .build())
        .icmpEntries(PolicyServiceIcmpEntryArgs.builder()
            .protocol("string")
            .description("string")
            .displayName("string")
            .icmpCode("string")
            .icmpType("string")
            .build())
        .algorithmEntries(PolicyServiceAlgorithmEntryArgs.builder()
            .algorithm("string")
            .destinationPort("string")
            .description("string")
            .displayName("string")
            .sourcePorts("string")
            .build())
        .ipProtocolEntries(PolicyServiceIpProtocolEntryArgs.builder()
            .protocol(0)
            .description("string")
            .displayName("string")
            .build())
        .l4PortSetEntries(PolicyServiceL4PortSetEntryArgs.builder()
            .protocol("string")
            .description("string")
            .destinationPorts("string")
            .displayName("string")
            .sourcePorts("string")
            .build())
        .nestedServiceEntries(PolicyServiceNestedServiceEntryArgs.builder()
            .nestedServicePath("string")
            .description("string")
            .displayName("string")
            .build())
        .nsxId("string")
        .policyServiceId("string")
        .tags(PolicyServiceTagArgs.builder()
            .scope("string")
            .tag("string")
            .build())
        .build());
    
    policy_service_resource = nsxt.PolicyService("policyServiceResource",
        display_name="string",
        igmp_entries=[{
            "description": "string",
            "display_name": "string",
        }],
        description="string",
        context={
            "project_id": "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",
        }],
        algorithm_entries=[{
            "algorithm": "string",
            "destination_port": "string",
            "description": "string",
            "display_name": "string",
            "source_ports": ["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"],
        }],
        nested_service_entries=[{
            "nested_service_path": "string",
            "description": "string",
            "display_name": "string",
        }],
        nsx_id="string",
        policy_service_id="string",
        tags=[{
            "scope": "string",
            "tag": "string",
        }])
    
    const policyServiceResource = new nsxt.PolicyService("policyServiceResource", {
        displayName: "string",
        igmpEntries: [{
            description: "string",
            displayName: "string",
        }],
        description: "string",
        context: {
            projectId: "string",
        },
        etherTypeEntries: [{
            etherType: 0,
            description: "string",
            displayName: "string",
        }],
        icmpEntries: [{
            protocol: "string",
            description: "string",
            displayName: "string",
            icmpCode: "string",
            icmpType: "string",
        }],
        algorithmEntries: [{
            algorithm: "string",
            destinationPort: "string",
            description: "string",
            displayName: "string",
            sourcePorts: ["string"],
        }],
        ipProtocolEntries: [{
            protocol: 0,
            description: "string",
            displayName: "string",
        }],
        l4PortSetEntries: [{
            protocol: "string",
            description: "string",
            destinationPorts: ["string"],
            displayName: "string",
            sourcePorts: ["string"],
        }],
        nestedServiceEntries: [{
            nestedServicePath: "string",
            description: "string",
            displayName: "string",
        }],
        nsxId: "string",
        policyServiceId: "string",
        tags: [{
            scope: "string",
            tag: "string",
        }],
    });
    
    type: nsxt:PolicyService
    properties:
        algorithmEntries:
            - algorithm: string
              description: string
              destinationPort: string
              displayName: string
              sourcePorts:
                - string
        context:
            projectId: string
        description: string
        displayName: 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
        nestedServiceEntries:
            - description: string
              displayName: string
              nestedServicePath: string
        nsxId: string
        policyServiceId: string
        tags:
            - scope: string
              tag: string
    

    PolicyService 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 PolicyService resource accepts the following input properties:

    DisplayName string
    Display name of the resource.
    AlgorithmEntries List<PolicyServiceAlgorithmEntry>
    Set of Algorithm type service entries. Each with the following attributes:
    Context PolicyServiceContext
    The context which the object belongs to
    Description string
    Description of the resource.
    EtherTypeEntries List<PolicyServiceEtherTypeEntry>
    Set of Ether type service entries. Each with the following attributes:
    IcmpEntries List<PolicyServiceIcmpEntry>
    Set of ICMP type service entries. Each with the following attributes:
    IgmpEntries List<PolicyServiceIgmpEntry>
    Set of IGMP type service entries. Each with the following attributes:
    IpProtocolEntries List<PolicyServiceIpProtocolEntry>
    Set of IP Protocol type service entries. Each with the following attributes:
    L4PortSetEntries List<PolicyServiceL4PortSetEntry>
    Set of L4 ports set service entries. Each with the following attributes:
    NestedServiceEntries List<PolicyServiceNestedServiceEntry>
    Feature introduced since at least NSX-T 3.1, set of Nested service entries. Each with the following attributes:
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    PolicyServiceId string
    ID of the service.
    Tags List<PolicyServiceTag>
    A list of scope + tag pairs to associate with this resource.
    DisplayName string
    Display name of the resource.
    AlgorithmEntries []PolicyServiceAlgorithmEntryArgs
    Set of Algorithm type service entries. Each with the following attributes:
    Context PolicyServiceContextArgs
    The context which the object belongs to
    Description string
    Description of the resource.
    EtherTypeEntries []PolicyServiceEtherTypeEntryArgs
    Set of Ether type service entries. Each with the following attributes:
    IcmpEntries []PolicyServiceIcmpEntryArgs
    Set of ICMP type service entries. Each with the following attributes:
    IgmpEntries []PolicyServiceIgmpEntryArgs
    Set of IGMP type service entries. Each with the following attributes:
    IpProtocolEntries []PolicyServiceIpProtocolEntryArgs
    Set of IP Protocol type service entries. Each with the following attributes:
    L4PortSetEntries []PolicyServiceL4PortSetEntryArgs
    Set of L4 ports set service entries. Each with the following attributes:
    NestedServiceEntries []PolicyServiceNestedServiceEntryArgs
    Feature introduced since at least NSX-T 3.1, set of Nested service entries. Each with the following attributes:
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    PolicyServiceId string
    ID of the service.
    Tags []PolicyServiceTagArgs
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    algorithmEntries List<PolicyServiceAlgorithmEntry>
    Set of Algorithm type service entries. Each with the following attributes:
    context PolicyServiceContext
    The context which the object belongs to
    description String
    Description of the resource.
    etherTypeEntries List<PolicyServiceEtherTypeEntry>
    Set of Ether type service entries. Each with the following attributes:
    icmpEntries List<PolicyServiceIcmpEntry>
    Set of ICMP type service entries. Each with the following attributes:
    igmpEntries List<PolicyServiceIgmpEntry>
    Set of IGMP type service entries. Each with the following attributes:
    ipProtocolEntries List<PolicyServiceIpProtocolEntry>
    Set of IP Protocol type service entries. Each with the following attributes:
    l4PortSetEntries List<PolicyServiceL4PortSetEntry>
    Set of L4 ports set service entries. Each with the following attributes:
    nestedServiceEntries List<PolicyServiceNestedServiceEntry>
    Feature introduced since at least NSX-T 3.1, set of Nested service entries. Each with the following attributes:
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    policyServiceId String
    ID of the service.
    tags List<PolicyServiceTag>
    A list of scope + tag pairs to associate with this resource.
    displayName string
    Display name of the resource.
    algorithmEntries PolicyServiceAlgorithmEntry[]
    Set of Algorithm type service entries. Each with the following attributes:
    context PolicyServiceContext
    The context which the object belongs to
    description string
    Description of the resource.
    etherTypeEntries PolicyServiceEtherTypeEntry[]
    Set of Ether type service entries. Each with the following attributes:
    icmpEntries PolicyServiceIcmpEntry[]
    Set of ICMP type service entries. Each with the following attributes:
    igmpEntries PolicyServiceIgmpEntry[]
    Set of IGMP type service entries. Each with the following attributes:
    ipProtocolEntries PolicyServiceIpProtocolEntry[]
    Set of IP Protocol type service entries. Each with the following attributes:
    l4PortSetEntries PolicyServiceL4PortSetEntry[]
    Set of L4 ports set service entries. Each with the following attributes:
    nestedServiceEntries PolicyServiceNestedServiceEntry[]
    Feature introduced since at least NSX-T 3.1, set of Nested service entries. Each with the following attributes:
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    policyServiceId string
    ID of the service.
    tags PolicyServiceTag[]
    A list of scope + tag pairs to associate with this resource.
    display_name str
    Display name of the resource.
    algorithm_entries Sequence[PolicyServiceAlgorithmEntryArgs]
    Set of Algorithm type service entries. Each with the following attributes:
    context PolicyServiceContextArgs
    The context which the object belongs to
    description str
    Description of the resource.
    ether_type_entries Sequence[PolicyServiceEtherTypeEntryArgs]
    Set of Ether type service entries. Each with the following attributes:
    icmp_entries Sequence[PolicyServiceIcmpEntryArgs]
    Set of ICMP type service entries. Each with the following attributes:
    igmp_entries Sequence[PolicyServiceIgmpEntryArgs]
    Set of IGMP type service entries. Each with the following attributes:
    ip_protocol_entries Sequence[PolicyServiceIpProtocolEntryArgs]
    Set of IP Protocol type service entries. Each with the following attributes:
    l4_port_set_entries Sequence[PolicyServiceL4PortSetEntryArgs]
    Set of L4 ports set service entries. Each with the following attributes:
    nested_service_entries Sequence[PolicyServiceNestedServiceEntryArgs]
    Feature introduced since at least NSX-T 3.1, set of Nested service entries. Each with the following attributes:
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    policy_service_id str
    ID of the service.
    tags Sequence[PolicyServiceTagArgs]
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    algorithmEntries List<Property Map>
    Set of Algorithm type service entries. Each with the following attributes:
    context Property Map
    The context which the object belongs to
    description String
    Description of the resource.
    etherTypeEntries List<Property Map>
    Set of Ether type service entries. Each with the following attributes:
    icmpEntries List<Property Map>
    Set of ICMP type service entries. Each with the following attributes:
    igmpEntries List<Property Map>
    Set of IGMP type service entries. Each with the following attributes:
    ipProtocolEntries List<Property Map>
    Set of IP Protocol type service entries. Each with the following attributes:
    l4PortSetEntries List<Property Map>
    Set of L4 ports set service entries. Each with the following attributes:
    nestedServiceEntries List<Property Map>
    Feature introduced since at least NSX-T 3.1, set of Nested service entries. Each with the following attributes:
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    policyServiceId String
    ID of the service.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PolicyService 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 PolicyService Resource

    Get an existing PolicyService 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?: PolicyServiceState, opts?: CustomResourceOptions): PolicyService
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            algorithm_entries: Optional[Sequence[PolicyServiceAlgorithmEntryArgs]] = None,
            context: Optional[PolicyServiceContextArgs] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            ether_type_entries: Optional[Sequence[PolicyServiceEtherTypeEntryArgs]] = None,
            icmp_entries: Optional[Sequence[PolicyServiceIcmpEntryArgs]] = None,
            igmp_entries: Optional[Sequence[PolicyServiceIgmpEntryArgs]] = None,
            ip_protocol_entries: Optional[Sequence[PolicyServiceIpProtocolEntryArgs]] = None,
            l4_port_set_entries: Optional[Sequence[PolicyServiceL4PortSetEntryArgs]] = None,
            nested_service_entries: Optional[Sequence[PolicyServiceNestedServiceEntryArgs]] = None,
            nsx_id: Optional[str] = None,
            path: Optional[str] = None,
            policy_service_id: Optional[str] = None,
            revision: Optional[float] = None,
            tags: Optional[Sequence[PolicyServiceTagArgs]] = None) -> PolicyService
    func GetPolicyService(ctx *Context, name string, id IDInput, state *PolicyServiceState, opts ...ResourceOption) (*PolicyService, error)
    public static PolicyService Get(string name, Input<string> id, PolicyServiceState? state, CustomResourceOptions? opts = null)
    public static PolicyService get(String name, Output<String> id, PolicyServiceState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyService    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:
    AlgorithmEntries List<PolicyServiceAlgorithmEntry>
    Set of Algorithm type service entries. Each with the following attributes:
    Context PolicyServiceContext
    The context which the object belongs to
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    EtherTypeEntries List<PolicyServiceEtherTypeEntry>
    Set of Ether type service entries. Each with the following attributes:
    IcmpEntries List<PolicyServiceIcmpEntry>
    Set of ICMP type service entries. Each with the following attributes:
    IgmpEntries List<PolicyServiceIgmpEntry>
    Set of IGMP type service entries. Each with the following attributes:
    IpProtocolEntries List<PolicyServiceIpProtocolEntry>
    Set of IP Protocol type service entries. Each with the following attributes:
    L4PortSetEntries List<PolicyServiceL4PortSetEntry>
    Set of L4 ports set service entries. Each with the following attributes:
    NestedServiceEntries List<PolicyServiceNestedServiceEntry>
    Feature introduced since at least NSX-T 3.1, set of Nested service entries. Each with the following attributes:
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    Path string
    The NSX path of the policy resource.
    PolicyServiceId string
    ID of the service.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags List<PolicyServiceTag>
    A list of scope + tag pairs to associate with this resource.
    AlgorithmEntries []PolicyServiceAlgorithmEntryArgs
    Set of Algorithm type service entries. Each with the following attributes:
    Context PolicyServiceContextArgs
    The context which the object belongs to
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    EtherTypeEntries []PolicyServiceEtherTypeEntryArgs
    Set of Ether type service entries. Each with the following attributes:
    IcmpEntries []PolicyServiceIcmpEntryArgs
    Set of ICMP type service entries. Each with the following attributes:
    IgmpEntries []PolicyServiceIgmpEntryArgs
    Set of IGMP type service entries. Each with the following attributes:
    IpProtocolEntries []PolicyServiceIpProtocolEntryArgs
    Set of IP Protocol type service entries. Each with the following attributes:
    L4PortSetEntries []PolicyServiceL4PortSetEntryArgs
    Set of L4 ports set service entries. Each with the following attributes:
    NestedServiceEntries []PolicyServiceNestedServiceEntryArgs
    Feature introduced since at least NSX-T 3.1, set of Nested service entries. Each with the following attributes:
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    Path string
    The NSX path of the policy resource.
    PolicyServiceId string
    ID of the service.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags []PolicyServiceTagArgs
    A list of scope + tag pairs to associate with this resource.
    algorithmEntries List<PolicyServiceAlgorithmEntry>
    Set of Algorithm type service entries. Each with the following attributes:
    context PolicyServiceContext
    The context which the object belongs to
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    etherTypeEntries List<PolicyServiceEtherTypeEntry>
    Set of Ether type service entries. Each with the following attributes:
    icmpEntries List<PolicyServiceIcmpEntry>
    Set of ICMP type service entries. Each with the following attributes:
    igmpEntries List<PolicyServiceIgmpEntry>
    Set of IGMP type service entries. Each with the following attributes:
    ipProtocolEntries List<PolicyServiceIpProtocolEntry>
    Set of IP Protocol type service entries. Each with the following attributes:
    l4PortSetEntries List<PolicyServiceL4PortSetEntry>
    Set of L4 ports set service entries. Each with the following attributes:
    nestedServiceEntries List<PolicyServiceNestedServiceEntry>
    Feature introduced since at least NSX-T 3.1, set of Nested service entries. Each with the following attributes:
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    path String
    The NSX path of the policy resource.
    policyServiceId String
    ID of the service.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags List<PolicyServiceTag>
    A list of scope + tag pairs to associate with this resource.
    algorithmEntries PolicyServiceAlgorithmEntry[]
    Set of Algorithm type service entries. Each with the following attributes:
    context PolicyServiceContext
    The context which the object belongs to
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    etherTypeEntries PolicyServiceEtherTypeEntry[]
    Set of Ether type service entries. Each with the following attributes:
    icmpEntries PolicyServiceIcmpEntry[]
    Set of ICMP type service entries. Each with the following attributes:
    igmpEntries PolicyServiceIgmpEntry[]
    Set of IGMP type service entries. Each with the following attributes:
    ipProtocolEntries PolicyServiceIpProtocolEntry[]
    Set of IP Protocol type service entries. Each with the following attributes:
    l4PortSetEntries PolicyServiceL4PortSetEntry[]
    Set of L4 ports set service entries. Each with the following attributes:
    nestedServiceEntries PolicyServiceNestedServiceEntry[]
    Feature introduced since at least NSX-T 3.1, set of Nested service entries. Each with the following attributes:
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    path string
    The NSX path of the policy resource.
    policyServiceId string
    ID of the service.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags PolicyServiceTag[]
    A list of scope + tag pairs to associate with this resource.
    algorithm_entries Sequence[PolicyServiceAlgorithmEntryArgs]
    Set of Algorithm type service entries. Each with the following attributes:
    context PolicyServiceContextArgs
    The context which the object belongs to
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    ether_type_entries Sequence[PolicyServiceEtherTypeEntryArgs]
    Set of Ether type service entries. Each with the following attributes:
    icmp_entries Sequence[PolicyServiceIcmpEntryArgs]
    Set of ICMP type service entries. Each with the following attributes:
    igmp_entries Sequence[PolicyServiceIgmpEntryArgs]
    Set of IGMP type service entries. Each with the following attributes:
    ip_protocol_entries Sequence[PolicyServiceIpProtocolEntryArgs]
    Set of IP Protocol type service entries. Each with the following attributes:
    l4_port_set_entries Sequence[PolicyServiceL4PortSetEntryArgs]
    Set of L4 ports set service entries. Each with the following attributes:
    nested_service_entries Sequence[PolicyServiceNestedServiceEntryArgs]
    Feature introduced since at least NSX-T 3.1, set of Nested service entries. Each with the following attributes:
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    path str
    The NSX path of the policy resource.
    policy_service_id str
    ID of the service.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags Sequence[PolicyServiceTagArgs]
    A list of scope + tag pairs to associate with this resource.
    algorithmEntries List<Property Map>
    Set of Algorithm type service entries. Each with the following attributes:
    context Property Map
    The context which the object belongs to
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    etherTypeEntries List<Property Map>
    Set of Ether type service entries. Each with the following attributes:
    icmpEntries List<Property Map>
    Set of ICMP type service entries. Each with the following attributes:
    igmpEntries List<Property Map>
    Set of IGMP type service entries. Each with the following attributes:
    ipProtocolEntries List<Property Map>
    Set of IP Protocol type service entries. Each with the following attributes:
    l4PortSetEntries List<Property Map>
    Set of L4 ports set service entries. Each with the following attributes:
    nestedServiceEntries List<Property Map>
    Feature introduced since at least NSX-T 3.1, set of Nested service entries. Each with the following attributes:
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    path String
    The NSX path of the policy resource.
    policyServiceId String
    ID of the service.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.

    Supporting Types

    PolicyServiceAlgorithmEntry, PolicyServiceAlgorithmEntryArgs

    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 service entry.
    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 service entry.
    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 service entry.
    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 service entry.
    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 service entry.
    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 service entry.
    displayName String
    Display name of the service entry.
    sourcePorts List<String>
    Set of source ports/ranges.

    PolicyServiceContext, PolicyServiceContextArgs

    ProjectId string
    The ID of the project which the object belongs to The service must contain at least 1 entry (of at least one of the types), and possibly more.
    ProjectId string
    The ID of the project which the object belongs to The service must contain at least 1 entry (of at least one of the types), and possibly more.
    projectId String
    The ID of the project which the object belongs to The service must contain at least 1 entry (of at least one of the types), and possibly more.
    projectId string
    The ID of the project which the object belongs to The service must contain at least 1 entry (of at least one of the types), and possibly more.
    project_id str
    The ID of the project which the object belongs to The service must contain at least 1 entry (of at least one of the types), and possibly more.
    projectId String
    The ID of the project which the object belongs to The service must contain at least 1 entry (of at least one of the types), and possibly more.

    PolicyServiceEtherTypeEntry, PolicyServiceEtherTypeEntryArgs

    EtherType double
    Type of the encapsulated protocol.
    Description string
    Description of the service entry.
    DisplayName string
    Display name of the service entry.
    EtherType float64
    Type of the encapsulated protocol.
    Description string
    Description of the service entry.
    DisplayName string
    Display name of the service entry.
    etherType Double
    Type of the encapsulated protocol.
    description String
    Description of the service entry.
    displayName String
    Display name of the service entry.
    etherType number
    Type of the encapsulated protocol.
    description string
    Description of the service entry.
    displayName string
    Display name of the service entry.
    ether_type float
    Type of the encapsulated protocol.
    description str
    Description of the service entry.
    display_name str
    Display name of the service entry.
    etherType Number
    Type of the encapsulated protocol.
    description String
    Description of the service entry.
    displayName String
    Display name of the service entry.

    PolicyServiceIcmpEntry, PolicyServiceIcmpEntryArgs

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

    PolicyServiceIgmpEntry, PolicyServiceIgmpEntryArgs

    Description string
    Description of the service entry.
    DisplayName string
    Display name of the service entry.
    Description string
    Description of the service entry.
    DisplayName string
    Display name of the service entry.
    description String
    Description of the service entry.
    displayName String
    Display name of the service entry.
    description string
    Description of the service entry.
    displayName string
    Display name of the service entry.
    description str
    Description of the service entry.
    display_name str
    Display name of the service entry.
    description String
    Description of the service entry.
    displayName String
    Display name of the service entry.

    PolicyServiceIpProtocolEntry, PolicyServiceIpProtocolEntryArgs

    Protocol double
    IP protocol number.
    Description string
    Description of the service entry.
    DisplayName string
    Display name of the service entry.
    Protocol float64
    IP protocol number.
    Description string
    Description of the service entry.
    DisplayName string
    Display name of the service entry.
    protocol Double
    IP protocol number.
    description String
    Description of the service entry.
    displayName String
    Display name of the service entry.
    protocol number
    IP protocol number.
    description string
    Description of the service entry.
    displayName string
    Display name of the service entry.
    protocol float
    IP protocol number.
    description str
    Description of the service entry.
    display_name str
    Display name of the service entry.
    protocol Number
    IP protocol number.
    description String
    Description of the service entry.
    displayName String
    Display name of the service entry.

    PolicyServiceL4PortSetEntry, PolicyServiceL4PortSetEntryArgs

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

    PolicyServiceNestedServiceEntry, PolicyServiceNestedServiceEntryArgs

    NestedServicePath string
    Path of the nested service.
    Description string
    Description of the service entry.
    DisplayName string
    Display name of the service entry.
    NestedServicePath string
    Path of the nested service.
    Description string
    Description of the service entry.
    DisplayName string
    Display name of the service entry.
    nestedServicePath String
    Path of the nested service.
    description String
    Description of the service entry.
    displayName String
    Display name of the service entry.
    nestedServicePath string
    Path of the nested service.
    description string
    Description of the service entry.
    displayName string
    Display name of the service entry.
    nested_service_path str
    Path of the nested service.
    description str
    Description of the service entry.
    display_name str
    Display name of the service entry.
    nestedServicePath String
    Path of the nested service.
    description String
    Description of the service entry.
    displayName String
    Display name of the service entry.

    PolicyServiceTag, PolicyServiceTagArgs

    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    Scope string
    Tag string
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.
    scope string
    tag string
    A list of scope + tag pairs to associate with this resource.
    scope str
    tag str
    A list of scope + tag pairs to associate with this resource.
    scope String
    tag String
    A list of scope + tag pairs to associate with this resource.

    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