Msvm_VirtualSystemManagementService class
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.
The following syntax is simplified Managed Object Format (MOF) code, and it includes all of the inherited properties.
Syntax
[Dynamic, Provider ("VmmsWmiInstanceAndMethodProvider")]
class Msvm_VirtualSystemManagementService : CIM_VirtualSystemManagementService
{
string Caption = "Virtual System Management Service";
string Description = "Service for creating, manipulating, and managing virtual systems";
string ElementName = "Virtual System Management Service";
datetime InstallDate;
uint16 OperationalStatus[] = { 2 };
string StatusDescriptions[] = { "The service is running normally" };
string Status;
uint16 HealthState = 5;
uint16 EnabledState = 2;
string OtherEnabledState;
uint16 RequestedState = 12;
uint16 EnabledDefault = 2;
datetime TimeOfLastStateChange;
string SystemCreationClassName = ;
string SystemName;
string CreationClassName = "Msvm_VirtualSystemManagementService";
string Name = "vmms";
string PrimaryOwnerName;
string PrimaryOwnerContact;
string StartMode;
boolean Started = TRUE;
};
Members
The Msvm_VirtualSystemManagementService class has these types of members:
- Methods
- Properties
Methods
The Msvm_VirtualSystemManagementService class has these methods.
| Method | Description |
|---|---|
| AddKvpItems | Adds key-value pairs to a virtual system. |
| AddVirtualSystemResources | Add resources to an existing virtual computer system. |
| ApplyVirtualSystemSnapshot | Applies the specified snapshot to the virtual computer system. |
| ApplyVirtualSystemSnapshotEx | Applies the specified snapshot to the virtual computer system. Windows Server 2008: The ApplyVirtualSystemSnapshotEx method is not supported before Windows Server 2008 R2. |
| CheckSystemCompatibilityInfo | Verifies whether this computer system is able to host the specified VM. Windows Server 2008: The CheckSystemCompatibilityInfo method is not supported before Windows Server 2008 R2. |
| CloneVirtualSystem | This method is not supported. |
| CreateVirtualSystemSnapshot | Creates a new snapshot for the virtual computer system. |
| DefineVirtualSystem | Creates a new virtual computer system definition. |
| DestroyVirtualSystem | Deletes an existing virtual computer system definition. |
| ExportVirtualSystem | Deprecated. Use the ExportVirtualSystemEx method. |
| ExportVirtualSystemEx | Exports a virtual computer system to a file. Windows Server 2008: The ExportVirtualSystemEx method is not supported before Windows Server 2008 R2. |
| FormatError | Returns the formatted error message string for the specified array of embedded Msvm_Error instances. |
| GetSummaryInformation | Returns virtual system summary information. |
| GetSystemCompatibilityInfo | Generates an opaque blob of data containing compatibility information for the specified system. Windows Server 2008: The GetSystemCompatibilityInfo method is not supported before Windows Server 2008 R2. |
| GetVirtualSystemImportSettingData | Returns an embedded instance of Msvm_VirtualSystemImportSettingData. Windows Server 2008: The GetVirtualSystemImportSettingData method is not supported before Windows Server 2008 R2. |
| GetVirtualSystemThumbnailImage | Retrieves a thumbnail image of an existing virtual computer system. |
| ImportVirtualSystem | Deprecated. Use the ImportVirtualSystemEx method. |
| ImportVirtualSystemEx | Imports a virtual computer system definition from the specified file. Windows Server 2008: The ImportVirtualSystemEx method is not supported before Windows Server 2008 R2. |
| InstantiateVirtualSystem | This method is not supported. |
| ModifyKvpItems | Modifies existing key-value pairs on a virtual computer system. |
| ModifyServiceSettings | Modifies the service's setting data. |
| ModifyVirtualSystem | Modifies the setting data for an existing virtual computer system. |
| ModifyVirtualSystemResources | Modifies the setting data for existing resources on a virtual computer system. |
| PlanVirtualSystem | This method is not supported. |
| RemoveKvpItems | Removes existing key-value pairs from a virtual computer system. |
| RemoveVirtualSystemResources | Remove resources from an existing virtual computer system. |
| RemoveVirtualSystemSnapshot | Deletes an existing snapshot from the virtual computer system. |
| RemoveVirtualSystemSnapshotTree | Removes an existing snapshot and all its children from the virtual computer system. |
| RequestStateChange | This method is not supported. |
| StartService | This method is not supported. |
| StopService | This method is not supported. |
Properties
The Msvm_VirtualSystemManagementService class has these properties.
Caption
Data type: string
Access type: Read-only
A short textual description (one-line string) of the object. This property is inherited from CIM_ManagedElement and it is always set to "Virtual System Management Service".
CreationClassName
Data type: string
Access type: Read-only
The name of the class or subclass used in the creation of an instance. This property is inherited from CIM_Service and it is always set to "Msvm_VirtualSystemManagementService".
Description
Data type: string
Access type: Read-only
A textual description of the object. This property is inherited from CIM_ManagedElement and it is always set to "Service for creating, manipulating, and managing virtual systems".
ElementName
Data type: string
Access type: Read-only
A user-friendly name for the object. This property is inherited from CIM_ManagedElement and it is always set to "Virtual System Management Service".
EnabledDefault
Data type: uint16
Access type: Read-only
An administrator's default or startup configuration for the enabled state of an element. This property is inherited from CIM_EnabledLogicalElement and it is always set to 2 (Enabled).
EnabledState
Data type: uint16
Access type: Read-only
The enabled and disabled states of an element. It can also indicate the transitions between these requested states. This property is inherited from CIM_EnabledLogicalElement and it is always set to 2 (Enabled).
HealthState
Data type: uint16
Access type: Read-only
The current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. This property is inherited from CIM_ManagedSystemElement and it is always set to 5 (OK).
InstallDate
Data type: datetime
Access type: Read-only
The date and time the virtual machine configuration was created. This property is inherited from CIM_ManagedSystemElement.
Name
Data type: string
Access type: Read-only
The label by which the object is known. This property is inherited from CIM_Service and it is always set to "vmms".
OperationalStatus
Data type: uint16 array
Access type: Read-only
The current statuses of the object. This property is inherited from CIM_ManagedSystemElement and each array element is always set to 2 (OK).
OtherEnabledState
Data type: string
Access type: Read-only
A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ("Other"). This property must be set to null when EnabledState is any value other than 1. This property is inherited from CIM_EnabledLogicalElement and it is always set to NULL.
PrimaryOwnerContact
Data type: string
Access type: Read-only
Any information about how the primary owner of the service can be reached (for example, phone number, email address, and so on). This property is inherited from CIM_Service and it is always set to NULL.
PrimaryOwnerName
Data type: string
Access type: Read-only
The name of the primary owner for the service, if one is defined. The primary owner is the initial support contact for the service. This property is inherited from CIM_Service and it is always set to NULL.
RequestedState
Data type: uint16
Access type: Read-only
The last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. A particular instance of CIM_EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ("Not Applicable") is used. This property is inherited from CIM_EnabledLogicalElement and it is always set to 12 (Not Applicable).
Started
Data type: boolean
Access type: Read-only
Indicates whether the service is currently running. This property is inherited from CIM_Service and it is always set to TRUE.
StartMode
Data type: string
Access type: Read-only
A string value that indicates whether the service is automatically started by a system, an operating system, or is started only upon request. This property is inherited from CIM_Service and it is always set to NULL.
Status
Data type: string
Access type: Read-only
This property is inherited from CIM_ManagedSystemElement but it is not used.
StatusDescriptions
Data type: string array
Access type: Read-only
Strings that describe the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement and each array element is always set to "The service is running normally".
SystemCreationClassName
Data type: string
Access type: Read-only
The scoping system's creation class name. This property is inherited from CIM_Service and it is always set to "Msvm_ComputerSystem".
SystemName
Data type: string
Access type: Read-only
The NetBIOS name of the hosting computer system. This property is inherited from CIM_Service.
TimeOfLastStateChange
Data type: datetime
Access type: Read-only
The date or time when the enabled state of the element last changed. This property is inherited from CIM_EnabledLogicalElement.
Remarks
Access to the Msvm_VirtualSystemManagementService class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.
Requirements
Minimum supported client |
None supported |
Minimum supported server |
Windows Server 2008 |
End of client support |
None supported |
End of server support |
Windows Server 2012 |
Namespace |
Root\Virtualization |
MOF |
WindowsVirtualization.mof |
See also
CIM_VirtualSystemManagementService