Virtual Machine Get Config

Virtual Machine Get Config

Configuration of this virtual machine, including the name and UUID.

This property is set when a virtual machine is created or when the reconfigVM method is called.

The virtual machine configuration is not guaranteed to be available. For example, the configuration information would be unavailable if the server is unable to access the virtual machine files on disk, and is often also unavailable during the initial phases of virtual machine creation.

Request
URI
GET
https://{vcenter-host}/sdk/vim25/{release}/VirtualMachine/{moId}/config
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the property attaches; the serialized managed object reference for a request has the form moType/moId, in this case VirtualMachine/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns VirtualMachineConfigInfo of type(s) application/json
This response body class contains all of the following: DataObject
{
    "_typeName": "string",
    "changeVersion": "string",
    "modified": "string",
    "name": "string",
    "guestFullName": "string",
    "version": "string",
    "uuid": "string",
    "createDate": "string",
    "instanceUuid": "string",
    "npivNodeWorldWideName": [
        0
    ],
    "npivPortWorldWideName": [
        0
    ],
    "npivWorldWideNameType": "string",
    "npivDesiredNodeWwns": 0,
    "npivDesiredPortWwns": 0,
    "npivTemporaryDisabled": false,
    "npivOnNonRdmDisks": false,
    "locationId": "string",
    "template": false,
    "guestId": "string",
    "alternateGuestName": "string",
    "annotation": "string",
    "files": {
        "_typeName": "string",
        "vmPathName": "string",
        "snapshotDirectory": "string",
        "suspendDirectory": "string",
        "logDirectory": "string",
        "ftMetadataDirectory": "string"
    },
    "tools": {
        "_typeName": "string",
        "toolsVersion": 0,
        "toolsInstallType": "string",
        "afterPowerOn": false,
        "afterResume": false,
        "beforeGuestStandby": false,
        "beforeGuestShutdown": false,
        "beforeGuestReboot": false,
        "toolsUpgradePolicy": "string",
        "pendingCustomization": "string",
        "customizationKeyId": {
            "_typeName": "string",
            "keyId": "string",
            "providerId": {
                "_typeName": "string",
                "id": "string"
            }
        },
        "syncTimeWithHostAllowed": false,
        "syncTimeWithHost": false,
        "lastInstallInfo": {
            "_typeName": "string",
            "counter": 0,
            "fault": {
                "_typeName": "string",
                "faultCause": "MethodFault Object",
                "faultMessage": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "arg": [
                            {
                                "_typeName": "string",
                                "key": "string",
                                "value": {
                                    "_typeName": "string"
                                }
                            }
                        ],
                        "message": "string"
                    }
                ]
            }
        }
    },
    "flags": {
        "_typeName": "string",
        "disableAcceleration": false,
        "enableLogging": false,
        "useToe": false,
        "runWithDebugInfo": false,
        "monitorType": "string",
        "htSharing": "string",
        "snapshotDisabled": false,
        "snapshotLocked": false,
        "diskUuidEnabled": false,
        "virtualMmuUsage": "string",
        "virtualExecUsage": "string",
        "snapshotPowerOffBehavior": "string",
        "recordReplayEnabled": false,
        "faultToleranceType": "string",
        "cbrcCacheEnabled": false,
        "vvtdEnabled": false,
        "vbsEnabled": false
    },
    "consolePreferences": {
        "_typeName": "string",
        "powerOnWhenOpened": false,
        "enterFullScreenOnPowerOn": false,
        "closeOnPowerOffOrSuspend": false
    },
    "defaultPowerOps": {
        "_typeName": "string",
        "powerOffType": "string",
        "suspendType": "string",
        "resetType": "string",
        "defaultPowerOffType": "string",
        "defaultSuspendType": "string",
        "defaultResetType": "string",
        "standbyAction": "string"
    },
    "rebootPowerOff": false,
    "hardware": {
        "_typeName": "string",
        "numCPU": 0,
        "numCoresPerSocket": 0,
        "autoCoresPerSocket": false,
        "memoryMB": 0,
        "virtualICH7MPresent": false,
        "virtualSMCPresent": false,
        "device": [
            {
                "_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
                }
            }
        ],
        "motherboardLayout": "string",
        "simultaneousThreads": 0
    },
    "vcpuConfig": [
        {
            "_typeName": "string",
            "latencySensitivity": {
                "_typeName": "string",
                "level": "string",
                "sensitivity": 0
            }
        }
    ],
    "cpuAllocation": {
        "_typeName": "string",
        "reservation": 0,
        "expandableReservation": false,
        "limit": 0,
        "shares": {
            "_typeName": "string",
            "shares": 0,
            "level": "string"
        },
        "overheadLimit": 0
    },
    "memoryAllocation": {
        "_typeName": "string",
        "reservation": 0,
        "expandableReservation": false,
        "limit": 0,
        "shares": {
            "_typeName": "string",
            "shares": 0,
            "level": "string"
        },
        "overheadLimit": 0
    },
    "latencySensitivity": {
        "_typeName": "string",
        "level": "string",
        "sensitivity": 0
    },
    "memoryHotAddEnabled": false,
    "cpuHotAddEnabled": false,
    "cpuHotRemoveEnabled": false,
    "hotPlugMemoryLimit": 0,
    "hotPlugMemoryIncrementSize": 0,
    "cpuAffinity": {
        "_typeName": "string",
        "affinitySet": [
            0
        ]
    },
    "memoryAffinity": {
        "_typeName": "string",
        "affinitySet": [
            0
        ]
    },
    "networkShaper": {
        "_typeName": "string",
        "enabled": false,
        "peakBps": 0,
        "averageBps": 0,
        "burstSize": 0
    },
    "extraConfig": [
        {
            "_typeName": "string",
            "key": "string",
            "value": {
                "_typeName": "string"
            }
        }
    ],
    "cpuFeatureMask": [
        {
            "_typeName": "string",
            "level": 0,
            "vendor": "string",
            "eax": "string",
            "ebx": "string",
            "ecx": "string",
            "edx": "string"
        }
    ],
    "datastoreUrl": [
        {
            "_typeName": "string",
            "name": "string",
            "url": "string"
        }
    ],
    "swapPlacement": "string",
    "bootOptions": {
        "_typeName": "string",
        "bootDelay": 0,
        "enterBIOSSetup": false,
        "efiSecureBootEnabled": false,
        "bootRetryEnabled": false,
        "bootRetryDelay": 0,
        "bootOrder": [
            {
                "_typeName": "string"
            }
        ],
        "networkBootProtocol": "string"
    },
    "ftInfo": {
        "_typeName": "string",
        "role": 0,
        "instanceUuids": [
            "string"
        ],
        "configPaths": [
            "string"
        ],
        "orphaned": false
    },
    "repConfig": {
        "_typeName": "string",
        "generation": 0,
        "vmReplicationId": "string",
        "destination": "string",
        "port": 0,
        "rpo": 0,
        "quiesceGuestEnabled": false,
        "paused": false,
        "oppUpdatesEnabled": false,
        "netCompressionEnabled": false,
        "netEncryptionEnabled": false,
        "encryptionDestination": "string",
        "encryptionPort": 0,
        "remoteCertificateThumbprint": "string",
        "dataSetsReplicationEnabled": false,
        "disk": [
            {
                "_typeName": "string",
                "key": 0,
                "diskReplicationId": "string"
            }
        ]
    },
    "vAppConfig": {
        "_typeName": "string",
        "product": [
            {
                "_typeName": "string",
                "key": 0,
                "classId": "string",
                "instanceId": "string",
                "name": "string",
                "vendor": "string",
                "version": "string",
                "fullVersion": "string",
                "vendorUrl": "string",
                "productUrl": "string",
                "appUrl": "string"
            }
        ],
        "property": [
            {
                "_typeName": "string",
                "key": 0,
                "classId": "string",
                "instanceId": "string",
                "id": "string",
                "category": "string",
                "label": "string",
                "type": "string",
                "typeReference": "string",
                "userConfigurable": false,
                "defaultValue": "string",
                "value": "string",
                "description": "string"
            }
        ],
        "ipAssignment": {
            "_typeName": "string",
            "supportedAllocationScheme": [
                "string"
            ],
            "ipAllocationPolicy": "string",
            "supportedIpProtocol": [
                "string"
            ],
            "ipProtocol": "string"
        },
        "eula": [
            "string"
        ],
        "ovfSection": [
            {
                "_typeName": "string",
                "key": 0,
                "namespace": "string",
                "type": "string",
                "atEnvelopeLevel": false,
                "contents": "string"
            }
        ],
        "ovfEnvironmentTransport": [
            "string"
        ],
        "installBootRequired": false,
        "installBootStopDelay": 0
    },
    "vAssertsEnabled": false,
    "changeTrackingEnabled": false,
    "firmware": "string",
    "maxMksConnections": 0,
    "guestAutoLockEnabled": false,
    "managedBy": {
        "_typeName": "string",
        "extensionKey": "string",
        "type": "string"
    },
    "memoryReservationLockedToMax": false,
    "initialOverhead": {
        "_typeName": "string",
        "initialMemoryReservation": 0,
        "initialSwapReservation": 0
    },
    "nestedHVEnabled": false,
    "vPMCEnabled": false,
    "scheduledHardwareUpgradeInfo": {
        "_typeName": "string",
        "upgradePolicy": "string",
        "versionKey": "string",
        "scheduledHardwareUpgradeStatus": "string",
        "fault": {
            "_typeName": "string",
            "faultCause": "MethodFault Object",
            "faultMessage": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "arg": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "value": {
                                "_typeName": "string"
                            }
                        }
                    ],
                    "message": "string"
                }
            ]
        }
    },
    "forkConfigInfo": {
        "_typeName": "string",
        "parentEnabled": false,
        "childForkGroupId": "string",
        "parentForkGroupId": "string",
        "childType": "string"
    },
    "vFlashCacheReservation": 0,
    "vmxConfigChecksum": "string",
    "messageBusTunnelEnabled": false,
    "vmStorageObjectId": "string",
    "swapStorageObjectId": "string",
    "keyId": {
        "_typeName": "string",
        "keyId": "string",
        "providerId": {
            "_typeName": "string",
            "id": "string"
        }
    },
    "guestIntegrityInfo": {
        "_typeName": "string",
        "enabled": false
    },
    "migrateEncryption": "string",
    "sgxInfo": {
        "_typeName": "string",
        "epcSize": 0,
        "flcMode": "string",
        "lePubKeyHash": "string",
        "requireAttestation": false
    },
    "contentLibItemInfo": {
        "_typeName": "string",
        "contentLibraryItemUuid": "string",
        "contentLibraryItemVersion": "string"
    },
    "ftEncryptionMode": "string",
    "guestMonitoringModeInfo": {
        "_typeName": "string",
        "gmmFile": "string",
        "gmmAppliance": "string"
    },
    "sevEnabled": false,
    "numaInfo": {
        "_typeName": "string",
        "coresPerNumaNode": 0,
        "autoCoresPerNumaNode": false,
        "vnumaOnCpuHotaddExposed": false
    },
    "pmemFailoverEnabled": false,
    "vmxStatsCollectionEnabled": false,
    "vmOpNotificationToAppEnabled": false,
    "vmOpNotificationTimeout": 0,
    "deviceSwap": {
        "_typeName": "string",
        "lsiToPvscsi": {
            "_typeName": "string",
            "enabled": false,
            "applicable": false,
            "status": "string"
        }
    },
    "pmem": {
        "_typeName": "string",
        "snapshotMode": "string"
    },
    "deviceGroups": {
        "_typeName": "string",
        "deviceGroup": [
            {
                "_typeName": "string",
                "groupInstanceKey": 0,
                "deviceInfo": {
                    "_typeName": "string",
                    "label": "string",
                    "summary": "string"
                }
            }
        ]
    },
    "fixedPassthruHotPlugEnabled": false,
    "metroFtEnabled": false,
    "metroFtHostGroup": "string"
}
string
changeVersion
Required

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.

