HostVirtualNicSpec

The HostVirtualNicSpec data object describes the HostVirtualNic configuration containing both the configured properties on a virtual NIC and identification information.

AllOf

This class requires all of the following:

DataObject

JSON Example

{
    "_typeName": "string",
    "dynamicProperty": [
        {
            "_typeName": "string",
            "name": "string",
            "val": {
                "_typeName": "string"
            }
        }
    ],
    "ip": {
        "_typeName": "string",
        "dhcp": false,
        "ipAddress": "string",
        "subnetMask": "string",
        "ipV6Config": {
            "_typeName": "string",
            "ipV6Address": [
                {
                    "_typeName": "string",
                    "ipAddress": "string",
                    "prefixLength": 0,
                    "origin": "string",
                    "dadState": "string",
                    "lifetime": "string",
                    "operation": "string"
                }
            ],
            "autoConfigurationEnabled": false,
            "dhcpV6Enabled": false
        }
    },
    "mac": "string",
    "distributedVirtualPort": {
        "_typeName": "string",
        "switchUuid": "string",
        "portgroupKey": "string",
        "portKey": "string",
        "connectionCookie": 0
    },
    "portgroup": "string",
    "mtu": 0,
    "tsoEnabled": false,
    "netStackInstanceKey": "string",
    "opaqueNetwork": {
        "_typeName": "string",
        "opaqueNetworkId": "string",
        "opaqueNetworkType": "string"
    },
    "externalId": "string",
    "pinnedPnic": "string",
    "ipRouteSpec": {
        "_typeName": "string",
        "ipRouteConfig": {
            "_typeName": "string",
            "defaultGateway": "string",
            "gatewayDevice": "string",
            "ipV6DefaultGateway": "string",
            "ipV6GatewayDevice": "string"
        }
    },
    "systemOwned": false,
    "dpuId": "string"
}

array of DynamicProperty

dynamicProperty

Optional

Set of dynamic properties.

This property is optional because only the properties of an object that are unknown to a client will be part of this set. This property is not readonly just in case we want to send such properties from a client in the future.

Optional

IP configuration on the virtual network adapter.

string

mac

Optional

Media access control (MAC) address of the virtual network adapter.

distributedVirtualPort

Optional

DistributedVirtualPort or DistributedVirtualPortgroup connection.

To specify a port connection, set switchUuid and portKey properties. To specify a portgroup connection, set switchUuid and portgroupKey properties.

When reconfiguring a virtual NIC, this property indicates the new portgroup to which the virtual NIC should connect. You can specify this property only if you do not specify distributedVirtualPort and opaqueNetwork

string

portgroup

Optional

Portgroup (HostPortGroup) to which the virtual NIC is connected.

integer As int32 As int32

mtu

Optional

Maximum transmission unit for packets size in bytes for the virtual NIC.

If not specified, the Server will use the system default value.

boolean

tsoEnabled

Optional

Flag enabling or disabling TCP segmentation offset for a virtual NIC.

If not specified, a default value of true will be used.

string

netStackInstanceKey

Optional

The NetStackInstance that the virtual NIC uses, the value of this property is default to be defaultTcpipStack

opaqueNetwork

Optional

Opaque network (HostOpaqueNetworkInfo) to which the virtual NIC is connected.

When reconfiguring a virtual NIC, this property indicates the specification of opaque network to which the virtual NIC should connect. You can specify this property only if you do not specify distributedVirtualPort and portgroup.

string

externalId

Optional

An ID assigned to the vmkernel adapter by external management plane.

The value and format of this property is determined by external management plane, and vSphere doesn't do any validation. It's also up to external management plane to set, unset or maintain this property.

This property is applicable only when opaqueNetwork property is set, otherwise it's value is ignored.

string

pinnedPnic

Optional

The physical nic to which the vmkernel adapter is pinned.

Setting this value ensures that the virtual NIC will access external network only via the the specified physical NIC.

This property is applicable only when opaqueNetwork property is set. If the vmkernel adapter is connected to a portgroup or dvPort, then such pinning can be achieved by configuring correct teaming policy on the portgroup or dvPort or dvPortgroup that is connected to virtual NIC.

ipRouteSpec

Optional

The ip route configuration used by the vmkernel adapter.

This attribute allows the vmkernel adapter to specify its own default gateway.

boolean

systemOwned

Optional

Deprecated as of vSphere API 9, use owner instead.

Set to true when the vmkernel adapter is configured by other system indirectly other than by the user directly.

string

dpuId

Optional