Set-RASVDITemplate

NAME

Set-RASVDITemplate

SYNOPSIS

Modifies properties of a RAS Template.

SYNTAX

Set-RASVDITemplate [- Name ] <string> [[- SiteId ] <uint> ] [- Administrator <string> ] [- AdminPassword <SecureString> ] [- DeleteUnusedGuests <bool> ] [- Domain <string> ] [- DomainPassword <SecureString> ] [- Enabled <bool> ] [- FolderId <string> ] [- FolderName <string> ] [- GroupType < UserGroupType > {RDUsers | Administrators}] [- GuestNameFormat <string> ] [- ImagePrepTool < VDIImagePrepTool > {RASPrep | SysPrep}] [- InheritDefVDIActionSettings <bool> ] [- InheritDefVDISecuritySettings <bool> ] [- InheritDefVDIUserProfileSettings <bool> ] [- IsUsersGrantedRDPermissions <bool> ] [- LicenseKeyType < VDILicenseType > {KMS | MAK}] [- MaxGuests <uint> ] [- NativePoolId <string> ] [- NativePoolName <string> ] [- NewName <string> ] [- Organization <string> ] [- OwnerName <string> ] [- PerformAction < PerformAction > {DoNothing | Shutdown | Restart | Suspend | Delete | Unassign | Recreate}] [- PerformActionAfterSec <uint> ] [- PhysicalHostId <string> ] [- PhysicalHostName <string> ] [- PreCreatedGuests <uint> ] [- SessionAction < SessionAction > {Disconnect | Logoff}] [- SessionResetTimeoutSec <uint> ] [- TargetOU <string> ] [- Technology < UserProfileTech > {DoNotManage | UPD | FSLogixProfileContainer}] [- UnusedGuestDurationMins <uint> ] [ < CommonParameters > ]

Set-RASVDITemplate [- Id ] <uint> [- Administrator <string> ] [- AdminPassword <SecureString> ] [- DeleteUnusedGuests <bool> ] [- Domain <string> ] [- DomainPassword <SecureString> ] [- Enabled <bool> ] [- FolderId <string> ] [- FolderName <string> ] [- GroupType < UserGroupType > {RDUsers | Administrators}] [- GuestNameFormat <string> ] [- ImagePrepTool < VDIImagePrepTool > {RASPrep | SysPrep}] [- InheritDefVDIActionSettings <bool> ] [- InheritDefVDISecuritySettings <bool> ] [- InheritDefVDIUserProfileSettings <bool> ] [- IsUsersGrantedRDPermissions <bool> ] [- LicenseKeyType < VDILicenseType > {KMS | MAK}] [- MaxGuests <uint> ] [- NativePoolId <string> ] [- NativePoolName <string> ] [- NewName <string> ] [- Organization <string> ] [- OwnerName <string> ] [- PerformAction < PerformAction > {DoNothing | Shutdown | Restart | Suspend | Delete | Unassign | Recreate}] [- PerformActionAfterSec <uint> ] [- PhysicalHostId <string> ] [- PhysicalHostName <string> ] [- PreCreatedGuests <uint> ] [- SessionAction < SessionAction > {Disconnect | Logoff}] [- SessionResetTimeoutSec <uint> ] [- TargetOU <string> ] [- Technology < UserProfileTech > {DoNotManage | UPD | FSLogixProfileContainer}] [- UnusedGuestDurationMins <uint> ] [ < CommonParameters > ]

Set-RASVDITemplate [- InputObject ] < VDITemplate > [- Administrator <string> ] [- AdminPassword <SecureString> ] [- DeleteUnusedGuests <bool> ] [- Domain <string> ] [- DomainPassword <SecureString> ] [- Enabled <bool> ] [- FolderId <string> ] [- FolderName <string> ] [- GroupType < UserGroupType > {RDUsers | Administrators}] [- GuestNameFormat <string> ] [- ImagePrepTool < VDIImagePrepTool > {RASPrep | SysPrep}] [- InheritDefVDIActionSettings <bool> ] [- InheritDefVDISecuritySettings <bool> ] [- InheritDefVDIUserProfileSettings <bool> ] [- IsUsersGrantedRDPermissions <bool> ] [- LicenseKeyType < VDILicenseType > {KMS | MAK}] [- MaxGuests <uint> ] [- NativePoolId <string> ] [- NativePoolName <string> ] [- NewName <string> ] [- Organization <string> ] [- OwnerName <string> ] [- PerformAction < PerformAction > {DoNothing | Shutdown | Restart | Suspend | Delete | Unassign | Recreate}] [- PerformActionAfterSec <uint> ] [- PhysicalHostId <string> ] [- PhysicalHostName <string> ] [- PreCreatedGuests <uint> ] [- SessionAction < SessionAction > {Disconnect | Logoff}] [- SessionResetTimeoutSec <uint> ] [- TargetOU <string> ] [- Technology < UserProfileTech > {DoNotManage | UPD | FSLogixProfileContainer}] [- UnusedGuestDurationMins <uint> ] [ < CommonParameters > ]

