Files
deb-python-pyvmomi/docs/vim/vm/GuestOsDescriptor.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation
This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15
2014-06-17 14:07:42 -04:00

4.8 KiB

vim.vm.GuestOsDescriptor

This data object type contains information to describe a particular guest operating system.

extends

vmodl.DynamicData

Attributes:

id (str):

Identifier (short name) for the guest operating system.

family (str):

Family to which this guest operating system belongs.

fullName (str):

Full name of the guest operating system. For example, if the value of "id" is "win2000Pro", then the value of "fullName" is "Windows 2000 Professional".

supportedMaxCPUs (int):

Maximum number of processors supported for this guest.

numSupportedPhysicalSockets (int):

Maximum number of sockets supported for this guest.

numSupportedCoresPerSocket (int):

Maximum number of cores per socket for this guest.

supportedMinMemMB (int):

Minimum memory requirements supported for this guest, in MB.

supportedMaxMemMB (int):

Maximum memory requirements supported for this guest, in MB.

recommendedMemMB (int):

Recommended default memory size for this guest, in MB.

recommendedColorDepth (int):

Recommended default color depth for this guest.

supportedDiskControllerList (str):

List of supported disk controller types for this guest.

recommendedSCSIController (str, optional):

Recommended default SCSI controller type for this guest.

recommendedDiskController (str):

Recommended default disk controller type for this guest.

supportedNumDisks (int):

Number of disks supported for this guest.

recommendedDiskSizeMB (int):

Recommended default disk size for this guest, in MB.

recommendedCdromController (str):

Recommended default CD-ROM type for this guest.

supportedEthernetCard (str):

List of supported ethernet cards for this guest.

recommendedEthernetCard (str, optional):

Recommended default ethernet controller type for this guest.

supportsSlaveDisk (bool, optional):

Flag to indicate whether or not this guest can support a disk configured as a slave.

cpuFeatureMask (vim.host.CpuIdInfo, optional):

Specifies the CPU feature compatibility masks.

smcRequired (bool):

Flag that indicates wether the guest requires an SMC (Apple hardware). This is logically equivalent to GuestOS = Mac OS

supportsWakeOnLan (bool):

Flag to indicate whether or not this guest can support Wake-on-LAN.

supportsVMI (bool):

Flag indicating whether or not this guest supports the virtual machine interface.

supportsMemoryHotAdd (bool):

Whether the memory size for this guest can be changed while the virtual machine is running.

supportsCpuHotAdd (bool):

Whether virtual CPUs can be added to this guest while the virtual machine is running.

supportsCpuHotRemove (bool):

Whether virtual CPUs can be removed from this guest while the virtual machine is running.

supportedFirmware (str):

Supported firmware types for this guest. Possible values are described in GuestOsDescriptorFirmwareType

recommendedFirmware (str):

Recommended firmware type for this guest. Possible values are described in GuestOsDescriptorFirmwareType

supportedUSBControllerList (str, optional):

List of supported USB controllers for this guest.

recommendedUSBController (str, optional):

Recommended default USB controller type for this guest.

supports3D (bool):

Whether this guest supports 3D graphics.

recommended3D (bool):

Recommended 3D graphics for this guest.

smcRecommended (bool):

Whether SMC (Apple hardware) is recommended for this guest.

ich7mRecommended (bool):

Whether I/O Controller Hub is recommended for this guest.

usbRecommended (bool):

Whether USB controller is recommended for this guest.

supportLevel (str):

Support level of this Guest Possible values are described in GuestOsDescriptorSupportLevel

supportedForCreate (bool):

Whether or not this guest should be allowed for selection during virtual machine creation.

vRAMSizeInKB (vim.option.IntOption):

Video RAM size limits supported by this guest, in KB.