Edit

Share via

New-RDVirtualDesktopCollection

Module:
RemoteDesktop Module

Creates a virtual desktop collection.

Syntax

PooledMgd 

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

PersonalMgd 

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

PooledUnmgd 

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

PersonalUnmgd 

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

Description

The New-RDVirtualDesktopCollection cmdlet creates a virtual desktop collection.

Examples

Example 1: Create a managed pooled virtual desktop 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

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.

Parameters

-AutoAssignPersonalVirtualDesktopToUser

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

Parameter properties

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

Parameter sets

PersonalMgd
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
PersonalUnmgd
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CentralStoragePath

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.

Parameter properties

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

Parameter sets

PooledMgd
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
PersonalMgd
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CollectionName

Specifies the name of a personal 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: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

-CustomSysprepUnattendFilePath

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

Parameter properties

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

Parameter sets

PooledMgd
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
PersonalMgd
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

Specifies a descriptive name for the unattended installation file.

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 rollback of a virtual desktop deployment.

Parameter properties

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

Parameter sets

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

-Domain

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

Parameter properties

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

Parameter sets

PooledMgd
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
PersonalMgd
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

-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.

Parameter properties

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

Parameter sets

PersonalMgd
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
PersonalUnmgd
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LocalStoragePath

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

Parameter properties

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

Parameter sets

PooledMgd
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
PersonalMgd
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MaxUserProfileDiskSizeGB

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

Parameter properties

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

Parameter sets

PooledMgd
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
PooledUnmgd
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OU

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.

Parameter properties

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

Parameter sets

PooledMgd
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
PersonalMgd
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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 VirtualDesktopTemplateName parameter.

Parameter properties

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

Parameter sets

PersonalMgd
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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 VirtualDesktopTemplateName parameter.

Parameter properties

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

Parameter sets

PersonalUnmgd
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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 VirtualDesktopTemplateName parameter.

Parameter properties

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

Parameter sets

PooledMgd
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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 VirtualDesktopTemplateName parameter.

Parameter properties

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

Parameter sets

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

-StorageType

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.

Parameter properties

Type:VirtualDesktopStorageType
Default value:None
Accepted values:LocalStorage, CentralSmbShareStorage, CentralSanStorage
Supports wildcards:False
DontShow:False

Parameter sets

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

-UserGroups

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

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

-UserProfileDiskPath

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

Parameter properties

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

Parameter sets

PooledMgd
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
PooledUnmgd
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VirtualDesktopAllocation

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

Parameter properties

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

Parameter sets

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

-VirtualDesktopName

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

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

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

-VirtualDesktopNamePrefix

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

Parameter properties

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

Parameter sets

PooledMgd
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
PersonalMgd
Position:Named
Mandatory:False
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 enforces a password update.

Parameter properties

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

Parameter sets

PooledMgd
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

PooledMgd
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
PersonalMgd
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

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

-VirtualDesktopTemplateStoragePath

Specifies the path where the parent disk for virtual machines in the collection is stored.

Parameter properties

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

Parameter sets

PooledMgd
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