15f7be9a52
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
13 KiB
vim.vm.ConfigInfo
The ConfigInfo data object type encapsulates the configuration settings and virtual hardware for a virtual machine. This type holds all the information that is present in the .vmx configuration file for the virtual machine.
- extends
- Attributes:
-
changeVersion (str):
The changeVersion is a unique identifier for a given version of the configuration. Each change to the configuration updates this value. This is typically implemented as an ever increasing count or a time-stamp. However, a client should always treat this as an opaque string.
modified (datetime):
Last time a virtual machine's configuration was modified.
name (str):
Display name of the virtual machine.Any / (slash), (backslash), character used in this name element is escaped. Similarly, any % (percent) character used in this name element is escaped, unless it is used to start an escape sequence. A slash is escaped as %2F or %2f. A backslash is escaped as %5C or %5c, and a percent is escaped as %25.
guestFullName (str):
This is the full name of the guest operating system for the virtual machine. For example: Windows 2000 Professional.See alternateGuestName
version (str):
The version string for this virtual machine.
uuid (str):
128-bit SMBIOS UUID of a virtual machine represented as a hexadecimal string in "12345678-abcd-1234-cdef-123456789abc" format.
instanceUuid (str, optional):
VirtualCenter-specific 128-bit UUID of a virtual machine, represented as a hexademical string. This identifier is used by VirtualCenter to uniquely identify all virtual machine instances, including those that may share the same SMBIOS UUID.
npivNodeWorldWideName (long, optional):
A 64-bit node WWN (World Wide Name). These WWNs are paired with the npivPortWorldWideName to be used by the NPIV VPORTs instantiated for the virtual machine on the physical HBAs of the host. A pair of node and port WWNs serves as a unique identifier in accessing a LUN, so that it can be monitored or controlled by the storage administrator.If this property contains a single node WWN, the same node WWN is used to pair with all port WWNs listed in npivPortWorldWideName . If this property or npivPortWorldWideName is empty or unset, NPIV WWN is disabled for the virtual machine.
npivPortWorldWideName (long, optional):
A 64-bit port WWN (World Wide Name). For detail description on WWN, see npivNodeWorldWideName .
npivWorldWideNameType (str, optional):
The source that provides/generates the assigned WWNs.See VirtualMachineConfigInfoNpivWwnType
npivDesiredNodeWwns (short, optional):
The NPIV node WWNs to be extended from the original list of WWN nummbers. This property should be set to desired number which is an aggregate of existing plus new numbers. Desired Node WWNs should always be greater than the existing number of node WWNs
npivDesiredPortWwns (short, optional):
The NPIV port WWNs to be extended from the original list of WWN nummbers. This property should be set to desired number which is an aggregate of existing plus new numbers. Desired Node WWNs should always be greater than the existing number of port WWNs
npivTemporaryDisabled (bool, optional):
This property is used to enable or disable the NPIV capability on a desired virtual machine on a temporary basis. When this property is set NPIV Vport will not be instantiated by the VMX process of the Virtual Machine. When this property is set port WWNs and node WWNs in the VM configuration are preserved.
npivOnNonRdmDisks (bool, optional):
This property is used to check whether the NPIV can be enabled on the Virtual machine with non-rdm disks in the configuration, so this is potentially not enabling npiv on vmfs disks. Also this property is used to check whether RDM is required to generate WWNs for a virtual machine.
locationId (str, optional):
Hash incorporating the virtual machine's config file location and the UUID of the host assigned to run the virtual machine.
template (bool):
Flag indicating whether or not a virtual machine is a template.
guestId (str):
Guest operating system configured on a virtual machine. This is a guest identifier that can be used to access the GuestOsDescriptor list for information about default configuration. For more information on possible values, see VirtualMachineGuestOsIdentifier .
alternateGuestName (str):
Used as display name for the operating system if guestId isotherorother-64.See guestFullName
annotation (str, optional):
Description for the virtual machine.
files (vim.vm.FileInfo):
Information about the files associated with a virtual machine. This information does not include files for specific virtual disks or snapshots.
tools (vim.vm.ToolsConfigInfo, optional):
Configuration of VMware Tools running in the guest operating system.
flags (vim.vm.FlagInfo):
Additional flags for a virtual machine.
consolePreferences (vim.vm.ConsolePreferences, optional):
Legacy console viewer preferences when doing power operations.
defaultPowerOps (vim.vm.DefaultPowerOpInfo):
Configuration of default power operations.
hardware (vim.vm.VirtualHardware):
Processor, memory, and virtual devices for a virtual machine.
cpuAllocation (vim.ResourceAllocationInfo, optional):
Resource limits for CPU.
memoryAllocation (vim.ResourceAllocationInfo, optional):
Resource limits for memory.
latencySensitivity (vim.LatencySensitivity, optional):
The latency-sensitivity of the virtual machine.
memoryHotAddEnabled (bool, optional):
Whether memory can be added while this virtual machine is running.
cpuHotAddEnabled (bool, optional):
Whether virtual processors can be added while this virtual machine is running.
cpuHotRemoveEnabled (bool, optional):
Whether virtual processors can be removed while this virtual machine is running.
hotPlugMemoryLimit (long, optional):
The maximum amount of memory, in MB, than can be added to a running virtual machine. This value is determined by the virtual machine and is specified only if memoryHotAddEnabled is set to true.
hotPlugMemoryIncrementSize (long, optional):
Memory, in MB that can be added to a running virtual machine must be in increments of this value and needs be a multiple of this value. This value is determined by the virtual machine and is specified only if memoryHotAddEnabled has been set to true.
cpuAffinity (vim.vm.AffinityInfo, optional):
Affinity settings for CPU.
memoryAffinity (vim.vm.AffinityInfo, optional):
Affinity settings for memory.
networkShaper (vim.vm.NetworkShaperInfo, optional):
Resource limits for network.
extraConfig (vim.option.OptionValue, optional):
Additional configuration information for the virtual machine.
cpuFeatureMask (vim.host.CpuIdInfo, optional):
Specifies CPU feature compatibility masks that override the defaults from the GuestOsDescriptor of the virtual machine's guest OS.
datastoreUrl (vim.vm.ConfigInfo.DatastoreUrlPair, optional):
Enumerates the set of datastores that this virtual machine is stored on, as well as the URL identification for each of these.Changes to datastores do not generate property updates on this property. However, when this property is retrieved it returns the current datastore information.
swapPlacement (str, optional):
Virtual machine swapfile placement policy. This will be unset if the virtual machine's swapPlacementSupported capability is false. If swapPlacementSupported is true, the default policy is "inherit".See VirtualMachineConfigInfoSwapPlacementType
bootOptions (vim.vm.BootOptions, optional):
Configuration options for the boot behavior of the virtual machine.
ftInfo (vim.vm.FaultToleranceConfigInfo, optional):
Fault Tolerance settings for this virtual machine.
vAppConfig (vim.vApp.VmConfigInfo, optional):
vApp meta-data for the virtual machine
vAssertsEnabled (bool, optional):
Indicates whether user-configured virtual asserts will be triggered during virtual machine replay.
changeTrackingEnabled (bool, optional):
Indicates whether changed block tracking for this VM's disks is active.
firmware (str, optional):
Information about firmware type for this Virtual Machine. Possible values are described in GuestOsDescriptorFirmwareType
maxMksConnections (int, optional):
Indicates the maximum number of active remote display connections that the virtual machine will support.
guestAutoLockEnabled (bool, optional):
Indicates whether the guest operating system will logout any active sessions whenever there are no remote display connections open to the virtual machine.
managedBy (vim.ext.ManagedByInfo, optional):
Specifies that this VM is managed by a VC Extension. See the managedBy property in the ConfigSpec for more details.
memoryReservationLockedToMax (bool, optional):
If set true, memory resource reservation for this virtual machine will always be equal to the virtual machine's memory size; increases in memory size will be rejected when a corresponding reservation increase is not possible.
initialOverhead (vim.vm.ConfigInfo.OverheadInfo, optional):
Set of values to be used only to perform admission control when determining if a host has sufficient resources for the virtual machine to power on.
nestedHVEnabled (bool, optional):
Indicates whether this VM is configured to use nested hardware-assisted virtualization.
vPMCEnabled (bool, optional):
Indicates whether this VM have vurtual CPU performance counters enabled.
scheduledHardwareUpgradeInfo (vim.vm.ScheduledHardwareUpgradeInfo, optional):
Configuration of scheduled hardware upgrades and result from last attempt to run scheduled hardware upgrade.See ScheduledHardwareUpgradeInfo
vFlashCacheReservation (long, optional):
Specifies the total vFlash resource reservation for the vFlash caches associated with this VM's virtual disks, in bytes. This reservation must be allocated to power on the VM. See vFlashCacheAllocation for allocated reservation when VM is powered on.