VDITemplate Class

NAMESPACE

RASAdminEngine.Core.OutputModels

DESCRIPTION

RAS VDI Template

INHERITED FROM

RASSerilazableObj
VDITemplate

INTERFACES

PUBLIC PROPERTIES

Type Name Description
String AdminCreate
String Administrator The administrator of the domain specified in the JoinDomain parameter.
String AdminLastMod
VDICloneMethod CloneMethod Clone method: Full clone (default) or Linked clone.
String ComputerName The FQDN or IP address of the target VM.
Boolean DeleteUnusedGuests Delete unused guest VMs (deprecated).
String Domain Domain or WorkGroup to join (assigned to a VM by RASprep or Sysprep).
String DomainOrgUnit Domain Organization unit
Boolean Enabled Whether the VDI Template is enabled or not
String FolderId The ID of a folder where guest VMs will be created.
String FolderName Folder name where guest VMs will be created.
FSLogixSettings FSLogix Specifies the 'FSLogix' object.
UserGroupType GroupType Group type that will get RD premission.
String GuestNameFormat The guest VM name format. All guest VMs created from the template will have this name with %ID:N:S% replaced.
UInt32 GuestsToCreate The number of guest VMs that will be created after template creation process has finished. These guests are created only once.
UInt32 Id
VDIImagePrepTool ImagePrepTool Image preparation tool: RASPrep (default) or SysPrep.
Boolean InheritDefUserProfileSettings Inherit Default User Profile Settings.
Boolean InheritDefVDIActionSettings Inherit Default VDI Action Settings.
Boolean InheritDefVDISecuritySettings Inherit Default VDI Security Settings.
Boolean IsMAK Whether License Type is MAK or not.
Boolean IsRASPrep Whether the image preparation tool is RASPrep or not.
Boolean IsUsersGrantedRDPermissions Grant users RD permission.
VDILicenseType LicenseKeyType VDI License Type (KMS or MAK)
List<VDITemplateLicKey> LicKeys List of VDI template license keys.
Boolean LinkedClone Whether Linked clone is selected or not.
UInt32 MaxGuests The maximum number of guest VMs that can be created from the template.
String Name VDI Template Name
String NativePoolId The ID of the native pool where guest VMs will be created.
String NativePoolName The name of the native pool where guest VMs will be created.
String Organization Organization name (assigned to a VM by RASprep or Sysprep).
String OwnerName A guest VM owner name (assigned to a VM by RASprep or Sysprep).
PerformAction PerformAction Perform action on session change.
UInt32 PerformActionAfterSec Perform action after (in seconds).
String PhysicalHostId The ID of a physical host where guest VMs will be created.
String PhysicalHostName The name of a physical host where guest VMs will be created.
UInt32 PreCreatedGuests The maximum pre-created guest VMs that can be created.
UInt32 ProviderId Provider ID
SessionAction SessionAction Session change state.
UInt32 SessionResetTimeoutSec Reset session after (in seconds).
UInt32 SiteId Site ID
String SubFolderName Subfolder name where guest VMs will be created.
UserProfileTech Technology Specifies the 'User Profile Technology' value.
VDITemplateType TemplateType VDI Template Type (VDI Desktop or RDSH)
DateTime TimeCreate
DateTime TimeLastMod
UInt32 UnusedGuestDurationMins The duration after which unused guest VMs should be deleted (in minutes), 0 means never.
Boolean UseDefAgentSettings Whether default Agent settings are used or not.
String VDIGuestId The ID of the source guest VM.

PUBLIC METHODS

Type Name Description
Int32 CompareTo (Object obj) Inherited from RASSerilazableObj
Boolean Equals (Object obj) Inherited from RASSerilazableObj
Int32 GetHashCode () Inherited from RASSerilazableObj
Type GetType ()
String ToString ()

References to Commands

Add-RASVDITemplateLicenseKey
Get-RASVDIGuest
Get-RASVDITemplate
Get-RASVDITemplateLicenseKey
Get-RASVDITemplateStatus
Invoke-RASVDITemplateCmd
New-RASPubVDIApp
New-RASPubVDIDesktop
New-RASRDSGroup
New-RASVDITemplate
Remove-RASVDITemplate
Remove-RASVDITemplateLicenseKey
Set-RASPubVDIApp
Set-RASPubVDIDesktop
Set-RASRDSGroup
Set-RASVDITemplate