< Back
Update-RDVirtualDesktopCollection
Post
NAME Update-RDVirtualDesktopCollection
SYNOPSIS
Associates a virtual desktop collection with a new virtual desktop template.
SYNTAX
Update-RDVirtualDesktopCollection [-CollectionName] <String> [-ConnectionBroker <String>] [-DisableVirtualDesktopRollback] [-Force]
[-VirtualDesktopPasswordAge <Int32>] -VirtualDesktopTemplateHostServer <String> -VirtualDesktopTemplateName <String> [-Confirm] [-WhatIf]
[<CommonParameters>]
Update-RDVirtualDesktopCollection [-CollectionName] <String> [-ConnectionBroker <String>] [-DisableVirtualDesktopRollback] [-Force]
[-VirtualDesktopPasswordAge <Int32>] -ForceLogoffTime <DateTime> -VirtualDesktopTemplateHostServer <String> -VirtualDesktopTemplateName <String>
[-Confirm] [-WhatIf] [<CommonParameters>]
Update-RDVirtualDesktopCollection [-CollectionName] <String> [-ConnectionBroker <String>] [-DisableVirtualDesktopRollback] [-Force]
[-VirtualDesktopPasswordAge <Int32>] -ForceLogoffTime <DateTime> -StartTime <DateTime> -VirtualDesktopTemplateHostServer <String>
-VirtualDesktopTemplateName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-DisableVirtualDesktopRollback [<SwitchParameter>]
Indicates that the server prevents the rollback of a virtual desktop deployment.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
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.
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.
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.
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.
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.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
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.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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Object
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294275
Get-RDVirtualDesktopCollection
New-RDVirtualDesktopCollection
Remove-RDVirtualDesktopCollection
SYNOPSIS
Associates a virtual desktop collection with a new virtual desktop template.
SYNTAX
Update-RDVirtualDesktopCollection [-CollectionName] <String> [-ConnectionBroker <String>] [-DisableVirtualDesktopRollback] [-Force]
[-VirtualDesktopPasswordAge <Int32>] -VirtualDesktopTemplateHostServer <String> -VirtualDesktopTemplateName <String> [-Confirm] [-WhatIf]
[<CommonParameters>]
Update-RDVirtualDesktopCollection [-CollectionName] <String> [-ConnectionBroker <String>] [-DisableVirtualDesktopRollback] [-Force]
[-VirtualDesktopPasswordAge <Int32>] -ForceLogoffTime <DateTime> -VirtualDesktopTemplateHostServer <String> -VirtualDesktopTemplateName <String>
[-Confirm] [-WhatIf] [<CommonParameters>]
Update-RDVirtualDesktopCollection [-CollectionName] <String> [-ConnectionBroker <String>] [-DisableVirtualDesktopRollback] [-Force]
[-VirtualDesktopPasswordAge <Int32>] -ForceLogoffTime <DateTime> -StartTime <DateTime> -VirtualDesktopTemplateHostServer <String>
-VirtualDesktopTemplateName <String> [-Confirm] [-WhatIf] [<CommonParameters>]
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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-DisableVirtualDesktopRollback [<SwitchParameter>]
Indicates that the server prevents the rollback of a virtual desktop deployment.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
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.
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.
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.
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.
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.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.
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.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, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
System.Object
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294275
Get-RDVirtualDesktopCollection
New-RDVirtualDesktopCollection
Remove-RDVirtualDesktopCollection