Set-RASTemplate.md

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?  false

SiteId (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?  false

Id (uint)

The ID of a RAS Template to modify.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

InputObject (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?  false

ObjType (Template)

Template object type.

Possible values: RDSTemplate, VDITemplate, AVDTemplate

        Required?                    true

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

NewName (string)

RAS Template Name.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Description (string)

RAS Template Description.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

FolderName (string)

Folder name where desktop VMs will be created.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

FolderId (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?  false

SubFolderName (string)

Subfolder name where desktop VMs will be created.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

NativePoolId (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?  false

NativePoolName (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?  false

HWGPU (bool)

Enable hardware acceleration graphics licensing support.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

PhysicalHostId (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?  false

PhysicalHostName (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?  false

UseSeperateNetworkInterface (bool)

Use a separate network interface for LAN access.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Address (string)

The address of the network interface.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SubnetMask (string)

The subnet mask of the network interface.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

InstanceType (string)

Instance type.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

DeviceName (string)

Device name.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

VolumeType (VolumeType)

Volume type.

Possible values: gp2, gp3, io1, io2, standard

        Required?                    false

        Position?                    named

        Default value                gp2

        Accept pipeline input?       false

        Accept wildcard characters?  false

Size (ulong)

Size (GiB).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

MaximumIOPS (ulong)

Maximum IOPS.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Throughput (ulong)

Throughput (MB/s).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

ResourceGroup (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?  false

VMSize (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?  false

OSDiskType (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?  false

VirtualNetworkID (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?  false

VirtualNetworkName (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?  false

SubnetID (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?  false

SubnetName (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?  false

ImagePrepTool (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?  false

ComputerName (string)

The FQDN or IP address of the target VM.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

OwnerName (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?  false

Organization (string)

Organization name (assigned to a VM by RASprep or Sysprep).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Domain (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?  false

DomainPassword (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?  false

Administrator (string)

The administrator of the domain specified in the JoinDomain parameter.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

AdminPassword (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?  false

DomainOrgUnit (string)

Domain Organization unit

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

DatastoreSource

(DatastoreSourceType) Datastore Source.

Possible values: Template, Selection

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

DatastoreIDs (string[])

Datastore IDs.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

InheritDefaultOptimizationSettings (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

Template

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

• New-RASTemplate

• Remove-RASTemplate

• Get-RASTemplate