string As date-time As date-time
modified
Required

Last time a virtual machine's configuration was modified.

string
name
Required

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.

string
guestFullName
Required

This is the full name of the guest operating system for the virtual machine.

For example: Windows 2000 Professional.

See also VirtualMachineConfigInfo.alternateGuestName.

string
version
Required

The version string for this virtual machine.

string
uuid
Required

128-bit SMBIOS UUID of a virtual machine represented as a hexadecimal string in "12345678-abcd-1234-cdef-123456789abc" format.

string As date-time As date-time
createDate
Optional

Time the virtual machine's configuration was created.

string
instanceUuid
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.

array of integer
npivNodeWorldWideName
Optional

A 64-bit node WWN (World Wide Name).

These WWNs are paired with the VirtualMachineConfigInfo.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 VirtualMachineConfigInfo.npivPortWorldWideName. If this property or VirtualMachineConfigInfo.npivPortWorldWideName is empty or unset, NPIV WWN is disabled for the virtual machine.

array of integer
npivPortWorldWideName
Optional

A 64-bit port WWN (World Wide Name).

For detail description on WWN, see VirtualMachineConfigInfo.npivNodeWorldWideName.

string
npivWorldWideNameType
Optional

The source that provides/generates the assigned WWNs.

See also VirtualMachineConfigInfoNpivWwnTypeEnum.

