vnic

vnic
vnic

NSX Edge vnic configuration details.

JSON Example
{
    "subInterfaces": {
        "subInterfaces": [
            {
                "index": 0,
                "tunnelId": 0,
                "name": "string",
                "addressGroups": {
                    "addressGroups": [
                        {
                            "subnetPrefixLength": "string",
                            "secondaryAddresses": {
                                "type": "string",
                                "ipAddress": [
                                    "string"
                                ]
                            },
                            "primaryAddress": "string",
                            "subnetMask": "string"
                        }
                    ]
                },
                "vlanId": 0,
                "label": "string",
                "logicalSwitchName": "string",
                "isConnected": false,
                "mtu": 0,
                "logicalSwitchId": "string",
                "enableSendRedirects": false
            }
        ]
    },
    "addressGroups": {
        "addressGroups": [
            {
                "subnetPrefixLength": "string",
                "secondaryAddresses": {
                    "type": "string",
                    "ipAddress": [
                        "string"
                    ]
                },
                "primaryAddress": "string",
                "subnetMask": "string"
            }
        ]
    },
    "isConnected": false,
    "enableSendRedirects": false,
    "inShapingPolicy": {
        "burstSize": 0,
        "averageBandwidth": 0,
        "peakBandwidth": 0,
        "enabled": false,
        "inherited": false
    },
    "label": "string",
    "enableProxyArp": false,
    "index": 0,
    "name": "string",
    "mtu": 0,
    "fenceParameters": [
        {
            "value": "string",
            "key": "string"
        }
    ],
    "macAddresses": [
        {
            "edgeVmHaIndex": 0,
            "value": "string"
        }
    ],
    "outShapingPolicy": {
        "burstSize": 0,
        "averageBandwidth": 0,
        "peakBandwidth": 0,
        "enabled": false,
        "inherited": false
    },
    "portgroupName": "string",
    "enableBridgeMode": false,
    "type": "string",
    "portgroupId": "string"
}
subInterfaces
Optional

subInterfaces

addressGroups
Optional

NSX Edge vnic address group configuration details.

boolean
isConnected
Optional

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

boolean
enableSendRedirects
Optional

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

inShapingPolicy
Optional

inShapingPolicy

string
label
Optional

Interface label of format vNic_{vnicIndex} provided by NSX Manager. Read only.

boolean
enableProxyArp
Optional

Value is true if proxy arp is enabled. Enable proxy ARP if you want to allow the NSX Edge of type 'gatewayServices' to answer ARP requests intended for other machines.

integer As int32 As int32
index
Required

Index of the vnic. Min value is 0 and max value is 9.

string
name
Optional

Name of the interface. Optional.

integer As int32 As int32
mtu
Optional

MTU of the interface, with default as 1500. Min is 68, Max is 9000. Optional.

fenceParameters
Optional

fenceParameters

array of MacAddress
macAddresses
Optional

Distinct MAC addresses configured for the vnic. Optional.

outShapingPolicy
Optional

outShapingPolicy

string
portgroupName
Optional

Name of the port group or logical switch.

boolean
enableBridgeMode
Optional

Value is true if bridge mode is enabled.

string
type
Optional

Type of the vnic. Values are uplink, internal, trunk. At least one internal interface must be configured for NSX Edge HA to work.

string
portgroupId
Optional

Value are port group ID (standard portgroup or distributed portgroup) or virtual wire ID (logical switch). Logical switch cannot be used for a TRUNK vnic. Portgroup cannot be shared among vnics/LIFs. Required when isConnected is specified as true. Example 'network-17' (standard portgroup), 'dvportgroup-34' (distributed portgroup) or 'virtualwire-2' (logical switch).