Represents the state of the shutdown component, which provides a mechanism to shut down the operating system of the virtual machine from the management interfaces on the host system.
{'Description':'A flag which, if TRUE, forces applications to be closed despite having unsaved data.','In':True}
Reason
string
1
✓
-
{'Description':'The reason for the shutdown operation. This is a user-defined string.','In':True}
Bypass_GetObject
True
Description
'Initiates an operating system shutdown operation on the associated child virtual machine. If zero (0) is returned, then the shutdown was initiated successfully. Any other return code indicates an error condition.'
['Completed with No Error', 'Method Parameters Checked - Job Started', 'Failed', 'Access Denied', 'Not Supported', 'Status is unknown', 'Timeout', 'Invalid parameter', 'System is in used', 'Invalid state for this operation', 'Incorrect data type', 'System is not available', 'Out of memory', 'File not found', 'The system is not ready', 'The machine is locked and cannot be shut down without the force option', 'A system shutdown is in progress']
InitiateShutdown method is in 1 class (Msvm_ShutdownComponent) of ROOT\virtualization\v2 and in 2 namespaces
Derived methods (8) of Msvm_ShutdownComponent class
{'Description':'The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ('Completed with No Error'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values.','ModelCorrespondence':['CIM_EnabledLogicalElement.RequestedState'],'ValueMap':['2', '3', '4', '6', '7', '8', '9', '10', '11', '..', '32768..65535'],'Values':['Enabled', 'Disabled', 'Shut Down', 'Offline', 'Test', 'Defer', 'Quiesce', 'Reboot', 'Reset', 'DMTF Reserved', 'Vendor Reserved']}
{'Description':'May contain a reference to the ConcreteJob created to track the state transition initiated by the method invocation.'}
TimeoutPeriod
datetime
2
✓
-
{'Description':'A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' shall be returned.'}
{'Description':'The power state to set.','ValueMap':['1', '2', '3', '4', '5', '6'],'Values':['Full Power', 'Power Save - Low Power Mode', 'Power Save - Standby', 'Power Save - Other', 'Power Cycle', 'Power Off']}
Time
datetime
1
✓
-
{'Description':'Time indicates when the power state should be set, either as a regular date-time value or as an interval value (where the interval begins when the method invocation is received.'}
'Represents the state of the shutdown component, which provides a mechanism to shut down the operating system of the virtual machine from the management interfaces on the host system.'