RequestStateChange method of the Msvm_VirtualSystemSnapshotService class

  • Article

Requests a state change for the virtual system snapshot service.

Syntax

uint32 RequestStateChange(
  [in]  uint16              RequestedState,
  [out] CIM_ConcreteJob REF Job,
  [in]  datetime            TimeoutPeriod
);

Parameters

RequestedState [in]

The new state.

The possible values are:

Enabled (2)

Disabled (3)

Shut Down (4)

Offline (6)

Test (7)

Defer (8)

Quiesce (9)

Reboot (10)

Reset (11)

DMTF Reserved

12 32767

Vendor Reserved

32768 65535

Job [out]

A reference to an optional job for the operation if the operation is run asynchronously.

TimeoutPeriod [in]

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 timeout period. 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, the return code "Use Of Timeout Parameter Not Supported" must be returned.

Return value

This method returns one of the following values.

Completed with No Error (0)

Not supported (1)

Requirements
Minimum supported client
 None supported
Minimum supported server
 Windows Server 2016
Namespace
 Root\HyperVCluster\v2
MOF
WindowsHyperVCluster.V2.mof
DLL
VMMS.exe

See also

Msvm_VirtualSystemSnapshotService