1. Packages
  2. Nsxt Provider
  3. API Docs
  4. LogicalRouterDownlinkPort
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware

nsxt.LogicalRouterDownlinkPort

Explore with Pulumi AI

Create LogicalRouterDownlinkPort Resource

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

Constructor syntax

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

@overload
def LogicalRouterDownlinkPort(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              ip_address: Optional[str] = None,
                              linked_logical_switch_port_id: Optional[str] = None,
                              logical_router_id: Optional[str] = None,
                              description: Optional[str] = None,
                              display_name: Optional[str] = None,
                              logical_router_downlink_port_id: Optional[str] = None,
                              service_bindings: Optional[Sequence[LogicalRouterDownlinkPortServiceBindingArgs]] = None,
                              tags: Optional[Sequence[LogicalRouterDownlinkPortTagArgs]] = None,
                              urpf_mode: Optional[str] = None)
func NewLogicalRouterDownlinkPort(ctx *Context, name string, args LogicalRouterDownlinkPortArgs, opts ...ResourceOption) (*LogicalRouterDownlinkPort, error)
public LogicalRouterDownlinkPort(string name, LogicalRouterDownlinkPortArgs args, CustomResourceOptions? opts = null)
public LogicalRouterDownlinkPort(String name, LogicalRouterDownlinkPortArgs args)
public LogicalRouterDownlinkPort(String name, LogicalRouterDownlinkPortArgs args, CustomResourceOptions options)
type: nsxt:LogicalRouterDownlinkPort
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. LogicalRouterDownlinkPortArgs
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. LogicalRouterDownlinkPortArgs
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. LogicalRouterDownlinkPortArgs
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. LogicalRouterDownlinkPortArgs
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. LogicalRouterDownlinkPortArgs
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 logicalRouterDownlinkPortResource = new Nsxt.LogicalRouterDownlinkPort("logicalRouterDownlinkPortResource", new()
{
    IpAddress = "string",
    LinkedLogicalSwitchPortId = "string",
    LogicalRouterId = "string",
    Description = "string",
    DisplayName = "string",
    LogicalRouterDownlinkPortId = "string",
    ServiceBindings = new[]
    {
        new Nsxt.Inputs.LogicalRouterDownlinkPortServiceBindingArgs
        {
            IsValid = false,
            TargetDisplayName = "string",
            TargetId = "string",
            TargetType = "string",
        },
    },
    Tags = new[]
    {
        new Nsxt.Inputs.LogicalRouterDownlinkPortTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
    UrpfMode = "string",
});
Copy
example, err := nsxt.NewLogicalRouterDownlinkPort(ctx, "logicalRouterDownlinkPortResource", &nsxt.LogicalRouterDownlinkPortArgs{
IpAddress: pulumi.String("string"),
LinkedLogicalSwitchPortId: pulumi.String("string"),
LogicalRouterId: pulumi.String("string"),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
LogicalRouterDownlinkPortId: pulumi.String("string"),
ServiceBindings: .LogicalRouterDownlinkPortServiceBindingArray{
&.LogicalRouterDownlinkPortServiceBindingArgs{
IsValid: pulumi.Bool(false),
TargetDisplayName: pulumi.String("string"),
TargetId: pulumi.String("string"),
TargetType: pulumi.String("string"),
},
},
Tags: .LogicalRouterDownlinkPortTagArray{
&.LogicalRouterDownlinkPortTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
UrpfMode: pulumi.String("string"),
})
Copy
var logicalRouterDownlinkPortResource = new LogicalRouterDownlinkPort("logicalRouterDownlinkPortResource", LogicalRouterDownlinkPortArgs.builder()
    .ipAddress("string")
    .linkedLogicalSwitchPortId("string")
    .logicalRouterId("string")
    .description("string")
    .displayName("string")
    .logicalRouterDownlinkPortId("string")
    .serviceBindings(LogicalRouterDownlinkPortServiceBindingArgs.builder()
        .isValid(false)
        .targetDisplayName("string")
        .targetId("string")
        .targetType("string")
        .build())
    .tags(LogicalRouterDownlinkPortTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .urpfMode("string")
    .build());
Copy
logical_router_downlink_port_resource = nsxt.LogicalRouterDownlinkPort("logicalRouterDownlinkPortResource",
    ip_address="string",
    linked_logical_switch_port_id="string",
    logical_router_id="string",
    description="string",
    display_name="string",
    logical_router_downlink_port_id="string",
    service_bindings=[{
        "is_valid": False,
        "target_display_name": "string",
        "target_id": "string",
        "target_type": "string",
    }],
    tags=[{
        "scope": "string",
        "tag": "string",
    }],
    urpf_mode="string")
Copy
const logicalRouterDownlinkPortResource = new nsxt.LogicalRouterDownlinkPort("logicalRouterDownlinkPortResource", {
    ipAddress: "string",
    linkedLogicalSwitchPortId: "string",
    logicalRouterId: "string",
    description: "string",
    displayName: "string",
    logicalRouterDownlinkPortId: "string",
    serviceBindings: [{
        isValid: false,
        targetDisplayName: "string",
        targetId: "string",
        targetType: "string",
    }],
    tags: [{
        scope: "string",
        tag: "string",
    }],
    urpfMode: "string",
});
Copy
type: nsxt:LogicalRouterDownlinkPort
properties:
    description: string
    displayName: string
    ipAddress: string
    linkedLogicalSwitchPortId: string
    logicalRouterDownlinkPortId: string
    logicalRouterId: string
    serviceBindings:
        - isValid: false
          targetDisplayName: string
          targetId: string
          targetType: string
    tags:
        - scope: string
          tag: string
    urpfMode: string
Copy

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

IpAddress This property is required. string
Logical router port subnet (ip_address / prefix length)
LinkedLogicalSwitchPortId This property is required. string
Identifier for port on logical switch to connect to
LogicalRouterId This property is required. string
Identifier for logical Tier-1 router on which this port is created
Description string
Description of the resource.
DisplayName string
Display name, defaults to ID if not set.
LogicalRouterDownlinkPortId string
ID of the logical router downlink port.
ServiceBindings List<LogicalRouterDownlinkPortServiceBinding>
A list of services for this port. Currently only "LogicalService" is supported as a target_type, and a DHCP relay service ID as target_id
Tags List<LogicalRouterDownlinkPortTag>
A list of scope + tag pairs to associate with this port.
UrpfMode string
Unicast Reverse Path Forwarding mode. Accepted values are "NONE" and "STRICT" which is the default value.
IpAddress This property is required. string
Logical router port subnet (ip_address / prefix length)
LinkedLogicalSwitchPortId This property is required. string
Identifier for port on logical switch to connect to
LogicalRouterId This property is required. string
Identifier for logical Tier-1 router on which this port is created
Description string
Description of the resource.
DisplayName string
Display name, defaults to ID if not set.
LogicalRouterDownlinkPortId string
ID of the logical router downlink port.
ServiceBindings []LogicalRouterDownlinkPortServiceBindingArgs
A list of services for this port. Currently only "LogicalService" is supported as a target_type, and a DHCP relay service ID as target_id
Tags []LogicalRouterDownlinkPortTagArgs
A list of scope + tag pairs to associate with this port.
UrpfMode string
Unicast Reverse Path Forwarding mode. Accepted values are "NONE" and "STRICT" which is the default value.
ipAddress This property is required. String
Logical router port subnet (ip_address / prefix length)
linkedLogicalSwitchPortId This property is required. String
Identifier for port on logical switch to connect to
logicalRouterId This property is required. String
Identifier for logical Tier-1 router on which this port is created
description String
Description of the resource.
displayName String
Display name, defaults to ID if not set.
logicalRouterDownlinkPortId String
ID of the logical router downlink port.
serviceBindings List<LogicalRouterDownlinkPortServiceBinding>
A list of services for this port. Currently only "LogicalService" is supported as a target_type, and a DHCP relay service ID as target_id
tags List<LogicalRouterDownlinkPortTag>
A list of scope + tag pairs to associate with this port.
urpfMode String
Unicast Reverse Path Forwarding mode. Accepted values are "NONE" and "STRICT" which is the default value.
ipAddress This property is required. string
Logical router port subnet (ip_address / prefix length)
linkedLogicalSwitchPortId This property is required. string
Identifier for port on logical switch to connect to
logicalRouterId This property is required. string
Identifier for logical Tier-1 router on which this port is created
description string
Description of the resource.
displayName string
Display name, defaults to ID if not set.
logicalRouterDownlinkPortId string
ID of the logical router downlink port.
serviceBindings LogicalRouterDownlinkPortServiceBinding[]
A list of services for this port. Currently only "LogicalService" is supported as a target_type, and a DHCP relay service ID as target_id
tags LogicalRouterDownlinkPortTag[]
A list of scope + tag pairs to associate with this port.
urpfMode string
Unicast Reverse Path Forwarding mode. Accepted values are "NONE" and "STRICT" which is the default value.
ip_address This property is required. str
Logical router port subnet (ip_address / prefix length)
linked_logical_switch_port_id This property is required. str
Identifier for port on logical switch to connect to
logical_router_id This property is required. str
Identifier for logical Tier-1 router on which this port is created
description str
Description of the resource.
display_name str
Display name, defaults to ID if not set.
logical_router_downlink_port_id str
ID of the logical router downlink port.
service_bindings Sequence[LogicalRouterDownlinkPortServiceBindingArgs]
A list of services for this port. Currently only "LogicalService" is supported as a target_type, and a DHCP relay service ID as target_id
tags Sequence[LogicalRouterDownlinkPortTagArgs]
A list of scope + tag pairs to associate with this port.
urpf_mode str
Unicast Reverse Path Forwarding mode. Accepted values are "NONE" and "STRICT" which is the default value.
ipAddress This property is required. String
Logical router port subnet (ip_address / prefix length)
linkedLogicalSwitchPortId This property is required. String
Identifier for port on logical switch to connect to
logicalRouterId This property is required. String
Identifier for logical Tier-1 router on which this port is created
description String
Description of the resource.
displayName String
Display name, defaults to ID if not set.
logicalRouterDownlinkPortId String
ID of the logical router downlink port.
serviceBindings List<Property Map>
A list of services for this port. Currently only "LogicalService" is supported as a target_type, and a DHCP relay service ID as target_id
tags List<Property Map>
A list of scope + tag pairs to associate with this port.
urpfMode String
Unicast Reverse Path Forwarding mode. Accepted values are "NONE" and "STRICT" which is the default value.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
MacAddress string
The MAC address assigned to this port
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.
MacAddress string
The MAC address assigned to this port
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.
macAddress String
The MAC address assigned to this port
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.
macAddress string
The MAC address assigned to this port
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.
mac_address str
The MAC address assigned to this port
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.
macAddress String
The MAC address assigned to this port
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 LogicalRouterDownlinkPort Resource

Get an existing LogicalRouterDownlinkPort 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?: LogicalRouterDownlinkPortState, opts?: CustomResourceOptions): LogicalRouterDownlinkPort
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        ip_address: Optional[str] = None,
        linked_logical_switch_port_id: Optional[str] = None,
        logical_router_downlink_port_id: Optional[str] = None,
        logical_router_id: Optional[str] = None,
        mac_address: Optional[str] = None,
        revision: Optional[float] = None,
        service_bindings: Optional[Sequence[LogicalRouterDownlinkPortServiceBindingArgs]] = None,
        tags: Optional[Sequence[LogicalRouterDownlinkPortTagArgs]] = None,
        urpf_mode: Optional[str] = None) -> LogicalRouterDownlinkPort
func GetLogicalRouterDownlinkPort(ctx *Context, name string, id IDInput, state *LogicalRouterDownlinkPortState, opts ...ResourceOption) (*LogicalRouterDownlinkPort, error)
public static LogicalRouterDownlinkPort Get(string name, Input<string> id, LogicalRouterDownlinkPortState? state, CustomResourceOptions? opts = null)
public static LogicalRouterDownlinkPort get(String name, Output<String> id, LogicalRouterDownlinkPortState state, CustomResourceOptions options)
resources:  _:    type: nsxt:LogicalRouterDownlinkPort    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.
IpAddress string
Logical router port subnet (ip_address / prefix length)
LinkedLogicalSwitchPortId string
Identifier for port on logical switch to connect to
LogicalRouterDownlinkPortId string
ID of the logical router downlink port.
LogicalRouterId string
Identifier for logical Tier-1 router on which this port is created
MacAddress string
The MAC address assigned to this port
Revision double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
ServiceBindings List<LogicalRouterDownlinkPortServiceBinding>
A list of services for this port. Currently only "LogicalService" is supported as a target_type, and a DHCP relay service ID as target_id
Tags List<LogicalRouterDownlinkPortTag>
A list of scope + tag pairs to associate with this port.
UrpfMode string
Unicast Reverse Path Forwarding mode. Accepted values are "NONE" and "STRICT" which is the default value.
Description string
Description of the resource.
DisplayName string
Display name, defaults to ID if not set.
IpAddress string
Logical router port subnet (ip_address / prefix length)
LinkedLogicalSwitchPortId string
Identifier for port on logical switch to connect to
LogicalRouterDownlinkPortId string
ID of the logical router downlink port.
LogicalRouterId string
Identifier for logical Tier-1 router on which this port is created
MacAddress string
The MAC address assigned to this port
Revision float64
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
ServiceBindings []LogicalRouterDownlinkPortServiceBindingArgs
A list of services for this port. Currently only "LogicalService" is supported as a target_type, and a DHCP relay service ID as target_id
Tags []LogicalRouterDownlinkPortTagArgs
A list of scope + tag pairs to associate with this port.
UrpfMode string
Unicast Reverse Path Forwarding mode. Accepted values are "NONE" and "STRICT" which is the default value.
description String
Description of the resource.
displayName String
Display name, defaults to ID if not set.
ipAddress String
Logical router port subnet (ip_address / prefix length)
linkedLogicalSwitchPortId String
Identifier for port on logical switch to connect to
logicalRouterDownlinkPortId String
ID of the logical router downlink port.
logicalRouterId String
Identifier for logical Tier-1 router on which this port is created
macAddress String
The MAC address assigned to this port
revision Double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
serviceBindings List<LogicalRouterDownlinkPortServiceBinding>
A list of services for this port. Currently only "LogicalService" is supported as a target_type, and a DHCP relay service ID as target_id
tags List<LogicalRouterDownlinkPortTag>
A list of scope + tag pairs to associate with this port.
urpfMode String
Unicast Reverse Path Forwarding mode. Accepted values are "NONE" and "STRICT" which is the default value.
description string
Description of the resource.
displayName string
Display name, defaults to ID if not set.
ipAddress string
Logical router port subnet (ip_address / prefix length)
linkedLogicalSwitchPortId string
Identifier for port on logical switch to connect to
logicalRouterDownlinkPortId string
ID of the logical router downlink port.
logicalRouterId string
Identifier for logical Tier-1 router on which this port is created
macAddress string
The MAC address assigned to this port
revision number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
serviceBindings LogicalRouterDownlinkPortServiceBinding[]
A list of services for this port. Currently only "LogicalService" is supported as a target_type, and a DHCP relay service ID as target_id
tags LogicalRouterDownlinkPortTag[]
A list of scope + tag pairs to associate with this port.
urpfMode string
Unicast Reverse Path Forwarding mode. Accepted values are "NONE" and "STRICT" which is the default value.
description str
Description of the resource.
display_name str
Display name, defaults to ID if not set.
ip_address str
Logical router port subnet (ip_address / prefix length)
linked_logical_switch_port_id str
Identifier for port on logical switch to connect to
logical_router_downlink_port_id str
ID of the logical router downlink port.
logical_router_id str
Identifier for logical Tier-1 router on which this port is created
mac_address str
The MAC address assigned to this port
revision float
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
service_bindings Sequence[LogicalRouterDownlinkPortServiceBindingArgs]
A list of services for this port. Currently only "LogicalService" is supported as a target_type, and a DHCP relay service ID as target_id
tags Sequence[LogicalRouterDownlinkPortTagArgs]
A list of scope + tag pairs to associate with this port.
urpf_mode str
Unicast Reverse Path Forwarding mode. Accepted values are "NONE" and "STRICT" which is the default value.
description String
Description of the resource.
displayName String
Display name, defaults to ID if not set.
ipAddress String
Logical router port subnet (ip_address / prefix length)
linkedLogicalSwitchPortId String
Identifier for port on logical switch to connect to
logicalRouterDownlinkPortId String
ID of the logical router downlink port.
logicalRouterId String
Identifier for logical Tier-1 router on which this port is created
macAddress String
The MAC address assigned to this port
revision Number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
serviceBindings List<Property Map>
A list of services for this port. Currently only "LogicalService" is supported as a target_type, and a DHCP relay service ID as target_id
tags List<Property Map>
A list of scope + tag pairs to associate with this port.
urpfMode String
Unicast Reverse Path Forwarding mode. Accepted values are "NONE" and "STRICT" which is the default value.

Supporting Types

LogicalRouterDownlinkPortServiceBinding
, LogicalRouterDownlinkPortServiceBindingArgs

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

LogicalRouterDownlinkPortTag
, LogicalRouterDownlinkPortTagArgs

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

Package Details

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