integer
npivDesiredNodeWwns
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

integer
npivDesiredPortWwns
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

boolean
npivTemporaryDisabled
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.

boolean
npivOnNonRdmDisks
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.

string
locationId
Optional

Hash incorporating the virtual machine's config file location and the UUID of the host assigned to run the virtual machine.

boolean
template
Required

Flag indicating whether or not a virtual machine is a template.

string
guestId
Required

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.

string
alternateGuestName
Required

Used as display name for the operating system if guestId is other or other-64.

See also VirtualMachineConfigInfo.guestFullName.

string
annotation
Optional

Description for the virtual machine.

files
Required

The FileInfo data object type contains the locations of virtual machine files other than the virtual disk files.

The configurable parameters are all in the FileInfo object.

The object also contains a FileLayout object that returns a complete list of additional files that makes up the virtual machine configuration. This is a read-only structure and is returned when the configuration is read. This is ignored during configuration and can be left out.

tools
Optional

ToolsConfigInfo is a data object type containing settings for the VMware Tools software running in the guest operating system.

flags
Required

The FlagInfo data object type encapsulates the flag settings for a virtual machine.

These properties are optional since the same structure is used to change the values during an edit or create operation.

consolePreferences
Optional

Preferences for the legacy console application that affect the way it behaves during power operations on the virtual machine.

