OfflineAction
Defines the operation that is performed on the Virtual Machine (VM) for an Offline call on the VM resource instance. The following table summarizes the attributes of the OfflineAction property.
| Attribute | Value |
|---|---|
| Data type | DWORD |
| Access | Read/write |
| Status | Required |
| Structure | CLUSPROP_DWORD |
| Minimum | 0 |
| Maximum | 3 |
| Default | 1 |
Remarks
The following table summarizes the values for OfflineAction.
| Name | Value | Description |
|---|---|---|
| Turn Off |
0 |
The VM is turned off. |
| Save |
1 (Default) |
The VM is saved. |
| Shutdown |
2 |
The guest operating system running in the VM is shut down. This requires that the guest operating system has the shutdown integration component installed. For more information on the shutdown integration component see the Msvm_ShutdownComponent and Msvm_ShutdownComponentSettingData classes. |
| Shutdown (Forced) |
3 |
The Windows guest operating system running in the VM is shut down forcibly. For more information see the EWX_FORCE option flag on the ExitWindowsEx function page. This requires that the guest operating system has the shutdown integration component installed. |
Examples
The property value portion of a property list entry for ShareFlags can be set with the following example code.
DWORD OfflineActionData = 2;
CLUSPROP_DWORD OfflineActionValue;
OfflineActionValue.Syntax.dw = CLUSPROP_SYNTAX_LIST_VALUE_DWORD;
OfflineActionValue.cbLength = sizeof(DWORD);
OfflineActionValue.dw = OfflineActionData;
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2008 Datacenter, Windows Server 2008 Enterprise |