subInterface

subInterface
subInterface

NSX Edge sub interface configuration details. Sub interfaces are created on a trunk interface.

JSON Example
{
    "logicalSwitchId": "string",
    "addressGroups": {
        "addressGroups": [
            {
                "subnetPrefixLength": "string",
                "secondaryAddresses": {
                    "ipAddress": [
                        "string"
                    ],
                    "type": "string"
                },
                "primaryAddress": "string",
                "subnetMask": "string"
            }
        ]
    },
    "logicalSwitchName": "string",
    "vlanId": 0,
    "tunnelId": 0,
    "isConnected": false,
    "name": "string",
    "index": 0,
    "enableSendRedirects": false,
    "label": "string",
    "mtu": 0
}
string
logicalSwitchId
Optional

ID of the logical switch connected to this sub interface.

addressGroups
Optional

addressGroups

string
logicalSwitchName
Optional

Name of the logical switch connected to this sub interface.

integer As int32 As int32
vlanId
Optional

VLAN ID of the virtual LAN used by this sub interface. VLAN IDs can range from 0 to 4094.

integer As int32 As int32
tunnelId
Required

Valid values for tunnel ID are min 1 to max 4093. Required.

boolean
isConnected
Optional

Value is true if the sub interface is connected to a logical switch, standard portgroup or distributed portgroup.

string
name
Optional

Name of the sub interface. Required.

integer As int32 As int32
index
Optional

Index of the sub interface assigned by NSX Manager. Min value is 10 and max value is 4103.

boolean
enableSendRedirects
Optional

Value is true if send redirects is enabled. Enable ICMP redirect to convey routing information to hosts.

string
label
Optional

Sub interface label of format vNic_{index} provided by NSX Manager. Read only.

integer As int32 As int32
mtu
Optional

MTU value of the sub interface. This value would be the least mtu for all the trunk interfaces of the NSX Edge. Default is 1500.

Property Of