Msvm_TerminalConnection class

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

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 = 5;
  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

The Msvm_TerminalConnection class has these methods.

MethodDescription
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

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-only

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

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).

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).

InstallDate
Data type: datetime
Access type: Read-only

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

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

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

OtherEnabledState
Data type: string
Access type: Read-only

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

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.

Status
Data type: string
Access type: Read-only

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

StatusDescriptions
Data type: string array
Access type: Read-only

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

Namespace

Root\Virtualization

MOF

WindowsVirtualization.mof

See also

CIM_EnabledLogicalElement
Video Classes

 

 

Show: