Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Msvm_ShutdownComponent class

Hyper-V

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

class Msvm_ShutdownComponent : CIM_LogicalDevice
{
  string   Caption = "Shutdown";
  string   Description = "Microsoft Shutdown Service";
  string   ElementName = "Shutdown";
  datetime InstallDate;
  string   Name = "Shutdown";
  uint16   OperationalStatus[];
  string   StatusDescriptions[];
  string   Status;
  uint16   HealthState = 5;
  uint16   EnabledState;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 7;
  datetime TimeOfLastStateChange;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName;
  string   CreationClassName = "Msvm_ShutdownComponent";
  string   DeviceID = "Microsoft:VMGUID\GUID";
  boolean  PowerManagementSupported;
  uint16   PowerManagementCapabilities[];
  uint16   Availability;
  uint16   StatusInfo;
  uint32   LastErrorCode;
  string   ErrorDescription;
  boolean  ErrorCleared;
  string   OtherIdentifyingInfo[];
  uint64   PowerOnHours;
  uint64   TotalPowerOnHours;
  string   IdentifyingDescriptions[];
  uint16   AdditionalAvailability[] = 6;
  uint64   MaxQuiesceTime;
  uint16   LocationIndicator = 4;
};

Members

The Msvm_ShutdownComponent class has these types of members:

Methods

The Msvm_ShutdownComponent class has these methods.

MethodDescription
EnableDevice

This method is not supported.

InitiateShutdown

Initiates an operating system shutdown operation on associated child VM.

OnlineDevice

This method is not supported.

QuiesceDevice

This method is not supported.

RequestStateChange

This method is not supported.

Reset

This method is not supported.

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 and is always set to 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 is not used.

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 is always set to "Shutdown".

CreationClassName
Data type: string
Access type: Read-only

The scoping system's creation class name. This property is inherited from CIM_LogicalDevice and is always set to "Msvm_ShutdownComponent".

Description
Data type: string
Access type: Read-only

A textual description of the object. This property is inherited from CIM_ManagedElement and is always set to "Microsoft Shutdown Service".

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 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 user-friendly name for the object. This property is inherited from CIM_ManagedElement and it is set to "Shutdown".

EnabledDefault
Data type: uint16
Access type: Read-only

This property is inherited from CIM_EnabledLogicalElement and is always set to 7 (No Default).

EnabledState
Data type: uint16
Access type: Read-only

The enabled and disabled states of an element. This property is inherited from CIM_EnabledLogicalElement and is either set to 2 (Enabled) or 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 is not used.

ErrorDescription
Data type: string
Access type: Read-only

A free-form string that provides more information about the error recorded in the LastErrorCode property, and information on any corrective actions that may be taken. This property is inherited from CIM_LogicalDevice but is not used.

HealthState
Data type: uint16
Access type: Read-only

The current health of the element. This property is inherited from CIM_ManagedSystemElement and is always set to 5 (OK).

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 is not used.

InstallDate
Data type: datetime
Access type: Read-only

The date and time that the integration service was installed into the virtual system. This property is inherited from CIM_ManagedSystemElement.

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 is not used.

LocationIndicator
Data type: uint16
Access type: Read-only

The state of an indicator that is part of a device. This property is inherited from CIM_LogicalDevice and it is always set to 4 (Not Supported).

MaxQuiesceTime
Data type: uint64
Access type: Read-only

This property is inherited from CIM_LogicalDevice but is not used.

Name
Data type: string
Access type: Read-only

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

OperationalStatus
Data type: uint16 array
Access type: Read-only

The current status of the element. This property is inherited from CIM_ManagedSystemElement.

Windows Server 2008:  The OperationalStatus[0] property is always set to 2 (OK).

The following are the possible values for the OperationalStatus[0] property value.

ValueMeaning
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 and is always set to NULL.

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 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 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.

RequestedState
Data type: uint16
Access type: Read-only

The last requested or desired state for the element. This property is inherited from CIM_EnabledLogicalElement and is always set to 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.

Windows Server 2008:  The OperationalStatus[0] property value is always set to "OK" before Windows Server 2008 R2.

StatusInfo
Data type: uint16
Access type: Read-only

The current state of the logical device. This property is inherited from CIM_LogicalDevice but 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 and is always set to "Msvm_ComputerSystem".

SystemName
Data type: string
Access type: Read-only

The scoping system's name. This property is inherited from CIM_LogicalDevice and is the Name property of the Msvm_ComputerSystem instance associated with this heartbeat 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 and is always set to NULL.

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 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

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_LogicalDevice
Integration Services Classes

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.