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

nsxt.LogicalTier0Router

Explore with Pulumi AI

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

Create LogicalTier0Router Resource

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

Constructor syntax

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

@overload
def LogicalTier0Router(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       edge_cluster_id: Optional[str] = None,
                       description: Optional[str] = None,
                       display_name: Optional[str] = None,
                       failover_mode: Optional[str] = None,
                       firewall_sections: Optional[Sequence[LogicalTier0RouterFirewallSectionArgs]] = None,
                       high_availability_mode: Optional[str] = None,
                       logical_tier0_router_id: Optional[str] = None,
                       tags: Optional[Sequence[LogicalTier0RouterTagArgs]] = None)
func NewLogicalTier0Router(ctx *Context, name string, args LogicalTier0RouterArgs, opts ...ResourceOption) (*LogicalTier0Router, error)
public LogicalTier0Router(string name, LogicalTier0RouterArgs args, CustomResourceOptions? opts = null)
public LogicalTier0Router(String name, LogicalTier0RouterArgs args)
public LogicalTier0Router(String name, LogicalTier0RouterArgs args, CustomResourceOptions options)

type: nsxt:LogicalTier0Router
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. LogicalTier0RouterArgs
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. LogicalTier0RouterArgs
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. LogicalTier0RouterArgs
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. LogicalTier0RouterArgs
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. LogicalTier0RouterArgs
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 logicalTier0RouterResource = new Nsxt.LogicalTier0Router("logicalTier0RouterResource", new()
{
    EdgeClusterId = "string",
    Description = "string",
    DisplayName = "string",
    FailoverMode = "string",
    FirewallSections = new[]
    {
        new Nsxt.Inputs.LogicalTier0RouterFirewallSectionArgs
        {
            IsValid = false,
            TargetDisplayName = "string",
            TargetId = "string",
            TargetType = "string",
        },
    },
    HighAvailabilityMode = "string",
    LogicalTier0RouterId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.LogicalTier0RouterTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});
