Scripting Object - VcVirtualEthernetCard


Scripting Object Description

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

Attributes

Name Type Description
addressType*string

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.

backing*VcVirtualDeviceBackingInfo

Information about the backing of this virtual device presented in the context of the virtual machine's environment. Not all devices are required to have backing information.
See VcVirtualMachineConfigOption
connectable*VcVirtualDeviceConnectInfo

Provides information about restrictions on removing this device while a virtual machine is running. If the device is not removable, then this property is null.
controllerKey*number

Object key for the controller object for this device. This property contains the key property value of the controller device object.
deviceInfo*VcDescription

Provides a label and summary information for the device.
externalId*string

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.
keynumber

A unique key that distinguishes this device from other devices in the same virtual machine. Keys are immutable but may be recycled; that is, a key does not change as long as the device is associated with a particular virtual machine. However, once a device is removed, its key may be used when another device is added.

This property is not read-only, but the client cannot control its value. Persistent device keys are always assigned and managed by the server, which guarantees that all devices will have non-negative key values.

When adding new devices, it may be necessary for a client to assign keys temporarily in order to associate controllers with devices in configuring a virtual machine. However, the server does not allow a client to reassign a device key, and the server may assign a different value from the one passed during configuration. Clients should ensure that existing device keys are not reused as temporary key values for the new device to be added (for example, by using unique negative integers as temporary keys).

When editing or deleting a device, clients must use the server-provided key to refer to an existing device.

macAddress*string

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.
resourceAllocation*VcVirtualEthernetCardResourceAllocation

Resource requirements of the virtual network adapter
slotInfo*VcVirtualDeviceBusSlotInfo

Information about the bus slot of a device in a virtual machine.
unitNumber*number

The unit number of this device on its controller. This property is null if the controller property is null (for example, when the device is not attached to a specific controller object).

Normally, two devices on the same controller may not be assigned the same unit number. If multiple devices could exist on a controller, then unit number has to be specified to configure respective devices.

uptCompatibilityEnabled*boolean

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.
wakeOnLanEnabled*boolean

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.
*May not be present

Methods

Methods defined in this Scripting Object
None