Set-RASTemplate
SYNOPSIS
Modifies a Template property.
SYNTAX
Set-RASTemplate [-Id] <uint> -ObjType {RDSTemplate | VDITemplate | AVDTemplate} [-Address <string>]
[-Administrator <string>] [-AdminPassword <SecureString>] [-ClusterId <string>]
[-ClusterName <string>] [-ComputerName <string>] [-DatastoreIDs <string[]>]
[-DatastoreSource {Template | Selection}] [-Description <string>] [-DeviceName <string>]
[-Domain <string>] [-DomainOrgUnit <string>] [-DomainPassword <SecureString>] [-FolderId <string>]
[-FolderName <string>] [-HWGPU <bool>] [-ImagePrepTool {SysPrep | RASPrep}]
[-InheritDefaultOptimizationSettings <bool>] [-InstanceType <string>] [-MaximumIOPS <ulong>]
[-NativePoolId <string>] [-NativePoolName <string>] [-NewName <string>] [-Organization <string>]
[-OSDiskType {StandardHDD | StandardSSD | PremiumSSD}] [-OwnerName <string>]
[-PhysicalHostId <string>] [-PhysicalHostName <string>] [-ResourceGroup <string>] [-Size <ulong>]
[-SubFolderName <string>] [-SubnetId <string>] [-SubnetMask <string>] [-SubnetName <string>]
[-Throughput <ulong>] [-UseSeperateNetworkInterface <bool>] [-VirtualNetworkID <string>]
[-VirtualNetworkName <string>] [-VMSize <string>] [-VolumeType {gp2 | gp3 | io1 | io2 | standard}]
[<CommonParameters>]Set-RASTemplate [-InputObject] <Template> -ObjType {RDSTemplate | VDITemplate | AVDTemplate}
[-Address <string>] [-Administrator <string>] [-AdminPassword <SecureString>] [-ClusterId <string>]
[-ClusterName <string>] [-ComputerName <string>] [-DatastoreIDs <string[]>]
[-DatastoreSource {Template | Selection}] [-Description <string>] [-DeviceName <string>]
[-Domain <string>] [-DomainOrgUnit <string>] [-DomainPassword <SecureString>] [-FolderId <string>]
[-FolderName <string>] [-HWGPU <bool>] [-ImagePrepTool {SysPrep | RASPrep}]
[-InheritDefaultOptimizationSettings <bool>] [-InstanceType <string>] [-MaximumIOPS <ulong>]
[-NativePoolId <string>] [-NativePoolName <string>] [-NewName <string>] [-Organization <string>]
[-OSDiskType {StandardHDD | StandardSSD | PremiumSSD}] [-OwnerName <string>]
[-PhysicalHostId <string>] [-PhysicalHostName <string>] [-ResourceGroup <string>] [-Size <ulong>]
[-SubFolderName <string>] [-SubnetId <string>] [-SubnetMask <string>] [-SubnetName <string>]
[-Throughput <ulong>] [-UseSeperateNetworkInterface <bool>] [-VirtualNetworkID <string>]
[-VirtualNetworkName <string>] [-VMSize <string>] [-VolumeType {gp2 | gp3 | io1 | io2 | standard}]
[<CommonParameters>]DESCRIPTION
The cmdlet modifies a Template property.
EXAMPLES
Example 1
Modifies the RDS Template properties specified by name from the Licensing Server site.
Example 2
Modifies VDI Template specified by ID from the Licensing Server site.
PARAMETERS
-Name
The name of the RAS Template to modify.
-SiteId
The site ID to which the RAS Template belongs.
If the parameter is omitted, the site ID of the Licensing Server will be used.
-Id
The ID of a RAS Template to modify.
-InputObject
An object of type Template representing the target RAS Template info.
To obtain the object, use the Get-RASTemplate command."
Type reference: Template
-ObjType
Template object type.
Possible values: RDSTemplate, VDITemplate, AVDTemplate
Type reference: Template
-NewName
RAS Template Name.
-Description
RAS Template Description.
-FolderName
Folder name where desktop VMs will be created.
-FolderId
The ID of a folder where desktop VMs will be created.
-SubFolderName
Subfolder name where desktop VMs will be created.
-NativePoolId
The ID of the native pool where desktop VMs will be created.
-NativePoolName
The name of the native pool where desktop VMs will be created.
-HWGPU
Enable hardware acceleration graphics licensing support.
-PhysicalHostId
The ID of a physical host where desktop VMs will be created.
-PhysicalHostName
The name of a physical host where desktop VMs will be created.
-UseSeperateNetworkInterface
Use a separate network interface for LAN access.
-Address
The address of the network interface.
-SubnetMask
The subnet mask of the network interface.
-InstanceType
Instance type.
-DeviceName
Device name.
-VolumeType
Volume type.
Possible values: gp2, gp3, io1, io2, standard
Type reference: VolumeType
-Size
Size (GiB).
-MaximumIOPS
Maximum IOPS.
-Throughput
Throughput (MB/s).
-ResourceGroup
Resource group.
Available to VDI/RDS Templates Azure and AVD Templates.
-VMSize
VM size.
Available to VDI/RDS Templates Azure and AVD Templates.
-OSDiskType
OS disk type.
Available to VDI/RDS Templates Azure and AVD Templates.
Possible values: StandardHDD, StandardSSD, PremiumSSD
Type reference: DiskType
-VirtualNetworkID
Virtual network ID.
Available to VDI/RDS Templates Azure and AVD Templates.
-VirtualNetworkName
Virtual network name.
Available to VDI/RDS Templates Azure and AVD Templates.
-SubnetId
Subnet Id.
Available to VDI/RDS Templates Azure/NutanixPC and AVD Templates.
-SubnetName
Subnet name.
Available to VDI/RDS Templates Azure/NutanixPC and AVD Templates.
-ClusterName
Cluster name where desktop VMs will be created.
Available to VDI/RDS Templates NutanixPC.
-ClusterId
The ID of a cluster where desktop VMs will be created.
Available to VDI/RDS Templates NutanixPC.
-ImagePrepTool
Image preparation tool: RASPrep (default) or SysPrep.
Possible values: SysPrep, RASPrep
Type reference: ImagePrepTool
-ComputerName
The FQDN or IP address of the target VM.
-OwnerName
A desktop VM owner name (assigned to a VM by RASprep or Sysprep).
-Organization
Organization name (assigned to a VM by RASprep or Sysprep).
-Domain
Domain or WorkGroup to join (assigned to a VM by RASprep or Sysprep).
-DomainPassword
The password of the domain administrator specified in the Administrator parameter.
-Administrator
The administrator of the domain specified in the JoinDomain parameter.
-AdminPassword
The password of the administrator for the desktop VM (assigned to a VM by RASprep or Sysprep).
-DomainOrgUnit
Domain Organization unit
-DatastoreSource
Datastore Source.
Possible values: Template, Selection
Type reference: DatastoreSourceType
-DatastoreIDs
Datastore IDs.
-InheritDefaultOptimizationSettings
If true, default Optimization settings will be inherited.
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS
Template
OUTPUTS
None
RELATED LINKS
Last updated