Win32_TSVm class

Represents a Remote Desktop virtual machine.

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

Syntax

[dynamic, provider("Win32_TSVmHost_Prov"), AMENDMENT]
class Win32_TSVm : CIM_LogicalElement
{
  string   Caption;
  string   Description;
  datetime InstallDate;
  string   Name;
  string   Status;
  string   VmName;
  string   EnlightmentSettings;
};

Members

The Win32_TSVm class has these types of members:

Methods

The Win32_TSVm class has these methods.

Method Description
DumpVmInfo For test purposes only.
Export Gets Session Monitoring Information of the VM
QueryOfflineInformation Queries properties only when it is offline.

Properties

The Win32_TSVm class has these properties.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

Short description (one-line string) of the object.

This property is inherited from CIM_ManagedSystemElement.

Description

Data type: string

Access type: Read-only

Description of the object.

This property is inherited from CIM_ManagedSystemElement.

EnlightmentSettings

Data type: string

Access type: Read/write

Qualifiers: optional

An XML BLOB that contains the enlightenment settings for the virtual machine.

InstallDate

Data type: datetime

Access type: Read-only

Qualifiers: Mappingstrings ("MIF.DMTF|ComponentID|001.5")

The date the object was installed. A lack of a value does not indicate that the object is not installed.

This property is inherited from CIM_ManagedSystemElement.

Name

Data type: string

Access type: Read-only

The name of the object.

This property is inherited from CIM_ManagedSystemElement.

Status

Data type: string

Access type: Read-only

Qualifiers: MaxLen (10)

Current status of the object. Various operational and nonoperational statuses can be defined. Operational statuses include: "OK", "Degraded", and "Pred Fail" (an element, such as a SMART-enabled hard disk drive, may be functioning properly but predicting a failure in the near future). Nonoperational statuses include: "Error", "Starting", "Stopping", and "Service". The latter, "Service", could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither "OK" nor in one of the other states.

This property is inherited from CIM_ManagedSystemElement.

("OK")

("Error")

("Degraded")

("Unknown")

("Pred Fail")

("Starting")

("Stopping")

("Service")

VmName

Data type: string

Access type: Read-only

Qualifiers: key

The name of the virtual machine.

Requirements

Requirement Value
Minimum supported client
None supported
Minimum supported server
Windows Server 2012
Namespace
Root\CIMV2\TerminalServices
MOF
TSVmHost.mof
DLL
TSVmHostWmi.dll