Edit

Share via

Update-RDVirtualDesktopCollection

Module:
RemoteDesktop Module

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

Syntax

Now (Default) 

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

OnUserLogoff 

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

OnSchedule 

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:True
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisableVirtualDesktopRollback

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Force

Forces the command to run without asking for user confirmation.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ForceLogoffTime

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

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

OnUserLogoff
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
OnSchedule
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StartTime

Specifies a date and time to start the operation.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

OnUserLogoff
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VirtualDesktopPasswordAge

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VirtualDesktopTemplateHostServer

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VirtualDesktopTemplateName

Specifies a descriptive name for the virtual desktop template.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

Object