DESCRIPTION

Modifies properties of a RAS Template.

When executing the cmdlet, you can include only the parameters that you want to modify.

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. 

        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 < VDITemplate >
An object of type VDITemplate representing a RAS Template.

The object is obtained using the Get-VDITemplate cmdlet. 

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  false

- Enabled <bool>
Enable or disable the specified RAS Template. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- NewName <string>
A new RAS Template name. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- MaxGuests <uint>
The maximum number of guest VMs that can be created from the template. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- PreCreatedGuests <uint>
The maximum pre-created guest VMs that can be created. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- GuestNameFormat <string>
The guest VM name format. All guest VMs created from the template will have this name with %ID:N:S% replaced. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- DeleteUnusedGuests <bool>
Delete unused guest VMs (deprecated).

If this value is set to true, UnusedGuestDurationMins will be set to 1 week. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- UnusedGuestDurationMins <uint>
The duration after which unused guest VMs should be deleted (in minutes), 0 means never. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- ImagePrepTool < VDIImagePrepTool >
Image Preparation tool.

Possible values: RASPrep, SysPrep 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- LicenseKeyType < VDILicenseType >
License Key Type: KMS or MAK.

Possible values: KMS, MAK 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- OwnerName <string>
The guest VM owner name. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- Organization <string>
The guest VM organization name. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- Domain <string>
The guest VM domain/workgroup name. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- DomainPassword <SecureString>
The password of the domain specified in the Domain parameter. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- Administrator <string>
The guest VM administrator name. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- AdminPassword <SecureString>
The password of the administrator specified in the Administrator parameter. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- FolderId <string>
The ID of a folder where guest VMs will be created. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- FolderName <string>
The name of a folder where guest 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 guest VMs will be created. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- NativePoolName <string>
The name of a native pool where guest VMs will be created. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- PhysicalHostId <string>
The ID of a physical host where guest 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 guest VMs will be created. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- TargetOU <string>
Target organization unit. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- InheritDefVDIActionSettings <bool>
Inherit Default VDI Action Settings for the specified guest VM. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- InheritDefVDISecuritySettings <bool>
Inherit Default VDI Security Settings for the specified guest VM. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- InheritDefVDIUserProfileSettings <bool>
Inherit Default VDI User Profile Settings for the specified guest VM. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- SessionResetTimeoutSec <uint>
Reset session after (in seconds). 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- SessionAction < SessionAction >
Session change state.

Possible values: Disconnect, Logoff 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- PerformAction < PerformAction >
Perform action on session change.

Possible values: DoNothing, Shutdown, Restart, Suspend, Delete, Unassign, Recreate 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- PerformActionAfterSec <uint>
Perform action after (in seconds). 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- IsUsersGrantedRDPermissions <bool>
Grant users RD permission. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- GroupType < UserGroupType >
Group type that will get RD premission.

Possible values: RDUsers, Administrators 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

- Technology < UserProfileTech >
Specifies the 'User Profile Technology' value.

Possible values: DoNotManage, UPD, FSLogixProfileContainer 

        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

VDITemplate

OUTPUTS

-none-

EXAMPLES


---------- EXAMPLE 1 ----------

Set-RASVDITemplate "TemplateName" -Enabled $False

Disables the specified RAS Template in the Licensing Server site.

To disable a RAS Template in a specific site, specify the -SiteId parameter.

---------- EXAMPLE 2 ----------

Set-RASVDITemplate -Id 1 -Enabled $True

Enables a RAS Template specified by ID.

---------- EXAMPLE 3 ----------

Set-RASVDITemplate $VDITemplate -Enabled $False

Disables a RAS Template specified by VDITemplate object (the $VDITemplate variable).

A VDITemplate object representing a RAS Template is obtained using the Get-VDITemplate cmdlet.

---------- EXAMPLE 4 ----------

Get-RASVDITemplate -Id 1 | Set-VDITemplate -Enabled $False

Disables a RAS Template represented by an object obtained from the pipeline output.

---------- EXAMPLE 5 ----------

Get-RASVDITemplate -Id 1 | Set-VDITemplate -Description "My new RAS Template"

Modifies the description of the RAS Template obtained from the pipeline output.

RELATED LINKS