Set-RASProvider

NAME

Set-RASProvider

SYNOPSIS

Modifies Provider server settings.

SYNTAX

Set-RASProvider [-Server] <string> [[-SiteId] <uint>] [-AllowFileTransfer <bool>] [-AllowURLAndMailRedirection <AllowURLAndMailRedirection> {Disabled | Enabled | EnabledWithAppRegistration}] [-AutoPreferredPA <SwitchParameter>] [-Description <string>] [-DirectAddress <string>] [-Enabled <bool>] [-EnableDriveRedirectionCache <bool>] [-FileTransferLocation <string>] [-FileTransferLockLocation <bool>] [-FileTransferMode <FileTransferControlMode> {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-NewServer <string>] [-Port <uint>] [-PreferredPAId <uint>] [-PreferredPAObj <PA>] [-PrinterNameFormat <PrnNameFormat> {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [-RemoveClientNameFromPrinterName <bool>] [-RemoveSessionNumberFromPrinterName <bool>] [-SupportShellURLNamespaceObjects <bool>] [-Type <HypervisorType> {HyperVUnknown | HyperVWin2012R2Std | HyperVWin2012R2Dtc | HyperVWin2012R2Srv | HyperVWin2016Std | HyperVWin2016Dtc | HyperVWin2016Srv | HyperVWin2019Std | HyperVWin2019Dtc | HyperVWin2019Srv | HyperVWin2022Std | HyperVWin2022Dtc | HyperVFailoverClusterUnknown | HyperVFailoverClusterEnt | HyperVFailoverClusterDtc | HyperVFailoverClusterWin2012 | HyperVFailoverClusterWin2012R2 | HyperVFailoverClusterWin2016 | HyperVFailoverClusterWin2019 | HyperVFailoverClusterWin2022 | VmwareESXUnknown | VmwareESXi4_0 | VmwareESX4_0 | VmwareESXi4_1 | VmwareESX4_1 | VmwareESXi5_0 | VmwareESXi5_1 | VmwareESXi5_5 | VmwareESXi6_0 | VmwareESXi6_5 | VmwareESXi6_7 | VmwareESXi7_0 | VmwareVCenterUnknown | VmwareVCenter4_0 | VmwareVCenter4_1 | VmwareVCenter5_0 | VmwareVCenter5_1 | VmwareVCenter5_5 | VmwareVCenter6_0 | VmwareVCenter6_5 | VmwareVCenter6_7 | VmwareVCenter7_0 | NutanixUnknown | Nutanix5_10 | Nutanix5_15 | Nutanix5_20 | RemotePCUnknown | RemotePCStatic | RemotePCDynamic | ScaleUnknown | Scale8_6_5 | Scale8_8 | Scale8_9 | Azure}] [-VDIAgent <string>] [-VDIPassword <SecureString>] [-VDIPort <uint>] [-VDIUsername <string>] [<CommonParameters>]

Set-RASProvider [-Id] <uint> [-AllowFileTransfer <bool>] [-AllowURLAndMailRedirection <AllowURLAndMailRedirection> {Disabled | Enabled | EnabledWithAppRegistration}] [-AutoPreferredPA <SwitchParameter>] [-Description <string>] [-DirectAddress <string>] [-Enabled <bool>] [-EnableDriveRedirectionCache <bool>] [-FileTransferLocation <string>] [-FileTransferLockLocation <bool>] [-FileTransferMode <FileTransferControlMode> {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-NewServer <string>] [-Port <uint>] [-PreferredPAId <uint>] [-PreferredPAObj <PA>] [-PrinterNameFormat <PrnNameFormat> {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [-RemoveClientNameFromPrinterName <bool>] [-RemoveSessionNumberFromPrinterName <bool>] [-SupportShellURLNamespaceObjects <bool>] [-Type <HypervisorType> {HyperVUnknown | HyperVWin2012R2Std | HyperVWin2012R2Dtc | HyperVWin2012R2Srv | HyperVWin2016Std | HyperVWin2016Dtc | HyperVWin2016Srv | HyperVWin2019Std | HyperVWin2019Dtc | HyperVWin2019Srv | HyperVWin2022Std | HyperVWin2022Dtc | HyperVFailoverClusterUnknown | HyperVFailoverClusterEnt | HyperVFailoverClusterDtc | HyperVFailoverClusterWin2012 | HyperVFailoverClusterWin2012R2 | HyperVFailoverClusterWin2016 | HyperVFailoverClusterWin2019 | HyperVFailoverClusterWin2022 | VmwareESXUnknown | VmwareESXi4_0 | VmwareESX4_0 | VmwareESXi4_1 | VmwareESX4_1 | VmwareESXi5_0 | VmwareESXi5_1 | VmwareESXi5_5 | VmwareESXi6_0 | VmwareESXi6_5 | VmwareESXi6_7 | VmwareESXi7_0 | VmwareVCenterUnknown | VmwareVCenter4_0 | VmwareVCenter4_1 | VmwareVCenter5_0 | VmwareVCenter5_1 | VmwareVCenter5_5 | VmwareVCenter6_0 | VmwareVCenter6_5 | VmwareVCenter6_7 | VmwareVCenter7_0 | NutanixUnknown | Nutanix5_10 | Nutanix5_15 | Nutanix5_20 | RemotePCUnknown | RemotePCStatic | RemotePCDynamic | ScaleUnknown | Scale8_6_5 | Scale8_8 | Scale8_9 | Azure}] [-VDIAgent <string>] [-VDIPassword <SecureString>] [-VDIPort <uint>] [-VDIUsername <string>] [<CommonParameters>]

Set-RASProvider [-InputObject] <Provider> [-AllowFileTransfer <bool>] [-AllowURLAndMailRedirection <AllowURLAndMailRedirection> {Disabled | Enabled | EnabledWithAppRegistration}] [-AutoPreferredPA <SwitchParameter>] [-Description <string>] [-DirectAddress <string>] [-Enabled <bool>] [-EnableDriveRedirectionCache <bool>] [-FileTransferLocation <string>] [-FileTransferLockLocation <bool>] [-FileTransferMode <FileTransferControlMode> {Disabled | ClientToServer | ServerToClient | Bidirectional}] [-NewServer <string>] [-Port <uint>] [-PreferredPAId <uint>] [-PreferredPAObj <PA>] [-PrinterNameFormat <PrnNameFormat> {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [-RemoveClientNameFromPrinterName <bool>] [-RemoveSessionNumberFromPrinterName <bool>] [-SupportShellURLNamespaceObjects <bool>] [-Type <HypervisorType> {HyperVUnknown | HyperVWin2012R2Std | HyperVWin2012R2Dtc | HyperVWin2012R2Srv | HyperVWin2016Std | HyperVWin2016Dtc | HyperVWin2016Srv | HyperVWin2019Std | HyperVWin2019Dtc | HyperVWin2019Srv | HyperVWin2022Std | HyperVWin2022Dtc | HyperVFailoverClusterUnknown | HyperVFailoverClusterEnt | HyperVFailoverClusterDtc | HyperVFailoverClusterWin2012 | HyperVFailoverClusterWin2012R2 | HyperVFailoverClusterWin2016 | HyperVFailoverClusterWin2019 | HyperVFailoverClusterWin2022 | VmwareESXUnknown | VmwareESXi4_0 | VmwareESX4_0 | VmwareESXi4_1 | VmwareESX4_1 | VmwareESXi5_0 | VmwareESXi5_1 | VmwareESXi5_5 | VmwareESXi6_0 | VmwareESXi6_5 | VmwareESXi6_7 | VmwareESXi7_0 | VmwareVCenterUnknown | VmwareVCenter4_0 | VmwareVCenter4_1 | VmwareVCenter5_0 | VmwareVCenter5_1 | VmwareVCenter5_5 | VmwareVCenter6_0 | VmwareVCenter6_5 | VmwareVCenter6_7 | VmwareVCenter7_0 | NutanixUnknown | Nutanix5_10 | Nutanix5_15 | Nutanix5_20 | RemotePCUnknown | RemotePCStatic | RemotePCDynamic | ScaleUnknown | Scale8_6_5 | Scale8_8 | Scale8_9 | Azure}] [-VDIAgent <string>] [-VDIPassword <SecureString>] [-VDIPort <uint>] [-VDIUsername <string>] [<CommonParameters>]

DESCRIPTION

Modifies settings of a Provider server.

For each setting, the cmdlet includes a corresponding input parameter. To modify a setting, specify a parameter and its value.

PARAMETERS


-Server <string>
The name of the target Provider server.

This must be the actual server name used in the RAS farm.

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

-Enabled <bool>
Enables or disables the specified Provider server in a site.

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

-NewServer <string>
A new server name. This must be the server FQDN or IP address.

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

-Description <string>
A user-defined Provider server description.

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

-DirectAddress <string>
Specifies the Provider server direct address.

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

-Port <uint>
Specifies the port number for the RAS VDI Agent.

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

-Type <HypervisorType>
Specifies the Provider type.

To get the list of available types, execute [System.Enum]::GetNames('RASAdminEngine.Core.OuputModels.HypervisorType')

From the returned list, choose a hypervisor type and then use it as a value for this parameter.

Possible values: HyperVUnknown, HyperVWin2012R2Std, HyperVWin2012R2Dtc, HyperVWin2012R2Srv, HyperVWin2016Std, HyperVWin2016Dtc, HyperVWin2016Srv, HyperVWin2019Std, HyperVWin2019Dtc, HyperVWin2019Srv, HyperVWin2022Std, HyperVWin2022Dtc, HyperVFailoverClusterUnknown, HyperVFailoverClusterEnt, HyperVFailoverClusterDtc, HyperVFailoverClusterWin2012, HyperVFailoverClusterWin2012R2, HyperVFailoverClusterWin2016, HyperVFailoverClusterWin2019, HyperVFailoverClusterWin2022, VmwareESXUnknown, VmwareESXi4_0, VmwareESX4_0, VmwareESXi4_1, VmwareESX4_1, VmwareESXi5_0, VmwareESXi5_1, VmwareESXi5_5, VmwareESXi6_0, VmwareESXi6_5, VmwareESXi6_7, VmwareESXi7_0, VmwareVCenterUnknown, VmwareVCenter4_0, VmwareVCenter4_1, VmwareVCenter5_0, VmwareVCenter5_1, VmwareVCenter5_5, VmwareVCenter6_0, VmwareVCenter6_5, VmwareVCenter6_7, VmwareVCenter7_0, NutanixUnknown, Nutanix5_10, Nutanix5_15, Nutanix5_20, RemotePCUnknown, RemotePCStatic, RemotePCDynamic, ScaleUnknown, Scale8_6_5, Scale8_8, Scale8_9, Azure

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

-VDIUsername <string>
A user account to log in to the hypervisor management tool (e.g. VMware vCenter).

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

-VDIPassword <SecureString>
The password of the account specified in the VDIUsername parameter.

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

-VDIAgent <string>
FQDN or IP address of the server where the RAS VDI Agent is running.

You only need to specify this parameter if the RAS VDI Agent is dedicated.

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

-VDIPort <uint>
The port to communicate with the dedicated VDIAgent specified in the VDIAgent parameter.

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

-AllowURLAndMailRedirection <AllowURLAndMailRedirection>
Set the URL and Mail Redirection option. Possible values: 0 = Disabled, 1 = Enabled, 2 = Enabled with application registration.

Possible values: Disabled, Enabled, EnabledWithAppRegistration

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

-SupportShellURLNamespaceObjects <bool>
Enable or disable the 'Support Shell URL Namespace Objects' option.

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

-AllowFileTransfer <bool>
Deprecated: use FileTransferMode instead.

Enable or disable the 'Allow file transfer' option.

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

-FileTransferMode <FileTransferControlMode>
File Transfer option. Possible values are: 0 (Disabled), 1 (client to Server only), 2 {Server To Client only), 3 (Bidirectional).

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

-RemoveClientNameFromPrinterName <bool>
Enable or disable the 'Remove client name from printer name' option.

        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

-PrinterNameFormat <PrnNameFormat>
Specifies the 'RDP Printer Name Format' option.

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

-AutoPreferredPA <SwitchParameter>
Set the 'Preferred Publishing Agent' option to 'Automatically". If number of PAs is less than 3 then preferred PA is not allowed to choose automatic.

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

-PreferredPAObj <PA>
The preferred Publishing Agent server.

To obtain an object of type PA representing the preferred Publishing Agent, use the Get-PA cmdlet.

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

-PreferredPAId <uint>
The preferred Publishing Agent server ID.

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

-EnableDriveRedirectionCache <bool>
Enable or disable the 'Enable Drive Redirection Cache' option.

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

-SiteId <uint>
Site ID in which to modify the specified Provider server.

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 Provider server to modify. To obtain the ID, use the Get-RASProvider cmdlet.

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

-InputObject <Provider>
An object representing the Provider server to modify.

To obtain the object, use the Get-RASProvider cmdlet.

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        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

Provider

OUTPUTS

-none-

EXAMPLES


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

Set-RASProvider -Server "server.company.dom" -Enabled $False

Disables the specified Provider server in the Licensing Server site.

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

Set-RASProvider -Id 3 -Enabled $False

Disables the Provider server specified by ID.

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

Set-RASProvider $Provider -Enabled $True

Enables the Provider server specified by the $Provider variable, which is an object of type Provider.

The object is obtained using the Get-RASProvider cmdlet.

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

Get-RASProvider -Id 3 | Set-RASProvider -Enabled $True

Enables the Provider server represented by a Provider object obtained from the pipeline output.

RELATED LINKS