Copy
example, err := nsxt.NewLogicalTier0Router(ctx, "logicalTier0RouterResource", &nsxt.LogicalTier0RouterArgs{
	EdgeClusterId: pulumi.String("string"),
	Description:   pulumi.String("string"),
	DisplayName:   pulumi.String("string"),
	FailoverMode:  pulumi.String("string"),
	FirewallSections: nsxt.LogicalTier0RouterFirewallSectionArray{
		&nsxt.LogicalTier0RouterFirewallSectionArgs{
			IsValid:           pulumi.Bool(false),
			TargetDisplayName: pulumi.String("string"),
			TargetId:          pulumi.String("string"),
			TargetType:        pulumi.String("string"),
		},
	},
	HighAvailabilityMode: pulumi.String("string"),
	LogicalTier0RouterId: pulumi.String("string"),
	Tags: nsxt.LogicalTier0RouterTagArray{
		&nsxt.LogicalTier0RouterTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})
Copy
var logicalTier0RouterResource = new LogicalTier0Router("logicalTier0RouterResource", LogicalTier0RouterArgs.builder()
    .edgeClusterId("string")
    .description("string")
    .displayName("string")
    .failoverMode("string")
    .firewallSections(LogicalTier0RouterFirewallSectionArgs.builder()
        .isValid(false)
        .targetDisplayName("string")
        .targetId("string")
        .targetType("string")
        .build())
    .highAvailabilityMode("string")
    .logicalTier0RouterId("string")
    .tags(LogicalTier0RouterTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());
Copy
logical_tier0_router_resource = nsxt.LogicalTier0Router("logicalTier0RouterResource",
    edge_cluster_id="string",
    description="string",
    display_name="string",
    failover_mode="string",
    firewall_sections=[{
        "is_valid": False,
        "target_display_name": "string",
        "target_id": "string",
        "target_type": "string",
    }],
    high_availability_mode="string",
    logical_tier0_router_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])
Copy
const logicalTier0RouterResource = new nsxt.LogicalTier0Router("logicalTier0RouterResource", {
    edgeClusterId: "string",
    description: "string",
    displayName: "string",
    failoverMode: "string",
    firewallSections: [{
        isValid: false,
        targetDisplayName: "string",
        targetId: "string",
        targetType: "string",
    }],
    highAvailabilityMode: "string",
    logicalTier0RouterId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});
Copy
type: nsxt:LogicalTier0Router
properties:
    description: string
    displayName: string
    edgeClusterId: string
    failoverMode: string
    firewallSections:
        - isValid: false
          targetDisplayName: string
          targetId: string
          targetType: string
    highAvailabilityMode: string
    logicalTier0RouterId: string
    tags:
        - scope: string
          tag: string
Copy

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

EdgeClusterId This property is required. string
Edge Cluster ID for the logical Tier0 router. Changing this setting on existing router will re-create the router.
Description string
Description of the resource.
DisplayName string
Display name, defaults to ID if not set.
FailoverMode string
Failover mode which determines whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE. This setting is relevant only for ACTIVE_STANDBY high availability mode.
FirewallSections List<LogicalTier0RouterFirewallSection>
(Optional) The list of firewall sections for this router
HighAvailabilityMode string
High availability mode "ACTIVE_ACTIVE"/"ACTIVE_STANDBY". Changing this setting on existing router will re-create the router.
LogicalTier0RouterId string
ID of the logical Tier0 router.
Tags List<LogicalTier0RouterTag>
A list of scope + tag pairs to associate with this logical Tier0 router.
EdgeClusterId This property is required. string
Edge Cluster ID for the logical Tier0 router. Changing this setting on existing router will re-create the router.
Description string
Description of the resource.
DisplayName string
Display name, defaults to ID if not set.
FailoverMode string
Failover mode which determines whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE. This setting is relevant only for ACTIVE_STANDBY high availability mode.
FirewallSections []LogicalTier0RouterFirewallSectionArgs
(Optional) The list of firewall sections for this router
HighAvailabilityMode string
High availability mode "ACTIVE_ACTIVE"/"ACTIVE_STANDBY". Changing this setting on existing router will re-create the router.
LogicalTier0RouterId string
ID of the logical Tier0 router.
Tags []LogicalTier0RouterTagArgs
A list of scope + tag pairs to associate with this logical Tier0 router.
edgeClusterId This property is required. String
Edge Cluster ID for the logical Tier0 router. Changing this setting on existing router will re-create the router.
description String
Description of the resource.
displayName String
Display name, defaults to ID if not set.
failoverMode String
Failover mode which determines whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE. This setting is relevant only for ACTIVE_STANDBY high availability mode.
firewallSections List<LogicalTier0RouterFirewallSection>
(Optional) The list of firewall sections for this router
highAvailabilityMode String
High availability mode "ACTIVE_ACTIVE"/"ACTIVE_STANDBY". Changing this setting on existing router will re-create the router.
logicalTier0RouterId String
ID of the logical Tier0 router.
tags List<LogicalTier0RouterTag>
A list of scope + tag pairs to associate with this logical Tier0 router.
edgeClusterId This property is required. string
Edge Cluster ID for the logical Tier0 router. Changing this setting on existing router will re-create the router.
description string
Description of the resource.
displayName string
Display name, defaults to ID if not set.
failoverMode string
Failover mode which determines whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE. This setting is relevant only for ACTIVE_STANDBY high availability mode.
firewallSections LogicalTier0RouterFirewallSection[]
(Optional) The list of firewall sections for this router
highAvailabilityMode string
High availability mode "ACTIVE_ACTIVE"/"ACTIVE_STANDBY". Changing this setting on existing router will re-create the router.
logicalTier0RouterId string
ID of the logical Tier0 router.
tags LogicalTier0RouterTag[]
A list of scope + tag pairs to associate with this logical Tier0 router.
edge_cluster_id This property is required. str
Edge Cluster ID for the logical Tier0 router. Changing this setting on existing router will re-create the router.
description str
Description of the resource.
display_name str
Display name, defaults to ID if not set.
failover_mode str
Failover mode which determines whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE. This setting is relevant only for ACTIVE_STANDBY high availability mode.
firewall_sections Sequence[LogicalTier0RouterFirewallSectionArgs]
(Optional) The list of firewall sections for this router
high_availability_mode str
High availability mode "ACTIVE_ACTIVE"/"ACTIVE_STANDBY". Changing this setting on existing router will re-create the router.
logical_tier0_router_id str
ID of the logical Tier0 router.
tags Sequence[LogicalTier0RouterTagArgs]
A list of scope + tag pairs to associate with this logical Tier0 router.
edgeClusterId This property is required. String
Edge Cluster ID for the logical Tier0 router. Changing this setting on existing router will re-create the router.
description String
Description of the resource.
displayName String
Display name, defaults to ID if not set.
failoverMode String
Failover mode which determines whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE. This setting is relevant only for ACTIVE_STANDBY high availability mode.
firewallSections List<Property Map>
(Optional) The list of firewall sections for this router
highAvailabilityMode String
High availability mode "ACTIVE_ACTIVE"/"ACTIVE_STANDBY". Changing this setting on existing router will re-create the router.
logicalTier0RouterId String
ID of the logical Tier0 router.
tags List<Property Map>
A list of scope + tag pairs to associate with this logical Tier0 router.

Outputs

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

Get an existing LogicalTier0Router 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?: LogicalTier0RouterState, opts?: CustomResourceOptions): LogicalTier0Router
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        edge_cluster_id: Optional[str] = None,
        failover_mode: Optional[str] = None,
        firewall_sections: Optional[Sequence[LogicalTier0RouterFirewallSectionArgs]] = None,
        high_availability_mode: Optional[str] = None,
        logical_tier0_router_id: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[LogicalTier0RouterTagArgs]] = None) -> LogicalTier0Router
