Remote Desktop

This reference provides cmdlet descriptions and syntax for all Remote Desktop Service-specific cmdlets. It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.

remotedesktop

Add-RDServer

Adds an RDS server to a Remote Desktop deployment.

Add-RDSession Host

Adds one or more RD Session Host servers to a session collection.

Add-RDVirtual Desktop ToCollection

Adds virtual desktops to a virtual desktop collection.

Disable-RDVirtual Desktop ADMachine Account Reuse

Prevents the RD Connection Broker server from reusing existing Active Directory (AD) computer accounts.

Disconnect-RDUser

Disconnects a user from a session that runs on a remote server.

Enable-RDVirtual Desktop ADMachine Account Reuse

Configures the RD Connection Broker server to reuse existing AD DS computer accounts.

Export-RDPersonal Session Desktop Assignment

Exports the current map of personal session desktops to users.

Export-RDPersonal Virtual Desktop Assignment

Exports the current associations between users and personal virtual desktops to a file.

Get-RDAvailable App

Gets a list of publishable applications from a collection.

Get-RDCertificate

Gets certificates associated with RDS roles.

Get-RDConnection Broker High Availability

Gets high availability settings for the RD Connection Broker server in a Remote Desktop deployment.

Get-RDDeployment Gateway Configuration

Gets configuration settings for the RD Gateway for a Remote Desktop deployment.

Get-RDFile Type Association

Displays the file extensions associated with a RemoteApp program.

Get-RDLicense Configuration

Retrieves the current settings for the RD Licensing server and the licensing mode of the Remote Desktop deployment.

Get-RDPersonal Session Desktop Assignment

Gets personal session desktop assignments.

Get-RDPersonal Virtual Desktop Assignment

Retrieves a list of personal virtual desktops and associated user accounts.

Get-RDPersonal Virtual Desktop Patch Schedule

Gets a patch schedule for a virtual desktop.

Get-RDRemote App

Gets RemoteApp programs in a Remote Desktop deployment.

Get-RDRemote Desktop

Gets published Remote Desktop connections.

Get-RDServer

Gets RDS servers in a Remote Desktop deployment.

Get-RDSession Collection

Gets session collections in a Remote Desktop deployment.

Get-RDSession Collection Configuration

Gets configuration information for a session collection.

Get-RDSession Host

Gets a list of RD Session Host servers in a session collection.

Get-RDUser Session

Gets a list of all user sessions in a collection or in a Remote Desktop deployment.

Get-RDVirtual Desktop

Gets a list of virtual desktops in the remote desktop deployment.

Get-RDVirtual Desktop Collection

Gets a list of virtual desktop collections in a remote desktop deployment.

Get-RDVirtual Desktop Collection Configuration

Gets configuration details of a virtual desktop collection.

Get-RDVirtual Desktop Collection Job Status

Gets the status of a job on a virtual desktop collection.

Get-RDVirtual Desktop Concurrency

Gets the number of virtual desktops that RDS can create in parallel.

Get-RDVirtual Desktop Idle Count

Gets the number of idle virtual desktops on hosts.

Get-RDVirtual Desktop Template Export Path

Gets the export path setting of the virtual desktop template.

Get-RDWorkspace

Gets the workspace name for a Remote Desktop deployment.

Grant-RDOUAccess

Grants the Remote Desktop Connection Broker server access to one or more organizational units in a given domain of Active Directory Domain Services.

Import-RDPersonal Session Desktop Assignment

Imports a map of personal session desktops to users.

Import-RDPersonal Virtual Desktop Assignment

Imports associations between user accounts and personal virtual desktops from a text file.

Invoke-RDUser Logoff

Ends a user session and closes all running applications.

Move-RDVirtual Desktop

Moves a virtual desktop to a new Remote Desktop Virtualization Host (RD Virtualization Host) server.

New-RDCertificate

Creates a certificate for an RDS role.

New-RDPersonal Virtual Desktop Patch Schedule

Creates a patch schedule for a personal virtual desktop.

New-RDRemote App

Publishes a RemoteApp program to a Remote Desktop deployment.

New-RDSession Collection

Creates a session collection of RD Session Host servers.

New-RDSession Deployment

Installs the required role services for session-based desktop deployment.

New-RDVirtual Desktop Collection

Creates a virtual desktop collection.

New-RDVirtual Desktop Deployment

Installs role services for Virtual Desktop Infrastructure.

Remove-RDDatabase Connection String

Removes the secondary database connection string for the shared database server in a high availability environment configuration.

Remove-RDPersonal Session Desktop Assignment

Removes the association between a personal session desktop assignment and a user.

Remove-RDPersonal Virtual Desktop Assignment

Removes the association between a personal virtual desktop and a user.

Remove-RDPersonal Virtual Desktop Patch Schedule

Removes a patch schedule from a personal virtual desktop.

Remove-RDRemote App

Removes a RemoteApp program.

Remove-RDServer

Removes a server from a Remote Desktop deployment.

Remove-RDSession Collection

Removes a session collection from a Remote Desktop deployment.

Remove-RDSession Host

Removes one or more RD Session Host servers from a session collection.

Remove-RDVirtual Desktop Collection

Removes a virtual desktop collection.

Remove-RDVirtual Desktop From Collection

Removes virtual desktops from a virtual desktop collection.

Send-RDUser Message

Sends a system message to a specified user session.

Set-RDActive Management Server

Sets the active Remote Desktop Connection Broker server, or management server, in a remote desktop deployment.

Set-RDCertificate

Imports and secures a certificate to use with an RDS role.

Set-RDClient Access Name

Sets a DNS name that clients use to connect to a Remote Desktop deployment.

Set-RDConnection Broker High Availability

Sets high availability settings for RD Connection Broker servers for a Remote Desktop deployment.

Set-RDDatabase Connection String

Configures the database connection string for the database server used in a high availability environment.

Set-RDDeployment Gateway Configuration

Specifies settings for the RD Gateway server for a Remote Desktop deployment.

Set-RDFile Type Association

Changes the file type association of a RemoteApp program in a Remote Desktop deployment.

Set-RDLicense Configuration

Defines settings for the RD Licensing server and the licensing mode of the Remote Desktop deployment.

Set-RDPersonal Session Desktop Assignment

Associates a personal session desktop assignment with a user.

Set-RDPersonal Virtual Desktop Assignment

Creates an association between a personal virtual desktop and a user account.

Set-RDPersonal Virtual Desktop Patch Schedule

Changes patch schedule settings for a personal virtual desktop.

Set-RDRemote App

Modifies configuration settings for a RemoteApp program.

Set-RDRemote Desktop

Changes whether to publish a Remote Desktop to a collection.

Set-RDSession Collection Configuration

Modifies configuration options for an existing session collection.

Set-RDSession Host

Configures one or more RD Session Host servers in a session collection.

Set-RDVirtual Desktop Collection Configuration

Changes configuration settings for a virtual desktop collection.

Set-RDVirtual Desktop Concurrency

Sets the number of virtual desktops that RDS can create in parallel.

Set-RDVirtual Desktop Idle Count

Sets the maximum number of idle virtual desktops on host servers.

Set-RDVirtual Desktop Template Export Path

Sets the export path for virtual desktop templates.

Set-RDWorkspace

Assigns a workspace name for a Remote Desktop deployment.

Stop-RDVirtual Desktop Collection Job

Stops a job on a virtual desktop collection.

Test-RDOUAccess

Verifies that the Remote Desktop Connection Broker server can access an Active Directory Domain Services organizational unit.

Test-RDVirtual Desktop ADMachine Account Reuse

Detects whether the RD Connection Broker server is configured to reuse existing AD DS computer accounts.

Update-RDVirtual Desktop Collection

Associates a virtual desktop collection with a new virtual desktop template.