Represents the virtualization service present on a single host system. Msvm_VirtualSystemManagementService is used to control the definition, modification, and deletion of virtual systems. It also has methods for performing operations on virtual systems, such as cloning, snapshotting, and the importing or exporting of virtual systems. To retrieve per-VM information, use Msvm_ComputerSystem and Msvm_PlannedComputerSystem.
Msvm_VirtualSystemManagementService methods
Msvm_VirtualSystemManagementService has 30 methods (30 Local)
'This API adds DH-CHAP parameters to a synthetic fibre channel port in a VM. This will fail if the VM is running.'
Values
['Completed with No Error', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
AddFibreChannelChap method is in 1 class (Msvm_VirtualSystemManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces
{'Description':'A reference to the virtual computer system on which the key-value pairs will be added.','In':True}
DataItems
string
1
✓
-
{'Description':'An array of key-value pairs to be added. Each element of the array is an embedded instance of the Msvm_KvpExchangeDataItem class. This method fails if any of the specified key-value pairs already exists on the target system. This array can contain at most 128 elements.','In':True}
{'Description':'An optional parameter for monitoring progress of the operation represented by an instance of the CIM_ConcreteJob class, which is used if the method could not be executed synchronously. If the operation is executing asynchronously, the return value is 4096.','Out':True}
Description
'Adds key-value pairs to a virtual system.'
Values
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
AddKvpItems method is in 1 class (Msvm_VirtualSystemManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces
'Adds resources to a virtual system configuration .When applied to a "state" virtual system configuration, as a side effect resources are added to the active virtual system.'
'Destroys a virtual system. The referenced virtual system is destroyed, including any elements scoped by it. Virtual resources are returned to their resource pools, which may imply the destruction of those resources (implementation dependent). If the virtual system is active when the operation is invoked, it is first deactivated and then destroyed. If snapshots were created from the virtual system, these are destroyed as well.'
{'Description':'A reference to a CIM_ComputerSystem that represents the virtual computer system to be exported.','In':True}
ExportDirectory
string
1
✓
-
{'Description':'The fully-qualified path of the directory to which the virtual computer system is to be exported. If the CreateVmExportSubdirectory property in the ExportSettingData parameter is set to True then this directory can be reused for exporting multiple virtual machines and this method places each virtual computer system definition in a separate subdirectory under this path.','In':True}
ExportSettingData
string
2
✓
-
{'Description':'An instance of Msvm_VirtualSystemExportSettingData that represents the settings for the export operation.','In':True}
{'Description':'An optional reference that is returned if the operation is executed asynchronously. If present, the returned reference to an instance of CIM_ConcreteJob can be used to monitor progress and to obtain the result of the method.','Out':True}
Description
'Exports a virtual computer system, or a snapshot of a virtual computer system, in the "powered off" or "saved" state to a file. The virtual computer system, its associated configuration settings, and its associated resource settings will be preserved in the resulting file. Return value: If this method is executed synchronously, it returns 0 if it succeeds. If this method is executed asynchronously, it returns 4096 and the Job output parameter can be used to track the progress of the asynchronous operation. Any other return value indicates an error.'
Values
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
ExportSystemDefinition method is in 1 class (Msvm_VirtualSystemManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces
{'Description':'An array of strings containing Msvm_Error instances used to generate the output error message.','In':True}
ErrorMessage
string
1
-
✓
{'Description':'On output, a string containing the error message represented by the Msvm_Error instances passed in the Errors parameter.','Out':True}
Description
'Returns the formatted error message string for the specified array of embedded Msvm_Error instances.'
Values
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
FormatError method is in 1 class (Msvm_VirtualSystemManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces
{'Description':'The number of WWPNs to be generated and returned in the output array.','In':True}
GeneratedWwpn
string
1
-
✓
{'Description':'An array of strings, each of which on success will have a generated WWPN.It will be formatted in string form as '0123456789abcdef'.','Out':True}
Description
'This API generates a requested number of WorldWidePortNames from within a preconfigured range defined by MinimumWwpnAddress and MaximumWwpnAddress properties of class Msvm_VirtualSystemManagementSettingData. The NumberOfWwpns requested per call must not be less than 1 or more than 1024. If the valid number of WWPNs that can be generated is less than the requested number, then the remaining entries in the GeneratedWwpn array will have the invalid entry of "0000000000000000" and the return value will indicate success (0).'
Values
['Completed with No Error', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
GenerateWwpn method is in 1 class (Msvm_VirtualSystemManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces
{'Description':'A string, which on success will have the value of the Current WWPN as used by the WWPN Generator. This will be the same value that will be the first WWPN generated by the subsequent call to GenerateWwpn().It will be formatted in string form as '0123456789abcdef'.','Out':True}
Description
'This API provides the ability to see the current WorldWidePortName from within a preconfigured range defined by MinimumWwpnAddress and MaximumWwpnAddress properties of class Msvm_VirtualSystemManagementSettingData. If the range as defined by these properties is exhausted, then the CurrentWwpn out parameter will have the invalid entry of "0000000000000000" and the return value will indicate success (0).'
Values
['Completed with No Error', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
GetCurrentWwpnFromGenerator method is in 1 class (Msvm_VirtualSystemManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces
{'Description':'An array of Msvm_SummaryInformation instances containing the requested information for the virtual machines and/or snapshots specified in the DefinitionFiles array. Only the Name, ElementName, CreateTime, and Notes properties are returned, all other properties are expected to be null.','Out':True}
Description
'Returns virtual system summary information for the specified virtual machine definition files.'
Values
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
GetDefinitionFileSummaryInformation method is in 1 class (Msvm_VirtualSystemManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces
{'Description':'A reference to the CIM_VirtualSystemSettingData instance whose system files size isto be retrieved. This instance may represent either the current instantiation of the virtual computer system, or an instance of a virtual computer system snapshot.','In':True}
Size
uint64
1
-
✓
{'Description':'The total size of system files.','Out':True}
Description
'Retrieves the total size of the system files. These include the configuration and saved state files.'
Values
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
GetSizeOfSystemFiles method is in 1 class (Msvm_VirtualSystemManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces
{'Description':'An array of CIM_VirtualSystemSettingData instances that specifies the virtual machines and/or snapshots for which information is to be retrieved. If this parameter is NULL, information for all virtual machines is retrieved.','In':True}
RequestedInformation
uint32
1
✓
-
{'Description':'An array of enumeration values (which correspond to the properties in the Msvm_SummaryInformation class) that specifies the data to retrieve for the virtual machines and/or snapshots specified in the SettingData array. Values in the 0-99 range apply to both virtual machines and snapshots. Values in the 100-199 range apply to virtual machines only, and will be ignored for elements of SettingData which represent snapshots. Values in the 200-299 range apply to snapshots only, and will be ignored for elements of SettingData which represent virtual machines.','In':True,'Values':['Name', 'Element Name', 'Creation Time', 'Notes', 'Number of Processors', 'Small Thumbnail Image (80x60)', 'Medium Thumbnail Image (160x120)', 'Large Thumbnail Image (320x240)', 'AllocatedGPU', 'VirtualSwitchNames', 'EnabledState', 'ProcessorLoad', 'ProcessorLoadHistory', 'MemoryUsage', 'Heartbeat', 'Uptime', 'GuestOperatingSystem', 'Snapshots', 'AsynchronousTasks', 'HealthState', 'OperationalStatus', 'StatusDescriptions', 'MemoryAvailable', 'AvailableMemoryBuffer', 'Replication Mode', 'Replication State', 'Replication HealthTest Replica System', 'Application Health', 'SwapFilesInUse', 'IntegrationServicesVersionState', 'MemorySpansPhysicalNumaNodes', 'OtherEnabledState']}
{'Description':'An array of Msvm_SummaryInformation instances containing the requested information for the virtual machines and/or snapshots specified in the SettingData array. Properties not specified in the RequestedInformation parameter will have a NULL value.','Out':True}
Description
'Returns virtual system summary information.'
Values
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
GetSummaryInformation method is in 1 class (Msvm_VirtualSystemManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces
{'Description':'A reference to the CIM_VirtualSystemSettingData instance whose thumbnail image is to be retrieved. This instance may represent either the current instantiation of the virtual computer system, or an instance of a virtual computer system snapshot.','In':True}
WidthPixels
uint16
1
✓
-
{'Description':'The width of the desired image.','In':True}
HeightPixels
uint16
2
✓
-
{'Description':'The height of the desired image.','In':True}
ImageData
uint8
3
-
✓
{'Description':'The image data.','Out':True}
Description
'Retrieves the thumbnail image of an existing virtual system. Return value: This method returns values in raw RGB 565 format.'
Values
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
GetVirtualSystemThumbnailImage method is in 1 class (Msvm_VirtualSystemManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces
{'Description':'If the operation completes synchronously, an array of references to the Msvm_VirtualSystemSettingData instances representing the snapshots which were successfully imported.'}
{'Description':'If the operation is being performed asynchronously, a reference to the job object which can be used to track the progress.'}
Description
'Searches the SnapshotFolder folder for any snapshot definition files associated with the specified planned computer system. A new snapshot is created on the planned computer system for every associated definition file in this location.'
Values
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File in Use']
ImportSnapshotDefinitions method is in 1 class (Msvm_VirtualSystemManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces
{'Description':'If the operation is being performed asynchronously, a reference to the job object which can be used to track the progress.'}
Description
'Creates a new planned computer system based on the specified virtual system definition. The specified definition files must not already be in use by the host system or the virtualization platform. The SnapshotFolder folder will be searched in order to locate any snapshots referenced by the virtual system definition. Any referenced snapshots not found in this location must be deleted using the RemoveVirtualSystemSnapshot method, or imported using the ImportSnapshotDefinitions method prior to realizing the planned computer system.'
Values
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File in Use']
ImportSystemDefinition method is in 1 class (Msvm_VirtualSystemManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces
{'Description':'An optional parameter for monitoring progress of the operation, which is used if the method could not be executed synchronously. If the operation is executing asynchronously, the return value is 4096.','Out':True}
Description
'Modifies the disk merge setting data.'
Values
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in used', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
ModifyDiskMergeSettings method is in 1 class (Msvm_VirtualSystemManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces
{'Description':'A reference to the virtual system on which the key-value pairs will be modified. ','In':True}
DataItems
string
1
✓
-
{'Description':'An array of key-value pairs to be modified. Each element of the array is an embedded instance of the Msvm_KvpExchangeDataItem class. This method fails if any of the specified key-value pairs does not exist on the target system. This array can contain at most 128 elements.','In':True}
{'Description':'An optional parameter for monitoring progress of the operation, which is used if the method could not be executed synchronously. If the operation is executing asynchronously, the return value is 4096.','Out':True}
Description
'Modifies existing key-value pairs on a virtual system.'
Values
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
ModifyKvpItems method is in 1 class (Msvm_VirtualSystemManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces
'Modifies virtual resource settings. When applied to parts of a "current" virtual system configuration, as a side effect resources of the active virtual system may be modified.'
{'Description':'An optional parameter for monitoring progress of the operation, which is used if the method could not be executed synchronously. If the operation is executing asynchronously, the return value is 4096.','Out':True}
Description
'Modifies the setting data for the service.'
Values
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
'Modifies virtual system settings. When applied to the system settings of a "current" virtual system configuration, as a side effect the virtual system instance may be modified.'
{'Description':'If the operation is being performed asynchronously, a reference to the job object which can be used to track the progress.'}
Description
'Validates the configuration of a planned virtual system and converts it to a realized virtual system. Any runtime or saved state files associated with the virtual system will be copied from the import directory to the virtual system's data root, if applicable.'
Values
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
RealizePlannedSystem method is in 1 class (Msvm_VirtualSystemManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces
'This API removes DH-CHAP parameters to a synthetic fibre channel port in a VM. This will fail if the VM is running.'
Values
['Completed with No Error', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
RemoveFibreChannelChap method is in 1 class (Msvm_VirtualSystemManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces
{'Description':'A reference to the virtual system on which the key-value pairs will be removed.','In':True}
DataItems
string
1
✓
-
{'Description':'An array of key-value pairs to be removed. Each element of the array is an embedded instance of the Msvm_KvpExchangeDataItem class. This method fails if any of the specified key-value pairs does not exist on the target system. This array can contain at most 128 elements.','In':True}
{'Description':'An optional parameter for monitoring progress of the operation, which is used if the method could not be executed synchronously. If the operation is executing asynchronously, the return value is 4096.','Out':True}
Description
'Removes existing key-value pairs from a virtual system.'
Values
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
RemoveKvpItems method is in 1 class (Msvm_VirtualSystemManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces
'Removes virtual resource settings from a virtual system configuration. When applied to parts of a "current" virtual system configuration, as a side effect resources of the active virtual system may be removed.'
{'Description':'A reference to the CIM_ComputerSystem instance whose network adapters are to be configured.','In':True}
NetworkConfiguration
string
1
✓
-
{'Description':'An array of embedded instances of Msvm_GuestNetworkAdapterConfiguration objects. Each instance describes the configuration parameters for one of the network adapters within the virtual machine. The InstanceID and DHCPEnabled properties must be specified on each instance.','In':True}
{'Description':'An optional reference that is returned if the operation is executed asynchronously. If present, the returned reference to an instance of CIM_ConcreteJob can be used to monitor progress and to obtain the result of the method.','Out':True}
Description
'Configures the network adapters within the guest operating system. These configuration parameters are applied immediately upon establishing communication with the KVP Exchange integration component running within the guest operating system.'
Values
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory']
SetGuestNetworkAdapterConfiguration method is in 1 class (Msvm_VirtualSystemManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in use', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File in Use']
ValidatePlannedSystem method is in 1 class (Msvm_VirtualSystemManagementService) of ROOT\virtualization\v2\ms_409 and in 2 namespaces
'Represents the virtualization service present on a single host system. Msvm_VirtualSystemManagementService is used to control the definition, modification, and deletion of virtual systems. It also has methods for performing operations on virtual systems, such as cloning, snapshotting, and the importing or exporting of virtual systems. To retrieve per-VM information, use Msvm_ComputerSystem and Msvm_PlannedComputerSystem.'
✗
✗
✓
✗
✓
LOCALE
1033
✗
✗
✓
✗
✓
Msvm_VirtualSystemManagementService System properties