Set-RASTemplate
NAME
Set-RASTemplate
SYNOPSIS
Modifies a Template property.
SYNTAX
Set-RASTemplate [Id] (uint)** -ObjType {RDSTemplate | VDITemplate | AVDTemplate} [Address (string)] [Administrator (string)] [AdminPassword (SecureString)] [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)] [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 [Name] (string)** [[-SiteId] (uint)] -ObjType {RDSTemplate | VDITemplate | AVDTemplate} [Address (string)] [Administrator (string)] [AdminPassword (SecureString)] [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.
PARAMETERS
Name (string)
The name of the RAS Template to modify.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? falseSiteId (uint)
The site ID to which the RAS Template belongs.
If the parameter is omitted, the site ID of the Licensing Server will be used.
Required? false
Position? 1
Default value 0
Accept pipeline input? false
Accept wildcard characters? falseId (uint)
The ID of a RAS Template to modify.
Required? true
Position? 0
Default value 0
Accept pipeline input? false
Accept wildcard characters? falseInputObject (Template)
An object of type Template representing the target RAS Template info.
To obtain the object, use the Get-RASTemplate command."
Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? falseObjType (Template)
Template object type.
Possible values: RDSTemplate, VDITemplate, AVDTemplate
Required? true
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? falseNewName (string)
RAS Template Name.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDescription (string)
RAS Template Description.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseFolderName (string)
Folder name where desktop VMs will be created.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseFolderId (string)
The ID of a folder where desktop VMs will be created.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseSubFolderName (string)
Subfolder name where desktop VMs will be created.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseNativePoolId (string)
The ID of the native pool where desktop VMs will be created.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseNativePoolName (string)
The name of the native pool where desktop VMs will be created.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseHWGPU (bool)
Enable hardware acceleration graphics licensing support.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falsePhysicalHostId (string)
The ID of a physical host where desktop VMs will be created.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falsePhysicalHostName (string)
The name of a physical host where desktop VMs will be created.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseUseSeperateNetworkInterface (bool)
Use a separate network interface for LAN access.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseAddress (string)
The address of the network interface.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseSubnetMask (string)
The subnet mask of the network interface.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseInstanceType (string)
Instance type.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDeviceName (string)
Device name.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseVolumeType (VolumeType)
Volume type.
Possible values: gp2, gp3, io1, io2, standard
Required? false
Position? named
Default value gp2
Accept pipeline input? false
Accept wildcard characters? falseSize (ulong)
Size (GiB).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseMaximumIOPS (ulong)
Maximum IOPS.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseThroughput (ulong)
Throughput (MB/s).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseResourceGroup (string)
Resource group.
Available to VDI/RDS Templates Azure and AVD Templates.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseVMSize (string)
VM size.
Available to VDI/RDS Templates Azure and AVD Templates.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseOSDiskType (DiskType)
OS disk type.
Available to VDI/RDS Templates Azure and AVD Templates.
Possible values: StandardHDD, StandardSSD, PremiumSSD
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseVirtualNetworkID (string)
Virtual network ID.
Available to VDI/RDS Templates Azure and AVD Templates.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseVirtualNetworkName (string)
Virtual network name.
Available to VDI/RDS Templates Azure and AVD Templates.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseSubnetID (string)
Subnet ID.
Available to VDI/RDS Templates Azure and AVD Templates.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseSubnetName (string)
Subnet name.
Available to VDI/RDS Templates Azure and AVD Templates.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseImagePrepTool (ImagePrepTool)
Image preparation tool: RASPrep (default) or SysPrep.
Possible values: SysPrep, RASPrep
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseComputerName (string)
The FQDN or IP address of the target VM.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseOwnerName (string)
A desktop VM owner name (assigned to a VM by RASprep or Sysprep).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseOrganization (string)
Organization name (assigned to a VM by RASprep or Sysprep).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDomain (string)
Domain or WorkGroup to join (assigned to a VM by RASprep or Sysprep).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDomainPassword (SecureString)
The password of the domain administrator specified in the Administrator parameter.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseAdministrator (string)
The administrator of the domain specified in the JoinDomain parameter.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseAdminPassword (SecureString)
The password of the administrator for the desktop VM (assigned to a VM by RASprep or Sysprep).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDomainOrgUnit (string)
Domain Organization unit
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDatastoreSource
(DatastoreSourceType) Datastore Source.
Possible values: Template, Selection
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDatastoreIDs (string[])
Datastore IDs.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseInheritDefaultOptimizationSettings (bool)
If true, default Optimization settings will be inherited.
Required? false
Position? named
Default value
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 documentation. INPUTS
OUTPUTS
-none-
EXAMPLES
**---------- EXAMPLE 1 ----------
Set-RASTemplate -ObjType RDSTemplate -Name "My Template" | Format-List
Modifies the RDS Template properties specified by name from the Licensing Server site. **---------- EXAMPLE 2 ----------
Set-RASTemplate -ObjType VDITemplate -Id 10
Modifies VDI Template specified by ID from the Licensing Server site.
RELATED LINKS
Last updated