nsxt 3.8.1, Apr 30 25

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

nsxt.PolicyPredefinedGatewayPolicy

Explore with Pulumi AI

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

Create PolicyPredefinedGatewayPolicy Resource

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

Constructor syntax

new PolicyPredefinedGatewayPolicy(name: string, args: PolicyPredefinedGatewayPolicyArgs, opts?: CustomResourceOptions);

@overload
def PolicyPredefinedGatewayPolicy(resource_name: str,
                                  args: PolicyPredefinedGatewayPolicyArgs,
                                  opts: Optional[ResourceOptions] = None)

@overload
def PolicyPredefinedGatewayPolicy(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  path: Optional[str] = None,
                                  context: Optional[PolicyPredefinedGatewayPolicyContextArgs] = None,
                                  default_rules: Optional[Sequence[PolicyPredefinedGatewayPolicyDefaultRuleArgs]] = None,
                                  description: Optional[str] = None,
                                  policy_predefined_gateway_policy_id: Optional[str] = None,
                                  rules: Optional[Sequence[PolicyPredefinedGatewayPolicyRuleArgs]] = None,
                                  tags: Optional[Sequence[PolicyPredefinedGatewayPolicyTagArgs]] = None)

func NewPolicyPredefinedGatewayPolicy(ctx *Context, name string, args PolicyPredefinedGatewayPolicyArgs, opts ...ResourceOption) (*PolicyPredefinedGatewayPolicy, error)

public PolicyPredefinedGatewayPolicy(string name, PolicyPredefinedGatewayPolicyArgs args, CustomResourceOptions? opts = null)

public PolicyPredefinedGatewayPolicy(String name, PolicyPredefinedGatewayPolicyArgs args)
public PolicyPredefinedGatewayPolicy(String name, PolicyPredefinedGatewayPolicyArgs args, CustomResourceOptions options)

type: nsxt:PolicyPredefinedGatewayPolicy
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 PolicyPredefinedGatewayPolicyArgs: 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 PolicyPredefinedGatewayPolicyArgs: 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 PolicyPredefinedGatewayPolicyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PolicyPredefinedGatewayPolicyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PolicyPredefinedGatewayPolicyArgs: 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 policyPredefinedGatewayPolicyResource = new Nsxt.PolicyPredefinedGatewayPolicy("policyPredefinedGatewayPolicyResource", new()
{
    Path = "string",
    Context = new Nsxt.Inputs.PolicyPredefinedGatewayPolicyContextArgs
    {
        ProjectId = "string",
    },
    DefaultRules = new[]
    {
        new Nsxt.Inputs.PolicyPredefinedGatewayPolicyDefaultRuleArgs
        {
            Scope = "string",
            Action = "string",
            Description = "string",
            LogLabel = "string",
            Logged = false,
            NsxId = "string",
            Path = "string",
            Revision = 0,
            SequenceNumber = 0,
            Tags = new[]
            {
                new Nsxt.Inputs.PolicyPredefinedGatewayPolicyDefaultRuleTagArgs
                {
                    Scope = "string",
                    Tag = "string",
                },
            },
        },
    },
    Description = "string",
    PolicyPredefinedGatewayPolicyId = "string",
    Rules = new[]
    {
        new Nsxt.Inputs.PolicyPredefinedGatewayPolicyRuleArgs
        {
            DisplayName = "string",
            Scopes = new[]
            {
                "string",
            },
            Notes = "string",
            Profiles = new[]
            {
                "string",
            },
            Direction = "string",
            Disabled = false,
            DestinationGroups = new[]
            {
                "string",
            },
            IpVersion = "string",
            LogLabel = "string",
            Logged = false,
            Action = "string",
            NsxId = "string",
            Path = "string",
            DestinationsExcluded = false,
            Revision = 0,
            RuleId = 0,
            Description = "string",
            SequenceNumber = 0,
            ServiceEntries = new Nsxt.Inputs.PolicyPredefinedGatewayPolicyRuleServiceEntriesArgs
            {
                AlgorithmEntries = new[]
                {
                    new Nsxt.Inputs.PolicyPredefinedGatewayPolicyRuleServiceEntriesAlgorithmEntryArgs
                    {
                        Algorithm = "string",
                        DestinationPort = "string",
                        Description = "string",
                        DisplayName = "string",
                        SourcePorts = new[]
                        {
                            "string",
                        },
                    },
                },
                EtherTypeEntries = new[]
                {
                    new Nsxt.Inputs.PolicyPredefinedGatewayPolicyRuleServiceEntriesEtherTypeEntryArgs
                    {
                        EtherType = 0,
                        Description = "string",
                        DisplayName = "string",
                    },
                },
                IcmpEntries = new[]
                {
                    new Nsxt.Inputs.PolicyPredefinedGatewayPolicyRuleServiceEntriesIcmpEntryArgs
                    {
                        Protocol = "string",
                        Description = "string",
                        DisplayName = "string",
                        IcmpCode = "string",
                        IcmpType = "string",
                    },
                },
                IgmpEntries = new[]
                {
                    new Nsxt.Inputs.PolicyPredefinedGatewayPolicyRuleServiceEntriesIgmpEntryArgs
                    {
                        Description = "string",
                        DisplayName = "string",
                    },
                },
                IpProtocolEntries = new[]
                {
                    new Nsxt.Inputs.PolicyPredefinedGatewayPolicyRuleServiceEntriesIpProtocolEntryArgs
                    {
                        Protocol = 0,
                        Description = "string",
                        DisplayName = "string",
                    },
                },
                L4PortSetEntries = new[]
                {
                    new Nsxt.Inputs.PolicyPredefinedGatewayPolicyRuleServiceEntriesL4PortSetEntryArgs
                    {
                        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.PolicyPredefinedGatewayPolicyRuleTagArgs
                {
                    Scope = "string",
                    Tag = "string",
                },
            },
        },
    },
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyPredefinedGatewayPolicyTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

example, err := nsxt.NewPolicyPredefinedGatewayPolicy(ctx, "policyPredefinedGatewayPolicyResource", &nsxt.PolicyPredefinedGatewayPolicyArgs{
	Path: pulumi.String("string"),
	Context: &nsxt.PolicyPredefinedGatewayPolicyContextArgs{
		ProjectId: pulumi.String("string"),
	},
	DefaultRules: nsxt.PolicyPredefinedGatewayPolicyDefaultRuleArray{
		&nsxt.PolicyPredefinedGatewayPolicyDefaultRuleArgs{
			Scope:          pulumi.String("string"),
			Action:         pulumi.String("string"),
			Description:    pulumi.String("string"),
			LogLabel:       pulumi.String("string"),
			Logged:         pulumi.Bool(false),
			NsxId:          pulumi.String("string"),
			Path:           pulumi.String("string"),
			Revision:       pulumi.Float64(0),
			SequenceNumber: pulumi.Float64(0),
			Tags: nsxt.PolicyPredefinedGatewayPolicyDefaultRuleTagArray{
				&nsxt.PolicyPredefinedGatewayPolicyDefaultRuleTagArgs{
					Scope: pulumi.String("string"),
					Tag:   pulumi.String("string"),
				},
			},
		},
	},
	Description:                     pulumi.String("string"),
	PolicyPredefinedGatewayPolicyId: pulumi.String("string"),
	Rules: nsxt.PolicyPredefinedGatewayPolicyRuleArray{
		&nsxt.PolicyPredefinedGatewayPolicyRuleArgs{
			DisplayName: pulumi.String("string"),
			Scopes: pulumi.StringArray{
				pulumi.String("string"),
			},
			Notes: pulumi.String("string"),
			Profiles: pulumi.StringArray{
				pulumi.String("string"),
			},
			Direction: pulumi.String("string"),
			Disabled:  pulumi.Bool(false),
			DestinationGroups: pulumi.StringArray{
				pulumi.String("string"),
			},
			IpVersion:            pulumi.String("string"),
			LogLabel:             pulumi.String("string"),
			Logged:               pulumi.Bool(false),
			Action:               pulumi.String("string"),
			NsxId:                pulumi.String("string"),
			Path:                 pulumi.String("string"),
			DestinationsExcluded: pulumi.Bool(false),
			Revision:             pulumi.Float64(0),
			RuleId:               pulumi.Float64(0),
			Description:          pulumi.String("string"),
			SequenceNumber:       pulumi.Float64(0),
			ServiceEntries: &nsxt.PolicyPredefinedGatewayPolicyRuleServiceEntriesArgs{
				AlgorithmEntries: nsxt.PolicyPredefinedGatewayPolicyRuleServiceEntriesAlgorithmEntryArray{
					&nsxt.PolicyPredefinedGatewayPolicyRuleServiceEntriesAlgorithmEntryArgs{
						Algorithm:       pulumi.String("string"),
						DestinationPort: pulumi.String("string"),
						Description:     pulumi.String("string"),
						DisplayName:     pulumi.String("string"),
						SourcePorts: pulumi.StringArray{
							pulumi.String("string"),
						},
					},
				},
				EtherTypeEntries: nsxt.PolicyPredefinedGatewayPolicyRuleServiceEntriesEtherTypeEntryArray{
					&nsxt.PolicyPredefinedGatewayPolicyRuleServiceEntriesEtherTypeEntryArgs{
						EtherType:   pulumi.Float64(0),
						Description: pulumi.String("string"),
						DisplayName: pulumi.String("string"),
					},
				},
				IcmpEntries: nsxt.PolicyPredefinedGatewayPolicyRuleServiceEntriesIcmpEntryArray{
					&nsxt.PolicyPredefinedGatewayPolicyRuleServiceEntriesIcmpEntryArgs{
						Protocol:    pulumi.String("string"),
						Description: pulumi.String("string"),
						DisplayName: pulumi.String("string"),
						IcmpCode:    pulumi.String("string"),
						IcmpType:    pulumi.String("string"),
					},
				},
				IgmpEntries: nsxt.PolicyPredefinedGatewayPolicyRuleServiceEntriesIgmpEntryArray{
					&nsxt.PolicyPredefinedGatewayPolicyRuleServiceEntriesIgmpEntryArgs{
						Description: pulumi.String("string"),
						DisplayName: pulumi.String("string"),
					},
				},
				IpProtocolEntries: nsxt.PolicyPredefinedGatewayPolicyRuleServiceEntriesIpProtocolEntryArray{
					&nsxt.PolicyPredefinedGatewayPolicyRuleServiceEntriesIpProtocolEntryArgs{
						Protocol:    pulumi.Float64(0),
						Description: pulumi.String("string"),
						DisplayName: pulumi.String("string"),
					},
				},
				L4PortSetEntries: nsxt.PolicyPredefinedGatewayPolicyRuleServiceEntriesL4PortSetEntryArray{
					&nsxt.PolicyPredefinedGatewayPolicyRuleServiceEntriesL4PortSetEntryArgs{
						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.PolicyPredefinedGatewayPolicyRuleTagArray{
				&nsxt.PolicyPredefinedGatewayPolicyRuleTagArgs{
					Scope: pulumi.String("string"),
					Tag:   pulumi.String("string"),
				},
			},
		},
	},
	Tags: nsxt.PolicyPredefinedGatewayPolicyTagArray{
		&nsxt.PolicyPredefinedGatewayPolicyTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

var policyPredefinedGatewayPolicyResource = new PolicyPredefinedGatewayPolicy("policyPredefinedGatewayPolicyResource", PolicyPredefinedGatewayPolicyArgs.builder()
    .path("string")
    .context(PolicyPredefinedGatewayPolicyContextArgs.builder()
        .projectId("string")
        .build())
    .defaultRules(PolicyPredefinedGatewayPolicyDefaultRuleArgs.builder()
        .scope("string")
        .action("string")
        .description("string")
        .logLabel("string")
        .logged(false)
        .nsxId("string")
        .path("string")
        .revision(0)
        .sequenceNumber(0)
        .tags(PolicyPredefinedGatewayPolicyDefaultRuleTagArgs.builder()
            .scope("string")
            .tag("string")
            .build())
        .build())
    .description("string")
    .policyPredefinedGatewayPolicyId("string")
    .rules(PolicyPredefinedGatewayPolicyRuleArgs.builder()
        .displayName("string")
        .scopes("string")
        .notes("string")
        .profiles("string")
        .direction("string")
        .disabled(false)
        .destinationGroups("string")
        .ipVersion("string")
        .logLabel("string")
        .logged(false)
        .action("string")
        .nsxId("string")
        .path("string")
        .destinationsExcluded(false)
        .revision(0)
        .ruleId(0)
        .description("string")
        .sequenceNumber(0)
        .serviceEntries(PolicyPredefinedGatewayPolicyRuleServiceEntriesArgs.builder()
            .algorithmEntries(PolicyPredefinedGatewayPolicyRuleServiceEntriesAlgorithmEntryArgs.builder()
                .algorithm("string")
                .destinationPort("string")
                .description("string")
                .displayName("string")
                .sourcePorts("string")
                .build())
            .etherTypeEntries(PolicyPredefinedGatewayPolicyRuleServiceEntriesEtherTypeEntryArgs.builder()
                .etherType(0)
                .description("string")
                .displayName("string")
                .build())
            .icmpEntries(PolicyPredefinedGatewayPolicyRuleServiceEntriesIcmpEntryArgs.builder()
                .protocol("string")
                .description("string")
                .displayName("string")
                .icmpCode("string")
                .icmpType("string")
                .build())
            .igmpEntries(PolicyPredefinedGatewayPolicyRuleServiceEntriesIgmpEntryArgs.builder()
                .description("string")
                .displayName("string")
                .build())
            .ipProtocolEntries(PolicyPredefinedGatewayPolicyRuleServiceEntriesIpProtocolEntryArgs.builder()
                .protocol(0)
                .description("string")
                .displayName("string")
                .build())
            .l4PortSetEntries(PolicyPredefinedGatewayPolicyRuleServiceEntriesL4PortSetEntryArgs.builder()
                .protocol("string")
                .description("string")
                .destinationPorts("string")
                .displayName("string")
                .sourcePorts("string")
                .build())
            .build())
        .services("string")
        .sourceGroups("string")
        .sourcesExcluded(false)
        .tags(PolicyPredefinedGatewayPolicyRuleTagArgs.builder()
            .scope("string")
            .tag("string")
            .build())
        .build())
    .tags(PolicyPredefinedGatewayPolicyTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

policy_predefined_gateway_policy_resource = nsxt.PolicyPredefinedGatewayPolicy("policyPredefinedGatewayPolicyResource",
    path="string",
    context={
        "project_id": "string",
    },
    default_rules=[{
        "scope": "string",
        "action": "string",
        "description": "string",
        "log_label": "string",
        "logged": False,
        "nsx_id": "string",
        "path": "string",
        "revision": 0,
        "sequence_number": 0,
        "tags": [{
            "scope": "string",
            "tag": "string",
        }],
    }],
    description="string",
    policy_predefined_gateway_policy_id="string",
    rules=[{
        "display_name": "string",
        "scopes": ["string"],
        "notes": "string",
        "profiles": ["string"],
        "direction": "string",
        "disabled": False,
        "destination_groups": ["string"],
        "ip_version": "string",
        "log_label": "string",
        "logged": False,
        "action": "string",
        "nsx_id": "string",
        "path": "string",
        "destinations_excluded": False,
        "revision": 0,
        "rule_id": 0,
        "description": "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",
        }],
    }],
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

const policyPredefinedGatewayPolicyResource = new nsxt.PolicyPredefinedGatewayPolicy("policyPredefinedGatewayPolicyResource", {
    path: "string",
    context: {
        projectId: "string",
    },
    defaultRules: [{
        scope: "string",
        action: "string",
        description: "string",
        logLabel: "string",
        logged: false,
        nsxId: "string",
        path: "string",
        revision: 0,
        sequenceNumber: 0,
        tags: [{
            scope: "string",
            tag: "string",
        }],
    }],
    description: "string",
    policyPredefinedGatewayPolicyId: "string",
    rules: [{
        displayName: "string",
        scopes: ["string"],
        notes: "string",
        profiles: ["string"],
        direction: "string",
        disabled: false,
        destinationGroups: ["string"],
        ipVersion: "string",
        logLabel: "string",
        logged: false,
        action: "string",
        nsxId: "string",
        path: "string",
        destinationsExcluded: false,
        revision: 0,
        ruleId: 0,
        description: "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",
        }],
    }],
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

type: nsxt:PolicyPredefinedGatewayPolicy
properties:
    context:
        projectId: string
    defaultRules:
        - action: string
          description: string
          logLabel: string
          logged: false
          nsxId: string
          path: string
          revision: 0
          scope: string
          sequenceNumber: 0
          tags:
            - scope: string
              tag: string
    description: string
    path: string
    policyPredefinedGatewayPolicyId: 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
    tags:
        - scope: string
          tag: string

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

Path string: Policy path for the predefined Gateway Policy to modify.
Context PolicyPredefinedGatewayPolicyContext: The context which the object belongs to
DefaultRules List<PolicyPredefinedGatewayPolicyDefaultRule>: A repeatable block to modify default rules for the Gateway Policy in a DEFAULT category. Each rule includes the following fields:
Description string: Description of the resource.
PolicyPredefinedGatewayPolicyId string
Rules List<PolicyPredefinedGatewayPolicyRule>: A repeatable block to specify rules for the Gateway Policy. This setting is not applicable to policy belonging to DEFAULT category. Each rule includes the following fields:
Tags List<PolicyPredefinedGatewayPolicyTag>: A list of scope + tag pairs to associate with this Gateway Policy.

Path string: Policy path for the predefined Gateway Policy to modify.
Context PolicyPredefinedGatewayPolicyContextArgs: The context which the object belongs to
DefaultRules []PolicyPredefinedGatewayPolicyDefaultRuleArgs: A repeatable block to modify default rules for the Gateway Policy in a DEFAULT category. Each rule includes the following fields:
Description string: Description of the resource.
PolicyPredefinedGatewayPolicyId string
Rules []PolicyPredefinedGatewayPolicyRuleArgs: A repeatable block to specify rules for the Gateway Policy. This setting is not applicable to policy belonging to DEFAULT category. Each rule includes the following fields:
Tags []PolicyPredefinedGatewayPolicyTagArgs: A list of scope + tag pairs to associate with this Gateway Policy.

path String: Policy path for the predefined Gateway Policy to modify.
context PolicyPredefinedGatewayPolicyContext: The context which the object belongs to
defaultRules List<PolicyPredefinedGatewayPolicyDefaultRule>: A repeatable block to modify default rules for the Gateway Policy in a DEFAULT category. Each rule includes the following fields:
description String: Description of the resource.
policyPredefinedGatewayPolicyId String
rules List<PolicyPredefinedGatewayPolicyRule>: A repeatable block to specify rules for the Gateway Policy. This setting is not applicable to policy belonging to DEFAULT category. Each rule includes the following fields:
tags List<PolicyPredefinedGatewayPolicyTag>: A list of scope + tag pairs to associate with this Gateway Policy.

path string: Policy path for the predefined Gateway Policy to modify.
context PolicyPredefinedGatewayPolicyContext: The context which the object belongs to
defaultRules PolicyPredefinedGatewayPolicyDefaultRule[]: A repeatable block to modify default rules for the Gateway Policy in a DEFAULT category. Each rule includes the following fields:
description string: Description of the resource.
policyPredefinedGatewayPolicyId string
rules PolicyPredefinedGatewayPolicyRule[]: A repeatable block to specify rules for the Gateway Policy. This setting is not applicable to policy belonging to DEFAULT category. Each rule includes the following fields:
tags PolicyPredefinedGatewayPolicyTag[]: A list of scope + tag pairs to associate with this Gateway Policy.

path str: Policy path for the predefined Gateway Policy to modify.
context PolicyPredefinedGatewayPolicyContextArgs: The context which the object belongs to
default_rules Sequence[PolicyPredefinedGatewayPolicyDefaultRuleArgs]: A repeatable block to modify default rules for the Gateway Policy in a DEFAULT category. Each rule includes the following fields:
description str: Description of the resource.
policy_predefined_gateway_policy_id str
rules Sequence[PolicyPredefinedGatewayPolicyRuleArgs]: A repeatable block to specify rules for the Gateway Policy. This setting is not applicable to policy belonging to DEFAULT category. Each rule includes the following fields:
tags Sequence[PolicyPredefinedGatewayPolicyTagArgs]: A list of scope + tag pairs to associate with this Gateway Policy.

path String: Policy path for the predefined Gateway Policy to modify.
context Property Map: The context which the object belongs to
defaultRules List<Property Map>: A repeatable block to modify default rules for the Gateway Policy in a DEFAULT category. Each rule includes the following fields:
description String: Description of the resource.
policyPredefinedGatewayPolicyId String
rules List<Property Map>: A repeatable block to specify rules for the Gateway Policy. This setting is not applicable to policy belonging to DEFAULT category. Each rule includes the following fields:
tags List<Property Map>: A list of scope + tag pairs to associate with this Gateway Policy.

Outputs

All input properties are implicitly available as output properties. Additionally, the PolicyPredefinedGatewayPolicy resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed 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.
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.
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.
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.
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.
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 PolicyPredefinedGatewayPolicy Resource

Get an existing PolicyPredefinedGatewayPolicy 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?: PolicyPredefinedGatewayPolicyState, opts?: CustomResourceOptions): PolicyPredefinedGatewayPolicy

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        context: Optional[PolicyPredefinedGatewayPolicyContextArgs] = None,
        default_rules: Optional[Sequence[PolicyPredefinedGatewayPolicyDefaultRuleArgs]] = None,
        description: Optional[str] = None,
        path: Optional[str] = None,
        policy_predefined_gateway_policy_id: Optional[str] = None,
        revision: Optional[float] = None,
        rules: Optional[Sequence[PolicyPredefinedGatewayPolicyRuleArgs]] = None,
        tags: Optional[Sequence[PolicyPredefinedGatewayPolicyTagArgs]] = None) -> PolicyPredefinedGatewayPolicy

func GetPolicyPredefinedGatewayPolicy(ctx *Context, name string, id IDInput, state *PolicyPredefinedGatewayPolicyState, opts ...ResourceOption) (*PolicyPredefinedGatewayPolicy, error)

public static PolicyPredefinedGatewayPolicy Get(string name, Input<string> id, PolicyPredefinedGatewayPolicyState? state, CustomResourceOptions? opts = null)

public static PolicyPredefinedGatewayPolicy get(String name, Output<String> id, PolicyPredefinedGatewayPolicyState state, CustomResourceOptions options)

resources:  _:    type: nsxt:PolicyPredefinedGatewayPolicy    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:

Context PolicyPredefinedGatewayPolicyContext: The context which the object belongs to
DefaultRules List<PolicyPredefinedGatewayPolicyDefaultRule>: A repeatable block to modify default rules for the Gateway Policy in a DEFAULT category. Each rule includes the following fields:
Description string: Description of the resource.
Path string: Policy path for the predefined Gateway Policy to modify.
PolicyPredefinedGatewayPolicyId string
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<PolicyPredefinedGatewayPolicyRule>: A repeatable block to specify rules for the Gateway Policy. This setting is not applicable to policy belonging to DEFAULT category. Each rule includes the following fields:
Tags List<PolicyPredefinedGatewayPolicyTag>: A list of scope + tag pairs to associate with this Gateway Policy.

Context PolicyPredefinedGatewayPolicyContextArgs: The context which the object belongs to
DefaultRules []PolicyPredefinedGatewayPolicyDefaultRuleArgs: A repeatable block to modify default rules for the Gateway Policy in a DEFAULT category. Each rule includes the following fields:
Description string: Description of the resource.
Path string: Policy path for the predefined Gateway Policy to modify.
PolicyPredefinedGatewayPolicyId string
Revision float64: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Rules []PolicyPredefinedGatewayPolicyRuleArgs: A repeatable block to specify rules for the Gateway Policy. This setting is not applicable to policy belonging to DEFAULT category. Each rule includes the following fields:
Tags []PolicyPredefinedGatewayPolicyTagArgs: A list of scope + tag pairs to associate with this Gateway Policy.

context PolicyPredefinedGatewayPolicyContext: The context which the object belongs to
defaultRules List<PolicyPredefinedGatewayPolicyDefaultRule>: A repeatable block to modify default rules for the Gateway Policy in a DEFAULT category. Each rule includes the following fields:
description String: Description of the resource.
path String: Policy path for the predefined Gateway Policy to modify.
policyPredefinedGatewayPolicyId String
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<PolicyPredefinedGatewayPolicyRule>: A repeatable block to specify rules for the Gateway Policy. This setting is not applicable to policy belonging to DEFAULT category. Each rule includes the following fields:
tags List<PolicyPredefinedGatewayPolicyTag>: A list of scope + tag pairs to associate with this Gateway Policy.

context PolicyPredefinedGatewayPolicyContext: The context which the object belongs to
defaultRules PolicyPredefinedGatewayPolicyDefaultRule[]: A repeatable block to modify default rules for the Gateway Policy in a DEFAULT category. Each rule includes the following fields:
description string: Description of the resource.
path string: Policy path for the predefined Gateway Policy to modify.
policyPredefinedGatewayPolicyId string
revision number: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
rules PolicyPredefinedGatewayPolicyRule[]: A repeatable block to specify rules for the Gateway Policy. This setting is not applicable to policy belonging to DEFAULT category. Each rule includes the following fields:
tags PolicyPredefinedGatewayPolicyTag[]: A list of scope + tag pairs to associate with this Gateway Policy.

context PolicyPredefinedGatewayPolicyContextArgs: The context which the object belongs to
default_rules Sequence[PolicyPredefinedGatewayPolicyDefaultRuleArgs]: A repeatable block to modify default rules for the Gateway Policy in a DEFAULT category. Each rule includes the following fields:
description str: Description of the resource.
path str: Policy path for the predefined Gateway Policy to modify.
policy_predefined_gateway_policy_id str
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[PolicyPredefinedGatewayPolicyRuleArgs]: A repeatable block to specify rules for the Gateway Policy. This setting is not applicable to policy belonging to DEFAULT category. Each rule includes the following fields:
tags Sequence[PolicyPredefinedGatewayPolicyTagArgs]: A list of scope + tag pairs to associate with this Gateway Policy.

context Property Map: The context which the object belongs to
defaultRules List<Property Map>: A repeatable block to modify default rules for the Gateway Policy in a DEFAULT category. Each rule includes the following fields:
description String: Description of the resource.
path String: Policy path for the predefined Gateway Policy to modify.
policyPredefinedGatewayPolicyId String
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 Gateway Policy. This setting is not applicable to policy belonging to DEFAULT category. Each rule includes the following fields:
tags List<Property Map>: A list of scope + tag pairs to associate with this Gateway Policy.

Supporting Types

PolicyPredefinedGatewayPolicyContext, PolicyPredefinedGatewayPolicyContextArgs

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

PolicyPredefinedGatewayPolicyDefaultRule, PolicyPredefinedGatewayPolicyDefaultRuleArgs

Scope string: Scope for the default rule that should be modified. Only one default rule can be present for each scope.
Action string: The action for the Rule. Must be one of: ALLOW, DROP or REJECT.
Description string: Description of the resource.
LogLabel string: Additional information (string) which will be propagated to the rule syslog.
Logged bool: A boolean flag to enable packet logging.
NsxId string: NSX ID for this resource
Path string: Policy path for the predefined Gateway Policy to modify.
Revision double: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
SequenceNumber double: Sequence number of the this rule, is defined by order of rules in the list.
Tags List<PolicyPredefinedGatewayPolicyDefaultRuleTag>: A list of scope + tag pairs to associate with this Rule.

Scope string: Scope for the default rule that should be modified. Only one default rule can be present for each scope.
Action string: The action for the Rule. Must be one of: ALLOW, DROP or REJECT.
Description string: Description of the resource.
LogLabel string: Additional information (string) which will be propagated to the rule syslog.
Logged bool: A boolean flag to enable packet logging.
NsxId string: NSX ID for this resource
Path string: Policy path for the predefined Gateway Policy to modify.
Revision float64: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
SequenceNumber float64: Sequence number of the this rule, is defined by order of rules in the list.
Tags []PolicyPredefinedGatewayPolicyDefaultRuleTag: A list of scope + tag pairs to associate with this Rule.

scope String: Scope for the default rule that should be modified. Only one default rule can be present for each scope.
action String: The action for the Rule. Must be one of: ALLOW, DROP or REJECT.
description String: Description of the resource.
logLabel String: Additional information (string) which will be propagated to the rule syslog.
logged Boolean: A boolean flag to enable packet logging.
nsxId String: NSX ID for this resource
path String: Policy path for the predefined Gateway Policy to modify.
revision Double: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
sequenceNumber Double: Sequence number of the this rule, is defined by order of rules in the list.
tags List<PolicyPredefinedGatewayPolicyDefaultRuleTag>: A list of scope + tag pairs to associate with this Rule.

scope string: Scope for the default rule that should be modified. Only one default rule can be present for each scope.
action string: The action for the Rule. Must be one of: ALLOW, DROP or REJECT.
description string: Description of the resource.
logLabel string: Additional information (string) which will be propagated to the rule syslog.
logged boolean: A boolean flag to enable packet logging.
nsxId string: NSX ID for this resource
path string: Policy path for the predefined Gateway Policy to modify.
revision number: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
sequenceNumber number: Sequence number of the this rule, is defined by order of rules in the list.
tags PolicyPredefinedGatewayPolicyDefaultRuleTag[]: A list of scope + tag pairs to associate with this Rule.

scope str: Scope for the default rule that should be modified. Only one default rule can be present for each scope.
action str: The action for the Rule. Must be one of: ALLOW, DROP or REJECT.
description str: Description of the resource.
log_label str: Additional information (string) which will be propagated to the rule syslog.
logged bool: A boolean flag to enable packet logging.
nsx_id str: NSX ID for this resource
path str: Policy path for the predefined Gateway Policy to modify.
revision float: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
sequence_number float: Sequence number of the this rule, is defined by order of rules in the list.
tags Sequence[PolicyPredefinedGatewayPolicyDefaultRuleTag]: A list of scope + tag pairs to associate with this Rule.

scope String: Scope for the default rule that should be modified. Only one default rule can be present for each scope.
action String: The action for the Rule. Must be one of: ALLOW, DROP or REJECT.
description String: Description of the resource.
logLabel String: Additional information (string) which will be propagated to the rule syslog.
logged Boolean: A boolean flag to enable packet logging.
nsxId String: NSX ID for this resource
path String: Policy path for the predefined Gateway Policy to modify.
revision Number: Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
sequenceNumber Number: Sequence number of the this rule, is defined by order of rules in the list.
tags List<Property Map>: A list of scope + tag pairs to associate with this Rule.

PolicyPredefinedGatewayPolicyDefaultRuleTag, PolicyPredefinedGatewayPolicyDefaultRuleTagArgs

Scope string
Tag string: A list of scope + tag pairs to associate with this Gateway Policy.

Scope string
Tag string: A list of scope + tag pairs to associate with this Gateway Policy.

scope String
tag String: A list of scope + tag pairs to associate with this Gateway Policy.

scope string
tag string: A list of scope + tag pairs to associate with this Gateway Policy.

scope str
tag str: A list of scope + tag pairs to associate with this Gateway Policy.

scope String
tag String: A list of scope + tag pairs to associate with this Gateway Policy.

PolicyPredefinedGatewayPolicyRule, PolicyPredefinedGatewayPolicyRuleArgs

DisplayName string: Display name of the resource.
Scopes List<string>: List of policy paths where the rule is applied.
Action string: The action for the Rule. Must be one of: ALLOW, DROP or REJECT. Defaults to ALLOW.
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: The traffic direction for the policy. Must be one of: IN, OUT or IN_OUT. Defaults to IN_OUT.
Disabled bool: A boolean value to indicate the rule is disabled. Defaults to false.
IpVersion string: The IP Protocol for the rule. Must be one of: IPV4, IPV6 or IPV4_IPV6. Defaults to IPV4_IPV6.
LogLabel string: Additional information (string) which will be propagated to the rule syslog.
Logged bool: A boolean flag to enable packet logging.
Notes string: Text for additional notes on changes for the rule.
NsxId string: NSX ID for this resource
Path string: Policy path for the predefined Gateway Policy to modify.
Profiles List<string>: A list of context profiles for the rule. Note: due to platform issue, this setting is only supported with NSX 3.2 onwards.
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.
SequenceNumber double: Sequence number of the this rule, is defined by order of rules in the list.
ServiceEntries PolicyPredefinedGatewayPolicyRuleServiceEntries: List of services to match
Services List<string>: List of services 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: Negation of source groups
Tags List<PolicyPredefinedGatewayPolicyRuleTag>: A list of scope + tag pairs to associate with this Rule.

DisplayName string: Display name of the resource.
Scopes []string: List of policy paths where the rule is applied.
Action string: The action for the Rule. Must be one of: ALLOW, DROP or REJECT. Defaults to ALLOW.
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: The traffic direction for the policy. Must be one of: IN, OUT or IN_OUT. Defaults to IN_OUT.
Disabled bool: A boolean value to indicate the rule is disabled. Defaults to false.
IpVersion string: The IP Protocol for the rule. Must be one of: IPV4, IPV6 or IPV4_IPV6. Defaults to IPV4_IPV6.
LogLabel string: Additional information (string) which will be propagated to the rule syslog.
Logged bool: A boolean flag to enable packet logging.
Notes string: Text for additional notes on changes for the rule.
NsxId string: NSX ID for this resource
Path string: Policy path for the predefined Gateway Policy to modify.
Profiles []string: A list of context profiles for the rule. Note: due to platform issue, this setting is only supported with NSX 3.2 onwards.
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.
SequenceNumber float64: Sequence number of the this rule, is defined by order of rules in the list.
ServiceEntries PolicyPredefinedGatewayPolicyRuleServiceEntries: List of services to match
Services []string: List of services 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: Negation of source groups
Tags []PolicyPredefinedGatewayPolicyRuleTag: A list of scope + tag pairs to associate with this Rule.

displayName String: Display name of the resource.
scopes List<String>: List of policy paths where the rule is applied.
action String: The action for the Rule. Must be one of: ALLOW, DROP or REJECT. Defaults to ALLOW.
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: The traffic direction for the policy. Must be one of: IN, OUT or IN_OUT. Defaults to IN_OUT.
disabled Boolean: A boolean value to indicate the rule is disabled. Defaults to false.
ipVersion String: The IP Protocol for the rule. Must be one of: IPV4, IPV6 or IPV4_IPV6. Defaults to IPV4_IPV6.
logLabel String: Additional information (string) which will be propagated to the rule syslog.
logged Boolean: A boolean flag to enable packet logging.
notes String: Text for additional notes on changes for the rule.
nsxId String: NSX ID for this resource
path String: Policy path for the predefined Gateway Policy to modify.
profiles List<String>: A list of context profiles for the rule. Note: due to platform issue, this setting is only supported with NSX 3.2 onwards.
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.
sequenceNumber Double: Sequence number of the this rule, is defined by order of rules in the list.
serviceEntries PolicyPredefinedGatewayPolicyRuleServiceEntries: List of services to match
services List<String>: List of services 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: Negation of source groups
tags List<PolicyPredefinedGatewayPolicyRuleTag>: A list of scope + tag pairs to associate with this Rule.

displayName string: Display name of the resource.
scopes string[]: List of policy paths where the rule is applied.
action string: The action for the Rule. Must be one of: ALLOW, DROP or REJECT. Defaults to ALLOW.
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: The traffic direction for the policy. Must be one of: IN, OUT or IN_OUT. Defaults to IN_OUT.
disabled boolean: A boolean value to indicate the rule is disabled. Defaults to false.
ipVersion string: The IP Protocol for the rule. Must be one of: IPV4, IPV6 or IPV4_IPV6. Defaults to IPV4_IPV6.
logLabel string: Additional information (string) which will be propagated to the rule syslog.
logged boolean: A boolean flag to enable packet logging.
notes string: Text for additional notes on changes for the rule.
nsxId string: NSX ID for this resource
path string: Policy path for the predefined Gateway Policy to modify.
profiles string[]: A list of context profiles for the rule. Note: due to platform issue, this setting is only supported with NSX 3.2 onwards.
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.
sequenceNumber number: Sequence number of the this rule, is defined by order of rules in the list.
serviceEntries PolicyPredefinedGatewayPolicyRuleServiceEntries: List of services to match
services string[]: List of services 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: Negation of source groups
tags PolicyPredefinedGatewayPolicyRuleTag[]: A list of scope + tag pairs to associate with this Rule.

display_name str: Display name of the resource.
scopes Sequence[str]: List of policy paths where the rule is applied.
action str: The action for the Rule. Must be one of: ALLOW, DROP or REJECT. Defaults to ALLOW.
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: The traffic direction for the policy. Must be one of: IN, OUT or IN_OUT. Defaults to IN_OUT.
disabled bool: A boolean value to indicate the rule is disabled. Defaults to false.
ip_version str: The IP Protocol for the rule. Must be one of: IPV4, IPV6 or IPV4_IPV6. Defaults to IPV4_IPV6.
log_label str: Additional information (string) which will be propagated to the rule syslog.
logged bool: A boolean flag to enable packet logging.
notes str: Text for additional notes on changes for the rule.
nsx_id str: NSX ID for this resource
path str: Policy path for the predefined Gateway Policy to modify.
profiles Sequence[str]: A list of context profiles for the rule. Note: due to platform issue, this setting is only supported with NSX 3.2 onwards.
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.
sequence_number float: Sequence number of the this rule, is defined by order of rules in the list.
service_entries PolicyPredefinedGatewayPolicyRuleServiceEntries: List of services to match
services Sequence[str]: List of services 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: Negation of source groups
tags Sequence[PolicyPredefinedGatewayPolicyRuleTag]: A list of scope + tag pairs to associate with this Rule.

displayName String: Display name of the resource.
scopes List<String>: List of policy paths where the rule is applied.
action String: The action for the Rule. Must be one of: ALLOW, DROP or REJECT. Defaults to ALLOW.
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: The traffic direction for the policy. Must be one of: IN, OUT or IN_OUT. Defaults to IN_OUT.
disabled Boolean: A boolean value to indicate the rule is disabled. Defaults to false.
ipVersion String: The IP Protocol for the rule. Must be one of: IPV4, IPV6 or IPV4_IPV6. Defaults to IPV4_IPV6.
logLabel String: Additional information (string) which will be propagated to the rule syslog.
logged Boolean: A boolean flag to enable packet logging.
notes String: Text for additional notes on changes for the rule.
nsxId String: NSX ID for this resource
path String: Policy path for the predefined Gateway Policy to modify.
profiles List<String>: A list of context profiles for the rule. Note: due to platform issue, this setting is only supported with NSX 3.2 onwards.
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.
sequenceNumber Number: Sequence number of the this rule, is defined by order of rules in the list.
serviceEntries Property Map: List of services to match
services List<String>: List of services 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: Negation of source groups
tags List<Property Map>: A list of scope + tag pairs to associate with this Rule.

PolicyPredefinedGatewayPolicyRuleServiceEntries, PolicyPredefinedGatewayPolicyRuleServiceEntriesArgs

AlgorithmEntries List<PolicyPredefinedGatewayPolicyRuleServiceEntriesAlgorithmEntry>: Algorithm type service entry
EtherTypeEntries List<PolicyPredefinedGatewayPolicyRuleServiceEntriesEtherTypeEntry>: Ether type service entry
IcmpEntries List<PolicyPredefinedGatewayPolicyRuleServiceEntriesIcmpEntry>: ICMP type service entry
IgmpEntries List<PolicyPredefinedGatewayPolicyRuleServiceEntriesIgmpEntry>: IGMP type service entry
IpProtocolEntries List<PolicyPredefinedGatewayPolicyRuleServiceEntriesIpProtocolEntry>: IP Protocol type service entry
L4PortSetEntries List<PolicyPredefinedGatewayPolicyRuleServiceEntriesL4PortSetEntry>: L4 port set type service entry

AlgorithmEntries []PolicyPredefinedGatewayPolicyRuleServiceEntriesAlgorithmEntry: Algorithm type service entry
EtherTypeEntries []PolicyPredefinedGatewayPolicyRuleServiceEntriesEtherTypeEntry: Ether type service entry
IcmpEntries []PolicyPredefinedGatewayPolicyRuleServiceEntriesIcmpEntry: ICMP type service entry
IgmpEntries []PolicyPredefinedGatewayPolicyRuleServiceEntriesIgmpEntry: IGMP type service entry
IpProtocolEntries []PolicyPredefinedGatewayPolicyRuleServiceEntriesIpProtocolEntry: IP Protocol type service entry
L4PortSetEntries []PolicyPredefinedGatewayPolicyRuleServiceEntriesL4PortSetEntry: L4 port set type service entry

algorithmEntries List<PolicyPredefinedGatewayPolicyRuleServiceEntriesAlgorithmEntry>: Algorithm type service entry
etherTypeEntries List<PolicyPredefinedGatewayPolicyRuleServiceEntriesEtherTypeEntry>: Ether type service entry
icmpEntries List<PolicyPredefinedGatewayPolicyRuleServiceEntriesIcmpEntry>: ICMP type service entry
igmpEntries List<PolicyPredefinedGatewayPolicyRuleServiceEntriesIgmpEntry>: IGMP type service entry
ipProtocolEntries List<PolicyPredefinedGatewayPolicyRuleServiceEntriesIpProtocolEntry>: IP Protocol type service entry
l4PortSetEntries List<PolicyPredefinedGatewayPolicyRuleServiceEntriesL4PortSetEntry>: L4 port set type service entry

algorithmEntries PolicyPredefinedGatewayPolicyRuleServiceEntriesAlgorithmEntry[]: Algorithm type service entry
etherTypeEntries PolicyPredefinedGatewayPolicyRuleServiceEntriesEtherTypeEntry[]: Ether type service entry
icmpEntries PolicyPredefinedGatewayPolicyRuleServiceEntriesIcmpEntry[]: ICMP type service entry
igmpEntries PolicyPredefinedGatewayPolicyRuleServiceEntriesIgmpEntry[]: IGMP type service entry
ipProtocolEntries PolicyPredefinedGatewayPolicyRuleServiceEntriesIpProtocolEntry[]: IP Protocol type service entry
l4PortSetEntries PolicyPredefinedGatewayPolicyRuleServiceEntriesL4PortSetEntry[]: L4 port set type service entry

algorithm_entries Sequence[PolicyPredefinedGatewayPolicyRuleServiceEntriesAlgorithmEntry]: Algorithm type service entry
ether_type_entries Sequence[PolicyPredefinedGatewayPolicyRuleServiceEntriesEtherTypeEntry]: Ether type service entry
icmp_entries Sequence[PolicyPredefinedGatewayPolicyRuleServiceEntriesIcmpEntry]: ICMP type service entry
igmp_entries Sequence[PolicyPredefinedGatewayPolicyRuleServiceEntriesIgmpEntry]: IGMP type service entry
ip_protocol_entries Sequence[PolicyPredefinedGatewayPolicyRuleServiceEntriesIpProtocolEntry]: IP Protocol type service entry
l4_port_set_entries Sequence[PolicyPredefinedGatewayPolicyRuleServiceEntriesL4PortSetEntry]: L4 port set type service entry

algorithmEntries List<Property Map>: Algorithm type service entry
etherTypeEntries List<Property Map>: Ether type service entry
icmpEntries List<Property Map>: ICMP type service entry
igmpEntries List<Property Map>: IGMP type service entry
ipProtocolEntries List<Property Map>: IP Protocol type service entry
l4PortSetEntries List<Property Map>: L4 port set type service entry

PolicyPredefinedGatewayPolicyRuleServiceEntriesAlgorithmEntry, PolicyPredefinedGatewayPolicyRuleServiceEntriesAlgorithmEntryArgs

Algorithm string: Algorithm
DestinationPort string: A single destination port
Description string: Description of the resource.
DisplayName string: Display name for this resource
SourcePorts List<string>: Set of source ports or ranges

Algorithm string: Algorithm
DestinationPort string: A single destination port
Description string: Description of the resource.
DisplayName string: Display name for this resource
SourcePorts []string: Set of source ports or ranges

algorithm String: Algorithm
destinationPort String: A single destination port
description String: Description of the resource.
displayName String: Display name for this resource
sourcePorts List<String>: Set of source ports or ranges

algorithm string: Algorithm
destinationPort string: A single destination port
description string: Description of the resource.
displayName string: Display name for this resource
sourcePorts string[]: Set of source ports or ranges

algorithm str: Algorithm
destination_port str: A single destination port
description str: Description of the resource.
display_name str: Display name for this resource
source_ports Sequence[str]: Set of source ports or ranges

algorithm String: Algorithm
destinationPort String: A single destination port
description String: Description of the resource.
displayName String: Display name for this resource
sourcePorts List<String>: Set of source ports or ranges

PolicyPredefinedGatewayPolicyRuleServiceEntriesEtherTypeEntry, PolicyPredefinedGatewayPolicyRuleServiceEntriesEtherTypeEntryArgs

EtherType double: Type of the encapsulated protocol
Description string: Description of the resource.
DisplayName string: Display name for this resource

EtherType float64: Type of the encapsulated protocol
Description string: Description of the resource.
DisplayName string: Display name for this resource

etherType Double: Type of the encapsulated protocol
description String: Description of the resource.
displayName String: Display name for this resource

etherType number: Type of the encapsulated protocol
description string: Description of the resource.
displayName string: Display name for this resource

ether_type float: Type of the encapsulated protocol
description str: Description of the resource.
display_name str: Display name for this resource

etherType Number: Type of the encapsulated protocol
description String: Description of the resource.
displayName String: Display name for this resource

PolicyPredefinedGatewayPolicyRuleServiceEntriesIcmpEntry, PolicyPredefinedGatewayPolicyRuleServiceEntriesIcmpEntryArgs

Protocol string: Version of ICMP protocol (ICMPv4/ICMPv6)
Description string: Description of the resource.
DisplayName string: Display name for this resource
IcmpCode string: ICMP message code
IcmpType string: ICMP message type

Protocol string: Version of ICMP protocol (ICMPv4/ICMPv6)
Description string: Description of the resource.
DisplayName string: Display name for this resource
IcmpCode string: ICMP message code
IcmpType string: ICMP message type

protocol String: Version of ICMP protocol (ICMPv4/ICMPv6)
description String: Description of the resource.
displayName String: Display name for this resource
icmpCode String: ICMP message code
icmpType String: ICMP message type

protocol string: Version of ICMP protocol (ICMPv4/ICMPv6)
description string: Description of the resource.
displayName string: Display name for this resource
icmpCode string: ICMP message code
icmpType string: ICMP message type

protocol str: Version of ICMP protocol (ICMPv4/ICMPv6)
description str: Description of the resource.
display_name str: Display name for this resource
icmp_code str: ICMP message code
icmp_type str: ICMP message type

protocol String: Version of ICMP protocol (ICMPv4/ICMPv6)
description String: Description of the resource.
displayName String: Display name for this resource
icmpCode String: ICMP message code
icmpType String: ICMP message type

PolicyPredefinedGatewayPolicyRuleServiceEntriesIgmpEntry, PolicyPredefinedGatewayPolicyRuleServiceEntriesIgmpEntryArgs

Description string: Description of the resource.
DisplayName string: Display name for this resource

Description string: Description of the resource.
DisplayName string: Display name for this resource

description String: Description of the resource.
displayName String: Display name for this resource

description string: Description of the resource.
displayName string: Display name for this resource

description str: Description of the resource.
display_name str: Display name for this resource

description String: Description of the resource.
displayName String: Display name for this resource

PolicyPredefinedGatewayPolicyRuleServiceEntriesIpProtocolEntry, PolicyPredefinedGatewayPolicyRuleServiceEntriesIpProtocolEntryArgs

Protocol double: IP protocol number
Description string: Description of the resource.
DisplayName string: Display name for this resource

Protocol float64: IP protocol number
Description string: Description of the resource.
DisplayName string: Display name for this resource

protocol Double: IP protocol number
description String: Description of the resource.
displayName String: Display name for this resource

protocol number: IP protocol number
description string: Description of the resource.
displayName string: Display name for this resource

protocol float: IP protocol number
description str: Description of the resource.
display_name str: Display name for this resource

protocol Number: IP protocol number
description String: Description of the resource.
displayName String: Display name for this resource

PolicyPredefinedGatewayPolicyRuleServiceEntriesL4PortSetEntry, PolicyPredefinedGatewayPolicyRuleServiceEntriesL4PortSetEntryArgs

Protocol string: L4 Protocol
Description string: Description of the resource.
DestinationPorts List<string>: Set of destination ports
DisplayName string: Display name for this resource
SourcePorts List<string>: Set of source ports

Protocol string: L4 Protocol
Description string: Description of the resource.
DestinationPorts []string: Set of destination ports
DisplayName string: Display name for this resource
SourcePorts []string: Set of source ports

protocol String: L4 Protocol
description String: Description of the resource.
destinationPorts List<String>: Set of destination ports
displayName String: Display name for this resource
sourcePorts List<String>: Set of source ports

protocol string: L4 Protocol
description string: Description of the resource.
destinationPorts string[]: Set of destination ports
displayName string: Display name for this resource
sourcePorts string[]: Set of source ports

protocol str: L4 Protocol
description str: Description of the resource.
destination_ports Sequence[str]: Set of destination ports
display_name str: Display name for this resource
source_ports Sequence[str]: Set of source ports

protocol String: L4 Protocol
description String: Description of the resource.
destinationPorts List<String>: Set of destination ports
displayName String: Display name for this resource
sourcePorts List<String>: Set of source ports

PolicyPredefinedGatewayPolicyRuleTag, PolicyPredefinedGatewayPolicyRuleTagArgs

Scope string
Tag string: A list of scope + tag pairs to associate with this Gateway Policy.

Scope string
Tag string: A list of scope + tag pairs to associate with this Gateway Policy.

scope String
tag String: A list of scope + tag pairs to associate with this Gateway Policy.

scope string
tag string: A list of scope + tag pairs to associate with this Gateway Policy.

scope str
tag str: A list of scope + tag pairs to associate with this Gateway Policy.

scope String
tag String: A list of scope + tag pairs to associate with this Gateway Policy.

PolicyPredefinedGatewayPolicyTag, PolicyPredefinedGatewayPolicyTagArgs

Scope string
Tag string: A list of scope + tag pairs to associate with this Gateway Policy.

Scope string
Tag string: A list of scope + tag pairs to associate with this Gateway Policy.

scope String
tag String: A list of scope + tag pairs to associate with this Gateway Policy.

scope string
tag string: A list of scope + tag pairs to associate with this Gateway Policy.

scope str
tag str: A list of scope + tag pairs to associate with this Gateway Policy.

scope String
tag String: A list of scope + tag pairs to associate with this Gateway Policy.

Package Details

Repository: nsxt vmware/terraform-provider-nsxt
License
Notes: This Pulumi package is based on the nsxt Terraform Provider.

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

vmware/terraform-provider-nsxt

nsxt.PolicyPredefinedGatewayPolicy

On this page

On this page

Create PolicyPredefinedGatewayPolicy Resource

Constructor syntax

Parameters

Constructor example

PolicyPredefinedGatewayPolicy Resource Properties

Inputs

Outputs

Look up Existing PolicyPredefinedGatewayPolicy Resource

Supporting Types

PolicyPredefinedGatewayPolicyContext, PolicyPredefinedGatewayPolicyContextArgs

PolicyPredefinedGatewayPolicyDefaultRule, PolicyPredefinedGatewayPolicyDefaultRuleArgs

PolicyPredefinedGatewayPolicyDefaultRuleTag, PolicyPredefinedGatewayPolicyDefaultRuleTagArgs

PolicyPredefinedGatewayPolicyRule, PolicyPredefinedGatewayPolicyRuleArgs

PolicyPredefinedGatewayPolicyRuleServiceEntries, PolicyPredefinedGatewayPolicyRuleServiceEntriesArgs

PolicyPredefinedGatewayPolicyRuleServiceEntriesAlgorithmEntry, PolicyPredefinedGatewayPolicyRuleServiceEntriesAlgorithmEntryArgs

PolicyPredefinedGatewayPolicyRuleServiceEntriesEtherTypeEntry, PolicyPredefinedGatewayPolicyRuleServiceEntriesEtherTypeEntryArgs

PolicyPredefinedGatewayPolicyRuleServiceEntriesIcmpEntry, PolicyPredefinedGatewayPolicyRuleServiceEntriesIcmpEntryArgs

PolicyPredefinedGatewayPolicyRuleServiceEntriesIgmpEntry, PolicyPredefinedGatewayPolicyRuleServiceEntriesIgmpEntryArgs

PolicyPredefinedGatewayPolicyRuleServiceEntriesIpProtocolEntry, PolicyPredefinedGatewayPolicyRuleServiceEntriesIpProtocolEntryArgs

PolicyPredefinedGatewayPolicyRuleServiceEntriesL4PortSetEntry, PolicyPredefinedGatewayPolicyRuleServiceEntriesL4PortSetEntryArgs

PolicyPredefinedGatewayPolicyRuleTag, PolicyPredefinedGatewayPolicyRuleTagArgs

PolicyPredefinedGatewayPolicyTag, PolicyPredefinedGatewayPolicyTagArgs

Package Details

On this page

On this page