New-RDVirtualDesktopCollection

New-RDVirtualDesktopCollection

Creates a new virtual desktop collection.

Syntax

Parameter Set: PersonalMgd
New-RDVirtualDesktopCollection [-CollectionName] <String> -PersonalManaged -StorageType <VirtualDesktopStorageType> -VirtualDesktopAllocation <Hashtable> -VirtualDesktopTemplateHostServer <String> -VirtualDesktopTemplateName <String> [-AutoAssignPersonalVirtualDesktopToUser] [-CentralStoragePath <String> ] [-ConnectionBroker <String> ] [-CustomSysprepUnattendFilePath <String> ] [-Description <String> ] [-Domain <String> ] [-Force] [-GrantAdministrativePrivilege] [-LocalStoragePath <String> ] [-OU <String> ] [-UserGroups <String[]> ] [-VirtualDesktopNamePrefix <String> ] [ <CommonParameters>]

Parameter Set: PersonalUnmgd
New-RDVirtualDesktopCollection [-CollectionName] <String> -PersonalUnmanaged -VirtualDesktopName <String[]> [-AutoAssignPersonalVirtualDesktopToUser] [-ConnectionBroker <String> ] [-Description <String> ] [-Force] [-GrantAdministrativePrivilege] [-UserGroups <String[]> ] [ <CommonParameters>]

Parameter Set: PooledMgd
New-RDVirtualDesktopCollection [-CollectionName] <String> -PooledManaged -StorageType <VirtualDesktopStorageType> -VirtualDesktopAllocation <Hashtable> -VirtualDesktopTemplateHostServer <String> -VirtualDesktopTemplateName <String> [-CentralStoragePath <String> ] [-ConnectionBroker <String> ] [-CustomSysprepUnattendFilePath <String> ] [-Description <String> ] [-DisableVirtualDesktopRollback] [-Domain <String> ] [-Force] [-LocalStoragePath <String> ] [-MaxUserProfileDiskSizeGB <Int32> ] [-OU <String> ] [-UserGroups <String[]> ] [-UserProfileDiskPath <String> ] [-VirtualDesktopNamePrefix <String> ] [-VirtualDesktopPasswordAge <Int32> ] [-VirtualDesktopTemplateStoragePath <String> ] [ <CommonParameters>]

Parameter Set: PooledUnmgd
New-RDVirtualDesktopCollection [-CollectionName] <String> -PooledUnmanaged -VirtualDesktopName <String[]> [-ConnectionBroker <String> ] [-Description <String> ] [-Force] [-MaxUserProfileDiskSizeGB <Int32> ] [-UserGroups <String[]> ] [-UserProfileDiskPath <String> ] [ <CommonParameters>]

Detailed Description

The New-RDVirtualDesktopCollection cmdlet creates a new virtual desktop collection.

Parameters

-AutoAssignPersonalVirtualDesktopToUser

Indicates that the server automatically associates virtual desktops with user accounts when you create a new personal virtual desktop collection.

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

-CentralStoragePath<String>

Specifies the path to a central storage location for virtual desktops in the collection. Use the StorageType parameter to specify the type of storage (local or centralized) for the collection.

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

-CollectionName<String>

Specifies the name of a personal virtual desktop collection.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	false
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

-CustomSysprepUnattendFilePath<String>

Provides the path to the .xml file that contains unattended installation settings for the remote desktop collection.

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

-Description<String>

Specifies a descriptive name for the unattended installation file.

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

-DisableVirtualDesktopRollback

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

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

-Domain<String>

Specifies the fully qualified domain name (FQDN) of the Active Directory domain to which you add the virtual desktops.

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

-Force

Runs the operation without prompting for user confirmation.

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

-GrantAdministrativePrivilege

Indicates that the server grants administrative privileges to the user account that the server assigns to a given personal virtual desktop. This parameter applies only to personal virtual desktop collections.

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

-LocalStoragePath<String>

Specifies the path to a local storage location for virtual desktops. Use the StorageType parameter to specify the type of storage for this collection.

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

-MaxUserProfileDiskSizeGB<Int32>

Specifies the maximum size (in gigabytes) for the user profile disk.

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

-OU<String>

Specifies the name of the Active Directory Domain Services (AD DS) organizational unit (OU) for the virtual desktop collection. OU names must be unique within a forest.

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

-PersonalManaged

Indicates that the server creates a new managed personal virtual desktop collection. New virtual desktops that you add to this collection are based on the template that you specify in the VirtualDesktopTempalteName parameter.

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

-PersonalUnmanaged

Indicates that the server creates a new unmanaged personal virtual desktop collection. New virtual desktops that you add to this collection are based on the template that you specify in the VirtualDesktopTempalteName parameter.

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

-PooledManaged

Indicates that the server creates a new managed pooled virtual desktop collection. New virtual desktops that you add to this collection are based on the template that you specify in the VirtualDesktopTempalteName parameter.

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

-PooledUnmanaged

Indicates that the server creates a new unmanaged pooled virtual desktop collection. New virtual desktops that you add to this collection are based on the template that you specify in the VirtualDesktopTempalteName parameter.

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

-StorageType<VirtualDesktopStorageType>

Specifies the storage type for the collection. The acceptable values for this parameter are:

-- LocalStorage
-- CentralSmbShareStorage
-- CentralSanStorage

If you specify LocalStorage, specify a value for the LocalStoragePath parameter. If you specify CentralSMBSharedStorage or CentralSanStorage, specify a value for the CentralStorage parameter.

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

-UserGroups<String[]>

Specifies an array of user groups that are authorized to connect to the collection.

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

-UserProfileDiskPath<String>

Specifies the path to the user profile disk for the collection.

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

-VirtualDesktopAllocation<Hashtable>

Specifies a collection of values (key=value pair) that allocate virtual desktops to Remote Desktop Virtualization (RD Virtualization Host) servers.

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

-VirtualDesktopName<String[]>

Specifies the name of a virtual desktop to add to an unmanaged collection.

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

-VirtualDesktopNamePrefix<String>

Specifies a prefix for virtual desktop names that Remote Desktop Services automatically creates in a managed virtual desktop collection.

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

-VirtualDesktopPasswordAge<Int32>

Specifies the number of days after which the server enforces a password update.

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

-VirtualDesktopTemplateStoragePath<String>

Specifies the path where the template for the virtual desktop collection is stored.

Aliases	none
Required?	false
Position?	named
Default Value	none
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: Create a managed pooled virtual desktop collection

This command creates a managed pooled virtual desktop collection and specifies configuration settings for the virtual desktop collection. The command specifies the LocalStorage type for the collection, and specifies the virtual desktop template named "RDS-Template" for the collection.

PS C:\> New-RDVirtualDesktopCollection -CollectionName "Virtual Desktop Pool" -PooledManaged -VirtualDesktopTemplateName "RDS-Template" -VirtualDesktopTemplateHostServer "rdvh-1.contoso.com" -VirtualDesktopAllocation @{"RDS-WKS-A26.contoso.com"=1;" RDS-WKS-A27.contoso.com"=2} -StorageType LocalStorage -Description "PowerShell created Virtual Desktop Pool" -UserGroups "contoso\domain users" -ConnectionBroker "rdcb.contoso.com" -VirtualDesktopNamePrefix "RDS-WKS-A" -VirtualDesktopPasswordAge 31 -UserProfileDiskPath "\\RDS-WKS-A26.contoso.com\uvhd" -MaxUserProfileDiskSizeGB 10

Related topics

Get-RDVirtualDesktopCollection

Update-RDVirtualDesktopCollection

Remove-RDVirtualDesktopCollection