Set-RASVDIHostPool
NAME
Set-RASVDIHostPool
SYNOPSIS
Modifies a VDI Host Pool.
SYNTAX
Set-RASVDIHostPool [Id] (uint)** [AllowRemoteExec (bool)] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [-AWSSubnetsIds (List`1)] [-DatastoreIDs (string[])] [-DatastoreSource {Template | Selection}] [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}] [Description (string)] [DisconnectActiveSessionAfter (uint)] [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [Duration (uint)] [Enabled (bool)] [EnableDriveRedirectionCache (bool)] [EnableZOrder (bool)] [FileTransferLocation (string)] [FileTransferLockLocation (bool)] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-GroupType {Administrators | RemoteDesktopUsers | RDUsers}] [HostName (string)] [InheritDefaultAgentSettings (bool)] [InheritDefaultAppPackageSettings (bool)] [InheritDefaultAutoUpgradeSettings (bool)] [InheritDefaultOptimizationSettings (bool)] [InheritDefaultRDPPrinterSettings (bool)] [InheritDefaultUserProfileSettings (bool)] [InheritDefaultVDIActionSettings (bool)] [InheritDefaultVDISecuritySettings (bool)] [IsUsersGrantedRDPermissions (bool)] [LogoffDisconnectedSessionAfter (uint)] [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [MaxHosts (uint)] [NewName (string)] [-PerformAction {DoNothing | Shutdown | Suspend | Delete | Restart | Unassign | Recreate}] [PerformActionAfterSec (uint)] [PreCreatedHosts (uint)] [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [RemoveSessionNumberFromPrinterName (bool)] [-SessionAction {Disconnect | Logoff}] [SessionReadinessTimeout (uint)] [SupportShellURLNamespaceObjects (bool)] [-Technology {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [TemplateId (uint)] [TemplateTagId (uint)] [TemplateVersionId (uint)] [WildCard (string)] [(CommonParameters)]
Set-RASVDIHostPool [-InputObject] (VDIHostPool) [AllowRemoteExec (bool)] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [-AWSSubnetsIds (List`1)] [-DatastoreIDs (string[])] [-DatastoreSource {Template | Selection}] [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}] [Description (string)] [DisconnectActiveSessionAfter (uint)] [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [Duration (uint)] [Enabled (bool)] [EnableDriveRedirectionCache (bool)] [EnableZOrder (bool)] [FileTransferLocation (string)] [FileTransferLockLocation (bool)] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-GroupType {Administrators | RemoteDesktopUsers | RDUsers}] [HostName (string)] [InheritDefaultAgentSettings (bool)] [InheritDefaultAppPackageSettings (bool)] [InheritDefaultAutoUpgradeSettings (bool)] [InheritDefaultOptimizationSettings (bool)] [InheritDefaultRDPPrinterSettings (bool)] [InheritDefaultUserProfileSettings (bool)] [InheritDefaultVDIActionSettings (bool)] [InheritDefaultVDISecuritySettings (bool)] [IsUsersGrantedRDPermissions (bool)] [LogoffDisconnectedSessionAfter (uint)] [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [MaxHosts (uint)] [NewName (string)] [-PerformAction {DoNothing | Shutdown | Suspend | Delete | Restart | Unassign | Recreate}] [PerformActionAfterSec (uint)] [PreCreatedHosts (uint)] [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [RemoveSessionNumberFromPrinterName (bool)] [-SessionAction {Disconnect | Logoff}] [SessionReadinessTimeout (uint)] [SupportShellURLNamespaceObjects (bool)] [-Technology {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [TemplateId (uint)] [TemplateTagId (uint)] [TemplateVersionId (uint)] [WildCard (string)] [(CommonParameters)]
Set-RASVDIHostPool [Name]** (string) [[-SiteId] (uint)] [AllowRemoteExec (bool)] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [-AWSSubnetsIds (List`1)] [-DatastoreIDs (string[])] [-DatastoreSource {Template | Selection}] [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}] [Description (string)] [DisconnectActiveSessionAfter (uint)] [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [Duration (uint)] [Enabled (bool)] [EnableDriveRedirectionCache (bool)] [EnableZOrder (bool)] [FileTransferLocation (string)] [FileTransferLockLocation (bool)] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-GroupType {Administrators | RemoteDesktopUsers | RDUsers}] [HostName (string)] [InheritDefaultAgentSettings (bool)] [InheritDefaultAppPackageSettings (bool)] [InheritDefaultAutoUpgradeSettings (bool)] [InheritDefaultOptimizationSettings (bool)] [InheritDefaultRDPPrinterSettings (bool)] [InheritDefaultUserProfileSettings (bool)] [InheritDefaultVDIActionSettings (bool)] [InheritDefaultVDISecuritySettings (bool)] [IsUsersGrantedRDPermissions (bool)] [LogoffDisconnectedSessionAfter (uint)] [-ManageRDPTransportProtocol {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [MaxHosts (uint)] [NewName (string)] [-PerformAction {DoNothing | Shutdown | Suspend | Delete | Restart | Unassign | Recreate}] [PerformActionAfterSec (uint)] [PreCreatedHosts (uint)] [-PrinterNameFormat {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [RemoveSessionNumberFromPrinterName (bool)] [-SessionAction {Disconnect | Logoff}] [SessionReadinessTimeout (uint)] [SupportShellURLNamespaceObjects (bool)] [-Technology {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [TemplateId (uint)] [TemplateTagId (uint)] [TemplateVersionId (uint)] [WildCard (string)] [(CommonParameters)]
DESCRIPTION
Modifies properties of a VDI Host Pool.
PARAMETERS
Name (string)
The name of the target VDI Host Pool.
This must be the actual VDI Host Pool name used in the RAS farm.
Required? true
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? falseSiteId (uint)
Site ID in which to modify the specified VDI Host Pool.
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 the VDIHostPool to modify. To obtain the ID, use the Get-RASVDIHostPool cmdlet.
Required? true
Position? 0
Default value 0
Accept pipeline input? false
Accept wildcard characters? falseInputObject (VDIHostPool)
The VDI Host Pool to modify.
To obtain an object of type VDIHostPool representing a VDI Host Pool, use the Get-RASVDIHostPool cmdlet.
Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? falseNewName (string)
The new name of the target VDI Host Pool.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDescription (string)
A user-defined VDI Host Pool description.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseEnabled (bool)
Enable or disable the specified VDI Host Pool in a site.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseTemplateId (uint)
Template ID, 0 = None
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseTemplateVersionId (uint)
Template Version ID
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseTemplateTagId (uint)
Template Tag ID
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseMaxHosts (uint)
The maximum number of hosts that can be created from the template.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falsePreCreatedHosts (uint)
The maximum pre-created hosts that can be created.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseHostName (string)
The VM name format. All 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? falseDefaultPowerState
(DefaultPowerState) The Default Power State
Possible values: PoweredOn, PoweredOff, Suspended
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDuration (uint)
The Duration
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseWildCard (string)
A user-defined VDI Host Pool wildcard.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseInheritDefaultVDIActionSettings (bool)
Enable or disable the 'Inherit default Action settings' option. This will inherit Global Action settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseSessionAction (SessionAction)
Session change state.
Possible values: Disconnect, Logoff
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falsePerformAction (PerformAction)
Perform action on session change.
Possible values: DoNothing, Shutdown, Suspend, Delete, Restart, Unassign, Recreate
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falsePerformActionAfterSec (uint)
Perform action after (in seconds).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseInheritDefaultUserProfileSettings (bool)
Enable or disable the 'Inherit default user profile settings' option. This will inherit VDI User Profile settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseTechnology (UserProfileTech)
Specifies the 'User Profile Technology' value.
Possible values: DoNotManage, UPD, FSLogix, FSLogixProfileContainer
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseInheritDefaultAppPackageSettings (bool)
If true, default app package settings will be inherited.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseInheritDefaultOptimizationSettings (bool)
Enable or disable the 'Inherit default Optimization Settings' option. This will inherit Image Optimization settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseInheritDefaultAgentSettings (bool)
If true, default VDI Agent settings will be inherited.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDisconnectActiveSessionAfter (uint)
Disconnect active session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseLogoffDisconnectedSessionAfter (uint)
Logoff disconnected session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseSessionReadinessTimeout (uint)
Session readiness timeout (in seconds). Accepted values: 20-3600 seconds.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseAllowURLAndMailRedirection
(AllowURLAndMailRedirection) Specifies the 'Allow Client URL/Mail Redirection'.
Possible values: Disabled, Enabled, EnabledWithAppRegistration
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseSupportShellURLNamespaceObjects (bool)
Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseDragAndDropMode
(DragAndDropModeValue) Specifies the mode the drag and drop feature will operate.
Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseAllowRemoteExec (bool)
Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseManageRDPTransportProtocol
(ManageRDPTransportProtocol) Manage RDP transport protocol.
Possible values: Disabled, BothUDPTCP, OnlyTCP, EitherUDPTCP
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseFileTransferMode
(FileTransferControlMode) Specifies if File Transfer option is allowed and if yes, which directions are allowed.
Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseFileTransferLocation (string)
Location where the File Transfer takes place, if and where it is allowed.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseFileTransferLockLocation (bool)
Lock Location where the File Transfer takes place, if and where it is allowed.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseEnableDriveRedirectionCache (bool)
Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseEnableZOrder (bool)
Specifies if the 'Enable Z-Order' option is enabled or disabled. (Experimental)
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseInheritDefaultRDPPrinterSettings (bool)
Enable or disable the 'Inherit default RDP printer settings' option. This will inherit Global printer settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falsePrinterNameFormat
(PrnNameFormat) Specifies the 'Printer Name Format' option. Accepted values: PrnFormat_PRN_CMP_SES, PrnFormat_SES_CMP_PRN, PrnFormat_PRN_REDSES.
Possible values: PrnFormat_PRN_CMP_SES, PrnFormat_SES_CMP_PRN, PrnFormat_PRN_REDSES
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseRemoveSessionNumberFromPrinterName (bool)
Enable or disable the 'Remove session number from printer name' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseInheritDefaultVDISecuritySettings (bool)
Enable or disable the 'Inherit default Security settings' option. This will inherit Global Security settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseIsUsersGrantedRDPermissions (bool)
Grant users RD permission.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseGroupType (UserGroupType)
Group type that will get RD premission.
Possible values: Administrators, RemoteDesktopUsers, RDUsers
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseInheritDefaultAutoUpgradeSettings (bool)
Enable or disable the 'Inherit default Auto-upgrade Settings' option. This will inherit Auto-upgrade settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? falseAWSSubnetsIds (List`1)
Add or remove Amazon Web Service Subnets.
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? 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-RASVDIHostPool "My VDI Host Pool" -Enabled $False
Disables the VDI Host Pool specified by name. **---------- EXAMPLE 2 ----------
Set-RASVDIHostPool -Id 10 -Enabled $False
Disables the VDI Host Pool specified by ID. **---------- EXAMPLE 3 ----------
Set-RASVDIHostPool $VDIHostPool -Enabled $False
Disables the VDI Host Pool specified by the $VDIHostPool variable (an object of type VDIHostPool). **---------- EXAMPLE 4 ----------
Get-RASVDIHostPool -Id 10 | Set-RASVDIHostPool -Enabled $False
Disables the VDI Host Pool obtained from the pipeline output.
RELATED LINKS
Last updated