CIM_VirtualSystemManagementService class
Represents a service that manages virtual systems.
The following syntax is simplified from MOF code and includes all inherited properties.
Syntax
[Abstract, AMENDMENT]
class CIM_VirtualSystemManagementService : CIM_Service
{
string Caption;
string Description;
string ElementName;
datetime InstallDate;
uint16 OperationalStatus[];
string StatusDescriptions[];
string Status;
uint16 HealthState;
uint16 EnabledState = 5;
string OtherEnabledState;
uint16 RequestedState = 12;
uint16 EnabledDefault = 2;
datetime TimeOfLastStateChange;
string SystemCreationClassName;
string SystemName;
string CreationClassName;
string Name;
string PrimaryOwnerName;
string PrimaryOwnerContact;
string StartMode;
boolean Started;
};
Members
The CIM_VirtualSystemManagementService class has these types of members:
Methods
The CIM_VirtualSystemManagementService class has these methods.
| Method | Description |
|---|---|
| ApplyVirtualSystemSnapshot | Applies the specified snapshot to the virtual computer system. |
| CloneVirtualSystem | This method is not supported. |
| CreateVirtualSystemSnapshot | Creates a new snapshot for the virtual computer system. |
| DefineVirtualSystem | Defines the specified virtual system. |
| DestroyVirtualSystem | Destroys the specified virtual system. |
| ExportVirtualSystem | This method has been deprecated. |
| ImportVirtualSystem | This method has been deprecated. |
| InstantiateVirtualSystem | This method is not supported. |
| 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. |
| RemoveVirtualSystemSnapshot | Deletes an existing snapshot from the virtual computer system. |
| RequestStateChange | Requests that the state of the element be changed to the specified value. This method is inherited from CIM_EnabledLogicalElement. |
| StartService | Starts the service. This method is inherited from CIM_Service. |
| StopService | Stops the service. This method is inherited from CIM_Service. |
Properties
The CIM_VirtualSystemManagementService class has these properties.
-
Caption
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
A short textual description of the object.
This property is inherited from CIM_ManagedElement.
-
-
CreationClassName
-
The class name used to create an instance of this class. CreationClassName is combined with other key properties of this class to uniquely identify instances of this class and its subclasses.
This property is inherited from CIM_Service.
-
Description
-
-
Data type: string
-
Access type: Read-only
A textual description of the object.
This property is inherited from CIM_ManagedElement.
-
-
ElementName
-
-
Data type: string
-
Access type: Read-only
A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information.
This property is inherited from CIM_ManagedElement.
-
-
EnabledDefault
-
-
Data type: uint16
-
Access type: Read/write
Indicates an administrator's default or startup configuration for the enabled state of an element. The default value Enabled (2).
This property is inherited from CIM_EnabledLogicalElement.
The possible values are.
-
-
Enabled (2)
-
Disabled (3)
-
Not Applicable (5)
-
Enabled but Offline (6)
-
No Default (7)
-
Quiesce (9)
-
DMTF Reserved
- 10 32767
-
Vendor Reserved
- 32768 65535
EnabledState
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.OtherEnabledState")
Indicates the enabled state of an element. Possible values include the transitions between states. For example, Shutting Down (4) and Starting (10) are transient states between Enabled and Disabled.
This property is inherited from CIM_EnabledLogicalElement.
The possible values are.
Unknown (0)
Indicates that the state of the element is unknown.
Other (1)
Indicates that the state of the element is described in the OtherEnabledState property.
Enabled (2)
Indicates that the element executes or could execute commands, processes any queued commands, and queues new requests.
Disabled (3)
Indicates that the element does not execute commands and that it drops any new requests.
Shutting Down (4)
Indicates that the element is in the process of changing to a Disabled state.
Not Applicable (5)
Indicates the element does not support to be enabled or disabled.
Enabled but Offline (6)
Indicates that the element might be completing commands and that it drops any new requests.
In Test (7)
Indicates that the element is in a test state.
Deferred (8)
Indicates that the element might be completing commands, but that it queues any new requests.
Quiesce (9)
Indicates that the element is enabled but is in a restricted mode.
Starting (10)
Indicates that the element is in the process of changing to an Enabled state. New requests are queued.
DMTF Reserved
Reserved.
Vendor Reserved
Reserved.
HealthState
-
Data type: uint16
-
Access type: Read-only
Indicates the current health of the element. This attribute expresses the health of this element, but not necessarily the health of its subcomponents.
This property is inherited from CIM_ManagedSystemElement.
Unknown (0)
The implementation cannot report on HealthState at this time.
OK (5)
The element is fully functional and operates within normal operational parameters and without error.
Degraded/Warning (10)
The element is in working order, and all functionality is provided. However, the element does not function to the best of its abilities. For example, the element might not operate at optimal performance, or it might report recoverable errors.
Minor failure (15)
All functionality is available, but some functionality might be degraded.
Major failure (20)
The element is failing. It is possible that some or all of the functionality of this component is degraded or does not work.
Critical failure (25)
The element is nonfunctional, and recovery might not be possible.
Non-recoverable error (30)
The element has completely failed, and recovery is not possible. All functionality that this element provides has been lost.
DMTF Reserved
Reserved.
InstallDate
-
Data type: datetime
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")
Indicates when the object was installed. The lack of a value does not indicate that the object is not installed.
This property is inherited from CIM_ManagedSystemElement.
Name
A unique identifier of the service that indicates the functionality of the service.
This property is inherited from CIM_Service.
OperationalStatus
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")
Contains indicators of the current status of the element. The first value of the OperationalStatus property should contain the primary status for the element.
Note
The OperationalStatus property replaces the deprecated Status property. Due to the widespread use of the existing Status property in management applications, we strongly recommend that providers or instrumentation provide both the Status and OperationalStatus properties. When instrumented, Status, because it is a single-valued property, should also provide the primary status of the element.
This property is inherited from CIM_ManagedSystemElement.
The possible values are.
Unknown (0)
Indicates that the implementation cannot report on the OperationalStatus property at this time.
Other (1)
Indicates an undefined state.
OK (2)
Indicates full functionality without errors.
Degraded (3)
Indicates that the element is in working order and that all functionality is provided. However, the element does not function to the best of its abilities. For example, the element might not operate at optimal performance, or it might report recoverable errors.
Stressed (4)
Indicates that the element functions, but requires attention. Overload and overheated are examples of Stressed states.
Predictive Failure (5)
Indicates that an element functions nominally, but predicts a failure in the near future.
Error (6)
Indicates that an error has occurred.
Non-Recoverable Error (7)
Indicates that a nonrecoverable error has occurred.
Starting (8)
Indicates that the job is starting.
Stopping (9)
Indicates that the job is stopping.
Stopped (10)
Indicates that the element has been intentionally stopped.
In Service (11)
Indicates that the element is in process to be configured, maintained, cleaned, or otherwise administered.
No Contact (12)
Indicates that the monitoring system has information about this element, but has never been able to establish communications with it.
Lost Communication (13)
Indicates that the monitoring system has successfully contacted this element in the past, but it is currently unavailable.
Aborted (14)
Indicates that the job stopped in an unexpected way. The state and configuration of the job might require an update.
Dormant (15)
Indicates that the job is inactive.
Supporting Entity in Error (16)
Indicates that an element on which this job depends is in error. This element might be OK but cannot function because of the state of a dependent element. An example is a network service or endpoint that cannot function due to lower-layer networking problems.
Completed (17)
Indicates that the job has completed its operation. This value should be combined with either OK, Error, or Degraded to indicate to a client whether the complete operation Completed with OK and passed, or completed with Error and failed, or completed with Degraded and finished the operation, but did not complete OK or did not report an error.
Power Mode (18)
Indicates that the element has additional power model information that is contained in the associated power management service.
DMTF Reserved
Reserved.
Vendor Reserved
Reserved.
OtherEnabledState
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")
Describes the state of the element when the value of the EnabledState property is Other. This property must be set to NULL when EnabledState is not Other.
This property is inherited from CIM_EnabledLogicalElement.
PrimaryOwnerContact
-
Data type: string
-
Access type: Read/write
-
Qualifiers: MaxLen (256), MappingStrings ("MIF.DMTF|General Information|001.4")
Contact information for the primary owner of the service.
This property is inherited from CIM_Service.
PrimaryOwnerName
-
Data type: string
-
Access type: Read/write
-
Qualifiers: MaxLen (64), MappingStrings ("MIF.DMTF|General Information|001.3")
The name of the primary owner of the service.
This property is inherited from CIM_Service.
RequestedState
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")
Indicates the last requested state for the element. The current state is indicated by the EnabledState property. This property enables you to compare the last requested and current states.
Note
When the value of the EnabledState property is Not Applicable, this property has no meaning.
This property is inherited from CIM_EnabledLogicalElement.
The possible values are.
Unknown (0)
Indicates the last requested state for the element is unknown.
Enabled (2)
Indicates that the element executes or could execute commands, processes any queued commands, and queues new requests.
Disabled (3)
Indicates a request to immediately disable the element, such that it does not execute or accept any commands or processing requests.
Shut Down (4)
Indicates a request for an orderly transition to the Disabled state, and might require you to shut off the power to completely erase any existing state.
No Change (5)
No state change has been requested.
Offline (6)
Indicates a request to change to the Enabled but Offline state.
Test (7)
Indicates that the element is in a test state.
Deferred (8)
Indicates that the element might be completing commands, but that it queues any new requests.
Quiesce (9)
Indicates that the element is enabled but is in a restricted mode.
Reboot (10)
Indicates a request to shut down and then change to an Enabled state.
Reset (11)
Indicates a request to change to a Disabled state and then change to an Enabled state.
Not Applicable (12)
Indicates that this instance does not support the RequestedState property.
DMTF Reserved
Reserved.
Vendor Reserved
Reserved.
Started
-
Data type: boolean
-
Access type: Read-only
true if the service has been started; otherwise, false.
This property is inherited from CIM_Service.
StartMode
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_Service.EnabledDefault"), MaxLen (10)
This property is deprecated. Instead, use the EnabledDefault property that is inherited from CIM_EnabledLogicalElement.
Note
Deprecated description: Indicates whether the service is automatically started (for example, by an operating system) or only started upon request.
This property is inherited from CIM_Service.
Status
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)
Indicates the primary status of the object.
Note
This property is deprecated. It is replaced by the OperationalStatus property. If you choose to use the Status property for backward compatibility, it should be secondary to the OperationalStatus property.
This property is inherited from CIM_ManagedSystemElement.
StatusDescriptions
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")
Indicates descriptions of the corresponding values in the OperationalStatus array. For example, if an element in the OperationalStatus property contains the value Stopping, then the element at the same array index in this property might contain an explanation as to why an object is being stopped.
This property is inherited from CIM_ManagedSystemElement.
SystemCreationClassName
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key, Propagated ("CIM_System.CreationClassName"), MaxLen (256)
The class name used to create an instance of the system that contains the service. SystemCreationClassName is combined with other key properties of this class to uniquely identify instances of this class and its subclasses.
This property is inherited from CIM_Service.
SystemName
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key, Propagated ("CIM_System.Name"), MaxLen (256)
The name of the scoping system.
This property is inherited from CIM_Service.
TimeOfLastStateChange
-
Data type: datetime
-
Access type: Read-only
Indicates when the element last changed state. If the state of the element has not changed and this property is populated, then it must be set to a zero interval value. If a state change was requested, but was rejected or is not yet processed, the property must not be updated.
This property is inherited from CIM_EnabledLogicalElement.
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 R2 |
| Namespace |
Root\virtualization |
| MOF |
|