Virtual Machine Get Capability

Virtual Machine Get Capability

Information about the runtime capabilities of this virtual machine.

Request
URI
GET
https://{vcenter-host}/sdk/vim25/{release}/VirtualMachine/{moId}/capability
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.2.0 APIs.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns VirtualMachineCapability of type(s) application/json
This response body class contains all of the following: DataObject
{
    "_typeName": "string",
    "snapshotOperationsSupported": false,
    "multipleSnapshotsSupported": false,
    "snapshotConfigSupported": false,
    "poweredOffSnapshotsSupported": false,
    "memorySnapshotsSupported": false,
    "revertToSnapshotSupported": false,
    "quiescedSnapshotsSupported": false,
    "disableSnapshotsSupported": false,
    "lockSnapshotsSupported": false,
    "consolePreferencesSupported": false,
    "cpuFeatureMaskSupported": false,
    "s1AcpiManagementSupported": false,
    "settingScreenResolutionSupported": false,
    "toolsAutoUpdateSupported": false,
    "vmNpivWwnSupported": false,
    "npivWwnOnNonRdmVmSupported": false,
    "vmNpivWwnDisableSupported": false,
    "vmNpivWwnUpdateSupported": false,
    "swapPlacementSupported": false,
    "toolsSyncTimeSupported": false,
    "virtualMmuUsageSupported": false,
    "diskSharesSupported": false,
    "bootOptionsSupported": false,
    "bootRetryOptionsSupported": false,
    "settingVideoRamSizeSupported": false,
    "settingDisplayTopologySupported": false,
    "recordReplaySupported": false,
    "changeTrackingSupported": false,
    "multipleCoresPerSocketSupported": false,
    "hostBasedReplicationSupported": false,
    "guestAutoLockSupported": false,
    "memoryReservationLockSupported": false,
    "featureRequirementSupported": false,
    "poweredOnMonitorTypeChangeSupported": false,
    "seSparseDiskSupported": false,
    "nestedHVSupported": false,
    "vPMCSupported": false,
    "secureBootSupported": false,
    "perVmEvcSupported": false,
    "virtualMmuUsageIgnored": false,
    "virtualExecUsageIgnored": false,
    "diskOnlySnapshotOnSuspendedVMSupported": false,
    "suspendToMemorySupported": false,
    "toolsSyncTimeAllowSupported": false,
    "sevSupported": false,
    "pmemFailoverSupported": false,
    "requireSgxAttestationSupported": false,
    "changeModeDisksSupported": false,
    "vendorDeviceGroupSupported": false
}
boolean
snapshotOperationsSupported
Required

Indicates whether or not a virtual machine supports snapshot operations.

boolean
multipleSnapshotsSupported
Required

Indicates whether or not a virtual machine supports multiple snapshots.

This value is not set when the virtual machine is unavailable, for instance, when it is being created or deleted.

boolean
snapshotConfigSupported
Required

Indicates whether or not a virtual machine supports snapshot config.

boolean
poweredOffSnapshotsSupported
Required

Indicates whether or not a virtual machine supports snapshot operations in poweredOff state.

This flag doesn't affect vim.VirtualMachine.GetSnapshot, which is always supported.

boolean
memorySnapshotsSupported
Required

Indicates whether or not a virtual machine supports memory snapshots.

boolean
revertToSnapshotSupported
Required

Indicates whether or not a virtual machine supports reverting to a snapshot.

boolean
quiescedSnapshotsSupported
Required

Indicates whether or not a virtual machine supports quiesced snapshots.

boolean
disableSnapshotsSupported
Required

Deprecated as of vSphere API 4.0. The value returned from the server is always false.

Indicates whether or not snapshots can be disabled.

boolean
lockSnapshotsSupported
Required

Indicates whether or not the snapshot tree can be locked.

boolean
consolePreferencesSupported
Required

Indicates whether console preferences can be set for this virtual machine.

boolean
cpuFeatureMaskSupported
Required

Indicates whether CPU feature requirements masks can be set for this virtual machine.

Masking for hardware version 9 and newer virtual machines is controlled by VirtualMachineCapability.featureRequirementSupported.

boolean
s1AcpiManagementSupported
Required

Indicates whether or not a virtual machine supports ACPI S1 settings management.

boolean
settingScreenResolutionSupported
Required

Indicates whether of not this virtual machine supports setting the screen resolution of the console window.

This capability depends on the guest operating system configured for this virtual machine.

boolean
toolsAutoUpdateSupported
Required

Supports tools auto-update.

boolean
vmNpivWwnSupported
Required

Supports virtual machine NPIV WWN.

boolean
npivWwnOnNonRdmVmSupported
Required

Supports assigning NPIV WWN to virtual machines that don't have RDM disks.

boolean
vmNpivWwnDisableSupported
Required

