VirtualEthernetCard

VirtualEthernetCard
VirtualEthernetCard

The VirtualEthernetCard data object contains the properties of an Ethernet adapter attached to a virtual machine.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "key": 0,
    "deviceInfo": {
        "_typeName": "string",
        "label": "string",
        "summary": "string"
    },
    "backing": {
        "_typeName": "string"
    },
    "connectable": {
        "_typeName": "string",
        "migrateConnect": "string",
        "startConnected": false,
        "allowGuestControl": false,
        "connected": false,
        "status": "string"
    },
    "slotInfo": {
        "_typeName": "string"
    },
    "controllerKey": 0,
    "unitNumber": 0,
    "numaNode": 0,
    "deviceGroupInfo": {
        "_typeName": "string",
        "groupInstanceKey": 0,
        "sequenceId": 0
    },
    "dynamicProperty": [
        {
            "_typeName": "string",
            "name": "string",
            "val": {
                "_typeName": "string"
            }
        }
    ],
    "addressType": "string",
    "macAddress": "string",
    "wakeOnLanEnabled": false,
    "resourceAllocation": {
        "_typeName": "string",
        "reservation": 0,
        "share": {
            "_typeName": "string",
            "shares": 0,
            "level": "string"
        },
        "limit": 0
    },
    "externalId": "string",
    "uptCompatibilityEnabled": false,
    "subnetId": "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.

string
addressType
Optional

MAC address type.

Valid values for address type are:

Manual
Statically assigned MAC address.
Generated
Automatically generated MAC address.
Assigned
MAC address assigned by VirtualCenter.
string
macAddress
Optional

MAC address assigned to the virtual network adapter.

Clients can set this property to any of the allowed address types. The server might override the specified value for "Generated" or "Assigned" if it does not fall in the right ranges or is determined to be a duplicate.

boolean
wakeOnLanEnabled
Optional

Indicates whether wake-on-LAN is enabled on this virtual network adapter.

Clients can set this property to selectively enable or disable wake-on-LAN.

resourceAllocation
Optional

Resource requirements of the virtual network adapter

string
externalId
Optional

An ID assigned to the virtual network adapter by external management plane or controller.

The value and format of this property is determined by external management plane or controller, and vSphere doesn't do any validation. It's also up to external management plane or controller to set, unset or maintain this property. Setting this property with an empty string value will unset the property.

boolean
uptCompatibilityEnabled
Optional

Deprecated as of vSphere API 8.0. VMDirectPath Gen 2 is no longer supported and there is no replacement.

Indicates whether UPT(Universal Pass-through) compatibility is enabled on this network adapter.

UPT is only compatible for Vmxnet3 adapter. Clients can set this property enabled or disabled if ethernet virtual device is Vmxnet3.

string
subnetId
Optional

The ID of the subnet the virtual network adapter connects to.

It is only set when the virtual network adapter is connected to a subnet.

Since: vSphere API Release 9.0.0.0

Property Of
Used By