DefinePlannedSystem method of the Msvm_VirtualSystemManagementService class
Defines a planned virtual system.
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]
-
An embedded instance of CIM_VirtualSystemSettingData that defines attributes of the virtual system.
-
ResourceSettings [in]
-
An array that contains embedded instances of CIM_ResourceAllocationSettingData for the virtual resource of the new virtual system.
-
ReferenceConfiguration [in]
-
A reference to the CIM_VirtualSystemSettingData instance that is the top level object of the reference configuration for the virtual system. The reference configuration is used to complement the configuration of the new virtual system if the SystemSettings and ResourceSettings parameters do not enough information.
-
ResultingSystem [out]
-
A reference to the CIM_ComputerSystem instance that represents the newly defined virtual system.
-
Job [out]
-
A reference to an optional job for the operation if the operation is run asynchronously.
If a job is used, the CIM_ComputerSystem instance that represents the newly defined virtual system can be retrieved with the AffectedElement property of the associated CIM_AffectedJobElement instance.
Return value
The possible values are:
-
Completed with No Error (0)
-
Not Supported (1)
-
Failed (2)
-
Timeout (3)
-
Invalid Parameter (4)
-
DMTF Reserved (5 4095)
-
Method Parameters Checked - Job Started (4096)
-
Method Reserved (4097 32767)
-
Vendor Specific (32768 65535)
Remarks
Default values for this class can be applied to properties that aren't specified.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2016 |
| Namespace |
Root\HyperVCluster\v2 |
| MOF |
|
| DLL |
|