func GetLogicalTier0Router(ctx *Context, name string, id IDInput, state *LogicalTier0RouterState, opts ...ResourceOption) (*LogicalTier0Router, error)
public static LogicalTier0Router Get(string name, Input<string> id, LogicalTier0RouterState? state, CustomResourceOptions? opts = null)
public static LogicalTier0Router get(String name, Output<String> id, LogicalTier0RouterState state, CustomResourceOptions options)
resources:  _:    type: nsxt:LogicalTier0Router    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:
Description string
Description of the resource.
DisplayName string
Display name, defaults to ID if not set.
EdgeClusterId string
Edge Cluster ID for the logical Tier0 router. Changing this setting on existing router will re-create the router.
FailoverMode string
Failover mode which determines whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE. This setting is relevant only for ACTIVE_STANDBY high availability mode.
FirewallSections List<LogicalTier0RouterFirewallSection>
(Optional) The list of firewall sections for this router
HighAvailabilityMode string
High availability mode "ACTIVE_ACTIVE"/"ACTIVE_STANDBY". Changing this setting on existing router will re-create the router.
LogicalTier0RouterId string
ID of the logical Tier0 router.
Revision double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Tags List<LogicalTier0RouterTag>
A list of scope + tag pairs to associate with this logical Tier0 router.
Description string
Description of the resource.
DisplayName string
Display name, defaults to ID if not set.
EdgeClusterId string
Edge Cluster ID for the logical Tier0 router. Changing this setting on existing router will re-create the router.
FailoverMode string
Failover mode which determines whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE. This setting is relevant only for ACTIVE_STANDBY high availability mode.
FirewallSections []LogicalTier0RouterFirewallSectionArgs
(Optional) The list of firewall sections for this router
HighAvailabilityMode string
High availability mode "ACTIVE_ACTIVE"/"ACTIVE_STANDBY". Changing this setting on existing router will re-create the router.
LogicalTier0RouterId string
ID of the logical Tier0 router.
Revision float64
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Tags []LogicalTier0RouterTagArgs
A list of scope + tag pairs to associate with this logical Tier0 router.
description String
Description of the resource.
displayName String
Display name, defaults to ID if not set.
edgeClusterId String
Edge Cluster ID for the logical Tier0 router. Changing this setting on existing router will re-create the router.
failoverMode String
Failover mode which determines whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE. This setting is relevant only for ACTIVE_STANDBY high availability mode.
firewallSections List<LogicalTier0RouterFirewallSection>
(Optional) The list of firewall sections for this router
highAvailabilityMode String
High availability mode "ACTIVE_ACTIVE"/"ACTIVE_STANDBY". Changing this setting on existing router will re-create the router.
logicalTier0RouterId String
ID of the logical Tier0 router.
revision Double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
tags List<LogicalTier0RouterTag>
A list of scope + tag pairs to associate with this logical Tier0 router.
description string
Description of the resource.
displayName string
Display name, defaults to ID if not set.
edgeClusterId string
Edge Cluster ID for the logical Tier0 router. Changing this setting on existing router will re-create the router.
failoverMode string
Failover mode which determines whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE. This setting is relevant only for ACTIVE_STANDBY high availability mode.
firewallSections LogicalTier0RouterFirewallSection[]
(Optional) The list of firewall sections for this router
highAvailabilityMode string
High availability mode "ACTIVE_ACTIVE"/"ACTIVE_STANDBY". Changing this setting on existing router will re-create the router.
logicalTier0RouterId string
ID of the logical Tier0 router.
revision number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
tags LogicalTier0RouterTag[]
A list of scope + tag pairs to associate with this logical Tier0 router.
description str
Description of the resource.
display_name str
Display name, defaults to ID if not set.
edge_cluster_id str
Edge Cluster ID for the logical Tier0 router. Changing this setting on existing router will re-create the router.
failover_mode str
Failover mode which determines whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE. This setting is relevant only for ACTIVE_STANDBY high availability mode.
firewall_sections Sequence[LogicalTier0RouterFirewallSectionArgs]
(Optional) The list of firewall sections for this router
high_availability_mode str
High availability mode "ACTIVE_ACTIVE"/"ACTIVE_STANDBY". Changing this setting on existing router will re-create the router.
logical_tier0_router_id str
ID of the logical Tier0 router.
revision float
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
tags Sequence[LogicalTier0RouterTagArgs]
A list of scope + tag pairs to associate with this logical Tier0 router.
description String
Description of the resource.
displayName String
Display name, defaults to ID if not set.
edgeClusterId String
Edge Cluster ID for the logical Tier0 router. Changing this setting on existing router will re-create the router.
failoverMode String
Failover mode which determines whether the preferred service router instance for given logical router will preempt the peer. Accepted values are PREEMPTIVE/NON_PREEMPTIVE. This setting is relevant only for ACTIVE_STANDBY high availability mode.
firewallSections List<Property Map>
(Optional) The list of firewall sections for this router
highAvailabilityMode String
High availability mode "ACTIVE_ACTIVE"/"ACTIVE_STANDBY". Changing this setting on existing router will re-create the router.
logicalTier0RouterId String
ID of the logical Tier0 router.
revision Number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
tags List<Property Map>
A list of scope + tag pairs to associate with this logical Tier0 router.

