Edit

Update-RDVirtualDesktopCollection

  • Reference
Module:
RemoteDesktop

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

Syntax

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

Description

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

Examples

Example 1: Update a virtual desktop collection

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"

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.

Parameters

-CollectionName

Specifies the name of a virtual desktop collection.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConnectionBroker

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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableVirtualDesktopRollback

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ForceLogoffTime

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

Type:DateTime
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-StartTime

Specifies a date and time to start the operation.

Type:DateTime
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-VirtualDesktopPasswordAge

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VirtualDesktopTemplateHostServer

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

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-VirtualDesktopTemplateName

Specifies a descriptive name for the virtual desktop template.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

Object