Defines a planned virtual system.
Input that is not completely specified may be filled out with default values.
Syntax
uint32 DefinePlannedSystem(
[in] string SystemSettings,
[in] string ResourceSettings[],
[in] CIM_VirtualSystemSettingData REF ReferenceConfiguration,
[out] CIM_ComputerSystem REF ResultingSystem,
[out] CIM_ConcreteJob REF Job
);
Parameters
SystemSettings [in]
The system settings for the virtual system.
ResourceSettings [in]
The resource settings for the virtual system.
ReferenceConfiguration [in]
A CIM_VirtualSystemSettingData containing the reference configuration.
ResultingSystem [out]
A CIM_ComputerSystem containing the resulting system.
Job [out]
If the operation is performed asynchronously, this method will return 4096, and this parameter will contain a reference to an object derived from CIM_ConcreteJob.
Return value
On success, returns 0 or 4096; otherwise, returns an error.
Completed with No Error (0)
Not Supported (1)
Failed (2)
Timeout (3)
Invalid Parameter (4)
DMTF Reserved (..)
Method Parameters Checked - Job Started (4096)
Method Reserved (4097..32767)
Vendor Specific (32768..65535)
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 10 [desktop apps only] |
| Minimum supported server | Windows Server 2016 |
| Namespace | Root\virtualization\v2 |
| MOF | WindowsVirtualization.V2.mof |
| DLL | Vmms.exe |
See also
Msvm_VirtualSystemManagementService
Source: Microsoft Learn / Windows Win32 documentation by Microsoft and contributors. Documentation licensed CC BY 4.0. Code samples are covered by the MIT License. Converted from Markdown, with links normalized and embedded media omitted.
