Msvm_ShutdownComponent class
Represents the state of the shutdown service, which provides a mechanism to shut down the operating system of the virtual machine from the management interfaces on the host system.
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_ShutdownComponent : CIM_LogicalDevice
{
string InstanceID;
string Caption = "Shutdown";
string Description = "Microsoft Shutdown Service";
string ElementName = "Shutdown";
datetime InstallDate;
string Name = "Shutdown";
uint16 OperationalStatus[];
string StatusDescriptions[] = { "OK" };
string Status;
uint16 HealthState = 5;
uint16 CommunicationStatus;
uint16 DetailedStatus;
uint16 OperatingStatus;
uint16 PrimaryStatus;
uint16 EnabledState = 2;
string OtherEnabledState;
uint16 RequestedState = 12;
uint16 EnabledDefault = 7;
datetime TimeOfLastStateChange;
uint16 AvailableRequestedStates[];
uint16 TransitioningToState;
string SystemCreationClassName = "Msvm_ComputerSystem";
string SystemName;
string CreationClassName = "Msvm_ShutdownComponent";
string DeviceID;
boolean PowerManagementSupported;
uint16 PowerManagementCapabilities[];
uint16 Availability = 6;
uint16 StatusInfo;
uint32 LastErrorCode;
string ErrorDescription;
boolean ErrorCleared;
string OtherIdentifyingInfo[];
uint64 PowerOnHours;
uint64 TotalPowerOnHours;
string IdentifyingDescriptions[];
uint16 AdditionalAvailability[] = 6;
uint64 MaxQuiesceTime;
};
Members
The Msvm_ShutdownComponent class has these types of members:
Methods
The Msvm_ShutdownComponent class has these methods.
| Method | Description |
|---|---|
| EnableDevice | This method is not supported. |
| InitiateReboot | Initiates an operating system reboot operation on the associated child virtual machine. |
| InitiateShutdown | Initiates an operating system shutdown operation on associated child virtual machine. |
| OnlineDevice | This method is not supported. |
| QuiesceDevice | This method is not supported. |
| RequestStateChange | Requests a state change. |
| Reset | Resets the component. |
| RestoreProperties | This method is not supported. |
| SaveProperties | This method is not supported. |
| SetPowerState | This method is not supported. |
Properties
The Msvm_ShutdownComponent class has these properties.
-
AdditionalAvailability
-
-
Data type: uint16 array
-
Access type: Read-only
Additional availability and status of the device. This property is inherited from CIM_LogicalDevice.
Value Meaning - 6
Not Applicable -
-
Availability
-
-
Data type: uint16
-
Access type: Read-only
The primary availability and status of the device. This property is inherited from CIM_LogicalDevice, but it is not used.
Value Meaning - 6
Not Applicable -
-
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, but it is not used.
-
-
Caption
-
-
Data type: string
-
Access type: Read-only
A short description of the object. This property is inherited from CIM_ManagedElement.
-
-
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
The scoping system's creation class name. This property is inherited from CIM_LogicalDevice.
-
-
Description
-
-
Data type: string
-
Access type: Read-only
A description of the object. This property is inherited from CIM_ManagedElement.
-
-
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.. )
-
-
DeviceID
-
-
Data type: string
-
Access type: Read-only
An address or other identifying information to uniquely name the LogicalDevice. This property is inherited from CIM_LogicalDevice, and it is always set to "Microsoft:VMGUID\GUID" where VMGUID is the Name property of the Msvm_ComputerSystem instance associated with this device.
-
-
ElementName
-
-
Data type: string
-
Access type: Read-only
A display name for the object. This property is inherited from CIM_ManagedElement.
-
-
EnabledDefault
-
-
Data type: uint16
-
Access type: Read-only
This property is inherited from CIM_EnabledLogicalElement.
Value Meaning - 7
No Default -
-
EnabledState
-
-
Data type: uint16
-
Access type: Read-only
The enabled state of the element. This property is inherited from CIM_EnabledLogicalElement and is either set to 2 (Enabled) or 3 (Disabled).
Value Meaning - 2
Enabled - 3
Disabled -
-
ErrorCleared
-
-
Data type: boolean
-
Access type: Read-only
Indicates whether the error reported in the LastErrorCode property is now cleared. This property is inherited from CIM_LogicalDevice, but it is not used.
-
-
ErrorDescription
-
-
Data type: string
-
Access type: Read-only
A string that provides more information about the error recorded in the LastErrorCode property and information about any corrective actions that may be taken. This property is inherited from CIM_LogicalDevice, but it is not used.
-
-
HealthState
-
-
Data type: uint16
-
Access type: Read-only
The current health of the element. 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.
-
-
IdentifyingDescriptions
-
-
Data type: string array
-
Access type: Read-only
An array of free-form strings that provide explanations and details behind the entries in the OtherIdentifyingInfo array. This property is inherited from CIM_LogicalDevice, but it is not used.
-
-
InstallDate
-
-
Data type: datetime
-
Access type: Read-only
The date and time that the integration service was installed into the virtual machine. 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.
-
-
LastErrorCode
-
-
Data type: uint32
-
Access type: Read-only
The last error code reported by the logical device. This property is inherited from CIM_LogicalDevice, but it is not used.
-
-
MaxQuiesceTime
-
-
Data type: uint64
-
Access type: Read-only
This property has been deprecated. This property is inherited from CIM_LogicalDevice.
-
-
Name
-
-
Data type: string
-
Access type: Read-only
The label by which the object is known. This property is inherited from CIM_ManagedSystemElement.
-
-
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 status of the element. This property is inherited from CIM_ManagedSystemElement.
The following are the possible values for the OperationalStatus[0] property value.
Value Meaning - OK
- 2
The service is operating normally. The OperationalStatus[1] and StatusDescriptions[1] property values may contain more information. - Degraded
- 3
The service is operating normally but the guest service negotiated a compatible communications protocol version. The OperationalStatus[1] and StatusDescriptions[1] property values may contain more information. - Non-Recoverable Error
- 7
The guest does not support a compatible protocol version. The OperationalStatus[1] and StatusDescriptions[1] property values may contain more information. - No Contact
- 12
The guest service is not installed or has not yet been contacted. - Lost Communication
- 13
The guest service is no longer responding normally. -
-
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 the EnabledState property is any value other than 1. This property is inherited from CIM_EnabledLogicalElement.
-
-
OtherIdentifyingInfo
-
-
Data type: string array
-
Access type: Read-only
Any additional data, beyond device ID information, that could be used to identify a logical device. This property is inherited from CIM_LogicalDevice and is always set to Null.
-
-
PowerManagementCapabilities
-
-
Data type: uint16 array
-
Access type: Read-only
The power management capabilities of the device. This property is inherited from CIM_LogicalDevice, but it is not used.
-
-
PowerManagementSupported
-
-
Data type: boolean
-
Access type: Read-only
Indicates whether the device can be power managed. This property is inherited from CIM_LogicalDevice, but it is not used.
-
-
PowerOnHours
-
-
Data type: uint64
-
Access type: Read-only
The number of consecutive hours that this Device has been powered on since its last power cycle. This property is inherited from CIM_LogicalDevice but is not used.
-
-
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 enabled or disabled states. This property is inherited from CIM_EnabledLogicalElement, and it is always set to 12 (Not Applicable).
Value Meaning - 12
Not Applicable -
-
Status
-
-
Data type: string
-
Access type: Read-only
The current status of the object. This property is inherited from CIM_ManagedSystemElement but 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.
-
-
StatusInfo
-
-
Data type: uint16
-
Access type: Read-only
The current state of the logical device. This property is inherited from CIM_LogicalDevice, but it is not used.
-
-
SystemCreationClassName
-
-
Data type: string
-
Access type: Read-only
The scoping system's creation class name. This property is inherited from CIM_LogicalDevice.
-
-
SystemName
-
-
Data type: string
-
Access type: Read-only
The unique identifier for the scoping virtual machine. This property is inherited from CIM_LogicalDevice.
-
-
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.
-
-
TotalPowerOnHours
-
-
Data type: uint64
-
Access type: Read-only
The total number of hours that this device has been powered. This property is inherited from CIM_LogicalDevice, but it is not used.
-
-
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, but it is not used.
-
Remarks
Access to the Msvm_ShutdownComponent 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 |
|
| DLL |
|
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for