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

nsxt.LogicalSwitch

Explore with Pulumi AI

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

    Create LogicalSwitch Resource

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

    Constructor syntax

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

@overload
def LogicalSwitch(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  transport_zone_id: Optional[str] = None,
                  mac_pool_id: Optional[str] = None,
                  description: Optional[str] = None,
                  display_name: Optional[str] = None,
                  ip_pool_id: Optional[str] = None,
                  logical_switch_id: Optional[str] = None,
                  address_bindings: Optional[Sequence[LogicalSwitchAddressBindingArgs]] = None,
                  replication_mode: Optional[str] = None,
                  switching_profile_ids: Optional[Sequence[LogicalSwitchSwitchingProfileIdArgs]] = None,
                  tags: Optional[Sequence[LogicalSwitchTagArgs]] = None,
                  admin_state: Optional[str] = None,
                  vlan: Optional[float] = None,
                  vni: Optional[float] = None)
    func NewLogicalSwitch(ctx *Context, name string, args LogicalSwitchArgs, opts ...ResourceOption) (*LogicalSwitch, error)
    public LogicalSwitch(string name, LogicalSwitchArgs args, CustomResourceOptions? opts = null)
    public LogicalSwitch(String name, LogicalSwitchArgs args)
public LogicalSwitch(String name, LogicalSwitchArgs args, CustomResourceOptions options)

    type: nsxt:LogicalSwitch
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 LogicalSwitchArgs
    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 LogicalSwitchArgs
    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 LogicalSwitchArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LogicalSwitchArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LogicalSwitchArgs
    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 logicalSwitchResource = new Nsxt.LogicalSwitch("logicalSwitchResource", new()
{
    TransportZoneId = "string",
    MacPoolId = "string",
    Description = "string",
    DisplayName = "string",
    IpPoolId = "string",
    LogicalSwitchId = "string",
    AddressBindings = new[]
    {
        new Nsxt.Inputs.LogicalSwitchAddressBindingArgs
        {
            IpAddress = "string",
            MacAddress = "string",
            Vlan = 0,
        },
    },
    ReplicationMode = "string",
    SwitchingProfileIds = new[]
    {
        new Nsxt.Inputs.LogicalSwitchSwitchingProfileIdArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    Tags = new[]
    {
        new Nsxt.Inputs.LogicalSwitchTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
    AdminState = "string",
    Vni = 0,
});

    example, err := nsxt.NewLogicalSwitch(ctx, "logicalSwitchResource", &nsxt.LogicalSwitchArgs{
	TransportZoneId: pulumi.String("string"),
	MacPoolId:       pulumi.String("string"),
	Description:     pulumi.String("string"),
	DisplayName:     pulumi.String("string"),
	IpPoolId:        pulumi.String("string"),
	LogicalSwitchId: pulumi.String("string"),
	AddressBindings: nsxt.LogicalSwitchAddressBindingArray{
		&nsxt.LogicalSwitchAddressBindingArgs{
			IpAddress:  pulumi.String("string"),
			MacAddress: pulumi.String("string"),
			Vlan:       pulumi.Float64(0),
		},
	},
	ReplicationMode: pulumi.String("string"),
	SwitchingProfileIds: nsxt.LogicalSwitchSwitchingProfileIdArray{
		&nsxt.LogicalSwitchSwitchingProfileIdArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	Tags: nsxt.LogicalSwitchTagArray{
		&nsxt.LogicalSwitchTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
	AdminState: pulumi.String("string"),
	Vni:        pulumi.Float64(0),
})

    var logicalSwitchResource = new LogicalSwitch("logicalSwitchResource", LogicalSwitchArgs.builder()
    .transportZoneId("string")
    .macPoolId("string")
    .description("string")
    .displayName("string")
    .ipPoolId("string")
    .logicalSwitchId("string")
    .addressBindings(LogicalSwitchAddressBindingArgs.builder()
        .ipAddress("string")
        .macAddress("string")
        .vlan(0)
        .build())
    .replicationMode("string")
    .switchingProfileIds(LogicalSwitchSwitchingProfileIdArgs.builder()
        .key("string")
        .value("string")
        .build())
    .tags(LogicalSwitchTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .adminState("string")
    .vni(0)
    .build());

    logical_switch_resource = nsxt.LogicalSwitch("logicalSwitchResource",
    transport_zone_id="string",
    mac_pool_id="string",
    description="string",
    display_name="string",
    ip_pool_id="string",
    logical_switch_id="string",
    address_bindings=[{
        "ip_address": "string",
        "mac_address": "string",
        "vlan": 0,
    }],
    replication_mode="string",
    switching_profile_ids=[{
        "key": "string",
        "value": "string",
    }],
    tags=[{
        "scope": "string",
        "tag": "string",
    }],
    admin_state="string",
    vni=0)

    const logicalSwitchResource = new nsxt.LogicalSwitch("logicalSwitchResource", {
    transportZoneId: "string",
    macPoolId: "string",
    description: "string",
    displayName: "string",
    ipPoolId: "string",
    logicalSwitchId: "string",
    addressBindings: [{
        ipAddress: "string",
        macAddress: "string",
        vlan: 0,
    }],
    replicationMode: "string",
    switchingProfileIds: [{
        key: "string",
        value: "string",
    }],
    tags: [{
        scope: "string",
        tag: "string",
    }],
    adminState: "string",
    vni: 0,
});

    type: nsxt:LogicalSwitch
properties:
    addressBindings:
        - ipAddress: string
          macAddress: string
          vlan: 0
    adminState: string
    description: string
    displayName: string
    ipPoolId: string
    logicalSwitchId: string
    macPoolId: string
    replicationMode: string
    switchingProfileIds:
        - key: string
          value: string
    tags:
        - scope: string
          tag: string
    transportZoneId: string
    vni: 0

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

    TransportZoneId string
    Transport Zone ID for the logical switch.
    AddressBindings List<LogicalSwitchAddressBinding>
    List of Address Bindings for the logical switch. This setting allows to provide bindings between IP address, mac Address and vlan.
    AdminState string
    Admin state for the logical switch. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    Description string
    Description of the resource.
    DisplayName string
    Display name, defaults to ID if not set.
    IpPoolId string
    Ip Pool ID to be associated with the logical switch.
    LogicalSwitchId string
    ID of the logical switch.
    MacPoolId string
    Mac Pool ID to be associated with the logical switch.
    ReplicationMode string
    Replication mode of the Logical Switch. Accepted values - 'MTEP' (Hierarchical Two-Tier replication) and 'SOURCE' (Head Replication), with 'MTEP' being the default value. Applies to overlay logical switches.
    SwitchingProfileIds List<LogicalSwitchSwitchingProfileId>
    List of IDs of switching profiles (of various types) to be associated with this switch. Default switching profiles will be used if not specified.
    Tags List<LogicalSwitchTag>
    A list of scope + tag pairs to associate with this logical switch.
    Vlan double
    Vlan for vlan logical switch. This attribute is deprecated, please use nsxt.VlanLogicalSwitch resource to manage vlan logical switches.

    Deprecated: Deprecated

    Vni double
    Vni for the logical switch.
    TransportZoneId string
    Transport Zone ID for the logical switch.
    AddressBindings []LogicalSwitchAddressBindingArgs
    List of Address Bindings for the logical switch. This setting allows to provide bindings between IP address, mac Address and vlan.
    AdminState string
    Admin state for the logical switch. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    Description string
    Description of the resource.
    DisplayName string
    Display name, defaults to ID if not set.
    IpPoolId string
    Ip Pool ID to be associated with the logical switch.
    LogicalSwitchId string
    ID of the logical switch.
    MacPoolId string
    Mac Pool ID to be associated with the logical switch.
    ReplicationMode string
    Replication mode of the Logical Switch. Accepted values - 'MTEP' (Hierarchical Two-Tier replication) and 'SOURCE' (Head Replication), with 'MTEP' being the default value. Applies to overlay logical switches.
    SwitchingProfileIds []LogicalSwitchSwitchingProfileIdArgs
    List of IDs of switching profiles (of various types) to be associated with this switch. Default switching profiles will be used if not specified.
    Tags []LogicalSwitchTagArgs
    A list of scope + tag pairs to associate with this logical switch.
    Vlan float64
    Vlan for vlan logical switch. This attribute is deprecated, please use nsxt.VlanLogicalSwitch resource to manage vlan logical switches.

    Deprecated: Deprecated

    Vni float64
    Vni for the logical switch.
    transportZoneId String
    Transport Zone ID for the logical switch.
    addressBindings List<LogicalSwitchAddressBinding>
    List of Address Bindings for the logical switch. This setting allows to provide bindings between IP address, mac Address and vlan.
    adminState String
    Admin state for the logical switch. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    description String
    Description of the resource.
    displayName String
    Display name, defaults to ID if not set.
    ipPoolId String
    Ip Pool ID to be associated with the logical switch.
    logicalSwitchId String
    ID of the logical switch.
    macPoolId String
    Mac Pool ID to be associated with the logical switch.
    replicationMode String
    Replication mode of the Logical Switch. Accepted values - 'MTEP' (Hierarchical Two-Tier replication) and 'SOURCE' (Head Replication), with 'MTEP' being the default value. Applies to overlay logical switches.
    switchingProfileIds List<LogicalSwitchSwitchingProfileId>
    List of IDs of switching profiles (of various types) to be associated with this switch. Default switching profiles will be used if not specified.
    tags List<LogicalSwitchTag>
    A list of scope + tag pairs to associate with this logical switch.
    vlan Double
    Vlan for vlan logical switch. This attribute is deprecated, please use nsxt.VlanLogicalSwitch resource to manage vlan logical switches.

    Deprecated: Deprecated

    vni Double
    Vni for the logical switch.
    transportZoneId string
    Transport Zone ID for the logical switch.
    addressBindings LogicalSwitchAddressBinding[]
    List of Address Bindings for the logical switch. This setting allows to provide bindings between IP address, mac Address and vlan.
    adminState string
    Admin state for the logical switch. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    description string
    Description of the resource.
    displayName string
    Display name, defaults to ID if not set.
    ipPoolId string
    Ip Pool ID to be associated with the logical switch.
    logicalSwitchId string
    ID of the logical switch.
    macPoolId string
    Mac Pool ID to be associated with the logical switch.
    replicationMode string
    Replication mode of the Logical Switch. Accepted values - 'MTEP' (Hierarchical Two-Tier replication) and 'SOURCE' (Head Replication), with 'MTEP' being the default value. Applies to overlay logical switches.
    switchingProfileIds LogicalSwitchSwitchingProfileId[]
    List of IDs of switching profiles (of various types) to be associated with this switch. Default switching profiles will be used if not specified.
    tags LogicalSwitchTag[]
    A list of scope + tag pairs to associate with this logical switch.
    vlan number
    Vlan for vlan logical switch. This attribute is deprecated, please use nsxt.VlanLogicalSwitch resource to manage vlan logical switches.

    Deprecated: Deprecated

    vni number
    Vni for the logical switch.
    transport_zone_id str
    Transport Zone ID for the logical switch.
    address_bindings Sequence[LogicalSwitchAddressBindingArgs]
    List of Address Bindings for the logical switch. This setting allows to provide bindings between IP address, mac Address and vlan.
    admin_state str
    Admin state for the logical switch. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    description str
    Description of the resource.
    display_name str
    Display name, defaults to ID if not set.
    ip_pool_id str
    Ip Pool ID to be associated with the logical switch.
    logical_switch_id str
    ID of the logical switch.
    mac_pool_id str
    Mac Pool ID to be associated with the logical switch.
    replication_mode str
    Replication mode of the Logical Switch. Accepted values - 'MTEP' (Hierarchical Two-Tier replication) and 'SOURCE' (Head Replication), with 'MTEP' being the default value. Applies to overlay logical switches.
    switching_profile_ids Sequence[LogicalSwitchSwitchingProfileIdArgs]
    List of IDs of switching profiles (of various types) to be associated with this switch. Default switching profiles will be used if not specified.
    tags Sequence[LogicalSwitchTagArgs]
    A list of scope + tag pairs to associate with this logical switch.
    vlan float
    Vlan for vlan logical switch. This attribute is deprecated, please use nsxt.VlanLogicalSwitch resource to manage vlan logical switches.

    Deprecated: Deprecated

    vni float
    Vni for the logical switch.
    transportZoneId String
    Transport Zone ID for the logical switch.
    addressBindings List<Property Map>
    List of Address Bindings for the logical switch. This setting allows to provide bindings between IP address, mac Address and vlan.
    adminState String
    Admin state for the logical switch. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    description String
    Description of the resource.
    displayName String
    Display name, defaults to ID if not set.
    ipPoolId String
    Ip Pool ID to be associated with the logical switch.
    logicalSwitchId String
    ID of the logical switch.
    macPoolId String
    Mac Pool ID to be associated with the logical switch.
    replicationMode String
    Replication mode of the Logical Switch. Accepted values - 'MTEP' (Hierarchical Two-Tier replication) and 'SOURCE' (Head Replication), with 'MTEP' being the default value. Applies to overlay logical switches.
    switchingProfileIds List<Property Map>
    List of IDs of switching profiles (of various types) to be associated with this switch. Default switching profiles will be used if not specified.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this logical switch.
    vlan Number
    Vlan for vlan logical switch. This attribute is deprecated, please use nsxt.VlanLogicalSwitch resource to manage vlan logical switches.

    Deprecated: Deprecated

    vni Number
    Vni for the logical switch.

    Outputs

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

    Get an existing LogicalSwitch 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?: LogicalSwitchState, opts?: CustomResourceOptions): LogicalSwitch
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address_bindings: Optional[Sequence[LogicalSwitchAddressBindingArgs]] = None,
        admin_state: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        ip_pool_id: Optional[str] = None,
        logical_switch_id: Optional[str] = None,
        mac_pool_id: Optional[str] = None,
        replication_mode: Optional[str] = None,
        revision: Optional[float] = None,
        switching_profile_ids: Optional[Sequence[LogicalSwitchSwitchingProfileIdArgs]] = None,
        tags: Optional[Sequence[LogicalSwitchTagArgs]] = None,
        transport_zone_id: Optional[str] = None,
        vlan: Optional[float] = None,
        vni: Optional[float] = None) -> LogicalSwitch
    func GetLogicalSwitch(ctx *Context, name string, id IDInput, state *LogicalSwitchState, opts ...ResourceOption) (*LogicalSwitch, error)
    public static LogicalSwitch Get(string name, Input<string> id, LogicalSwitchState? state, CustomResourceOptions? opts = null)
    public static LogicalSwitch get(String name, Output<String> id, LogicalSwitchState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:LogicalSwitch    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:
    AddressBindings List<LogicalSwitchAddressBinding>
    List of Address Bindings for the logical switch. This setting allows to provide bindings between IP address, mac Address and vlan.
    AdminState string
    Admin state for the logical switch. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    Description string
    Description of the resource.
    DisplayName string
    Display name, defaults to ID if not set.
    IpPoolId string
    Ip Pool ID to be associated with the logical switch.
    LogicalSwitchId string
    ID of the logical switch.
    MacPoolId string
    Mac Pool ID to be associated with the logical switch.
    ReplicationMode string
    Replication mode of the Logical Switch. Accepted values - 'MTEP' (Hierarchical Two-Tier replication) and 'SOURCE' (Head Replication), with 'MTEP' being the default value. Applies to overlay logical switches.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    SwitchingProfileIds List<LogicalSwitchSwitchingProfileId>
    List of IDs of switching profiles (of various types) to be associated with this switch. Default switching profiles will be used if not specified.
    Tags List<LogicalSwitchTag>
    A list of scope + tag pairs to associate with this logical switch.
    TransportZoneId string
    Transport Zone ID for the logical switch.
    Vlan double
    Vlan for vlan logical switch. This attribute is deprecated, please use nsxt.VlanLogicalSwitch resource to manage vlan logical switches.

    Deprecated: Deprecated

    Vni double
    Vni for the logical switch.
    AddressBindings []LogicalSwitchAddressBindingArgs
    List of Address Bindings for the logical switch. This setting allows to provide bindings between IP address, mac Address and vlan.
    AdminState string
    Admin state for the logical switch. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    Description string
    Description of the resource.
    DisplayName string
    Display name, defaults to ID if not set.
    IpPoolId string
    Ip Pool ID to be associated with the logical switch.
    LogicalSwitchId string
    ID of the logical switch.
    MacPoolId string
    Mac Pool ID to be associated with the logical switch.
    ReplicationMode string
    Replication mode of the Logical Switch. Accepted values - 'MTEP' (Hierarchical Two-Tier replication) and 'SOURCE' (Head Replication), with 'MTEP' being the default value. Applies to overlay logical switches.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    SwitchingProfileIds []LogicalSwitchSwitchingProfileIdArgs
    List of IDs of switching profiles (of various types) to be associated with this switch. Default switching profiles will be used if not specified.
    Tags []LogicalSwitchTagArgs
    A list of scope + tag pairs to associate with this logical switch.
    TransportZoneId string
    Transport Zone ID for the logical switch.
    Vlan float64
    Vlan for vlan logical switch. This attribute is deprecated, please use nsxt.VlanLogicalSwitch resource to manage vlan logical switches.

    Deprecated: Deprecated

    Vni float64
    Vni for the logical switch.
    addressBindings List<LogicalSwitchAddressBinding>
    List of Address Bindings for the logical switch. This setting allows to provide bindings between IP address, mac Address and vlan.
    adminState String
    Admin state for the logical switch. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    description String
    Description of the resource.
    displayName String
    Display name, defaults to ID if not set.
    ipPoolId String
    Ip Pool ID to be associated with the logical switch.
    logicalSwitchId String
    ID of the logical switch.
    macPoolId String
    Mac Pool ID to be associated with the logical switch.
    replicationMode String
    Replication mode of the Logical Switch. Accepted values - 'MTEP' (Hierarchical Two-Tier replication) and 'SOURCE' (Head Replication), with 'MTEP' being the default value. Applies to overlay logical switches.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    switchingProfileIds List<LogicalSwitchSwitchingProfileId>
    List of IDs of switching profiles (of various types) to be associated with this switch. Default switching profiles will be used if not specified.
    tags List<LogicalSwitchTag>
    A list of scope + tag pairs to associate with this logical switch.
    transportZoneId String
    Transport Zone ID for the logical switch.
    vlan Double
    Vlan for vlan logical switch. This attribute is deprecated, please use nsxt.VlanLogicalSwitch resource to manage vlan logical switches.

    Deprecated: Deprecated

    vni Double
    Vni for the logical switch.
    addressBindings LogicalSwitchAddressBinding[]
    List of Address Bindings for the logical switch. This setting allows to provide bindings between IP address, mac Address and vlan.
    adminState string
    Admin state for the logical switch. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    description string
    Description of the resource.
    displayName string
    Display name, defaults to ID if not set.
    ipPoolId string
    Ip Pool ID to be associated with the logical switch.
    logicalSwitchId string
    ID of the logical switch.
    macPoolId string
    Mac Pool ID to be associated with the logical switch.
    replicationMode string
    Replication mode of the Logical Switch. Accepted values - 'MTEP' (Hierarchical Two-Tier replication) and 'SOURCE' (Head Replication), with 'MTEP' being the default value. Applies to overlay logical switches.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    switchingProfileIds LogicalSwitchSwitchingProfileId[]
    List of IDs of switching profiles (of various types) to be associated with this switch. Default switching profiles will be used if not specified.
    tags LogicalSwitchTag[]
    A list of scope + tag pairs to associate with this logical switch.
    transportZoneId string
    Transport Zone ID for the logical switch.
    vlan number
    Vlan for vlan logical switch. This attribute is deprecated, please use nsxt.VlanLogicalSwitch resource to manage vlan logical switches.

    Deprecated: Deprecated

    vni number
    Vni for the logical switch.
    address_bindings Sequence[LogicalSwitchAddressBindingArgs]
    List of Address Bindings for the logical switch. This setting allows to provide bindings between IP address, mac Address and vlan.
    admin_state str
    Admin state for the logical switch. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    description str
    Description of the resource.
    display_name str
    Display name, defaults to ID if not set.
    ip_pool_id str
    Ip Pool ID to be associated with the logical switch.
    logical_switch_id str
    ID of the logical switch.
    mac_pool_id str
    Mac Pool ID to be associated with the logical switch.
    replication_mode str
    Replication mode of the Logical Switch. Accepted values - 'MTEP' (Hierarchical Two-Tier replication) and 'SOURCE' (Head Replication), with 'MTEP' being the default value. Applies to overlay logical switches.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    switching_profile_ids Sequence[LogicalSwitchSwitchingProfileIdArgs]
    List of IDs of switching profiles (of various types) to be associated with this switch. Default switching profiles will be used if not specified.
    tags Sequence[LogicalSwitchTagArgs]
    A list of scope + tag pairs to associate with this logical switch.
    transport_zone_id str
    Transport Zone ID for the logical switch.
    vlan float
    Vlan for vlan logical switch. This attribute is deprecated, please use nsxt.VlanLogicalSwitch resource to manage vlan logical switches.

    Deprecated: Deprecated

    vni float
    Vni for the logical switch.
    addressBindings List<Property Map>
    List of Address Bindings for the logical switch. This setting allows to provide bindings between IP address, mac Address and vlan.
    adminState String
    Admin state for the logical switch. Accepted values - 'UP' or 'DOWN'. The default value is 'UP'.
    description String
    Description of the resource.
    displayName String
    Display name, defaults to ID if not set.
    ipPoolId String
    Ip Pool ID to be associated with the logical switch.
    logicalSwitchId String
    ID of the logical switch.
    macPoolId String
    Mac Pool ID to be associated with the logical switch.
    replicationMode String
    Replication mode of the Logical Switch. Accepted values - 'MTEP' (Hierarchical Two-Tier replication) and 'SOURCE' (Head Replication), with 'MTEP' being the default value. Applies to overlay logical switches.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    switchingProfileIds List<Property Map>
    List of IDs of switching profiles (of various types) to be associated with this switch. Default switching profiles will be used if not specified.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this logical switch.
    transportZoneId String
    Transport Zone ID for the logical switch.
    vlan Number
    Vlan for vlan logical switch. This attribute is deprecated, please use nsxt.VlanLogicalSwitch resource to manage vlan logical switches.

    Deprecated: Deprecated

    vni Number
    Vni for the logical switch.

    Supporting Types

    LogicalSwitchAddressBinding, LogicalSwitchAddressBindingArgs

    IpAddress string
    IP Address
    MacAddress string
    MAC Address
    Vlan double
    Vlan
    IpAddress string
    IP Address
    MacAddress string
    MAC Address
    Vlan float64
    Vlan
    ipAddress String
    IP Address
    macAddress String
    MAC Address
    vlan Double
    Vlan
    ipAddress string
    IP Address
    macAddress string
    MAC Address
    vlan number
    Vlan
    ip_address str
    IP Address
    mac_address str
    MAC Address
    vlan float
    Vlan
    ipAddress String
    IP Address
    macAddress String
    MAC Address
    vlan Number
    Vlan

    LogicalSwitchSwitchingProfileId, LogicalSwitchSwitchingProfileIdArgs

    Key string
    The resource type of this profile
    Value string
    The ID of this profile
    Key string
    The resource type of this profile
    Value string
    The ID of this profile
    key String
    The resource type of this profile
    value String
    The ID of this profile
    key string
    The resource type of this profile
    value string
    The ID of this profile
    key str
    The resource type of this profile
    value str
    The ID of this profile
    key String
    The resource type of this profile
    value String
    The ID of this profile

    LogicalSwitchTag, LogicalSwitchTagArgs

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

    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