InlineLogicalSwitch1

InlineLogicalSwitch1
InlineLogicalSwitch1
JSON Example
{
    "admin_state": "string",
    "extra_configs": [
        {
            "config_pair": {
                "key": "string",
                "value": "string"
            }
        }
    ],
    "global_vni": 0,
    "hybrid": false,
    "ip_pool_id": "string",
    "mac_pool_id": "string",
    "node_local_switch": false,
    "origin_id": "string",
    "origin_type": "string",
    "replication_mode": "string",
    "span": [
        "string"
    ],
    "switch_type": "string",
    "switching_profile_ids": [
        "SwitchingProfileTypeIdEntry Object"
    ],
    "transport_zone_id": "string",
    "uplink_teaming_policy_name": "string",
    "vlan": 0,
    "vlan_trunk_spec": "VlanTrunkSpec Object",
    "vni": 0
}
string
admin_state
Required

Represents Desired state of the Logical Switch

Possible values are : UP, DOWN,
array of ExtraConfig
extra_configs
Optional

This property could be used for vendor specific configuration in key value string pairs, the setting in extra_configs will be automatically inheritted by logical ports in the logical switch.

integer As int32 As int32
global_vni
Optional

The VNI is used for intersite traffic and the global logical switch ID. The global VNI pool is agnostic of the local VNI pool, and there is no need to have an exclusive VNI range. For example, VNI x can be the global VNI for logical switch B and the local VNI for logical switch A.

boolean
hybrid
Optional

If this flag is set to true, then all the logical switch ports attached to this logical switch will behave in a hybrid fashion. The hybrid logical switch port indicates to NSX that the VM intends to operate in underlay mode, but retains the ability to forward egress traffic to the NSX overlay network. This flag can be enabled only for the logical switches in the overlay type transport zone which has host switch mode as LEGACY and also has either CrossCloud or CloudScope tag scopes. Only the NSX public cloud gateway (PCG) uses this flag, other host agents like ESX, KVM and Edge will ignore it. This property cannot be modified once the logical switch is created.

string
ip_pool_id
Optional

IP pool id that associated with a LogicalSwitch.

string
mac_pool_id
Optional

Mac pool id that associated with a LogicalSwitch.

boolean
node_local_switch
Optional

A flag to prevent BUM (broadcast, unknown-unicast and multicast) traffic from reaching the other spanned edges.

string
origin_id
Optional

ID populated by NSX when NSX on DVPG is used to indicate the source DVPG.

string
origin_type
Optional

The type of source from which the DVPG is discovered

string
replication_mode
Optional

Replication mode of the Logical Switch

Possible values are : MTEP, SOURCE,
array of string
span
Optional
Constraints: minItems: 0 maxItems: 16

Each manager ID represents the NSX Local Manager the logical switch connects. This will be populated by the manager.

string
switch_type
Optional

This field indicates purpose of a LogicalSwitch. It is set by manager internally or user can provide this field. If not set, DEFAULT type is assigned. NSX components can use this field to create LogicalSwitch that provides component specific functionality. DEFAULT type LogicalSwitches are created for basic L2 connectivity by API users. SERVICE_PLANE type LogicalSwitches are system created service plane LogicalSwitches for Service Insertion service. User can not create SERVICE_PLANE type of LogicalSwitch. DHCP_RELAY type LogicalSwitches are created by external user like Policy with special permissions or by system and will be treated as internal LogicalSwitches. Such LogicalSwitch will not be exposed to vSphere user. GLOBAL type LogicalSwitches are created to span multiple NSX domains to connect multiple remote sites. INTER_ROUTER type LogicalSwitches are policy-created LogicalSwitches which provide inter-router connectivity. DVPG type LogicalSwitches are NSX-created based on DVPGs found in VC which are used as shadow objects in NSX on DVPG.

Possible values are : DEFAULT, SERVICE_PLANE, DHCP_RELAY, GLOBAL, INTER_ROUTER, EVPN, DVPG,
switching_profile_ids
Optional

switching_profile_ids

string
transport_zone_id
Required

Id of the TransportZone to which this LogicalSwitch is associated

string
uplink_teaming_policy_name
Optional

This name has to be one of the switching uplink teaming policy names listed inside the logical switch's TransportZone. If this field is not specified, the logical switch will not have a teaming policy associated with it and the host switch's default teaming policy will be used.

integer As int64 As int64
vlan
Optional

This property is dedicated to VLAN based network, to set VLAN of logical network. It is mutually exclusive with 'vlan_trunk_spec'.

vlan_trunk_spec
Optional

VlanTrunkspec is used for specifying trunk VLAN id ranges.

integer As int32 As int32
vni
Optional

Only for OVERLAY network. A VNI will be auto-allocated from the default VNI pool if not given; otherwise the given VNI has to be inside the default pool and not used by any other LogicalSwitch.