Represents a keyboard device.Keyboards are logical devices that are always present in a virtual system, and thus are not allocated through a resource pool. One instance is always present in a virtual computer system.
{'Description':'The virtual key code of the key to query.','In':True}
keyState
boolean
1
-
✓
{'Description':'The current down state of the key. A TRUE value means the key is down.','Out':True}
Bypass_GetObject
True
Description
'Retrieves the key state of a key. The IsKeyPressed method will always return FALSE for the VK_MENU (18), VK_CONTROL (17),and VK_SHIFT (16) keys because these are not real keys on a keyboard. These virtual key codes are always mapped to VK_LMENU (164), VK_LCONTROL (162), and VK_LSHIFT (160), respectively, by the PressKey and ReleaseKey methods. Return value: A return value of zero indicates success. A non-zero value indicates a failure to query the key state.'
['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']
IsKeyPressed method is in 1 class (Msvm_Keyboard) of ROOT\virtualization\v2 and in 2 namespaces
{'Description':'The virtual key code of the key to press.','In':True}
Bypass_GetObject
True
Description
'Simulates a key press. When successful the key will be in the down state. The PressKey method maps references to the VK_MENU (18), VK_CONTROL (17), and VK_SHIFT (16) to VK_LMENU (164), VK_LCONTROL (162), and VK_LSHIFT (160), respectively, because the VK_MENU, VK_CONTROL, and VK_SHIFT virtual key codes do not represent real keys on a keyboard. Return value: A return value of zero indicates success. A non-zero value indicates a failure to modify the key state.'
['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']
PressKey method is in 1 class (Msvm_Keyboard) of ROOT\virtualization\v2 and in 2 namespaces
{'Description':'The virtual key code of the key to release.','In':True}
Bypass_GetObject
True
Description
'Simulates a key release. When successful, the key will be in the up state. The ReleaseKey method maps references to the VK_MENU (18), VK_CONTROL (17), and VK_SHIFT (16) to VK_LMENU (164), VK_LCONTROL (162), and VK_LSHIFT (160), respectively, because the VK_MENU, VK_CONTROL, and VK_SHIFT virtual key codes do not represent real keys on a keyboard. Return value: A return value of zero indicates success. A non-zero value indicates a failure to modify the key state.'
['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']
ReleaseKey method is in 1 class (Msvm_Keyboard) of ROOT\virtualization\v2 and in 2 namespaces
['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']
TypeCtrlAltDel method is in 1 class (Msvm_Keyboard) of ROOT\virtualization\v2 and in 2 namespaces
{'Description':'The virtual key code of the key to press.','In':True}
Bypass_GetObject
True
Description
'Simulates a press-release key sequence. Return value: A return value of zero indicates success. A non-zero value indicates a failure to modify the key state.'
['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']
TypeKey method is in 1 class (Msvm_Keyboard) of ROOT\virtualization\v2 and in 2 namespaces
['Completed with No Error', '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']
TypeScancodes method is in 1 class (Msvm_Keyboard) of ROOT\virtualization\v2 and in 2 namespaces
{'Description':'The series of ASCII text characters to type.','In':True}
Bypass_GetObject
True
Description
'Simulates a series of typed ASCII characters. This routine may not be used to simulate the input of non-ASCII characters. Return value: A return value of zero indicates success. A return value of one indicates a failure because of non-translatable characters in the input string. All other non-zero value indicates a failure to modify the key state.'
['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']
TypeText method is in 1 class (Msvm_Keyboard) of ROOT\virtualization\v2 and in 2 namespaces
{'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 a keyboard device.Keyboards are logical devices that are always present in a virtual system, and thus are not allocated through a resource pool. One instance is always present in a virtual computer system.'