New-RASTemplate
Creates a Template.
New-RASTemplate [-ProviderId] <uint> [-AzureId] <string> -Administrator <string> -AdminPassword <SecureString> -CustomHost <SwitchParameter> -Domain <string> -DomainPassword <SecureString> -ObjType {RDSTemplate | VDITemplate | AVDTemplate} -TemplateType {SingleSession | MultiSession} [-Address <string>] [-CloneMethod {FullClone | LinkedClone}] [-ComputerName <string>] [-Description <string>] [-DeviceName <string>] [-DomainOrgUnit <string>] [-FolderId <string>] [-FolderName <string>] [-HWGPU <bool>] [-ImagePrepTool {SysPrep | RASPrep}] [-InstanceType <string>] [-MaximumIOPS <ulong>] [-Name <string>] [-NativePoolId <string>] [-NativePoolName <string>] [-NoAllowRemoteConnections <SwitchParameter>] [-NoApplyParallelsPowerPlan <SwitchParameter>] [-NoFireWallRules <SwitchParameter>] [-NoRestart <SwitchParameter>] [-Organization <string>] [-OSDiskType {StandardHDD | StandardSSD | PremiumSSD}] [-OwnerName <string>] [-Password <SecureString>] [-PhysicalHostId <string>] [-PhysicalHostName <string>] [-ResourceGroup <string>] [-SiteId <uint>] [-Size <uint>] [-SubFolderName <string>] [-SubnetID <string>] [-SubnetMask <string>] [-SubnetName <string>] [-Throughput <ulong>] [-Username <string>] [-UseSeperateNetworkInterface <bool>] [-VirtualNetworkID <string>] [-VirtualNetworkName <string>] [-VMSize <string>] [-VolumeType {gp2 | gp3 | io1 | io2 | standard}] [<CommonParameters>]
New-RASTemplate [-ProviderId] <uint> [-AzureId] <string> -Administrator <string> -AdminPassword <SecureString> -AzureGallery <SwitchParameter> -Domain <string> -DomainPassword <SecureString> -LocalAdminPassword <SecureString> -LocalAdminUsername <string> -Location <string> -Name <string> -ObjType {RDSTemplate | VDITemplate | AVDTemplate} -OSDiskType {StandardHDD | StandardSSD | PremiumSSD} -ResourceGroup <string> -SubnetName <string> -TemplateType {SingleSession | MultiSession} -VirtualNetworkName <string> [-Address <string>] [-CloneMethod {FullClone | LinkedClone}] [-ComputerName <string>] [-Description <string>] [-DeviceName <string>] [-DomainOrgUnit <string>] [-FolderId <string>] [-FolderName <string>] [-GalleryName <string>] [-HWGPU <bool>] [-ImagePrepTool {SysPrep | RASPrep}] [-InstanceType <string>] [-MaximumIOPS <ulong>] [-NativePoolId <string>] [-NativePoolName <string>] [-NoAllowRemoteConnections <SwitchParameter>] [-NoApplyParallelsPowerPlan <SwitchParameter>] [-NoFireWallRules <SwitchParameter>] [-NoRestart <SwitchParameter>] [-Organization <string>] [-OwnerName <string>] [-Password <SecureString>] [-PhysicalHostId <string>] [-PhysicalHostName <string>] [-SiteId <uint>] [-Size <uint>] [-SubFolderName <string>] [-SubnetID <string>] [-SubnetMask <string>] [-Throughput <ulong>] [-Username <string>] [-UseSeperateNetworkInterface <bool>] [-VirtualNetworkID <string>] [-VMSize <string>] [-VolumeType {gp2 | gp3 | io1 | io2 | standard}] [<CommonParameters>]
New-RASTemplate [-ProviderId] <uint> [-VMId] <string> -Administrator <string> -AdminPassword <SecureString> -Domain <string> -DomainPassword <SecureString> -ObjType {RDSTemplate | VDITemplate | AVDTemplate} [-Address <string>] [-CloneMethod {FullClone | LinkedClone}] [-ComputerName <string>] [-Description <string>] [-DeviceName <string>] [-DomainOrgUnit <string>] [-FolderId <string>] [-FolderName <string>] [-HWGPU <bool>] [-ImagePrepTool {SysPrep | RASPrep}] [-InstanceType <string>] [-MaximumIOPS <ulong>] [-Name <string>] [-NativePoolId <string>] [-NativePoolName <string>] [-NoAllowRemoteConnections <SwitchParameter>] [-NoApplyParallelsPowerPlan <SwitchParameter>] [-NoDesktopExperience <SwitchParameter>] [-NoFireWallRules <SwitchParameter>] [-NoRestart <SwitchParameter>] [-NoTerminalServices <SwitchParameter>] [-Organization <string>] [-OSDiskType {StandardHDD | StandardSSD | PremiumSSD}] [-OwnerName <string>] [-Password <SecureString>] [-PhysicalHostId <string>] [-PhysicalHostName <string>] [-ResourceGroup <string>] [-SiteId <uint>] [-Size <uint>] [-SubFolderName <string>] [-SubnetID <string>] [-SubnetMask <string>] [-SubnetName <string>] [-TemplateType {SingleSession | MultiSession}] [-Throughput <ulong>] [-Username <string>] [-UseSeperateNetworkInterface <bool>] [-VirtualNetworkID <string>] [-VirtualNetworkName <string>] [-VMSize <string>] [-VolumeType {gp2 | gp3 | io1 | io2 | standard}] [<CommonParameters>]
New-RASTemplate [-InputObject] <VM> -Administrator <string> -AdminPassword <SecureString> -Domain <string> -DomainPassword <SecureString> -ObjType {RDSTemplate | VDITemplate | AVDTemplate} [-Address <string>] [-CloneMethod {FullClone | LinkedClone}] [-ComputerName <string>] [-Description <string>] [-DeviceName <string>] [-DomainOrgUnit <string>] [-FolderId <string>] [-FolderName <string>] [-HWGPU <bool>] [-ImagePrepTool {SysPrep | RASPrep}] [-InstanceType <string>] [-MaximumIOPS <ulong>] [-Name <string>] [-NativePoolId <string>] [-NativePoolName <string>] [-NoAllowRemoteConnections <SwitchParameter>] [-NoApplyParallelsPowerPlan <SwitchParameter>] [-NoDesktopExperience <SwitchParameter>] [-NoFireWallRules <SwitchParameter>] [-NoRestart <SwitchParameter>] [-NoTerminalServices <SwitchParameter>] [-Organization <string>] [-OSDiskType {StandardHDD | StandardSSD | PremiumSSD}] [-OwnerName <string>] [-Password <SecureString>] [-PhysicalHostId <string>] [-PhysicalHostName <string>] [-ResourceGroup <string>] [-SiteId <uint>] [-Size <uint>] [-SubFolderName <string>] [-SubnetID <string>] [-SubnetMask <string>] [-SubnetName <string>] [-TemplateType {SingleSession | MultiSession}] [-Throughput <ulong>] [-Username <string>] [-UseSeperateNetworkInterface <bool>] [-VirtualNetworkID <string>] [-VirtualNetworkName <string>] [-VMSize <string>] [-VolumeType {gp2 | gp3 | io1 | io2 | standard}] [<CommonParameters>]
The cmdlet creates a Template.
-ProviderId <uint> The ID of a Provider on which the source desktop VM resides.
-VMId <string> The ID of the source VM.
-InputObject <VM> The desktop VM to be converted to a RAS Template.
To obtain an object of type VDIDesktop representing the VM, use the Get-VM or Get-VDIDesktop cmdlet.
-ObjType <TemplateObjType> Template object type.
Possible values: RDSTemplate, VDITemplate, AVDTemplate
-Name <string> RAS Template Name.
-SiteId <uint> The site ID in which to create the RAS Template info.
If the parameter is omitted, the site ID of the Licensing Server will be used.
-Description <string> RAS Template Description.
-TemplateType <HostSessionType> Template type: Single Session (VDI / AVD) or Multi Session (RDS / AVD (default))
Possible values: SingleSession, MultiSession
-CloneMethod <CloneMethod> Clone method: Full clone (default) or Linked clone (Not supported for RDS/VDI - Azure/AWS).
Possible values: FullClone, LinkedClone
-Username <string> An administrator account for push installing the RD Session Host agent on the server.
If this parameter is omitted, your RAS admin username (and password) will be used.
-Password <SecureString> The password of the account specified in the Username parameter.
-NoRestart <SwitchParameter> Specifies not to restart the server after the RD Session Host agent is installed.
If this parameter is omitted, the server will be restarted if required.
This parameter applies only for RDSH Templates.
-NoFireWallRules <SwitchParameter> Specifies not to add firewall rules to allow the RAS Guest Agent to communicate.
If this parameter is omitted, the firewall rules will not be added.
-NoAllowRemoteConnections <SwitchParameter> Specifies not to enable allow remote connection when the RAS Guest Agent is installed.
If this parameter is omitted, remote connections are enabled.
-NoApplyParallelsPowerPlan <SwitchParameter> Specifies not to apply Parallels power plan when the RAS Guest Agent is installed.
If this parameter is omitted, the plan will be applied.
-FolderName <string> Folder name where desktop VMs will be created.
-FolderId <string> The ID of a folder where desktop VMs will be created.
-SubFolderName <string> Subfolder name where desktop VMs will be created.
-NativePoolId <string> The ID of the native pool where desktop VMs will be created.
-NativePoolName <string> The name of the native pool where desktop VMs will be created.
-HWGPU <bool> Enable hardware acceleration graphics licensing support.
-PhysicalHostId <string> The ID of a physical host where desktop VMs will be created.
-PhysicalHostName <string> The name of a physical host where desktop VMs will be created.
-UseSeperateNetworkInterface <bool> Use a separate network interface for LAN access.
-Address <string> The address of the network interface.
-SubnetMask <string> The subnet mask of the network interface.
-InstanceType <string> Instance type.
-DeviceName <string> Device name.
-VolumeType <VolumeType> Volume type.
Possible values: gp2, gp3, io1, io2, standard
-Size <uint> Size (GiB).
-MaximumIOPS <ulong> Maximum IOPS.
-Throughput <ulong> Throughput (MB/s).
-ResourceGroup <string> Resource group.
Available to VDI/RDS Templates Azure and AVD Templates.
-VMSize <string> VM size.
Available to VDI/RDS Templates Azure and AVD Templates. Default: Standard_B2s
-OSDiskType <DiskType> OS disk type.
Available to VDI/RDS Templates Azure and AVD Templates.
Possible values: StandardHDD, StandardSSD, PremiumSSD
-VirtualNetworkID <string> Virtual network ID.
Available to VDI/RDS Templates Azure and AVD Templates.
-VirtualNetworkName <string> Virtual network name.
Available to VDI/RDS Templates Azure and AVD Templates.
-SubnetID <string> Subnet ID.
Available to VDI/RDS Templates Azure and AVD Templates.
-SubnetName <string> Subnet name.
Available to VDI/RDS Templates Azure and AVD Templates.
-ImagePrepTool <ImagePrepTool> Image preparation tool: RASPrep (default) or SysPrep.
Possible values: SysPrep, RASPrep
-ComputerName <string> The FQDN or IP address of the target VM.
-OwnerName <string> A desktop VM owner name (assigned to a VM by RASprep or Sysprep).
-Organization <string> Organization name (assigned to a VM by RASprep or Sysprep).
-Domain <string> Domain or WorkGroup to join (assigned to a VM by RASprep or Sysprep).
-DomainPassword <SecureString> The password of the domain administrator specified in the Administrator parameter.
-Administrator <string> The administrator of the domain specified in the JoinDomain parameter.
-AdminPassword <SecureString> The password of the administrator for the desktop VM (assigned to a VM by RASprep or Sysprep).
-DomainOrgUnit <string> Domain Organization unit
-NoDesktopExperience <SwitchParameter> Specifies not to install the Desktop Experience after the RD Session Host agent is installed.
If this parameter is omitted, the Desktop Experience is installed.
-NoTerminalServices <SwitchParameter> Specifies not to install the Terminal Services role after the RD Session Host agent is installed.
If this parameter is omitted, the Terminal Services role will be installed.
-AzureId <string> The Azure ID of the AVD Custom Host or AVD Gallery Image.
-CustomHost <SwitchParameter> Specifies that the AVD Template will use an AVD Custom Host.
-AzureGallery <SwitchParameter> Specifies that the AVD Template will use an AVD Gallery Image.
-GalleryName <string> The name of the AVD Gallery that contains the AVD Gallery Image.
-Location <string> The AVD Location of the AVD Gallery Image.
-LocalAdminUsername <string> The local admin username.
-LocalAdminPassword <SecureString> The local admin password.
<CommonParameters>
---------- EXAMPLE 1 ----------
New-RASTemplate -ObjType VDITemplate -Name "My Template" -ProviderId 1 Domain "my domain" -DomainPassword $password -Administrator "admin" -AdminPassword $password
Creates an VDI Template with the specified data. ---------- EXAMPLE 2 ----------
New-RASTemplate -ObjType AVDTemplate -Name "My Template" -AzureGallery -ProviderId 1 -Domain "my domain" -DomainPassword $password -Administrator "admin" -AdminPassword $password -TemplateType SingleSession -OSDiskType StandardSSD -ResourceGroup "my Resource Group" -location "westeurope" -VirtualNetworkName "vnet" -SubnetName "subnet" -LocalAdminUsername "admin" -LocalAdminPassword $password -AzureId "/subscriptions/j383475632498-93h5-034f-le09-768ds6f78987sd3/resourceGroups/myResourceGourp/providers/Microsoft.Compute/galleries/myGallery/images/myImage"
Creates an AVD Template based on the specified AVD Gallery Image. ---------- EXAMPLE 3 ----------
New-RASTemplate -ObjType AVDTemplate -Name "My Template" -CustomHost -ProviderId 1 -Domain "my domain" -DomainPassword $password -Administrator "admin" -AdminPassword $password -AzureId "/subscriptions/j383475632498-93h5-034f-le09-768ds6f78987sd3/resourceGroups/myResourceGourp/providers/Microsoft.Compute/virtualMachines/myMachine"
Creates an AVD Template based on the specified AVD Custom Host.