Win32_RDMSVirtualDesktop class

Represents a virtual desktop.

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

Syntax

[dynamic, provider("Win32_RDManagement_Prov"), AMENDMENT]
class Win32_RDMSVirtualDesktop
{
  string Name;
  string HostName;
  uint32 Status;
  string CollectionAlias;
  string SessionState;
  string SessionUserName;
  string UserName;
  string UserDomain;
  uint32 VMState;
};

Members

The Win32_RDMSVirtualDesktop class has these types of members:

Methods

The Win32_RDMSVirtualDesktop class has these methods.

Method Description
GetUserAssignment Retrieves the username and domain name of the user that is assigned to the virtual desktop.
GetVirtualDesktopAssignedToUser Retrieves the virtual desktop that is assigned to the specified user.
GetVirtualDesktopDetails Retrieves the additional information about the virtual desktop.
GetVirtualDesktopState Retrieves the state of the virtual desktop.
RemoveUserAssignment Removes the user assignment from the virtual desktop.
SetUserAssignment Assigns a virtual desktop to a user.
SetVirtualDesktopState Updates the state of the virtual desktop.

Properties

The Win32_RDMSVirtualDesktop class has these properties.

CollectionAlias

Data type: string

Access type: Read-only

Qualifiers: optional

Gets the alias to the virtual desktop collection that manages the virtual machine.

HostName

Data type: string

Access type: Read-only

Gets the name of the machine that hosts the virtual machine.

Name

Data type: string

Access type: Read-only

Qualifiers: key

Gets the name of the of virtual machine.

SessionState

Data type: string

Access type: Read-only

Qualifiers: optional

Gets the state of the virtual desktop session.

SessionUserName

Data type: string

Access type: Read-only

Qualifiers: optional

Gets the username of the user that is logged in to the virtual desktop session.

Status

Data type: uint32

Access type: Read-only

Gets the status of the virtual machine.

UserDomain

Data type: string

Access type: Read-only

Qualifiers: optional

Gets the domain name of the user that is assigned to the virtual desktop.

UserName

Data type: string

Access type: Read-only

Qualifiers: optional

Gets the username of the user that is assigned to the virtual desktop.

VMState

Data type: uint32

Access type: Read-only

Gets the state of the virtual desktop.

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2012
Namespace
Root\cimv2\rdms
MOF
RDManagement.mof
DLL
RDMS.dll

See also

Remote Desktop Management Services Provider