Msvm_VirtualSystemManagementService class

Article
01/07/2021

Represents the virtualization service present on a single host system. Msvm_VirtualSystemManagementService is used to control the definition, modification, and deletion of virtual machines. It also has methods for performing operations on virtual machines, such as cloning, snapshotting, and the importing or exporting of virtual machines. To retrieve per-virtual machine 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"), AMENDMENT]
class Msvm_VirtualSystemManagementService : CIM_VirtualSystemManagementService
{
  string   InstanceID;
  string   Caption = "Virtual System Management Service";
  string   Description = "Service for creating, manipulating, and managing virtual machines";
  string   ElementName = "Hyper-V Virtual System Management Service";
  datetime InstallDate;
  string   Name = "vmms";
  uint16   OperationalStatus[] = { 2 };
  string   StatusDescriptions[] = { "The service is running normally" };
  string   Status;
  uint16   HealthState = 5;
  uint16   CommunicationStatus;
  uint16   DetailedStatus;
  uint16   OperatingStatus;
  uint16   PrimaryStatus;
  uint16   EnabledState = 2;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  uint16   AvailableRequestedStates[];
  uint16   TransitioningToState;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName;
  string   CreationClassName = "Msvm_VirtualSystemManagementService";
  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
AddBootSourceSettings	Adds boot sources to a virtual system configuration when applied to a "state" virtual system configuration.
AddFeatureSettings	Adds Ethernet feature settings to the configuration of a virtual machine Ethernet connection.
AddFibreChannelChap	Adds DH-CHAP parameters to a synthetic Fibre Channel port in a virtual machine.
AddGuestServiceSettings	Adds guest service settings to a virtual system configuration. When applied to parts of a "current" virtual system configuration, as a side effect guest services of the active virtual system may be modified.
AddKvpItems	Adds key-value pairs to a virtual machine.
AddResourceSettings	Adds resources to a virtual machine configuration.
AddSystemComponentSettings	Adds generic settings to a virtual system configuration.
DefinePlannedSystem	Defines a planned virtual system. Input that is not completely specified may be filled out with default values.
DefineSystem	Creates a new virtual machine definition.
DestroySystem	Deletes an existing virtual machine definition.
DiagnoseNetworkConnection	Diagnoses the network connectivity of a VM in a Windows Network Virtualization Environment.
ExportSystemDefinition	Exports a virtual machine, or a snapshot of a virtual machine, to a file.
FormatError	Returns a formatted error message string for the specified array of embedded Msvm_Error instances.
GenerateWwpn	Generates a set of World Wide Port Names (WWPNs).
GetCurrentWwpnFromGenerator	Provides the ability to preview the current World Wide Port Name (WWPN) without the WWPN being reserved.
GetDefinitionFileSummaryInformation	Returns virtual machine summary information for the specified virtual machine definition files.
GetSizeOfSystemFiles	Retrieves the total size of the system files of virtual machine.
GetSummaryInformation	Returns virtual machine summary information.
GetVirtualSystemThumbnailImage	Retrieves a thumbnail image of an existing virtual machine.
ImportSnapshotDefinitions	Searches the specified folder for any snapshot definition files associated with the specified planned computer system, and creates a new snapshot on the planned computer system for every associated definition file in this location.
ImportSystemDefinition	Creates a new planned computer system based on the specified virtual machine definition.
ModifyDiskMergeSettings	Modifies the disk merge setting data.
ModifyFeatureSettings	Modifies the current feature settings of a virtual machine Ethernet connection.
ModifyGuestServiceSettings	Modifies guest service settings. When applied to parts of a "current" virtual system configuration, as a side effect guest services of the active virtual system may be modified.
ModifyKvpItems	Modifies existing key-value pairs on a virtual machine.
ModifyResourceSettings	Modifies virtual resource settings.
ModifyServiceSettings	Modifies the service's setting data.
ModifySystemComponentSettings	Modifies generic system component settings.
ModifySystemSettings	Modifies virtual machine settings.
RealizePlannedSystem	Validates the configuration of a planned virtual machine and converts it to a realized virtual machine.
RemoveBootSourceSettings	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.
RemoveFeatureSettings	Removes feature settings from a virtual machine Ethernet connection.
RemoveFibreChannelChap	Removes DH-CHAP parameters from a synthetic Fibre Channel port in a virtual machine.
RemoveGuestServiceSettings	Removes guest service settings from a virtual system configuration. When applied to parts of a "current" virtual system configuration, as a side effect guest services of the active virtual system may be modified.
RemoveKvpItems	Removes existing key-value pairs from a virtual machine.
RemoveResourceSettings	Removes virtual resource settings from a virtual machine configuration.
RemoveSystemComponentSettings	Removes generic component settings from a virtual system configuration.
RequestStateChange	This method is not supported.
SetGuestNetworkAdapterConfiguration	Configures the network adapters within the guest operating system.
SetInitialMachineConfigurationData	Sets a VM's initial machine configuration data.
StartService	This method is not supported.
StopService	This method is not supported.
TestNetworkConnection	Tests the network connectivity of a VM in a Windows Network Virtualization Environment.
UpgradeSystemVersion	Upgrades the virtual system. When applied to the system settings of a "current" virtual system configuration
ValidatePlannedSystem	Validates the specified planned system.

Properties

The Msvm_VirtualSystemManagementService class has these properties.

AvailableRequestedStates

Data type: uint16 array
Access type: Read-only

Indicates the possible values for the RequestedState parameter of the RequestStateChange method. This property is inherited from CIM_EnabledLogicalElement, and it is always set to Null.

Caption

Data type: string
Access type: Read-only

A short description of the object. This property is inherited from CIM_ManagedElement, and it is always set to "Hyper-V Virtual System Management Service".

CommunicationStatus

Data type: uint16
Access type: Read-only

Indicates the ability of the instrumentation to communicate with the underlying managed element. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)
Not Available (1)
Communication OK (2)
Lost Communication (3)
No Contact (4)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )

CreationClassName

Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen ( 256 )

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 description of the object. This property is inherited from CIM_ManagedElement, and it is always set to "Service for creating, manipulating, and managing virtual machines".

DetailedStatus

Data type: uint16
Access type: Read-only

Compliments the PrimaryStatus property with additional status detail. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Not Available (0)
No Additional Information (1)
Stressed (2)
Predictive Failure (3)
Non-Recoverable Error (4)
Supporting Entity in Error (5)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )

ElementName

Data type: string
Access type: Read-only

A display name for the object. This property is inherited from CIM_ManagedElement, and it is always set to "Hyper-V 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).

Value	Meaning
2	Enabled

EnabledState

Data type: uint16
Access type: Read-only

The enabled and disabled states of an element. This property can also indicate the transitions between these requested states. This property is inherited from CIM_EnabledLogicalElement, and it is always set to 2 (Enabled).

Value	Meaning
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 nonfunctional. This property is inherited from CIM_ManagedSystemElement, and it is always set to 5 (OK).

Value	Meaning
5	The health status is normal.

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.

InstanceID

Data type: string
Access type: Read-only
Qualifiers: Key

Uniquely identifies an instance of this class. This property is inherited from CIM_ManagedElement.

Name

Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen ( 256 )

The label by which the object is known. This property is inherited from CIM_ManagedSystemElement, and it is always set to "vmms".

OperatingStatus

Data type: uint16
Access type: Read-only

Provides current status information for the operational condition of the element and can be used for providing more detail with respect to the value of the EnabledState property. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)
Not Available (1)
Servicing (2)
Starting (3)
Stopping (4)
Stopped (5)
Aborted (6)
Dormant (7)
Completed (8)
Migrating (9)
Emigrating (10)
Immigrating (11)
Snapshotting (12)
Shutting Down (13)
In Test (14)
Transitioning (15)
In Service (16)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )

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
Qualifiers: MaxLen ( 256 )

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
Qualifiers: MaxLen ( 64 )

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.

PrimaryStatus

Data type: uint16
Access type: Read-only

Provides high level status information. This property should be used in conjunction with the DetailedStatus property to provide high level and detailed health status of the element and its subcomponents. A Null value indicates that this property is not implemented. This property is inherited from CIM_ManagedSystemElement.

Unknown (0)
OK (1)
Degraded (2)
Error (3)
DMTF Reserved (..)
Vendor Reserved (0x8000.. )

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 states for an element. A particular instance of the CIM_EnabledLogicalElement class might not support the RequestedState property. 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).

Value	Meaning
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
Qualifiers: MaxLen ( 10 )

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
Qualifiers: Key, MaxLen ( 256 )

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
Qualifiers: Key, MaxLen ( 256 )

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.

TransitioningToState

Data type: uint16
Access type: Read-only

Indicates the target state to which the instance is transitioning. This property is inherited from CIM_EnabledLogicalElement, and it is always set to Null.

Remarks

Access to the Msvm_VirtualSystemManagementService class might be restricted by UAC Filtering. For more information, see User Account Control and WMI.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Namespace	Root\Virtualization\V2
MOF	WindowsVirtualization.V2.mof
DLL	Vmms.exe

Share via