Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Update-RDVirtualDesktopCollection

Update-RDVirtualDesktopCollection

remotedesktop.psm1

Synopsis

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

Syntax

Update-RDVirtualDesktopCollection [-CollectionName] [-ConnectionBroker] [-DisableVirtualDesktopRollback] [-Force] [-VirtualDesktopPasswordAge] [-VirtualDesktopTemplateHostServer] [-VirtualDesktopTemplateName] [-Confirm] [-WhatIf] [<CommonParameters>]

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

Update-RDVirtualDesktopCollection [-CollectionName] [-ConnectionBroker] [-DisableVirtualDesktopRollback] [-Force] [-VirtualDesktopPasswordAge] [-ForceLogoffTime] [-StartTime] [-VirtualDesktopTemplateHostServer] [-VirtualDesktopTemplateName] [-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

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

Accept pipeline input?

false

Accept wildcard characters?

false

-DisableVirtualDesktopRollback <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

Performs the action without a confirmation message.

Aliases

None

Required?

false

Position

named

Default value

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

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

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

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

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

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type

System.Object

Notes

None

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"

Online Version
Get-RDVirtualDesktopCollection
New-RDVirtualDesktopCollection
Remove-RDVirtualDesktopCollection