defaultPowerOps
Required

The DefaultPowerOpInfo data object type holds the configured defaults for the power operations on a virtual machine.

The properties indicated whether to do a "soft" or guest initiated operation, or a "hard" operation.

boolean
rebootPowerOff
Optional

Whether the next reboot will result in a power off.

Since: vSphere API Release 8.0.0.1

hardware
Required

The VirtualHardware data object type contains the complete configuration of the hardware in a virtual machine.

vcpuConfig
Optional

Vcpu configuration.

The vcpuConfig array is indexed by vcpu number.

cpuAllocation
Optional

The ResourceAllocationInfo data object specifies the reserved resource requirement as well as the limit (maximum allowed usage) for a given kind of resource.

This is specified for both memory allocation (specified in MB) and CPU allocation (specified in MHz).

For a ResourcePool, the ResourceAllocationInfo object describes both the guaranteed amount of the resource (reservation) and whether or not it is expandable (expandableReservation). If expandableReservation is true, then the resource pool can grow its reservation dynamically by borrowing unreserved resources from its parent resource pool. For the methods CreateResourcePool, CreateVApp and ImportVApp, you must provide values for all properties except overheadLimit; they are not optional. (Currently, overheadLimit is for vCenter Server use only.)

If the limit is configured, it must be greater than or equal to the reservation.

