Set-RASVDIHostPool

NAME

Set-RASVDIHostPool

SYNOPSIS

Modifies a VDI Host Pool.

SYNTAX

Set-RASVDIHostPool [-Id] <uint> [-AllowRemoteExec <bool>] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}] [-Description <string>] [-DisconnectActiveSessionAfter <uint>] [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-Duration <uint>] [-Enabled <bool>] [-EnableDriveRedirectionCache <bool>] [-FileTransferLocation <string>] [-FileTransferLockLocation <bool>] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-GroupType {Administrators | RemoteDesktopUsers | RDUsers}] [-HostName <string>] [-InheritDefaultAgentSettings <bool>] [-InheritDefaultAppPackageSettings <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>] [-TemplateVersionId <uint>] [-WildCard <string>] [<CommonParameters>] Set-RASVDIHostPool [-InputObject] <VDIHostPool> [-AllowRemoteExec <bool>] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}] [-Description <string>] [-DisconnectActiveSessionAfter <uint>] [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-Duration <uint>] [-Enabled <bool>] [-EnableDriveRedirectionCache <bool>] [-FileTransferLocation <string>] [-FileTransferLockLocation <bool>] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-GroupType {Administrators | RemoteDesktopUsers | RDUsers}] [-HostName <string>] [-InheritDefaultAgentSettings <bool>] [-InheritDefaultAppPackageSettings <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>] [-TemplateVersionId <uint>] [-WildCard <string>] [<CommonParameters>] Set-RASVDIHostPool [-Name] <string> [[-SiteId] <uint>] [-AllowRemoteExec <bool>] [-AllowURLAndMailRedirection {Disabled | Enabled | EnabledWithAppRegistration}] [-DefaultPowerState {PoweredOn | PoweredOff | Suspended}] [-Description <string>] [-DisconnectActiveSessionAfter <uint>] [-DragAndDropMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-Duration <uint>] [-Enabled <bool>] [-EnableDriveRedirectionCache <bool>] [-FileTransferLocation <string>] [-FileTransferLockLocation <bool>] [-FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-GroupType {Administrators | RemoteDesktopUsers | RDUsers}] [-HostName <string>] [-InheritDefaultAgentSettings <bool>] [-InheritDefaultAppPackageSettings <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>] [-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?  false

-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.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

-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.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

-NewName <string> The new name of the target VDI Host Pool.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Description <string> A user-defined VDI Host Pool description.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

-TemplateId <uint> Template ID, 0 = None

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-TemplateVersionId <uint> Template Version ID

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

-PreCreatedHosts <uint> The maximum pre-created hosts that can be created.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

-DefaultPowerState <DefaultPowerState> The Default Power State Possible values: PoweredOn, PoweredOff, Suspended

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Duration <uint> The Duration

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-WildCard <string> A user-defined VDI Host Pool wildcard.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-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.

        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, Suspend, Delete, Restart, 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

-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.

        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, FSLogix, FSLogixProfileContainer

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InheritDefaultAppPackageSettings <bool> If true, default app package settings will be inherited.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-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.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InheritDefaultAgentSettings <bool> If true, default VDI Agent settings will be inherited.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

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

-SessionReadinessTimeout <uint> Session readiness timeout (in seconds). Accepted values: 20-3600 seconds.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

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

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

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

-ManageRDPTransportProtocol <ManageRDPTransportProtocol> Manage RDP transport protocol. Possible values: Disabled, BothUDPTCP, OnlyTCP, EitherUDPTCP

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

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

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

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

-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.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-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

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

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

-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.

        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: Administrators, RemoteDesktopUsers, RDUsers

        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 . 

INPUTS

VDIHostPool

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.