Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicyTier1Gateway
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.PolicyTier1Gateway

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

    Create PolicyTier1Gateway Resource

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

    Constructor syntax

    new PolicyTier1Gateway(name: string, args: PolicyTier1GatewayArgs, opts?: CustomResourceOptions);
    @overload
def PolicyTier1Gateway(resource_name: str,
                       args: PolicyTier1GatewayArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def PolicyTier1Gateway(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       display_name: Optional[str] = None,
                       ingress_qos_profile_path: Optional[str] = None,
                       enable_firewall: Optional[bool] = None,
                       dhcp_config_path: Optional[str] = None,
                       default_rule_logging: Optional[bool] = None,
                       edge_cluster_path: Optional[str] = None,
                       egress_qos_profile_path: Optional[str] = None,
                       context: Optional[PolicyTier1GatewayContextArgs] = None,
                       enable_standby_relocation: Optional[bool] = None,
                       failover_mode: Optional[str] = None,
                       force_whitelisting: Optional[bool] = None,
                       description: Optional[str] = None,
                       ha_mode: Optional[str] = None,
                       nsx_id: Optional[str] = None,
                       ipv6_dad_profile_path: Optional[str] = None,
                       ipv6_ndra_profile_path: Optional[str] = None,
                       locale_services: Optional[Sequence[PolicyTier1GatewayLocaleServiceArgs]] = None,
                       intersite_config: Optional[PolicyTier1GatewayIntersiteConfigArgs] = None,
                       policy_tier1_gateway_id: Optional[str] = None,
                       pool_allocation: Optional[str] = None,
                       route_advertisement_rules: Optional[Sequence[PolicyTier1GatewayRouteAdvertisementRuleArgs]] = None,
                       route_advertisement_types: Optional[Sequence[str]] = None,
                       tags: Optional[Sequence[PolicyTier1GatewayTagArgs]] = None,
                       tier0_path: Optional[str] = None,
                       type: Optional[str] = None)
    func NewPolicyTier1Gateway(ctx *Context, name string, args PolicyTier1GatewayArgs, opts ...ResourceOption) (*PolicyTier1Gateway, error)
    public PolicyTier1Gateway(string name, PolicyTier1GatewayArgs args, CustomResourceOptions? opts = null)
    public PolicyTier1Gateway(String name, PolicyTier1GatewayArgs args)
public PolicyTier1Gateway(String name, PolicyTier1GatewayArgs args, CustomResourceOptions options)

    type: nsxt:PolicyTier1Gateway
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 PolicyTier1GatewayArgs
    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 PolicyTier1GatewayArgs
    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 PolicyTier1GatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyTier1GatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyTier1GatewayArgs
    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 policyTier1GatewayResource = new Nsxt.PolicyTier1Gateway("policyTier1GatewayResource", new()
{
    DisplayName = "string",
    IngressQosProfilePath = "string",
    EnableFirewall = false,
    DhcpConfigPath = "string",
    DefaultRuleLogging = false,
    EdgeClusterPath = "string",
    EgressQosProfilePath = "string",
    Context = new Nsxt.Inputs.PolicyTier1GatewayContextArgs
    {
        ProjectId = "string",
    },
    EnableStandbyRelocation = false,
    FailoverMode = "string",
    Description = "string",
    HaMode = "string",
    NsxId = "string",
    Ipv6DadProfilePath = "string",
    Ipv6NdraProfilePath = "string",
    LocaleServices = new[]
    {
        new Nsxt.Inputs.PolicyTier1GatewayLocaleServiceArgs
        {
            EdgeClusterPath = "string",
            DisplayName = "string",
            NsxId = "string",
            Path = "string",
            PreferredEdgePaths = new[]
            {
                "string",
            },
            Revision = 0,
        },
    },
    IntersiteConfig = new Nsxt.Inputs.PolicyTier1GatewayIntersiteConfigArgs
    {
        FallbackSitePaths = new[]
        {
            "string",
        },
        PrimarySitePath = "string",
        TransitSubnet = "string",
    },
    PolicyTier1GatewayId = "string",
    PoolAllocation = "string",
    RouteAdvertisementRules = new[]
    {
        new Nsxt.Inputs.PolicyTier1GatewayRouteAdvertisementRuleArgs
        {
            Name = "string",
            Subnets = new[]
            {
                "string",
            },
            Action = "string",
            PrefixOperator = "string",
            RouteAdvertisementTypes = new[]
            {
                "string",
            },
        },
    },
    RouteAdvertisementTypes = new[]
    {
        "string",
    },
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyTier1GatewayTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
    Tier0Path = "string",
    Type = "string",
});

    example, err := nsxt.NewPolicyTier1Gateway(ctx, "policyTier1GatewayResource", &nsxt.PolicyTier1GatewayArgs{
	DisplayName:           pulumi.String("string"),
	IngressQosProfilePath: pulumi.String("string"),
	EnableFirewall:        pulumi.Bool(false),
	DhcpConfigPath:        pulumi.String("string"),
	DefaultRuleLogging:    pulumi.Bool(false),
	EdgeClusterPath:       pulumi.String("string"),
	EgressQosProfilePath:  pulumi.String("string"),
	Context: &nsxt.PolicyTier1GatewayContextArgs{
		ProjectId: pulumi.String("string"),
	},
	EnableStandbyRelocation: pulumi.Bool(false),
	FailoverMode:            pulumi.String("string"),
	Description:             pulumi.String("string"),
	HaMode:                  pulumi.String("string"),
	NsxId:                   pulumi.String("string"),
	Ipv6DadProfilePath:      pulumi.String("string"),
	Ipv6NdraProfilePath:     pulumi.String("string"),
	LocaleServices: nsxt.PolicyTier1GatewayLocaleServiceArray{
		&nsxt.PolicyTier1GatewayLocaleServiceArgs{
			EdgeClusterPath: pulumi.String("string"),
			DisplayName:     pulumi.String("string"),
			NsxId:           pulumi.String("string"),
			Path:            pulumi.String("string"),
			PreferredEdgePaths: pulumi.StringArray{
				pulumi.String("string"),
			},
			Revision: pulumi.Float64(0),
		},
	},
	IntersiteConfig: &nsxt.PolicyTier1GatewayIntersiteConfigArgs{
		FallbackSitePaths: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrimarySitePath: pulumi.String("string"),
		TransitSubnet:   pulumi.String("string"),
	},
	PolicyTier1GatewayId: pulumi.String("string"),
	PoolAllocation:       pulumi.String("string"),
	RouteAdvertisementRules: nsxt.PolicyTier1GatewayRouteAdvertisementRuleArray{
		&nsxt.PolicyTier1GatewayRouteAdvertisementRuleArgs{
			Name: pulumi.String("string"),
			Subnets: pulumi.StringArray{
				pulumi.String("string"),
			},
			Action:         pulumi.String("string"),
			PrefixOperator: pulumi.String("string"),
			RouteAdvertisementTypes: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	RouteAdvertisementTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: nsxt.PolicyTier1GatewayTagArray{
		&nsxt.PolicyTier1GatewayTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
	Tier0Path: pulumi.String("string"),
	Type:      pulumi.String("string"),
})

    var policyTier1GatewayResource = new PolicyTier1Gateway("policyTier1GatewayResource", PolicyTier1GatewayArgs.builder()
    .displayName("string")
    .ingressQosProfilePath("string")
    .enableFirewall(false)
    .dhcpConfigPath("string")
    .defaultRuleLogging(false)
    .edgeClusterPath("string")
    .egressQosProfilePath("string")
    .context(PolicyTier1GatewayContextArgs.builder()
        .projectId("string")
        .build())
    .enableStandbyRelocation(false)
    .failoverMode("string")
    .description("string")
    .haMode("string")
    .nsxId("string")
    .ipv6DadProfilePath("string")
    .ipv6NdraProfilePath("string")
    .localeServices(PolicyTier1GatewayLocaleServiceArgs.builder()
        .edgeClusterPath("string")
        .displayName("string")
        .nsxId("string")
        .path("string")
        .preferredEdgePaths("string")
        .revision(0)
        .build())
    .intersiteConfig(PolicyTier1GatewayIntersiteConfigArgs.builder()
        .fallbackSitePaths("string")
        .primarySitePath("string")
        .transitSubnet("string")
        .build())
    .policyTier1GatewayId("string")
    .poolAllocation("string")
    .routeAdvertisementRules(PolicyTier1GatewayRouteAdvertisementRuleArgs.builder()
        .name("string")
        .subnets("string")
        .action("string")
        .prefixOperator("string")
        .routeAdvertisementTypes("string")
        .build())
    .routeAdvertisementTypes("string")
    .tags(PolicyTier1GatewayTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .tier0Path("string")
    .type("string")
    .build());

    policy_tier1_gateway_resource = nsxt.PolicyTier1Gateway("policyTier1GatewayResource",
    display_name="string",
    ingress_qos_profile_path="string",
    enable_firewall=False,
    dhcp_config_path="string",
    default_rule_logging=False,
    edge_cluster_path="string",
    egress_qos_profile_path="string",
    context={
        "project_id": "string",
    },
    enable_standby_relocation=False,
    failover_mode="string",
    description="string",
    ha_mode="string",
    nsx_id="string",
    ipv6_dad_profile_path="string",
    ipv6_ndra_profile_path="string",
    locale_services=[{
        "edge_cluster_path": "string",
        "display_name": "string",
        "nsx_id": "string",
        "path": "string",
        "preferred_edge_paths": ["string"],
        "revision": 0,
    }],
    intersite_config={
        "fallback_site_paths": ["string"],
        "primary_site_path": "string",
        "transit_subnet": "string",
    },
    policy_tier1_gateway_id="string",
    pool_allocation="string",
    route_advertisement_rules=[{
        "name": "string",
        "subnets": ["string"],
        "action": "string",
        "prefix_operator": "string",
        "route_advertisement_types": ["string"],
    }],
    route_advertisement_types=["string"],
    tags=[{
        "scope": "string",
        "tag": "string",
    }],
    tier0_path="string",
    type="string")

    const policyTier1GatewayResource = new nsxt.PolicyTier1Gateway("policyTier1GatewayResource", {
    displayName: "string",
    ingressQosProfilePath: "string",
    enableFirewall: false,
    dhcpConfigPath: "string",
    defaultRuleLogging: false,
    edgeClusterPath: "string",
    egressQosProfilePath: "string",
    context: {
        projectId: "string",
    },
    enableStandbyRelocation: false,
    failoverMode: "string",
    description: "string",
    haMode: "string",
    nsxId: "string",
    ipv6DadProfilePath: "string",
    ipv6NdraProfilePath: "string",
    localeServices: [{
        edgeClusterPath: "string",
        displayName: "string",
        nsxId: "string",
        path: "string",
        preferredEdgePaths: ["string"],
        revision: 0,
    }],
    intersiteConfig: {
        fallbackSitePaths: ["string"],
        primarySitePath: "string",
        transitSubnet: "string",
    },
    policyTier1GatewayId: "string",
    poolAllocation: "string",
    routeAdvertisementRules: [{
        name: "string",
        subnets: ["string"],
        action: "string",
        prefixOperator: "string",
        routeAdvertisementTypes: ["string"],
    }],
    routeAdvertisementTypes: ["string"],
    tags: [{
        scope: "string",
        tag: "string",
    }],
    tier0Path: "string",
    type: "string",
});

    type: nsxt:PolicyTier1Gateway
properties:
    context:
        projectId: string
    defaultRuleLogging: false
    description: string
    dhcpConfigPath: string
    displayName: string
    edgeClusterPath: string
    egressQosProfilePath: string
    enableFirewall: false
    enableStandbyRelocation: false
    failoverMode: string
    haMode: string
    ingressQosProfilePath: string
    intersiteConfig:
        fallbackSitePaths:
            - string
        primarySitePath: string
        transitSubnet: string
    ipv6DadProfilePath: string
    ipv6NdraProfilePath: string
    localeServices:
        - displayName: string
          edgeClusterPath: string
          nsxId: string
          path: string
          preferredEdgePaths:
            - string
          revision: 0
    nsxId: string
    policyTier1GatewayId: string
    poolAllocation: string
    routeAdvertisementRules:
        - action: string
          name: string
          prefixOperator: string
          routeAdvertisementTypes:
            - string
          subnets:
            - string
    routeAdvertisementTypes:
        - string
    tags:
        - scope: string
          tag: string
    tier0Path: string
    type: string

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

    DisplayName string
    Display name of the resource.
    Context PolicyTier1GatewayContext
    The context which the object belongs to
    DefaultRuleLogging bool
    Boolean flag indicating if the default rule logging will be enabled or not. The default value is false.
    Description string
    Description of the resource.
    DhcpConfigPath string
    Policy path to DHCP server or relay configuration to use for this gateway.
    EdgeClusterPath string
    The path of the edge cluster where the Tier-1 is placed.For advanced configuration, use locale_service clause instead.
    EgressQosProfilePath string
    QoS Profile path for egress traffic on link connected to Tier0 gateway.
    EnableFirewall bool
    Boolean flag indicating if the edge firewall will be enabled or not. The default value is true.
    EnableStandbyRelocation bool
    Boolean flag indicating if the standby relocation will be enabled or not. The default value is false.
    FailoverMode string
    This failover mode determines, whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE.
    ForceWhitelisting bool
    Boolean flag indicating if white-listing will be forced or not. The default value is false. This argument is deprecated and will be removed. Please use nsxt.PolicyPredefinedGatewayPolicy resource to control default action.

    Deprecated: Deprecated

    HaMode string
    High-availability Mode for Tier-1. Valid values are ACTIVE_ACTIVE, ACTIVE_STANDBY and NONE. ACTIVE_ACTIVE is supported with NSX version 4.0.0 and above. NONE mode should be used for Distributed Only, e.g when a gateway is created and has no services.
    IngressQosProfilePath string
    QoS Profile path for ingress traffic on link connected to Tier0 gateway.
    IntersiteConfig PolicyTier1GatewayIntersiteConfig
    This clause is relevant for Global Manager only.
    Ipv6DadProfilePath string
    Policy path to IPv6 DAD profile.
    Ipv6NdraProfilePath string
    Policy path to IPv6 NDRA profile.
    LocaleServices List<PolicyTier1GatewayLocaleService>
    This argument is required on NSX Global Manager. Multiple locale services can be specified for multiple locations.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    PolicyTier1GatewayId string
    ID of the Tier-1 gateway.
    PoolAllocation string
    Size of edge node allocation at for routing and load balancer service to meet performance and scalability requirements, one of ROUTING, LB_SMALL, LB_MEDIUM, LB_LARGE, LB_XLARGE. Default is ROUTING. Changing this attribute would force new resource.
    RouteAdvertisementRules List<PolicyTier1GatewayRouteAdvertisementRule>
    List of rules for routes advertisement:
    RouteAdvertisementTypes List<string>
    List of desired types of route advertisements, supported values: TIER1_STATIC_ROUTES, TIER1_CONNECTED, TIER1_NAT, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_IPSEC_LOCAL_ENDPOINT. This field is Computed, meaning that NSX can auto-assign types. Hence, in order to revert to default behavior, set route advertisement values explicitly rather than removing this clause from configuration.
    Tags List<PolicyTier1GatewayTag>
    A list of scope + tag pairs to associate with this Tier-1 gateway.
    Tier0Path string
    The path of the connected Tier0.
    Type string
    This setting is only applicable to VMC and it helps auto-configure router advertisements for the gateway. Valid values are ROUTED, NATTED and ISOLATED. For ROUTED and NATTED, tier0_path should be specified in configuration.
    DisplayName string
    Display name of the resource.
    Context PolicyTier1GatewayContextArgs
    The context which the object belongs to
    DefaultRuleLogging bool
    Boolean flag indicating if the default rule logging will be enabled or not. The default value is false.
    Description string
    Description of the resource.
    DhcpConfigPath string
    Policy path to DHCP server or relay configuration to use for this gateway.
    EdgeClusterPath string
    The path of the edge cluster where the Tier-1 is placed.For advanced configuration, use locale_service clause instead.
    EgressQosProfilePath string
    QoS Profile path for egress traffic on link connected to Tier0 gateway.
    EnableFirewall bool
    Boolean flag indicating if the edge firewall will be enabled or not. The default value is true.
    EnableStandbyRelocation bool
    Boolean flag indicating if the standby relocation will be enabled or not. The default value is false.
    FailoverMode string
    This failover mode determines, whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE.
    ForceWhitelisting bool
    Boolean flag indicating if white-listing will be forced or not. The default value is false. This argument is deprecated and will be removed. Please use nsxt.PolicyPredefinedGatewayPolicy resource to control default action.

    Deprecated: Deprecated

    HaMode string
    High-availability Mode for Tier-1. Valid values are ACTIVE_ACTIVE, ACTIVE_STANDBY and NONE. ACTIVE_ACTIVE is supported with NSX version 4.0.0 and above. NONE mode should be used for Distributed Only, e.g when a gateway is created and has no services.
    IngressQosProfilePath string
    QoS Profile path for ingress traffic on link connected to Tier0 gateway.
    IntersiteConfig PolicyTier1GatewayIntersiteConfigArgs
    This clause is relevant for Global Manager only.
    Ipv6DadProfilePath string
    Policy path to IPv6 DAD profile.
    Ipv6NdraProfilePath string
    Policy path to IPv6 NDRA profile.
    LocaleServices []PolicyTier1GatewayLocaleServiceArgs
    This argument is required on NSX Global Manager. Multiple locale services can be specified for multiple locations.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    PolicyTier1GatewayId string
    ID of the Tier-1 gateway.
    PoolAllocation string
    Size of edge node allocation at for routing and load balancer service to meet performance and scalability requirements, one of ROUTING, LB_SMALL, LB_MEDIUM, LB_LARGE, LB_XLARGE. Default is ROUTING. Changing this attribute would force new resource.
    RouteAdvertisementRules []PolicyTier1GatewayRouteAdvertisementRuleArgs
    List of rules for routes advertisement:
    RouteAdvertisementTypes []string
    List of desired types of route advertisements, supported values: TIER1_STATIC_ROUTES, TIER1_CONNECTED, TIER1_NAT, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_IPSEC_LOCAL_ENDPOINT. This field is Computed, meaning that NSX can auto-assign types. Hence, in order to revert to default behavior, set route advertisement values explicitly rather than removing this clause from configuration.
    Tags []PolicyTier1GatewayTagArgs
    A list of scope + tag pairs to associate with this Tier-1 gateway.
    Tier0Path string
    The path of the connected Tier0.
    Type string
    This setting is only applicable to VMC and it helps auto-configure router advertisements for the gateway. Valid values are ROUTED, NATTED and ISOLATED. For ROUTED and NATTED, tier0_path should be specified in configuration.
    displayName String
    Display name of the resource.
    context PolicyTier1GatewayContext
    The context which the object belongs to
    defaultRuleLogging Boolean
    Boolean flag indicating if the default rule logging will be enabled or not. The default value is false.
    description String
    Description of the resource.
    dhcpConfigPath String
    Policy path to DHCP server or relay configuration to use for this gateway.
    edgeClusterPath String
    The path of the edge cluster where the Tier-1 is placed.For advanced configuration, use locale_service clause instead.
    egressQosProfilePath String
    QoS Profile path for egress traffic on link connected to Tier0 gateway.
    enableFirewall Boolean
    Boolean flag indicating if the edge firewall will be enabled or not. The default value is true.
    enableStandbyRelocation Boolean
    Boolean flag indicating if the standby relocation will be enabled or not. The default value is false.
    failoverMode String
    This failover mode determines, whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE.
    forceWhitelisting Boolean
    Boolean flag indicating if white-listing will be forced or not. The default value is false. This argument is deprecated and will be removed. Please use nsxt.PolicyPredefinedGatewayPolicy resource to control default action.

    Deprecated: Deprecated

    haMode String
    High-availability Mode for Tier-1. Valid values are ACTIVE_ACTIVE, ACTIVE_STANDBY and NONE. ACTIVE_ACTIVE is supported with NSX version 4.0.0 and above. NONE mode should be used for Distributed Only, e.g when a gateway is created and has no services.
    ingressQosProfilePath String
    QoS Profile path for ingress traffic on link connected to Tier0 gateway.
    intersiteConfig PolicyTier1GatewayIntersiteConfig
    This clause is relevant for Global Manager only.
    ipv6DadProfilePath String
    Policy path to IPv6 DAD profile.
    ipv6NdraProfilePath String
    Policy path to IPv6 NDRA profile.
    localeServices List<PolicyTier1GatewayLocaleService>
    This argument is required on NSX Global Manager. Multiple locale services can be specified for multiple locations.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    policyTier1GatewayId String
    ID of the Tier-1 gateway.
    poolAllocation String
    Size of edge node allocation at for routing and load balancer service to meet performance and scalability requirements, one of ROUTING, LB_SMALL, LB_MEDIUM, LB_LARGE, LB_XLARGE. Default is ROUTING. Changing this attribute would force new resource.
    routeAdvertisementRules List<PolicyTier1GatewayRouteAdvertisementRule>
    List of rules for routes advertisement:
    routeAdvertisementTypes List<String>
    List of desired types of route advertisements, supported values: TIER1_STATIC_ROUTES, TIER1_CONNECTED, TIER1_NAT, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_IPSEC_LOCAL_ENDPOINT. This field is Computed, meaning that NSX can auto-assign types. Hence, in order to revert to default behavior, set route advertisement values explicitly rather than removing this clause from configuration.
    tags List<PolicyTier1GatewayTag>
    A list of scope + tag pairs to associate with this Tier-1 gateway.
    tier0Path String
    The path of the connected Tier0.
    type String
    This setting is only applicable to VMC and it helps auto-configure router advertisements for the gateway. Valid values are ROUTED, NATTED and ISOLATED. For ROUTED and NATTED, tier0_path should be specified in configuration.
    displayName string
    Display name of the resource.
    context PolicyTier1GatewayContext
    The context which the object belongs to
    defaultRuleLogging boolean
    Boolean flag indicating if the default rule logging will be enabled or not. The default value is false.
    description string
    Description of the resource.
    dhcpConfigPath string
    Policy path to DHCP server or relay configuration to use for this gateway.
    edgeClusterPath string
    The path of the edge cluster where the Tier-1 is placed.For advanced configuration, use locale_service clause instead.
    egressQosProfilePath string
    QoS Profile path for egress traffic on link connected to Tier0 gateway.
    enableFirewall boolean
    Boolean flag indicating if the edge firewall will be enabled or not. The default value is true.
    enableStandbyRelocation boolean
    Boolean flag indicating if the standby relocation will be enabled or not. The default value is false.
    failoverMode string
    This failover mode determines, whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE.
    forceWhitelisting boolean
    Boolean flag indicating if white-listing will be forced or not. The default value is false. This argument is deprecated and will be removed. Please use nsxt.PolicyPredefinedGatewayPolicy resource to control default action.

    Deprecated: Deprecated

    haMode string
    High-availability Mode for Tier-1. Valid values are ACTIVE_ACTIVE, ACTIVE_STANDBY and NONE. ACTIVE_ACTIVE is supported with NSX version 4.0.0 and above. NONE mode should be used for Distributed Only, e.g when a gateway is created and has no services.
    ingressQosProfilePath string
    QoS Profile path for ingress traffic on link connected to Tier0 gateway.
    intersiteConfig PolicyTier1GatewayIntersiteConfig
    This clause is relevant for Global Manager only.
    ipv6DadProfilePath string
    Policy path to IPv6 DAD profile.
    ipv6NdraProfilePath string
    Policy path to IPv6 NDRA profile.
    localeServices PolicyTier1GatewayLocaleService[]
    This argument is required on NSX Global Manager. Multiple locale services can be specified for multiple locations.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    policyTier1GatewayId string
    ID of the Tier-1 gateway.
    poolAllocation string
    Size of edge node allocation at for routing and load balancer service to meet performance and scalability requirements, one of ROUTING, LB_SMALL, LB_MEDIUM, LB_LARGE, LB_XLARGE. Default is ROUTING. Changing this attribute would force new resource.
    routeAdvertisementRules PolicyTier1GatewayRouteAdvertisementRule[]
    List of rules for routes advertisement:
    routeAdvertisementTypes string[]
    List of desired types of route advertisements, supported values: TIER1_STATIC_ROUTES, TIER1_CONNECTED, TIER1_NAT, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_IPSEC_LOCAL_ENDPOINT. This field is Computed, meaning that NSX can auto-assign types. Hence, in order to revert to default behavior, set route advertisement values explicitly rather than removing this clause from configuration.
    tags PolicyTier1GatewayTag[]
    A list of scope + tag pairs to associate with this Tier-1 gateway.
    tier0Path string
    The path of the connected Tier0.
    type string
    This setting is only applicable to VMC and it helps auto-configure router advertisements for the gateway. Valid values are ROUTED, NATTED and ISOLATED. For ROUTED and NATTED, tier0_path should be specified in configuration.
    display_name str
    Display name of the resource.
    context PolicyTier1GatewayContextArgs
    The context which the object belongs to
    default_rule_logging bool
    Boolean flag indicating if the default rule logging will be enabled or not. The default value is false.
    description str
    Description of the resource.
    dhcp_config_path str
    Policy path to DHCP server or relay configuration to use for this gateway.
    edge_cluster_path str
    The path of the edge cluster where the Tier-1 is placed.For advanced configuration, use locale_service clause instead.
    egress_qos_profile_path str
    QoS Profile path for egress traffic on link connected to Tier0 gateway.
    enable_firewall bool
    Boolean flag indicating if the edge firewall will be enabled or not. The default value is true.
    enable_standby_relocation bool
    Boolean flag indicating if the standby relocation will be enabled or not. The default value is false.
    failover_mode str
    This failover mode determines, whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE.
    force_whitelisting bool
    Boolean flag indicating if white-listing will be forced or not. The default value is false. This argument is deprecated and will be removed. Please use nsxt.PolicyPredefinedGatewayPolicy resource to control default action.

    Deprecated: Deprecated

    ha_mode str
    High-availability Mode for Tier-1. Valid values are ACTIVE_ACTIVE, ACTIVE_STANDBY and NONE. ACTIVE_ACTIVE is supported with NSX version 4.0.0 and above. NONE mode should be used for Distributed Only, e.g when a gateway is created and has no services.
    ingress_qos_profile_path str
    QoS Profile path for ingress traffic on link connected to Tier0 gateway.
    intersite_config PolicyTier1GatewayIntersiteConfigArgs
    This clause is relevant for Global Manager only.
    ipv6_dad_profile_path str
    Policy path to IPv6 DAD profile.
    ipv6_ndra_profile_path str
    Policy path to IPv6 NDRA profile.
    locale_services Sequence[PolicyTier1GatewayLocaleServiceArgs]
    This argument is required on NSX Global Manager. Multiple locale services can be specified for multiple locations.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    policy_tier1_gateway_id str
    ID of the Tier-1 gateway.
    pool_allocation str
    Size of edge node allocation at for routing and load balancer service to meet performance and scalability requirements, one of ROUTING, LB_SMALL, LB_MEDIUM, LB_LARGE, LB_XLARGE. Default is ROUTING. Changing this attribute would force new resource.
    route_advertisement_rules Sequence[PolicyTier1GatewayRouteAdvertisementRuleArgs]
    List of rules for routes advertisement:
    route_advertisement_types Sequence[str]
    List of desired types of route advertisements, supported values: TIER1_STATIC_ROUTES, TIER1_CONNECTED, TIER1_NAT, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_IPSEC_LOCAL_ENDPOINT. This field is Computed, meaning that NSX can auto-assign types. Hence, in order to revert to default behavior, set route advertisement values explicitly rather than removing this clause from configuration.
    tags Sequence[PolicyTier1GatewayTagArgs]
    A list of scope + tag pairs to associate with this Tier-1 gateway.
    tier0_path str
    The path of the connected Tier0.
    type str
    This setting is only applicable to VMC and it helps auto-configure router advertisements for the gateway. Valid values are ROUTED, NATTED and ISOLATED. For ROUTED and NATTED, tier0_path should be specified in configuration.
    displayName String
    Display name of the resource.
    context Property Map
    The context which the object belongs to
    defaultRuleLogging Boolean
    Boolean flag indicating if the default rule logging will be enabled or not. The default value is false.
    description String
    Description of the resource.
    dhcpConfigPath String
    Policy path to DHCP server or relay configuration to use for this gateway.
    edgeClusterPath String
    The path of the edge cluster where the Tier-1 is placed.For advanced configuration, use locale_service clause instead.
    egressQosProfilePath String
    QoS Profile path for egress traffic on link connected to Tier0 gateway.
    enableFirewall Boolean
    Boolean flag indicating if the edge firewall will be enabled or not. The default value is true.
    enableStandbyRelocation Boolean
    Boolean flag indicating if the standby relocation will be enabled or not. The default value is false.
    failoverMode String
    This failover mode determines, whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE.
    forceWhitelisting Boolean
    Boolean flag indicating if white-listing will be forced or not. The default value is false. This argument is deprecated and will be removed. Please use nsxt.PolicyPredefinedGatewayPolicy resource to control default action.

    Deprecated: Deprecated

    haMode String
    High-availability Mode for Tier-1. Valid values are ACTIVE_ACTIVE, ACTIVE_STANDBY and NONE. ACTIVE_ACTIVE is supported with NSX version 4.0.0 and above. NONE mode should be used for Distributed Only, e.g when a gateway is created and has no services.
    ingressQosProfilePath String
    QoS Profile path for ingress traffic on link connected to Tier0 gateway.
    intersiteConfig Property Map
    This clause is relevant for Global Manager only.
    ipv6DadProfilePath String
    Policy path to IPv6 DAD profile.
    ipv6NdraProfilePath String
    Policy path to IPv6 NDRA profile.
    localeServices List<Property Map>
    This argument is required on NSX Global Manager. Multiple locale services can be specified for multiple locations.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    policyTier1GatewayId String
    ID of the Tier-1 gateway.
    poolAllocation String
    Size of edge node allocation at for routing and load balancer service to meet performance and scalability requirements, one of ROUTING, LB_SMALL, LB_MEDIUM, LB_LARGE, LB_XLARGE. Default is ROUTING. Changing this attribute would force new resource.
    routeAdvertisementRules List<Property Map>
    List of rules for routes advertisement:
    routeAdvertisementTypes List<String>
    List of desired types of route advertisements, supported values: TIER1_STATIC_ROUTES, TIER1_CONNECTED, TIER1_NAT, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_IPSEC_LOCAL_ENDPOINT. This field is Computed, meaning that NSX can auto-assign types. Hence, in order to revert to default behavior, set route advertisement values explicitly rather than removing this clause from configuration.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this Tier-1 gateway.
    tier0Path String
    The path of the connected Tier0.
    type String
    This setting is only applicable to VMC and it helps auto-configure router advertisements for the gateway. Valid values are ROUTED, NATTED and ISOLATED. For ROUTED and NATTED, tier0_path should be specified in configuration.

    Outputs

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

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

    Look up Existing PolicyTier1Gateway Resource

    Get an existing PolicyTier1Gateway 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?: PolicyTier1GatewayState, opts?: CustomResourceOptions): PolicyTier1Gateway
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        context: Optional[PolicyTier1GatewayContextArgs] = None,
        default_rule_logging: Optional[bool] = None,
        description: Optional[str] = None,
        dhcp_config_path: Optional[str] = None,
        display_name: Optional[str] = None,
        edge_cluster_path: Optional[str] = None,
        egress_qos_profile_path: Optional[str] = None,
        enable_firewall: Optional[bool] = None,
        enable_standby_relocation: Optional[bool] = None,
        failover_mode: Optional[str] = None,
        force_whitelisting: Optional[bool] = None,
        ha_mode: Optional[str] = None,
        ingress_qos_profile_path: Optional[str] = None,
        intersite_config: Optional[PolicyTier1GatewayIntersiteConfigArgs] = None,
        ipv6_dad_profile_path: Optional[str] = None,
        ipv6_ndra_profile_path: Optional[str] = None,
        locale_services: Optional[Sequence[PolicyTier1GatewayLocaleServiceArgs]] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_tier1_gateway_id: Optional[str] = None,
        pool_allocation: Optional[str] = None,
        revision: Optional[float] = None,
        route_advertisement_rules: Optional[Sequence[PolicyTier1GatewayRouteAdvertisementRuleArgs]] = None,
        route_advertisement_types: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[PolicyTier1GatewayTagArgs]] = None,
        tier0_path: Optional[str] = None,
        type: Optional[str] = None) -> PolicyTier1Gateway
    func GetPolicyTier1Gateway(ctx *Context, name string, id IDInput, state *PolicyTier1GatewayState, opts ...ResourceOption) (*PolicyTier1Gateway, error)
    public static PolicyTier1Gateway Get(string name, Input<string> id, PolicyTier1GatewayState? state, CustomResourceOptions? opts = null)
    public static PolicyTier1Gateway get(String name, Output<String> id, PolicyTier1GatewayState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyTier1Gateway    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 PolicyTier1GatewayContext
    The context which the object belongs to
    DefaultRuleLogging bool
    Boolean flag indicating if the default rule logging will be enabled or not. The default value is false.
    Description string
    Description of the resource.
    DhcpConfigPath string
    Policy path to DHCP server or relay configuration to use for this gateway.
    DisplayName string
    Display name of the resource.
    EdgeClusterPath string
    The path of the edge cluster where the Tier-1 is placed.For advanced configuration, use locale_service clause instead.
    EgressQosProfilePath string
    QoS Profile path for egress traffic on link connected to Tier0 gateway.
    EnableFirewall bool
    Boolean flag indicating if the edge firewall will be enabled or not. The default value is true.
    EnableStandbyRelocation bool
    Boolean flag indicating if the standby relocation will be enabled or not. The default value is false.
    FailoverMode string
    This failover mode determines, whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE.
    ForceWhitelisting bool
    Boolean flag indicating if white-listing will be forced or not. The default value is false. This argument is deprecated and will be removed. Please use nsxt.PolicyPredefinedGatewayPolicy resource to control default action.

    Deprecated: Deprecated

    HaMode string
    High-availability Mode for Tier-1. Valid values are ACTIVE_ACTIVE, ACTIVE_STANDBY and NONE. ACTIVE_ACTIVE is supported with NSX version 4.0.0 and above. NONE mode should be used for Distributed Only, e.g when a gateway is created and has no services.
    IngressQosProfilePath string
    QoS Profile path for ingress traffic on link connected to Tier0 gateway.
    IntersiteConfig PolicyTier1GatewayIntersiteConfig
    This clause is relevant for Global Manager only.
    Ipv6DadProfilePath string
    Policy path to IPv6 DAD profile.
    Ipv6NdraProfilePath string
    Policy path to IPv6 NDRA profile.
    LocaleServices List<PolicyTier1GatewayLocaleService>
    This argument is required on NSX Global Manager. Multiple locale services can be specified for multiple locations.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    Path string
    The NSX path of the policy resource.
    PolicyTier1GatewayId string
    ID of the Tier-1 gateway.
    PoolAllocation string
    Size of edge node allocation at for routing and load balancer service to meet performance and scalability requirements, one of ROUTING, LB_SMALL, LB_MEDIUM, LB_LARGE, LB_XLARGE. Default is ROUTING. Changing this attribute would force new resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    RouteAdvertisementRules List<PolicyTier1GatewayRouteAdvertisementRule>
    List of rules for routes advertisement:
    RouteAdvertisementTypes List<string>
    List of desired types of route advertisements, supported values: TIER1_STATIC_ROUTES, TIER1_CONNECTED, TIER1_NAT, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_IPSEC_LOCAL_ENDPOINT. This field is Computed, meaning that NSX can auto-assign types. Hence, in order to revert to default behavior, set route advertisement values explicitly rather than removing this clause from configuration.
    Tags List<PolicyTier1GatewayTag>
    A list of scope + tag pairs to associate with this Tier-1 gateway.
    Tier0Path string
    The path of the connected Tier0.
    Type string
    This setting is only applicable to VMC and it helps auto-configure router advertisements for the gateway. Valid values are ROUTED, NATTED and ISOLATED. For ROUTED and NATTED, tier0_path should be specified in configuration.
    Context PolicyTier1GatewayContextArgs
    The context which the object belongs to
    DefaultRuleLogging bool
    Boolean flag indicating if the default rule logging will be enabled or not. The default value is false.
    Description string
    Description of the resource.
    DhcpConfigPath string
    Policy path to DHCP server or relay configuration to use for this gateway.
    DisplayName string
    Display name of the resource.
    EdgeClusterPath string
    The path of the edge cluster where the Tier-1 is placed.For advanced configuration, use locale_service clause instead.
    EgressQosProfilePath string
    QoS Profile path for egress traffic on link connected to Tier0 gateway.
    EnableFirewall bool
    Boolean flag indicating if the edge firewall will be enabled or not. The default value is true.
    EnableStandbyRelocation bool
    Boolean flag indicating if the standby relocation will be enabled or not. The default value is false.
    FailoverMode string
    This failover mode determines, whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE.
    ForceWhitelisting bool
    Boolean flag indicating if white-listing will be forced or not. The default value is false. This argument is deprecated and will be removed. Please use nsxt.PolicyPredefinedGatewayPolicy resource to control default action.

    Deprecated: Deprecated

    HaMode string
    High-availability Mode for Tier-1. Valid values are ACTIVE_ACTIVE, ACTIVE_STANDBY and NONE. ACTIVE_ACTIVE is supported with NSX version 4.0.0 and above. NONE mode should be used for Distributed Only, e.g when a gateway is created and has no services.
    IngressQosProfilePath string
    QoS Profile path for ingress traffic on link connected to Tier0 gateway.
    IntersiteConfig PolicyTier1GatewayIntersiteConfigArgs
    This clause is relevant for Global Manager only.
    Ipv6DadProfilePath string
    Policy path to IPv6 DAD profile.
    Ipv6NdraProfilePath string
    Policy path to IPv6 NDRA profile.
    LocaleServices []PolicyTier1GatewayLocaleServiceArgs
    This argument is required on NSX Global Manager. Multiple locale services can be specified for multiple locations.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    Path string
    The NSX path of the policy resource.
    PolicyTier1GatewayId string
    ID of the Tier-1 gateway.
    PoolAllocation string
    Size of edge node allocation at for routing and load balancer service to meet performance and scalability requirements, one of ROUTING, LB_SMALL, LB_MEDIUM, LB_LARGE, LB_XLARGE. Default is ROUTING. Changing this attribute would force new resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    RouteAdvertisementRules []PolicyTier1GatewayRouteAdvertisementRuleArgs
    List of rules for routes advertisement:
    RouteAdvertisementTypes []string
    List of desired types of route advertisements, supported values: TIER1_STATIC_ROUTES, TIER1_CONNECTED, TIER1_NAT, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_IPSEC_LOCAL_ENDPOINT. This field is Computed, meaning that NSX can auto-assign types. Hence, in order to revert to default behavior, set route advertisement values explicitly rather than removing this clause from configuration.
    Tags []PolicyTier1GatewayTagArgs
    A list of scope + tag pairs to associate with this Tier-1 gateway.
    Tier0Path string
    The path of the connected Tier0.
    Type string
    This setting is only applicable to VMC and it helps auto-configure router advertisements for the gateway. Valid values are ROUTED, NATTED and ISOLATED. For ROUTED and NATTED, tier0_path should be specified in configuration.
    context PolicyTier1GatewayContext
    The context which the object belongs to
    defaultRuleLogging Boolean
    Boolean flag indicating if the default rule logging will be enabled or not. The default value is false.
    description String
    Description of the resource.
    dhcpConfigPath String
    Policy path to DHCP server or relay configuration to use for this gateway.
    displayName String
    Display name of the resource.
    edgeClusterPath String
    The path of the edge cluster where the Tier-1 is placed.For advanced configuration, use locale_service clause instead.
    egressQosProfilePath String
    QoS Profile path for egress traffic on link connected to Tier0 gateway.
    enableFirewall Boolean
    Boolean flag indicating if the edge firewall will be enabled or not. The default value is true.
    enableStandbyRelocation Boolean
    Boolean flag indicating if the standby relocation will be enabled or not. The default value is false.
    failoverMode String
    This failover mode determines, whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE.
    forceWhitelisting Boolean
    Boolean flag indicating if white-listing will be forced or not. The default value is false. This argument is deprecated and will be removed. Please use nsxt.PolicyPredefinedGatewayPolicy resource to control default action.

    Deprecated: Deprecated

    haMode String
    High-availability Mode for Tier-1. Valid values are ACTIVE_ACTIVE, ACTIVE_STANDBY and NONE. ACTIVE_ACTIVE is supported with NSX version 4.0.0 and above. NONE mode should be used for Distributed Only, e.g when a gateway is created and has no services.
    ingressQosProfilePath String
    QoS Profile path for ingress traffic on link connected to Tier0 gateway.
    intersiteConfig PolicyTier1GatewayIntersiteConfig
    This clause is relevant for Global Manager only.
    ipv6DadProfilePath String
    Policy path to IPv6 DAD profile.
    ipv6NdraProfilePath String
    Policy path to IPv6 NDRA profile.
    localeServices List<PolicyTier1GatewayLocaleService>
    This argument is required on NSX Global Manager. Multiple locale services can be specified for multiple locations.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    path String
    The NSX path of the policy resource.
    policyTier1GatewayId String
    ID of the Tier-1 gateway.
    poolAllocation String
    Size of edge node allocation at for routing and load balancer service to meet performance and scalability requirements, one of ROUTING, LB_SMALL, LB_MEDIUM, LB_LARGE, LB_XLARGE. Default is ROUTING. Changing this attribute would force new resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    routeAdvertisementRules List<PolicyTier1GatewayRouteAdvertisementRule>
    List of rules for routes advertisement:
    routeAdvertisementTypes List<String>
    List of desired types of route advertisements, supported values: TIER1_STATIC_ROUTES, TIER1_CONNECTED, TIER1_NAT, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_IPSEC_LOCAL_ENDPOINT. This field is Computed, meaning that NSX can auto-assign types. Hence, in order to revert to default behavior, set route advertisement values explicitly rather than removing this clause from configuration.
    tags List<PolicyTier1GatewayTag>
    A list of scope + tag pairs to associate with this Tier-1 gateway.
    tier0Path String
    The path of the connected Tier0.
    type String
    This setting is only applicable to VMC and it helps auto-configure router advertisements for the gateway. Valid values are ROUTED, NATTED and ISOLATED. For ROUTED and NATTED, tier0_path should be specified in configuration.
    context PolicyTier1GatewayContext
    The context which the object belongs to
    defaultRuleLogging boolean
    Boolean flag indicating if the default rule logging will be enabled or not. The default value is false.
    description string
    Description of the resource.
    dhcpConfigPath string
    Policy path to DHCP server or relay configuration to use for this gateway.
    displayName string
    Display name of the resource.
    edgeClusterPath string
    The path of the edge cluster where the Tier-1 is placed.For advanced configuration, use locale_service clause instead.
    egressQosProfilePath string
    QoS Profile path for egress traffic on link connected to Tier0 gateway.
    enableFirewall boolean
    Boolean flag indicating if the edge firewall will be enabled or not. The default value is true.
    enableStandbyRelocation boolean
    Boolean flag indicating if the standby relocation will be enabled or not. The default value is false.
    failoverMode string
    This failover mode determines, whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE.
    forceWhitelisting boolean
    Boolean flag indicating if white-listing will be forced or not. The default value is false. This argument is deprecated and will be removed. Please use nsxt.PolicyPredefinedGatewayPolicy resource to control default action.

    Deprecated: Deprecated

    haMode string
    High-availability Mode for Tier-1. Valid values are ACTIVE_ACTIVE, ACTIVE_STANDBY and NONE. ACTIVE_ACTIVE is supported with NSX version 4.0.0 and above. NONE mode should be used for Distributed Only, e.g when a gateway is created and has no services.
    ingressQosProfilePath string
    QoS Profile path for ingress traffic on link connected to Tier0 gateway.
    intersiteConfig PolicyTier1GatewayIntersiteConfig
    This clause is relevant for Global Manager only.
    ipv6DadProfilePath string
    Policy path to IPv6 DAD profile.
    ipv6NdraProfilePath string
    Policy path to IPv6 NDRA profile.
    localeServices PolicyTier1GatewayLocaleService[]
    This argument is required on NSX Global Manager. Multiple locale services can be specified for multiple locations.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    path string
    The NSX path of the policy resource.
    policyTier1GatewayId string
    ID of the Tier-1 gateway.
    poolAllocation string
    Size of edge node allocation at for routing and load balancer service to meet performance and scalability requirements, one of ROUTING, LB_SMALL, LB_MEDIUM, LB_LARGE, LB_XLARGE. Default is ROUTING. Changing this attribute would force new resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    routeAdvertisementRules PolicyTier1GatewayRouteAdvertisementRule[]
    List of rules for routes advertisement:
    routeAdvertisementTypes string[]
    List of desired types of route advertisements, supported values: TIER1_STATIC_ROUTES, TIER1_CONNECTED, TIER1_NAT, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_IPSEC_LOCAL_ENDPOINT. This field is Computed, meaning that NSX can auto-assign types. Hence, in order to revert to default behavior, set route advertisement values explicitly rather than removing this clause from configuration.
    tags PolicyTier1GatewayTag[]
    A list of scope + tag pairs to associate with this Tier-1 gateway.
    tier0Path string
    The path of the connected Tier0.
    type string
    This setting is only applicable to VMC and it helps auto-configure router advertisements for the gateway. Valid values are ROUTED, NATTED and ISOLATED. For ROUTED and NATTED, tier0_path should be specified in configuration.
    context PolicyTier1GatewayContextArgs
    The context which the object belongs to
    default_rule_logging bool
    Boolean flag indicating if the default rule logging will be enabled or not. The default value is false.
    description str
    Description of the resource.
    dhcp_config_path str
    Policy path to DHCP server or relay configuration to use for this gateway.
    display_name str
    Display name of the resource.
    edge_cluster_path str
    The path of the edge cluster where the Tier-1 is placed.For advanced configuration, use locale_service clause instead.
    egress_qos_profile_path str
    QoS Profile path for egress traffic on link connected to Tier0 gateway.
    enable_firewall bool
    Boolean flag indicating if the edge firewall will be enabled or not. The default value is true.
    enable_standby_relocation bool
    Boolean flag indicating if the standby relocation will be enabled or not. The default value is false.
    failover_mode str
    This failover mode determines, whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE.
    force_whitelisting bool
    Boolean flag indicating if white-listing will be forced or not. The default value is false. This argument is deprecated and will be removed. Please use nsxt.PolicyPredefinedGatewayPolicy resource to control default action.

    Deprecated: Deprecated

    ha_mode str
    High-availability Mode for Tier-1. Valid values are ACTIVE_ACTIVE, ACTIVE_STANDBY and NONE. ACTIVE_ACTIVE is supported with NSX version 4.0.0 and above. NONE mode should be used for Distributed Only, e.g when a gateway is created and has no services.
    ingress_qos_profile_path str
    QoS Profile path for ingress traffic on link connected to Tier0 gateway.
    intersite_config PolicyTier1GatewayIntersiteConfigArgs
    This clause is relevant for Global Manager only.
    ipv6_dad_profile_path str
    Policy path to IPv6 DAD profile.
    ipv6_ndra_profile_path str
    Policy path to IPv6 NDRA profile.
    locale_services Sequence[PolicyTier1GatewayLocaleServiceArgs]
    This argument is required on NSX Global Manager. Multiple locale services can be specified for multiple locations.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    path str
    The NSX path of the policy resource.
    policy_tier1_gateway_id str
    ID of the Tier-1 gateway.
    pool_allocation str
    Size of edge node allocation at for routing and load balancer service to meet performance and scalability requirements, one of ROUTING, LB_SMALL, LB_MEDIUM, LB_LARGE, LB_XLARGE. Default is ROUTING. Changing this attribute would force new resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    route_advertisement_rules Sequence[PolicyTier1GatewayRouteAdvertisementRuleArgs]
    List of rules for routes advertisement:
    route_advertisement_types Sequence[str]
    List of desired types of route advertisements, supported values: TIER1_STATIC_ROUTES, TIER1_CONNECTED, TIER1_NAT, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_IPSEC_LOCAL_ENDPOINT. This field is Computed, meaning that NSX can auto-assign types. Hence, in order to revert to default behavior, set route advertisement values explicitly rather than removing this clause from configuration.
    tags Sequence[PolicyTier1GatewayTagArgs]
    A list of scope + tag pairs to associate with this Tier-1 gateway.
    tier0_path str
    The path of the connected Tier0.
    type str
    This setting is only applicable to VMC and it helps auto-configure router advertisements for the gateway. Valid values are ROUTED, NATTED and ISOLATED. For ROUTED and NATTED, tier0_path should be specified in configuration.
    context Property Map
    The context which the object belongs to
    defaultRuleLogging Boolean
    Boolean flag indicating if the default rule logging will be enabled or not. The default value is false.
    description String
    Description of the resource.
    dhcpConfigPath String
    Policy path to DHCP server or relay configuration to use for this gateway.
    displayName String
    Display name of the resource.
    edgeClusterPath String
    The path of the edge cluster where the Tier-1 is placed.For advanced configuration, use locale_service clause instead.
    egressQosProfilePath String
    QoS Profile path for egress traffic on link connected to Tier0 gateway.
    enableFirewall Boolean
    Boolean flag indicating if the edge firewall will be enabled or not. The default value is true.
    enableStandbyRelocation Boolean
    Boolean flag indicating if the standby relocation will be enabled or not. The default value is false.
    failoverMode String
    This failover mode determines, whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE.
    forceWhitelisting Boolean
    Boolean flag indicating if white-listing will be forced or not. The default value is false. This argument is deprecated and will be removed. Please use nsxt.PolicyPredefinedGatewayPolicy resource to control default action.

    Deprecated: Deprecated

    haMode String
    High-availability Mode for Tier-1. Valid values are ACTIVE_ACTIVE, ACTIVE_STANDBY and NONE. ACTIVE_ACTIVE is supported with NSX version 4.0.0 and above. NONE mode should be used for Distributed Only, e.g when a gateway is created and has no services.
    ingressQosProfilePath String
    QoS Profile path for ingress traffic on link connected to Tier0 gateway.
    intersiteConfig Property Map
    This clause is relevant for Global Manager only.
    ipv6DadProfilePath String
    Policy path to IPv6 DAD profile.
    ipv6NdraProfilePath String
    Policy path to IPv6 NDRA profile.
    localeServices List<Property Map>
    This argument is required on NSX Global Manager. Multiple locale services can be specified for multiple locations.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    path String
    The NSX path of the policy resource.
    policyTier1GatewayId String
    ID of the Tier-1 gateway.
    poolAllocation String
    Size of edge node allocation at for routing and load balancer service to meet performance and scalability requirements, one of ROUTING, LB_SMALL, LB_MEDIUM, LB_LARGE, LB_XLARGE. Default is ROUTING. Changing this attribute would force new resource.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    routeAdvertisementRules List<Property Map>
    List of rules for routes advertisement:
    routeAdvertisementTypes List<String>
    List of desired types of route advertisements, supported values: TIER1_STATIC_ROUTES, TIER1_CONNECTED, TIER1_NAT, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_IPSEC_LOCAL_ENDPOINT. This field is Computed, meaning that NSX can auto-assign types. Hence, in order to revert to default behavior, set route advertisement values explicitly rather than removing this clause from configuration.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this Tier-1 gateway.
    tier0Path String
    The path of the connected Tier0.
    type String
    This setting is only applicable to VMC and it helps auto-configure router advertisements for the gateway. Valid values are ROUTED, NATTED and ISOLATED. For ROUTED and NATTED, tier0_path should be specified in configuration.

    Supporting Types

    PolicyTier1GatewayContext, PolicyTier1GatewayContextArgs

    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

    PolicyTier1GatewayIntersiteConfig, PolicyTier1GatewayIntersiteConfigArgs

    FallbackSitePaths List<string>
    Fallback sites to be used as new primary site on current primary site failure
    PrimarySitePath string
    Primary egress site for gateway.
    TransitSubnet string
    IPv4 subnet for inter-site transit segment connecting service routers across sites for stretched gateway. For IPv6 link local subnet is auto configured.
    FallbackSitePaths []string
    Fallback sites to be used as new primary site on current primary site failure
    PrimarySitePath string
    Primary egress site for gateway.
    TransitSubnet string
    IPv4 subnet for inter-site transit segment connecting service routers across sites for stretched gateway. For IPv6 link local subnet is auto configured.
    fallbackSitePaths List<String>
    Fallback sites to be used as new primary site on current primary site failure
    primarySitePath String
    Primary egress site for gateway.
    transitSubnet String
    IPv4 subnet for inter-site transit segment connecting service routers across sites for stretched gateway. For IPv6 link local subnet is auto configured.
    fallbackSitePaths string[]
    Fallback sites to be used as new primary site on current primary site failure
    primarySitePath string
    Primary egress site for gateway.
    transitSubnet string
    IPv4 subnet for inter-site transit segment connecting service routers across sites for stretched gateway. For IPv6 link local subnet is auto configured.
    fallback_site_paths Sequence[str]
    Fallback sites to be used as new primary site on current primary site failure
    primary_site_path str
    Primary egress site for gateway.
    transit_subnet str
    IPv4 subnet for inter-site transit segment connecting service routers across sites for stretched gateway. For IPv6 link local subnet is auto configured.
    fallbackSitePaths List<String>
    Fallback sites to be used as new primary site on current primary site failure
    primarySitePath String
    Primary egress site for gateway.
    transitSubnet String
    IPv4 subnet for inter-site transit segment connecting service routers across sites for stretched gateway. For IPv6 link local subnet is auto configured.

    PolicyTier1GatewayLocaleService, PolicyTier1GatewayLocaleServiceArgs

    EdgeClusterPath string
    The path of the edge cluster where the Tier-0 is placed.
    DisplayName string
    Display name for the locale service.
    NsxId string
    NSX id for the locale service. It is recommended to specify this attribute in order to avoid unnecessary recreation of this object. Should be unique within the gateway.
    Path string
    The NSX path of the policy resource.
    PreferredEdgePaths List<string>
    Policy paths to edge nodes. Specified edge is used as preferred edge cluster member when failover mode is set to PREEMPTIVE.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    EdgeClusterPath string
    The path of the edge cluster where the Tier-0 is placed.
    DisplayName string
    Display name for the locale service.
    NsxId string
    NSX id for the locale service. It is recommended to specify this attribute in order to avoid unnecessary recreation of this object. Should be unique within the gateway.
    Path string
    The NSX path of the policy resource.
    PreferredEdgePaths []string
    Policy paths to edge nodes. Specified edge is used as preferred edge cluster member when failover mode is set to PREEMPTIVE.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    edgeClusterPath String
    The path of the edge cluster where the Tier-0 is placed.
    displayName String
    Display name for the locale service.
    nsxId String
    NSX id for the locale service. It is recommended to specify this attribute in order to avoid unnecessary recreation of this object. Should be unique within the gateway.
    path String
    The NSX path of the policy resource.
    preferredEdgePaths List<String>
    Policy paths to edge nodes. Specified edge is used as preferred edge cluster member when failover mode is set to PREEMPTIVE.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    edgeClusterPath string
    The path of the edge cluster where the Tier-0 is placed.
    displayName string
    Display name for the locale service.
    nsxId string
    NSX id for the locale service. It is recommended to specify this attribute in order to avoid unnecessary recreation of this object. Should be unique within the gateway.
    path string
    The NSX path of the policy resource.
    preferredEdgePaths string[]
    Policy paths to edge nodes. Specified edge is used as preferred edge cluster member when failover mode is set to PREEMPTIVE.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    edge_cluster_path str
    The path of the edge cluster where the Tier-0 is placed.
    display_name str
    Display name for the locale service.
    nsx_id str
    NSX id for the locale service. It is recommended to specify this attribute in order to avoid unnecessary recreation of this object. Should be unique within the gateway.
    path str
    The NSX path of the policy resource.
    preferred_edge_paths Sequence[str]
    Policy paths to edge nodes. Specified edge is used as preferred edge cluster member when failover mode is set to PREEMPTIVE.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    edgeClusterPath String
    The path of the edge cluster where the Tier-0 is placed.
    displayName String
    Display name for the locale service.
    nsxId String
    NSX id for the locale service. It is recommended to specify this attribute in order to avoid unnecessary recreation of this object. Should be unique within the gateway.
    path String
    The NSX path of the policy resource.
    preferredEdgePaths List<String>
    Policy paths to edge nodes. Specified edge is used as preferred edge cluster member when failover mode is set to PREEMPTIVE.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

    PolicyTier1GatewayRouteAdvertisementRule, PolicyTier1GatewayRouteAdvertisementRuleArgs

    Name string
    The name of the rule.
    Subnets List<string>
    list of network CIDRs to be routed.
    Action string
    Action to advertise filtered routes to the connected Tier0 gateway. PERMIT (which is the default): Enables the advertisement, DENY: Disables the advertisement.
    PrefixOperator string
    Prefix operator to apply on subnets. GE prefix operator (which is the default|) filters all the routes having network subset of any of the networks configured in Advertise rule. EQ prefix operator filter all the routes having network equal to any of the network configured in Advertise rule.The name of the rule.
    RouteAdvertisementTypes List<string>
    List of desired types of route advertisements, supported values: TIER1_STATIC_ROUTES, TIER1_CONNECTED, TIER1_NAT, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_IPSEC_LOCAL_ENDPOINT. This field is Computed, meaning that NSX can auto-assign types. Hence, in order to revert to default behavior, set route advertisement values explicitly rather than removing this clause from configuration.
    Name string
    The name of the rule.
    Subnets []string
    list of network CIDRs to be routed.
    Action string
    Action to advertise filtered routes to the connected Tier0 gateway. PERMIT (which is the default): Enables the advertisement, DENY: Disables the advertisement.
    PrefixOperator string
    Prefix operator to apply on subnets. GE prefix operator (which is the default|) filters all the routes having network subset of any of the networks configured in Advertise rule. EQ prefix operator filter all the routes having network equal to any of the network configured in Advertise rule.The name of the rule.
    RouteAdvertisementTypes []string
    List of desired types of route advertisements, supported values: TIER1_STATIC_ROUTES, TIER1_CONNECTED, TIER1_NAT, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_IPSEC_LOCAL_ENDPOINT. This field is Computed, meaning that NSX can auto-assign types. Hence, in order to revert to default behavior, set route advertisement values explicitly rather than removing this clause from configuration.
    name String
    The name of the rule.
    subnets List<String>
    list of network CIDRs to be routed.
    action String
    Action to advertise filtered routes to the connected Tier0 gateway. PERMIT (which is the default): Enables the advertisement, DENY: Disables the advertisement.
    prefixOperator String
    Prefix operator to apply on subnets. GE prefix operator (which is the default|) filters all the routes having network subset of any of the networks configured in Advertise rule. EQ prefix operator filter all the routes having network equal to any of the network configured in Advertise rule.The name of the rule.
    routeAdvertisementTypes List<String>
    List of desired types of route advertisements, supported values: TIER1_STATIC_ROUTES, TIER1_CONNECTED, TIER1_NAT, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_IPSEC_LOCAL_ENDPOINT. This field is Computed, meaning that NSX can auto-assign types. Hence, in order to revert to default behavior, set route advertisement values explicitly rather than removing this clause from configuration.
    name string
    The name of the rule.
    subnets string[]
    list of network CIDRs to be routed.
    action string
    Action to advertise filtered routes to the connected Tier0 gateway. PERMIT (which is the default): Enables the advertisement, DENY: Disables the advertisement.
    prefixOperator string
    Prefix operator to apply on subnets. GE prefix operator (which is the default|) filters all the routes having network subset of any of the networks configured in Advertise rule. EQ prefix operator filter all the routes having network equal to any of the network configured in Advertise rule.The name of the rule.
    routeAdvertisementTypes string[]
    List of desired types of route advertisements, supported values: TIER1_STATIC_ROUTES, TIER1_CONNECTED, TIER1_NAT, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_IPSEC_LOCAL_ENDPOINT. This field is Computed, meaning that NSX can auto-assign types. Hence, in order to revert to default behavior, set route advertisement values explicitly rather than removing this clause from configuration.
    name str
    The name of the rule.
    subnets Sequence[str]
    list of network CIDRs to be routed.
    action str
    Action to advertise filtered routes to the connected Tier0 gateway. PERMIT (which is the default): Enables the advertisement, DENY: Disables the advertisement.
    prefix_operator str
    Prefix operator to apply on subnets. GE prefix operator (which is the default|) filters all the routes having network subset of any of the networks configured in Advertise rule. EQ prefix operator filter all the routes having network equal to any of the network configured in Advertise rule.The name of the rule.
    route_advertisement_types Sequence[str]
    List of desired types of route advertisements, supported values: TIER1_STATIC_ROUTES, TIER1_CONNECTED, TIER1_NAT, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_IPSEC_LOCAL_ENDPOINT. This field is Computed, meaning that NSX can auto-assign types. Hence, in order to revert to default behavior, set route advertisement values explicitly rather than removing this clause from configuration.
    name String
    The name of the rule.
    subnets List<String>
    list of network CIDRs to be routed.
    action String
    Action to advertise filtered routes to the connected Tier0 gateway. PERMIT (which is the default): Enables the advertisement, DENY: Disables the advertisement.
    prefixOperator String
    Prefix operator to apply on subnets. GE prefix operator (which is the default|) filters all the routes having network subset of any of the networks configured in Advertise rule. EQ prefix operator filter all the routes having network equal to any of the network configured in Advertise rule.The name of the rule.
    routeAdvertisementTypes List<String>
    List of desired types of route advertisements, supported values: TIER1_STATIC_ROUTES, TIER1_CONNECTED, TIER1_NAT, TIER1_LB_VIP, TIER1_LB_SNAT, TIER1_DNS_FORWARDER_IP, TIER1_IPSEC_LOCAL_ENDPOINT. This field is Computed, meaning that NSX can auto-assign types. Hence, in order to revert to default behavior, set route advertisement values explicitly rather than removing this clause from configuration.

    PolicyTier1GatewayTag, PolicyTier1GatewayTagArgs

    Scope string
    Tag string
    A list of scope + tag pairs to associate with this Tier-1 gateway.
    Scope string
    Tag string
    A list of scope + tag pairs to associate with this Tier-1 gateway.
    scope String
    tag String
    A list of scope + tag pairs to associate with this Tier-1 gateway.
    scope string
    tag string
    A list of scope + tag pairs to associate with this Tier-1 gateway.
    scope str
    tag str
    A list of scope + tag pairs to associate with this Tier-1 gateway.
    scope String
    tag String
    A list of scope + tag pairs to associate with this Tier-1 gateway.

    Package Details

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