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.
SiteId (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.
Id (uint)
The ID of the VDIHostPool to modify. To obtain the ID, use the Get-RASVDIHostPool cmdlet.
InputObject (VDIHostPool)
The VDI Host Pool to modify.
To obtain an object of type VDIHostPool representing a VDI Host Pool, use the Get-RASVDIHostPool cmdlet.
NewName (string)
The new name of the target VDI Host Pool.
Description (string)
A user-defined VDI Host Pool description.
Enabled (bool)
Enable or disable the specified VDI Host Pool in a site.
TemplateId (uint)
Template ID, 0 = None
TemplateVersionId (uint)
Template Version ID
TemplateTagId (uint)
Template Tag ID
MaxHosts (uint)
The maximum number of hosts that can be created from the template.
PreCreatedHosts (uint)
The maximum pre-created hosts that can be created.
HostName (string)
The VM name format. All VMs created from the template will have this name with %ID:N:S% replaced.
DefaultPowerState
(DefaultPowerState) The Default Power State
Possible values: PoweredOn, PoweredOff, Suspended
Duration (uint)
The Duration
WildCard (string)
A user-defined VDI Host Pool wildcard.
InheritDefaultVDIActionSettings (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.
SessionAction (SessionAction)
Session change state.
Possible values: Disconnect, Logoff
PerformAction (PerformAction)
Perform action on session change.
Possible values: DoNothing, Shutdown, Suspend, Delete, Restart, Unassign, Recreate
PerformActionAfterSec (uint)
Perform action after (in seconds).
InheritDefaultUserProfileSettings (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.
Technology (UserProfileTech)
Specifies the 'User Profile Technology' value.
Possible values: DoNotManage, UPD, FSLogix, FSLogixProfileContainer
InheritDefaultAppPackageSettings (bool)
If true, default app package settings will be inherited.
InheritDefaultOptimizationSettings (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.
InheritDefaultAgentSettings (bool)
If true, default VDI Agent settings will be inherited.
DisconnectActiveSessionAfter (uint)
Disconnect active session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'.
LogoffDisconnectedSessionAfter (uint)
Logoff disconnected session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'.
SessionReadinessTimeout (uint)
Session readiness timeout (in seconds). Accepted values: 20-3600 seconds.
AllowURLAndMailRedirection
(AllowURLAndMailRedirection) Specifies the 'Allow Client URL/Mail Redirection'.
Possible values: Disabled, Enabled, EnabledWithAppRegistration
SupportShellURLNamespaceObjects (bool)
Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled.
DragAndDropMode
(DragAndDropModeValue) Specifies the mode the drag and drop feature will operate.
Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional
AllowRemoteExec (bool)
Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled.
ManageRDPTransportProtocol
(ManageRDPTransportProtocol) Manage RDP transport protocol.
Possible values: Disabled, BothUDPTCP, OnlyTCP, EitherUDPTCP
FileTransferMode
(FileTransferControlMode) Specifies if File Transfer option is allowed and if yes, which directions are allowed.
Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional
FileTransferLocation (string)
Location where the File Transfer takes place, if and where it is allowed.
FileTransferLockLocation (bool)
Lock Location where the File Transfer takes place, if and where it is allowed.
EnableDriveRedirectionCache (bool)
Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled.
EnableZOrder (bool)
Specifies if the 'Enable Z-Order' option is enabled or disabled. (Experimental)
InheritDefaultRDPPrinterSettings (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.
PrinterNameFormat
(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
RemoveSessionNumberFromPrinterName (bool)
Enable or disable the 'Remove session number from printer name' option.
InheritDefaultVDISecuritySettings (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.
IsUsersGrantedRDPermissions (bool)
Grant users RD permission.
GroupType (UserGroupType)
Group type that will get RD premission.
Possible values: Administrators, RemoteDesktopUsers, RDUsers
InheritDefaultAutoUpgradeSettings (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.
AWSSubnetsIds (List`1)
Add or remove Amazon Web Service Subnets.
DatastoreSource
(DatastoreSourceType) Datastore Source.
Possible values: Template, Selection
DatastoreIDs (string[])
Datastore IDs.
(CommonParameters)
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