memoryAllocation
Optional

The ResourceAllocationInfo data object specifies the reserved resource requirement as well as the limit (maximum allowed usage) for a given kind of resource.

This is specified for both memory allocation (specified in MB) and CPU allocation (specified in MHz).

For a ResourcePool, the ResourceAllocationInfo object describes both the guaranteed amount of the resource (reservation) and whether or not it is expandable (expandableReservation). If expandableReservation is true, then the resource pool can grow its reservation dynamically by borrowing unreserved resources from its parent resource pool. For the methods CreateResourcePool, CreateVApp and ImportVApp, you must provide values for all properties except overheadLimit; they are not optional. (Currently, overheadLimit is for vCenter Server use only.)

If the limit is configured, it must be greater than or equal to the reservation.

latencySensitivity
Optional

Specification of the latency-sensitivity information.

The latency-sensitivity is used to request from the kernel a constraint on the scheduling delay of the virtual CPUs or other resources. This allows latency-sensitive applications(e.g. VOIP, audio/video streaming, etc.) to run in a virtual machine which is configured to use specific scheduling latencies and to be scheduled with low latency.

The kernel does not provide any guarantee that it will meet the latency-sensitivity requirement of a virtual machine CPU or other resources but it will always accept the latency-sensitivity value provided.

boolean
memoryHotAddEnabled
Optional

Whether memory can be added while this virtual machine is running.

boolean
cpuHotAddEnabled
Optional

Whether virtual processors can be added while this virtual machine is running.

boolean
cpuHotRemoveEnabled
Optional

Whether virtual processors can be removed while this virtual machine is running.

integer As int64 As int64
hotPlugMemoryLimit
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 VirtualMachineConfigInfo.memoryHotAddEnabled is set to true.

integer As int64 As int64
hotPlugMemoryIncrementSize
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 VirtualMachineConfigSpec.memoryHotAddEnabled has been set to true.

cpuAffinity
Optional

Specification of scheduling affinity.

Scheduling affinity is used for explicitly specifying which processors or NUMA nodes may be used by a virtual machine.

memoryAffinity
Optional

Specification of scheduling affinity.

Scheduling affinity is used for explicitly specifying which processors or NUMA nodes may be used by a virtual machine.

networkShaper
Optional

Network traffic shaping specification.

Traffic shaping is used to configure the network utilization characteristics of a virtual machine.

extraConfig
Optional

Additional configuration information for the virtual machine.

cpuFeatureMask
Optional

Specifies CPU feature compatibility masks that override the defaults from the GuestOsDescriptor of the virtual machine's guest OS.

As of vSphere API 6.5 FeatureMask is the recommended method for masking virtual machines with hardware version 9 and above (newer). They can be viewed via featureMask.

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

string
swapPlacement
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 also VirtualMachineConfigInfoSwapPlacementTypeEnum.

bootOptions
Optional

The VirtualMachineBootOptions data object defines the boot-time behavior of a virtual machine.

You can use the delay options to specify a time interval during which you can enter the virtual machine BIOS setup. These options provide a solution for the situation that occurs when the console attaches to the virtual machine after the boot sequence has passed the BIOS setup entry point.

ftInfo
Optional

FaultToleranceConfigInfo is a data object type containing Fault Tolerance settings for this virtual machine.

role, instanceUuids and configPaths contain information about the whole fault tolerance group.

repConfig
Optional

The ReplicationConfigSpec object type encapsulates the replication configuration parameters for a virtual machine.

It consists of two parts: 1) a set of virtual machine-wide replication properties; 2) a set of properties per replicated virtual disk. ReplicationSetting is passed as an argument for initial replication configuration (@see vim.HbrManager#enableReplication) as well as for re-configuration of a replicated VM's properties (@see vim.HbrManager#reconfigureReplication).

vAppConfig
Optional

VM Configuration.

boolean
vAssertsEnabled
Optional

Indicates whether user-configured virtual asserts will be triggered during virtual machine replay.

boolean
changeTrackingEnabled
Optional

Indicates whether changed block tracking for this VM's disks is active.

string
firmware
Optional

Information about firmware type for this Virtual Machine.

Possible values are described in GuestOsDescriptorFirmwareTypeEnum When creating a new VM: - If vim.vm.FlagInfo.vbsEnabled is set to true and this property is set to bios, error is returned. - If this property is unset and vim.vm.FlagInfo.vbsEnabled is set to true, this property is set to efi.

integer As int32 As int32
maxMksConnections
Optional

Indicates the maximum number of active remote display connections that the virtual machine will support.

boolean
guestAutoLockEnabled
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
Optional

The ManagedByInfo data object contains information about the extension responsible for the life-cycle of the entity.

boolean
memoryReservationLockedToMax
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
Optional

Information about virtualization overhead required to power on the virtual machine on the registered host.

boolean
nestedHVEnabled
Optional

Indicates whether this VM is configured to use nested hardware-assisted virtualization.

boolean
vPMCEnabled
Optional

Indicates whether this VM have vurtual CPU performance counters enabled.

scheduledHardwareUpgradeInfo
Optional

Data object type containing settings for the scheduled hardware upgrades.

forkConfigInfo
Optional

This data object describes the fork configuration of this virtual machine.

integer As int64 As int64
vFlashCacheReservation
Optional

Deprecated since vSphere 7.0 because vFlash Read Cache end of availability.

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 VirtualMachineRuntimeInfo.vFlashCacheAllocation for allocated reservation when VM is powered on.

string As byte As byte
vmxConfigChecksum
Optional

A checksum of vmx config file.

boolean
messageBusTunnelEnabled
Optional

Whether to allow tunneling of clients from the guest VM into the common message bus on the host network.

string
vmStorageObjectId
Optional

Virtual Machine Object Identifier.

With Object-based Storage systems, Virtual Machine home directory is backed by an object. This identifier will be set only if VM directory resided on object-based storage systems.

string
swapStorageObjectId
Optional

Virtual Machine Swap Object Identifier.

With Object-based Storage systems, VM's Swap is backed by an object. This identifier will be set only if VM swap resided on object-based storage systems.

keyId
Optional

Data Object representing a cryptographic key.

guestIntegrityInfo
Optional

This data object describes the guest integrity platform configuration of this virtual machine.

string
migrateEncryption
Optional

An enum describing whether encrypted vMotion is required for this VM.

See VirtualMachineConfigSpecEncryptedVMotionModesEnum for allowed values. This defaults to opportunistic for a regular VM, and will be set to required for an encrypted VM.

sgxInfo
Optional

This data object describes the virtual software guard extension (vSGX) configuration of this virtual machine.

contentLibItemInfo
Optional

Describes the content library item information associated with the virtual machine.

string
ftEncryptionMode
Optional

An enum describing whether encrypted Fault Tolerance is required for this VM.

See VirtualMachineConfigSpecEncryptedFtModesEnum for allowed values. - This defaults to opportunistic for a regular VM, and will be set to required for an encrypted VM. - If this property is unset, the mode of encrypted Fault Tolerance will be set to opportunistic.

Since: vSphere API Release 7.0.2.0

guestMonitoringModeInfo
Optional

This data object describes the GMM (Guest Mode Monitoring) configuration of this virtual machine.

boolean
sevEnabled
Optional

SEV (Secure Encrypted Virtualization) enabled or not.

SEV is enabled when set to true, and disabled otherwise.

Since: vSphere API Release 7.0.1.0

numaInfo
Optional

vNUMA: This is read-only data for ConfigInfo since this portion is not configurable.

Since: vSphere API Release 8.0.0.1

boolean
pmemFailoverEnabled
Optional

Property to indicate PMem HA failover configuration.

- When set to TRUE, VMs configured to use PMem will be failed over to other hosts by HA, but the data in NVDIMM is not persistent. - When set to FALSE, VMs configured to use PMem will not be failed over to other hosts by HA. Property is currently only applicable to VMs with NVDimms and will fail to set True if vPMem disks are present.

Since: vSphere API Release 7.0.2.0

boolean
vmxStatsCollectionEnabled
Optional

Indicates whether VMXStats Collection is enabled/disabled.

- If TRUE, VMXStats is enabled for the VM and a scoreboard file is created to store stats for various VMX components. - If FALSE, VMXStats is disabled for the VM and there is no scoreboard file created.

Since: vSphere API Release 7.0.3.1

boolean
vmOpNotificationToAppEnabled
Optional

Indicates whether operation notification to applications is enabled/disabled.

- When set to TRUE, application running inside the VM will be notified of operations for which they have registered. - If unset or FALSE, new applications are not allowed to register for notifications and RPCs will no longer be supported from already registered applications.

Since: vSphere API Release 7.0.3.0

integer As int64 As int64
vmOpNotificationTimeout
Optional

Operation notification timeout in seconds.

- Specifies the maximum time the application can take to prepare for the operation after its been notified. This value is used only if VirtualMachineConfigInfo.vmOpNotificationToAppEnabled is set to TRUE. - If VirtualMachineConfigInfo.vmOpNotificationTimeout is unset, then it defaults to cluster/host timeout.

Since: vSphere API Release 8.0.0.1

deviceSwap
Optional

Device Swap: Report current status of device swap feature.

Since: vSphere API Release 8.0.0.1

pmem
Optional

Virtual Persistent Memory configuration for the VM.

Since: vSphere API Release 7.0.3.0

deviceGroups
Optional

The VirtualDeviceGroups data object type contains information about the backing that maps the virtual device onto a physical device for a Vendor Device Group device.

Vendor Device Groups allow third-parties to define collections of devices that must be allocated to a virtual machine as a unit. Typically, this is because the set of devices are related in a some way, e.g. a physical link connects the devices.

Since: vSphere API Release 8.0.0.1

boolean
fixedPassthruHotPlugEnabled
Optional

Indicates whether support to add and remove fixed passthrough devices when the VM is running is enabled.

When the virtual machine is powered on, this indicates if support for hot adding and removing fixed passthrough devices was enabled prior to power on. Otherwise, it indicates whether it will be enabled when the VM is powered on. NOTE: When setting this to true, the memory reservation should be equal to the guest memory size or the option to reserve all guest memory should be selected. If unset, the current value is left unchanged.

Since: vSphere API Release 8.0.1.0

boolean
metroFtEnabled
Optional

Indicates whether FT Metro Cluster is enabled/disabled.

- If TRUE, FT Metro Cluster is enabled for the VM. An implicit Anti-HostGroup will be generated from HostGroup defined for FT primary, then affine the primary with one HostGroup and affine the secondary with another HostGroup. - If FALSE or unset, FT Metro Cluster is disabled for the VM. Both FT primary and secondary will be put in the same HostGroup.

Since: vSphere API Release 8.0.3.0

string
metroFtHostGroup
Optional

Indicate the Host Group (ClusterHostGroup) for FT Metro Cluster enabled Virtual Machine.

Based on the selected Host Group, FT can divide the hosts in the cluster into two groups and ensure to place FT primary and FT secondary in different groups.

Since: vSphere API Release 8.0.3.0


Virtual Infrastructure Operations
POST
Virtual Machine Acquire Mks Ticket
POST
Virtual Machine Acquire Ticket
POST
Virtual Machine Answer VM
POST
Virtual Machine Apply Evc Mode VM Task
POST
Virtual Machine Attach Disk Task
POST
Virtual Machine Check Customization Spec
POST
Virtual Machine Clone VM Task
POST
Virtual Machine Consolidate VM Disks Task
POST
Virtual Machine Create Screenshot Task
POST
Virtual Machine Create Secondary VM Task
POST
Virtual Machine Create Secondary VM Ex Task
POST
Virtual Machine Create Snapshot Task
POST
Virtual Machine Create Snapshot Ex Task
POST
Virtual Machine Crypto Unlock Task
POST
Virtual Machine Customize VM Task
POST
Virtual Machine Defragment All Disks
POST
Virtual Machine Destroy Task
POST
Virtual Machine Detach Disk Task
POST
Virtual Machine Disable Secondary VM Task
POST
Virtual Machine Drop Connections
POST
Virtual Machine Enable Secondary VM Task
POST
Virtual Machine Estimate Storage For Consolidate Snapshots Task
POST
Virtual Machine Export Vm
POST
Virtual Machine Extract Ovf Environment
GET
Virtual Machine Get Alarm Actions Enabled
GET
Virtual Machine Get Available Field
GET
Virtual Machine Get Capability
GET
Virtual Machine Get Config
GET
Virtual Machine Get Config Issue
GET
Virtual Machine Get Config Status
GET
Virtual Machine Get Custom Value
GET
Virtual Machine Get Datastore
GET
Virtual Machine Get Declared Alarm State
GET
Virtual Machine Get Disabled Method
GET
Virtual Machine Get Effective Role
GET
Virtual Machine Get Environment Browser
GET
Virtual Machine Get Guest
GET
Virtual Machine Get Guest Heartbeat Status
GET
Virtual Machine Get Layout
GET
Virtual Machine Get Layout Ex
GET
Virtual Machine Get Name
GET
Virtual Machine Get Network
GET
Virtual Machine Get Overall Status
GET
Virtual Machine Get Parent
GET
Virtual Machine Get Parent V App
GET
Virtual Machine Get Permission
GET
Virtual Machine Get Recent Task
GET
Virtual Machine Get Resource Config
GET
Virtual Machine Get Resource Pool
GET
Virtual Machine Get Root Snapshot
GET
Virtual Machine Get Runtime
GET
Virtual Machine Get Snapshot
GET
Virtual Machine Get Storage
GET
Virtual Machine Get Summary
GET
Virtual Machine Get Tag
GET
Virtual Machine Get Triggered Alarm State
GET
Virtual Machine Get Value
POST
Virtual Machine Instant Clone Task
POST
Virtual Machine Make Primary VM Task
POST
Virtual Machine Mark As Template
POST
Virtual Machine Mark As Virtual Machine
POST
Virtual Machine Migrate VM Task
POST
Virtual Machine Mount Tools Installer
POST
Virtual Machine Power Off VM Task
POST
Virtual Machine Power On VM Task
POST
Virtual Machine Promote Disks Task
POST
Virtual Machine Put Usb Scan Codes
POST
Virtual Machine Query Changed Disk Areas
POST
Virtual Machine Query Connections
POST
Virtual Machine Query Fault Tolerance Compatibility
POST
Virtual Machine Query Fault Tolerance Compatibility Ex
POST
Virtual Machine Query Unowned Files
POST
Virtual Machine Reboot Guest
POST
Virtual Machine Reconfig VM Task
POST
Virtual Machine Refresh Storage Info
POST
Virtual Machine Reload
POST
Virtual Machine Reload Virtual Machine From Path Task
POST
Virtual Machine Relocate VM Task
POST
Virtual Machine Remove All Snapshots Task
POST
Virtual Machine Rename Task
POST
Virtual Machine Reset Guest Information
POST
Virtual Machine Reset VM Task
POST
Virtual Machine Revert To Current Snapshot Task
POST
Virtual Machine Send NMI
POST
Virtual Machine Set Custom Value
POST
Virtual Machine Set Display Topology
POST
Virtual Machine Set Screen Resolution
POST
Virtual Machine Shutdown Guest
POST
Virtual Machine Standby Guest
POST
Virtual Machine Start Recording Task
POST
Virtual Machine Start Replaying Task
POST
Virtual Machine Stop Recording Task
POST
Virtual Machine Stop Replaying Task
POST
Virtual Machine Suspend VM Task
POST
Virtual Machine Terminate Fault Tolerant VM Task
POST
Virtual Machine Terminate VM
POST
Virtual Machine Turn Off Fault Tolerance For VM Task
POST
Virtual Machine Unmount Tools Installer
POST
Virtual Machine Unregister VM
POST
Virtual Machine Upgrade Tools Task
POST
Virtual Machine Upgrade VM Task