Supporting Types

LogicalTier0RouterFirewallSection
, LogicalTier0RouterFirewallSectionArgs

IsValid bool
A boolean flag which will be set to false if the referenced NSX resource has been deleted
TargetDisplayName string
Display name of the NSX resource
TargetId string
Identifier of the NSX resource
TargetType string
Type of the NSX resource
IsValid bool
A boolean flag which will be set to false if the referenced NSX resource has been deleted
TargetDisplayName string
Display name of the NSX resource
TargetId string
Identifier of the NSX resource
TargetType string
Type of the NSX resource
isValid Boolean
A boolean flag which will be set to false if the referenced NSX resource has been deleted
targetDisplayName String
Display name of the NSX resource
targetId String
Identifier of the NSX resource
targetType String
Type of the NSX resource
isValid boolean
A boolean flag which will be set to false if the referenced NSX resource has been deleted
targetDisplayName string
Display name of the NSX resource
targetId string
Identifier of the NSX resource
targetType string
Type of the NSX resource
is_valid bool
A boolean flag which will be set to false if the referenced NSX resource has been deleted
target_display_name str
Display name of the NSX resource
target_id str
Identifier of the NSX resource
target_type str
Type of the NSX resource
isValid Boolean
A boolean flag which will be set to false if the referenced NSX resource has been deleted
targetDisplayName String
Display name of the NSX resource
targetId String
Identifier of the NSX resource
targetType String
Type of the NSX resource

LogicalTier0RouterTag
, LogicalTier0RouterTagArgs

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

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