Scripting Object - VcVirtualMachineVideoCard


Scripting Object Description

The VirtualVideoCard data object type represents a video card in a virtual machine.

Attributes

Name Type Description
backingVcVirtualDeviceBackingInfo

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. @since VI API 2.5
connectableVcVirtualDeviceConnectInfo

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. @since VI API 2.5
controllerKeyNumber

Object key for the controller object for this device. This property contains the key property value of the controller device object. @since VI API 2.5
deviceInfoVcDescription

Provides a label and summary information for the device. @since VI API 2.5
dynamicPropertyVcDynamicProperty []

@since Unknown
dynamicTypeString

@since Unknown
enable3DSupportBoolean

Flag to indicate whether the virtual video card supports 3D functions. This property can only be updated when the virtual machine is powered off. @since vSphere API 4.0
enableMPTSupportBoolean

Flag to indicate whether the virtual video card supports mediated passthrough. This property can only be updated when the virtual machine is powered off. @since vim legacy version
graphicsMemorySizeInKBNumber

The size of graphics memory. If 3d support is enabled this setting gives the amount of guest memory used for graphics resources. This property can only be updated when the virtual machine is powered off. @since vSphere API 6.0
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. @since VI API 2.5

numDisplaysNumber

Indicates the number of supported monitors. The number of displays X the maximum resolution of each display is bounded by the video RAM size of the virtual video card. This property can only be updated when the virtual machine is powered off. @since vSphere API 4.0
slotInfoVcVirtualDeviceBusSlotInfo

Information about the bus slot of a device in a virtual machine. @since vSphere API 5.1
unitNumberNumber

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. @since VI API 2.5

use3dRendererString

Indicate how the virtual video device renders 3D graphics.

The virtual video device can use hardware acceleration and software rendering. By default, VMware products determine whether or not to use hardware acceleration based on the availability of physical graphics devices. Certain workloads can benefit from explicitly specifying if hardware acceleration is required. For example, 3D intensive workloads may indicate to run on systems with graphics hardware.

There are three settings.

(automatic) - The virtual device chooses how to render 3D graphics (default). (software) - The virtual device will use software rendering and will not attempt to use hardware acceleration. (hardware) - The virtual device will use hardware acceleration and will not activate without it. @since vSphere API 5.1

useAutoDetectBoolean

Flag to indicate whether the display settings of the host on which the virtual machine is running should be used to automatically determine the display settings of the virtual machine's video card. This setting takes effect at virtual machine power-on time. If this value is set to TRUE, numDisplays will be ignored. @since vSphere API 4.0
videoRamSizeInKBNumber

The size of the framebuffer for a virtual machine. @since VI API 2.5

Methods

Methods defined in this Scripting Object
isEnable3DSupport, isEnableMPTSupport, isUseAutoDetect

isEnable3DSupport

Flag to indicate whether the virtual video card supports 3D functions. This property can only be updated when the virtual machine is powered off. @since vSphere API 4.0

Parameters

NameTypeDescription
None

Return Value

Type Description
Boolean

isUseAutoDetect

Flag to indicate whether the display settings of the host on which the virtual machine is running should be used to automatically determine the display settings of the virtual machine's video card. This setting takes effect at virtual machine power-on time. If this value is set to TRUE, numDisplays will be ignored. @since vSphere API 4.0

Parameters

NameTypeDescription
None

Return Value

Type Description
Boolean

isEnableMPTSupport

Flag to indicate whether the virtual video card supports mediated passthrough. This property can only be updated when the virtual machine is powered off. @since vim legacy version

Parameters

NameTypeDescription
None

Return Value

Type Description
Boolean