HostVirtualNic

HostVirtualNic
HostVirtualNic

The HostVirtualNic data object describes a virtual network adapter that connects to a virtual switch.

A host virtual NIC differs from a physical NIC:

  • A host virtual NIC is a virtual device that is connected to a virtual switch.
  • A physical NIC (pnic) corresponds to a physical device that is connected to the physical network.

A host virtual NIC provides access to the external network through a virtual switch that is bridged through a Physical NIC to a physical network.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "device": "string",
    "key": "string",
    "portgroup": "string",
    "spec": {
        "_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"
    },
    "port": "string",
    "owner": "string"
}
string
device
Required

Device name.

string
key
Required

Linkable identifier.

string
portgroup
Required

If the Virtual NIC is connecting to a vSwitch, this property is the name of portgroup connected.

If the Virtual NIC is connecting to a DistributedVirtualSwitch or opaque network, this property is an empty string.

spec
Required

Configurable properties for the virtual network adapter object.

string
port
Optional

Port(port) on the port group that the virtual NIC is using when it is enabled.

If the Virtual NIC is connected to DistributedVirtualSwitch or opaque network, this property is unset.

string
owner
Optional

Owner of vmknic.

It is only valid for system vmknic. The unset means not owned by the system. See HostConfigChangeOwnerEnum for supported values.

Since: vSphere API Release 9.0.0.0

Property Of