Indicates whether the NPIV disabling operation is supported the virtual machine.

boolean
vmNpivWwnUpdateSupported
Required

Indicates whether the update of NPIV WWNs are supported on the virtual machine.

boolean
swapPlacementSupported
Required

Flag indicating whether the virtual machine has a configurable swapfile placement policy.

boolean
toolsSyncTimeSupported
Required

Indicates whether asking tools to sync time with the host is supported.

boolean
virtualMmuUsageSupported
Required

Indicates whether or not the use of nested page table hardware support can be explicitly set.

boolean
diskSharesSupported
Required

Indicates whether resource settings for disks can be applied to this virtual machine.

boolean
bootOptionsSupported
Required

Indicates whether boot options can be configured for this virtual machine.

boolean
bootRetryOptionsSupported
Required

Indicates whether automatic boot retry can be configured for this virtual machine.

boolean
settingVideoRamSizeSupported
Required

Flag indicating whether the video ram size of this virtual machine can be configured.

boolean
settingDisplayTopologySupported
Required

Indicates whether of not this virtual machine supports setting the display topology of the console window.

This capability depends on the guest operating system configured for this virtual machine.

boolean
recordReplaySupported
Required

Deprecated as of vSphere API 6.0.

Indicates whether record and replay functionality is supported on this virtual machine.

boolean
changeTrackingSupported
Required

Indicates that change tracking is supported for virtual disks of this virtual machine.

However, even if change tracking is supported, it might not be available for all disks of the virtual machine. For example, passthru raw disk mappings or disks backed by any Ver1BackingInfo cannot be tracked.

boolean
multipleCoresPerSocketSupported
Required

Indicates whether multiple virtual cores per socket is supported on this VM.

boolean
hostBasedReplicationSupported
Required

Indicates that host based replication is supported on this virtual machine.

However, even if host based replication is supported, it might not be available for all disk types. For example, passthru raw disk mappings can not be replicated.

boolean
guestAutoLockSupported
Required

Indicates whether features like guest OS auto-lock and MKS connection controls are supported for this virtual machine.

boolean
memoryReservationLockSupported
Required

Indicates whether memoryReservationLockedToMax may be set to true for this virtual machine.

boolean
featureRequirementSupported
Required

Indicates whether featureRequirement feature is supported.

boolean
poweredOnMonitorTypeChangeSupported
Required

Indicates whether a monitor type change is supported while this virtual machine is in the poweredOn state.

boolean
seSparseDiskSupported
Required

Indicates whether this virtual machine supports the Flex-SE (space-efficient, sparse) format for virtual disks.

boolean
nestedHVSupported
Required

Indicates whether this virtual machine supports nested hardware-assisted virtualization.

boolean
vPMCSupported
Required

Indicates whether this virtual machine supports virtualized CPU performance counters.

boolean
secureBootSupported
Optional

Indicates whether secureBoot is supported for this virtual machine.

boolean
perVmEvcSupported
Optional

Indicates whether this virtual machine supports Per-VM EVC mode.

boolean
virtualMmuUsageIgnored
Optional

Indicates that VirtualMachineFlagInfo.virtualMmuUsage is ignored by this virtual machine, always operating as if "on" was selected.

boolean
virtualExecUsageIgnored
Optional

Indicates that VirtualMachineFlagInfo.virtualExecUsage is ignored by this virtual machine, always operating as if "hvOn" was selected.

boolean
diskOnlySnapshotOnSuspendedVMSupported
Optional

Indicates whether this virtual machine supports creating disk-only snapshots in suspended state.

If this capability is not set, the snapshot of a virtual machine in suspended state will always include memory.

boolean
suspendToMemorySupported
Optional

Indicates whether this virtual machine supports suspending to memory.

Since: vSphere API Release 7.0.2.0

boolean
toolsSyncTimeAllowSupported
Optional

Indicates support for allowing or disallowing all tools time sync with host.

Since: vSphere API Release 7.0.1.0

boolean
sevSupported
Optional

Indicates support for AMD-SEV (Secure Encrypted Virtualization).

SEV is supported when set to true, and unsupported otherwise.

Since: vSphere API Release 7.0.1.0

boolean
pmemFailoverSupported
Optional

Indicates support for failover to a dfferent host on VM's with pmem.

Failover is supported when set to true, and unsupported otherwise.

Since: vSphere API Release 7.0.2.0

boolean
requireSgxAttestationSupported
Optional

Whether the VM supports requiring SGX remote attestation.

Since: vSphere API Release 8.0.0.1

boolean
changeModeDisksSupported
Optional

Indicates support for change mode on virtual disks

Since: vSphere API Release 8.0.0.1

boolean
vendorDeviceGroupSupported
Optional

Indicates support for Vendor Device Groups

Since: vSphere API Release 8.0.1.0


Virtual Machine 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