Msvm_TerminalConnection class

Articolo
05/31/2018

Indicates the state of an active remote session interacting with a virtual computer system. There can only be one connection at a time.

The following syntax is simplified Managed Object Format (MOF) code, and it includes all of the inherited properties.

Syntax

[Dynamic, Provider("VmmsWmiInstanceAndMethodProvider"), AMENDMENT]
class Msvm_TerminalConnection : CIM_EnabledLogicalElement
{
  string   Caption = "Microsoft Virtual Machine Terminal Connection";
  string   Description = "Microsoft Virtual Machine Terminal Connection";
  string   ElementName = "Microsoft Virtual Machine Terminal Connection";
  datetime InstallDate;
  string   Name = "Microsoft Virtual Machine Terminal Connection";
  uint16   OperationalStatus[] = 2;
  string   StatusDescriptions[] = { "OK" };
  string   Status;
  uint16   HealthState = 5;
  uint16   EnabledState = 2;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  string   ConnectionID = "Microsoft:VMID\Index";
};

Members

The Msvm_TerminalConnection class has these types of members:

Methods
Properties

Methods

The Msvm_TerminalConnection class has these methods.

Method	Description
RequestStateChange	The input parameter may be any value described in the RequestedState property. This method returns 0 (Success) or 4096 (Job Started).

Properties

The Msvm_TerminalConnection class has these properties.

Caption

Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

A short textual description (one-line string) of the object. This property is inherited from CIM_ManagedElement and it is set to "Microsoft Virtual Machine Terminal Connection".

ConnectionID

Data type: string
Access type: Read-only
Qualifiers: Key

The unique identifier for an instance of the terminal connection object. The identifier is of the form "Microsoft:VMID\Index". For example, "Microsoft:67A5D397-A02D-11DB-AC13-001676AA34F0\0".

Description

Data type: string
Access type: Read-only

A textual description of the object. This property is inherited from CIM_ManagedElement and it is always set to "Microsoft Virtual Machine Terminal Connection".

ElementName

Data type: string
Access type: Read-only

This property is inherited from CIM_ManagedElement and it is set to "Microsoft Virtual Machine Terminal Connection".

EnabledDefault

Data type: uint16
Access type: Read/write

An administrator's default or startup configuration for the enabled state of an element. This property is inherited from CIM_EnabledLogicalElement and it is always set to 2 (Enabled).

EnabledState

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.OtherEnabledState")

The enabled and disabled states of an element. It can also indicate the transitions between these requested states. This property is inherited from CIM_EnabledLogicalElement and it is set to 2 (Enabled) or 3 (Disabled).

Enabled (2)

Indicates that the element executes or could execute commands, processes any queued commands, and queues new requests.

HealthState

Data type: uint16
Access type: Read-only

The current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. This property is inherited from CIM_ManagedSystemElement and it is always set to 5 (OK).

OK (5)

The element is fully functional and operates within normal operational parameters and without error.

InstallDate

Data type: datetime
Access type: Read-only
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")

The date and time the virtual machine configuration was created. This property is inherited from CIM_ManagedSystemElement.

Name

Data type: string
Access type: Read-only
Qualifiers: MaxLen (1024)

The label by which the object is known. This property is inherited from CIM_ManagedSystemElement and it is the same as the ElementName property.

OperationalStatus

Data type: uint16 array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")

The current statuses of the object. This property is inherited from CIM_ManagedSystemElement and each array element is always set to 2 (OK).

OK (2)

Indicates full functionality without errors.

OtherEnabledState

Data type: string
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

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 EnabledState is any value other than 1. This property is inherited from CIM_EnabledLogicalElement and it is always set to NULL.

RequestedState

Data type: uint16
Access type: Read-only
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")

The last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. A particular instance of CIM_EnabledLogicalElement might not support RequestStateChange. If this occurs, the value 12 (Not Applicable) is used. This property is inherited from CIM_EnabledLogicalElement.

The possible values are.

Unknown (0)

Indicates the last requested state for the element is unknown.

Enabled (2)

Indicates that the element executes or could execute commands, processes any queued commands, and queues new requests.

Disabled (3)

Indicates a request to immediately disable the element, such that it does not execute or accept any commands or processing requests.

Shut Down (4)

Indicates a request for an orderly transition to the Disabled state, and might require you to shut off the power to completely erase any existing state.

No Change (5)

No state change has been requested.

Offline (6)

Indicates a request to change to the Enabled but Offline state.

Test (7)

Indicates that the element is in a test state.

Deferred (8)

Indicates that the element might be completing commands, but that it queues any new requests.

Quiesce (9)

Indicates that the element is enabled but is in a restricted mode.

Reboot (10)

Indicates a request to shut down and then change to an Enabled state.

Reset (11)

Indicates a request to change to a Disabled state and then change to an Enabled state.

Not Applicable (12)

Indicates that this instance does not support the RequestedState property.

DMTF Reserved

Reserved.

Vendor Reserved

Reserved.

Status

Data type: string
Access type: Read-only
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)

This property is inherited from CIM_ManagedSystemElement but it is not used.

StatusDescriptions

Data type: string array
Access type: Read-only
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")

Strings that describe the various OperationalStatus array values. This property is inherited from CIM_ManagedSystemElement and each array element is always set to "OK".

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

Remarks

Access to the Msvm_TerminalConnection 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 R2
Namespace	Root\Virtualization
MOF	WindowsVirtualization.mof

Condividi tramite