Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicyPredefinedGatewayPolicy
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.PolicyPredefinedGatewayPolicy

Explore with Pulumi AI

nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt

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 This property is required. string
The unique name of the resource.
args This property is required. PolicyPredefinedGatewayPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. PolicyPredefinedGatewayPolicyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PolicyPredefinedGatewayPolicyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
            NsxId = "string",
            Direction = "string",
            Disabled = false,
            DestinationGroups = new[]
            {
                "string",
            },
            IpVersion = "string",
            LogLabel = "string",
            Logged = false,
            Action = "string",
            DestinationsExcluded = false,
            Path = "string",
            Profiles = new[]
            {
                "string",
            },
            Revision = 0,
            RuleId = 0,
            Description = "string",
            SequenceNumber = 0,
            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",
        },
    },
});
Copy
example, err := nsxt.NewPolicyPredefinedGatewayPolicy(ctx, "policyPredefinedGatewayPolicyResource", &nsxt.PolicyPredefinedGatewayPolicyArgs{
Path: pulumi.String("string"),
Context: &.PolicyPredefinedGatewayPolicyContextArgs{
ProjectId: pulumi.String("string"),
},
DefaultRules: .PolicyPredefinedGatewayPolicyDefaultRuleArray{
&.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: .PolicyPredefinedGatewayPolicyDefaultRuleTagArray{
&.PolicyPredefinedGatewayPolicyDefaultRuleTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
},
},
Description: pulumi.String("string"),
PolicyPredefinedGatewayPolicyId: pulumi.String("string"),
Rules: .PolicyPredefinedGatewayPolicyRuleArray{
&.PolicyPredefinedGatewayPolicyRuleArgs{
DisplayName: pulumi.String("string"),
Scopes: pulumi.StringArray{
pulumi.String("string"),
},
Notes: pulumi.String("string"),
NsxId: 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"),
DestinationsExcluded: pulumi.Bool(false),
Path: pulumi.String("string"),
Profiles: pulumi.StringArray{
pulumi.String("string"),
},
Revision: pulumi.Float64(0),
RuleId: pulumi.Float64(0),
Description: pulumi.String("string"),
SequenceNumber: pulumi.Float64(0),
Services: pulumi.StringArray{
pulumi.String("string"),
},
SourceGroups: pulumi.StringArray{
pulumi.String("string"),
},
SourcesExcluded: pulumi.Bool(false),
Tags: .PolicyPredefinedGatewayPolicyRuleTagArray{
&.PolicyPredefinedGatewayPolicyRuleTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
},
},
Tags: .PolicyPredefinedGatewayPolicyTagArray{
&.PolicyPredefinedGatewayPolicyTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
})
Copy
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")
        .nsxId("string")
        .direction("string")
        .disabled(false)
        .destinationGroups("string")
        .ipVersion("string")
        .logLabel("string")
        .logged(false)
        .action("string")
        .destinationsExcluded(false)
        .path("string")
        .profiles("string")
        .revision(0)
        .ruleId(0)
        .description("string")
        .sequenceNumber(0)
        .services("string")
        .sourceGroups("string")
        .sourcesExcluded(false)
        .tags(PolicyPredefinedGatewayPolicyRuleTagArgs.builder()
            .scope("string")
            .tag("string")
            .build())
        .build())
    .tags(PolicyPredefinedGatewayPolicyTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());
Copy
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",
        "nsx_id": "string",
        "direction": "string",
        "disabled": False,
        "destination_groups": ["string"],
        "ip_version": "string",
        "log_label": "string",
        "logged": False,
        "action": "string",
        "destinations_excluded": False,
        "path": "string",
        "profiles": ["string"],
        "revision": 0,
        "rule_id": 0,
        "description": "string",
        "sequence_number": 0,
        "services": ["string"],
        "source_groups": ["string"],
        "sources_excluded": False,
        "tags": [{
            "scope": "string",
            "tag": "string",
        }],
    }],
    tags=[{
        "scope": "string",
        "tag": "string",
    }])
Copy
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",
        nsxId: "string",
        direction: "string",
        disabled: false,
        destinationGroups: ["string"],
        ipVersion: "string",
        logLabel: "string",
        logged: false,
        action: "string",
        destinationsExcluded: false,
        path: "string",
        profiles: ["string"],
        revision: 0,
        ruleId: 0,
        description: "string",
        sequenceNumber: 0,
        services: ["string"],
        sourceGroups: ["string"],
        sourcesExcluded: false,
        tags: [{
            scope: "string",
            tag: "string",
        }],
    }],
    tags: [{
        scope: "string",
        tag: "string",
    }],
});
Copy
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
          services:
            - string
          sourceGroups:
            - string
          sourcesExcluded: false
          tags:
            - scope: string
              tag: string
    tags:
        - scope: string
          tag: string
Copy

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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required. string
The ID of the project which the object belongs to
ProjectId This property is required. string
The ID of the project which the object belongs to
projectId This property is required. String
The ID of the project which the object belongs to
projectId This property is required. string
The ID of the project which the object belongs to
project_id This property is required. str
The ID of the project which the object belongs to
projectId This property is required. String
The ID of the project which the object belongs to

PolicyPredefinedGatewayPolicyDefaultRule
, PolicyPredefinedGatewayPolicyDefaultRuleArgs

Scope This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. string
Display name of the resource.
Scopes This property is required. 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.
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 This property is required. string
Display name of the resource.
Scopes This property is required. []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.
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 This property is required. String
Display name of the resource.
scopes This property is required. 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.
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 This property is required. string
Display name of the resource.
scopes This property is required. 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.
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 This property is required. str
Display name of the resource.
scopes This property is required. 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.
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 This property is required. String
Display name of the resource.
scopes This property is required. 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.
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.

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.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt