Update-RDVirtualDesktopCollection

Update-RDVirtualDesktopCollection

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

Syntax

Parameter Set: Now
Update-RDVirtualDesktopCollection [-CollectionName] <String> -VirtualDesktopTemplateHostServer <String> -VirtualDesktopTemplateName <String> [-ConnectionBroker <String> ] [-DisableVirtualDesktopRollback] [-Force] [-VirtualDesktopPasswordAge <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: OnSchedule
Update-RDVirtualDesktopCollection [-CollectionName] <String> -ForceLogoffTime <DateTime> -VirtualDesktopTemplateHostServer <String> -VirtualDesktopTemplateName <String> [-ConnectionBroker <String> ] [-DisableVirtualDesktopRollback] [-Force] [-VirtualDesktopPasswordAge <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: OnUserLogoff
Update-RDVirtualDesktopCollection [-CollectionName] <String> -ForceLogoffTime <DateTime> -StartTime <DateTime> -VirtualDesktopTemplateHostServer <String> -VirtualDesktopTemplateName <String> [-ConnectionBroker <String> ] [-DisableVirtualDesktopRollback] [-Force] [-VirtualDesktopPasswordAge <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Update-RDVirtualDesktopCollection cmdlet associates an existing virtual desktop collection with a new virtual desktop template.

Parameters

-CollectionName<String>

Specifies the name of a virtual desktop collection.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
Accept Wildcard Characters?	false

-ConnectionBroker<String>

Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for a remote desktop deployment. If you do not specify a value, the cmdlet uses the fully qualified domain name (FQDN) of the local computer.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-DisableVirtualDesktopRollback

Indicates that the server prevents the rollback of a virtual desktop deployment.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Force

Performs the action without a confirmation message.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-ForceLogoffTime<DateTime>

Specifies a date and time by which the server ends the session if the operation is still running.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-StartTime<DateTime>

Specifies a date and time to start the operation.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VirtualDesktopPasswordAge<Int32>

Specifies the number of days after which the server forces a password update for the computer account.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VirtualDesktopTemplateHostServer<String>

Specifies the fully qualified domain name (FQDN) of the server where the virtual desktop template associated with the collection is stored.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VirtualDesktopTemplateName<String>

Specifies a descriptive name for the virtual desktop template.

Aliases	none
Required?	true
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

• System.Object

Examples

Example 1: Update a virtual desktop collection

This command updates the virtual desktop collection named "Virtual Desktop pool" with the virtual desktop template named "RDS-Template" on the host server named "rdvh-1.contoso.com".

The command specifies that the server ends the session if the update operation is still running at 12:00am. The command disables the rollback of a virtual desktop deployment and specifies that the server forces a password update for the computer account for a virtual desktop after 31 days.

PS C:\> Update-RDVirtualDesktopCollection -CollectionName "Virtual Desktop pool" VirtualDesktopTemplateName "RDS-Template" -VirtualDesktopTemplateHostServer "rdvh-1.contoso.com" -ForceLogoffTime 12:00am -DisableVirtualDesktopRollback -VirtualDesktopPasswordAge 31 -ConnectionBroker "rdcb.contoso.com"