Share via


Msvm_TerminalService class

Manages all remote terminal connections to a particular host. The service uses a configurable port to initiate all terminal connections.

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_TerminalService : CIM_Service
{
  string   Caption = ;
  string   Description = "Microsoft Virtual Terminal Service";
  string   ElementName = "Microsoft Virtual Terminal Connection Management Service";
  datetime InstallDate;
  uint16   OperationalStatus[] = 2;
  string   StatusDescriptions[] = { "The virtual terminal connection management service is fully operational" };
  string   Status;
  uint16   HealthState = 5;
  uint16   EnabledState = 5;
  string   OtherEnabledState;
  uint16   RequestedState = 12;
  uint16   EnabledDefault = 2;
  datetime TimeOfLastStateChange;
  string   SystemCreationClassName = "Msvm_ComputerSystem";
  string   SystemName;
  string   CreationClassName = "Msvm_TerminalService";
  string   Name = "Microsoft Virtual Terminal Connection Management Service";
  string   PrimaryOwnerName;
  string   PrimaryOwnerContact;
  string   StartMode;
  boolean  Started;
  uint32   ListenerPort;
};

Members

The Msvm_TerminalService class has these types of members:

Methods

The Msvm_TerminalService class has these methods.

Method Description
RequestStateChange This method is not supported.
StartService This method is not supported.
StopService This method is not supported.

Properties

The Msvm_TerminalService 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 always set to "Terminal Service".

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (256)

The name of the class or subclass used in the creation of an instance. This property is inherited from CIM_Service and it is set to "Msvm_TerminalService".

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 Terminal Service".

ElementName

Data type: string

Access type: Read-only

A user-friendly name for the object. This property is inherited from CIM_ManagedElement and it is set to "Microsoft Virtual Terminal Connection Management Service" by default.

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 5 (Enabled).

Not Applicable (5)

Indicates the element does not support to be enabled or 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).

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.

ListenerPort

Data type: uint32

Access type: Read-only

The network port on which the initial remote session connection will be made.

Name

Data type: string

Access type: Read-only

Qualifiers: Key, MaxLen (256)

The label by which the object is known. This property is inherited from CIM_Service 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.

PrimaryOwnerContact

Data type: string

Access type: Read/write

Qualifiers: MaxLen (256), MappingStrings ("MIF.DMTF|General Information|001.4")

A value that provides information about how the primary owner of the service can be reached (for example, phone number, email address, and so on). This property is inherited from CIM_Service and it is set to NULL.

PrimaryOwnerName

Data type: string

Access type: Read/write

Qualifiers: MaxLen (64), MappingStrings ("MIF.DMTF|General Information|001.3")

The name of the primary owner for the service, if one is defined. The primary owner is the initial support contact for the service. This property is inherited from CIM_Service and it is 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 the RequestStateChange method. If this occurs, the value 12 (Not Applicable) is used. This property is inherited from CIM_EnabledLogicalElement and it is set to 12 (Not Applicable).

Not Applicable (12)

Indicates that this instance does not support the RequestedState property.

Started

Data type: boolean

Access type: Read-only

Qualifiers:

Indicates whether the service is currently running. This property is inherited from CIM_Service.

StartMode

Data type: string

Access type: Read-only

Qualifiers: Deprecated ("CIM_Service.EnabledDefault"), MaxLen (10)

A string value that indicates whether the service is automatically started by a system, an operating system, or is started only upon request. This property is inherited from CIM_Service and it is always set to NULL.

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 "The virtual terminal connection management service is fully operational".

SystemCreationClassName

Data type: string

Access type: Read-only

Qualifiers: Key, Propagated ("CIM_System.CreationClassName"), MaxLen (256)

The scoping system's creation class name. This property is inherited from CIM_Service and it is set to "Msvm_ComputerSystem".

SystemName

Data type: string

Access type: Read-only

Qualifiers: Key, Propagated ("CIM_System.Name"), MaxLen (256)

The name of the hosting computer system. This property is inherited from CIM_Service.

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

Remarks

Access to the Msvm_TerminalService 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

See also

CIM_Service

CIM_Service

Video Classes