setsettings

AppserverClient Command Line Interface

setsettings

updates settings from a connection or generic to Parallels Client.

Category: Settings

AppServerClientCLI setsettings [-id ras:5] -settings settingname1=0[,settings2=1]

Arguments

id (optional) Specify the connection ID to use.
settings (mandatory) Specify which setting to set.

Return codes:

ok - Command was successful NotAvailable - Communication with the client backend failed, ensure that the client is running AccessDenied - Logged on user does not have permission to perform the action Exception - System problem

Examples:

AppServerClientCLI setsettings -id ras:5/rdp:5 -settings incognitomode=1,username=myuser

Notes:

Possible settings and their relative information:

Global settings:

Name

Type

Read

Write

Minimum

Maximum

Possible Values

Description

modernui

bool

yes

Enable or disable the Modern interface.

appearance

int

yes

0 = System
1 = Light
2 = Dark

Change the color theme used by the application.

banner

int

yes

0 = Splash window
1 = Taskbar toast window
2 = None

Select what user interface to use while a connection is being established.

autorefresh

bool

yes

Whether connections are automatically refreshed.

autorefreshtime

int

yes

9999

Specifies the time in minutes for the automatic refresh.

oncloseallsessions

int

yes

0 = Do nothing
1 = Lock the workstation
2 = Sign out from the workstation

Specifies what happens when all user sessions are closed.

loglevel

int

yes

3 = Standard
4 = Extended
5 = Verbose

Specifies the log level.

logduration

int

yes

3600

259200

0 = Never

Specifies the time in milliseconds after which the logs will return to the Standard level.

checkforupdate

bool

yes

Whether Parallels Client checks for available updates on startup.

avdclienttype

int

yes

0 = Azure Virtual Desktop client
1 = Windows App (verified version)

Specifies using "Azure Virtual Desktop client" or "Windows App" when connecting to Azure Virtual Desktop resources.

ssoforcethirdparty

bool

yes

Enable or disable force wrap of the third-party SSO component.

ssowrapprovidername

string

yes

The name of the third-party SSO component. This setting is read only. See also listavailablessoproviders.

ssowrapproviderguid

guid

yes

Specify the GUID of the third-party SSO component. See also listavailablessoproviders.

language

int

yes

0 = Default
1 = English
2 = German
3 = Japanese
5 = French
6 = Spanish
7 = Italian
8 = Portuguese
9 = Chinese Simplified
10 = Chinese Traditional
11 = Korean
12 = Dutch

Specify the UI language. You must restart Parallels Client for the changes to take effect.

hidelauncher

bool

yes

When enabled, the launcher will be minimized to the system tray after an application is launched.

launchonstartup

bool

yes

When enabled, the launcher will be launched automatically on Windows startup.

redirectfxusbredir

bool

yes

Enables the RemoteFX USB redirection feature on Windows. Note that the computer must be restarted for the changes to take effect.

showconnectionstree

bool

yes

When enabled, if an application is closed it continue to run in the background.

keepapprunning

bool

yes

When enabled, Parallels Client will be shown in the System Tray when you click on the Close button or press Escape.

sslnowarn

bool

yes

When enabled, connections over SSL with a non-verified certificate will not display a warning message.

autoaddras

bool

yes

When enabled, a new connection is added to Parallels Client when an item is started from a connection that is not yet listed.

donotpromptautoaddras

bool

yes

Enable this option to disable prompt messages when adding auto connections.

clearcookiesonexit

bool

yes

When a user signs in, a Parallels RAS logon cookie is kept on the Parallels Client side. This allows the user to re-connect to Parallels RAS without re-authenticating. When this option is enabled, cookies are deleted when the user closes Parallels Client.

autocloseerrormsgs

bool

yes

When enabled, all session disconnect error messages are automatically dismissed after 15 seconds.

swapmousebuttons

bool

yes

When enabled, mouse buttons will be swapped on the remote computer.

dpiaware

bool

yes

When enabled, this option forces a published application to be DPI-aware depending on the Parallels Client's DPI settings.

turnoffudponclient

bool

yes

When enabled, RDP sessions will not use the UDP protocol.

autoinstallfonts

bool

yes

When enabled, server-configured fonts are automatically installed.

rawprinting

bool

yes

When enabled, Universal Printing will convert non-distributable fonts into images.

usefontsimageswhereneeded

bool

yes

When enabled, server-configured fonts are automatically installed.

cacheembeddedfonts

bool

yes

Enable caching of embedded fonts locally to speed up Universal Printing process.

dynamicprinterredir

bool

yes

When enabled, if any printer configuration which matches the redirection rules is updated, the changes are reflected on the remote virtual printer. This includes adding and removing printers.

telemetry

bool

yes

Enable this option to participate in the Customer Experience Program.

Connection settings:

Name

Type

Connection

Read

Write

Minimum

Maximum

Possible Values

Description

server

string

ras/rdp

yes

255

Specify the server name or IP address. To connect to a specific RAS Theme, specify its name after the server name or IP address separated by a slash.

port

int

ras/rdp

yes

65535

Specify the port on which the server listens for incoming connections.

mode

int

ras/rdp

yes

Ras:

0 = Gateway mode
1 = Direct mode
2 = Gateway SSL mode
3 = Direct SSL mode

Rdp:

4 = Standard RDP

Specify the connection mode to use.

alias

string

ras/rdp

yes

255

Specify the friendly name to use for this connection.

backup

string

ras

yes

2048

Specify the secondary connections. Every connection requires a server name or IP address, a port and a connection mode. **Format: **server,port,connectionmode,...,server,port,connectionmode.

publicipsvcurl

string

ras

yes

255

Specify the service URL set to retrieve the public IP.

authtype

int

ras/rdp

yes

Ras:

0 = Credentials
1 = Single Sign-On
2 = Smart card
3 = Web
4 = Web+Credentials

Rdp:

0 = Credentials
2 = Smart card

Specify the authentication type to use.

autologin

bool

ras/rdp

yes

When enabled, Parallels Client will connect to this connection on startup automatically.

username

string

ras/rdp

yes

127

Specify the username to use, preferebly in the UPN format. If authtype is set to "Web + Credentials", you cannot set the username.

domain

string

ras/rdp

yes

If you did not specify the full username, you can specify the domain name.

password

string

ras/rdp

yes

127

Specify the password to use. This setting can only be set using setsettings.

savepassword

bool

ras/rdp

yes

When enabled, the password will be remembered.

colordepth

int

ras/rdp

yes

0 = 256 colors
1 = High colors (15 bit)
2 = High colors (16 bit)
3 = True colors (24 bit)
4 = Highest quality (32 bit)

Specify the color depth to use.

useprimarymonitor

bool

ras/rdp

yes

When enabled, display a published resource on the primary monitor only. Other monitors connected to the computer will not be used.

usedynamicresizeapps

bool

ras/rdp

yes

Eable this option if you want published resources to use the display settings of the local desktop.

displayconfiguration

int

ras/rdp

yes

0 = Primary
1 = All
2 = Selected

Choose which monitors will be used to display published resources. If "Selected" is used, you need to set a value for selected display.

selecteddisplay

string

ras/rdp

yes

100

Choose one or several displays manually. See also listavailabledisplays.

smartsizing

int

ras/rdp

yes

0 = Disabled
1 = Scale (fit to window)
2 = Resize (update resolution)

Choose a smart sizing option.

fullscreenconnbar

int

ras/rdp

yes

0 = Do not show
1 = Show pinned
2 = Show unpinned

Choose how the connection bar should be displayed in full screen mode by default: pinned, unpinned, or hidden.

desktopembed

bool

ras/rdp

yes

Enable this option to open a remote desktop inside the Parallels Client window (launcher). This feature is only available in the Classic user interface only.

spandesktops

bool

ras/rdp

yes

Enable this option to span published desktops across all connected monitors.

audiolocation

int

ras/rdp

yes

0 = Bring to this computer
1 = Do not play
2 = Leave at remote computer

Choose where to playback remote audio.

audioquality

int

ras/rdp

yes

0 = Adjust dymanically based on available bandwidth
1 = Always use medium audio quality
2 = Always use uncompressed audio quality

Choose the audio quality when redirecting to the local computer.

enablerecording

bool

ras/rdp

yes

Enable this option to be able to record audio on the remote computer.

keyboard

int

ras/rdp

yes

0 = On the local computer
1 = On the remote computer
2 = In fullscreen mode only

Choose when to apply Windows key combinations.

clipboard

int

ras/rdp

yes

0 = Disabled
1 = Client to server only
2 = Server to client only
3 = Bidirectional

Choose the clipboard redirection mode.

diskdrives

bool

ras/rdp

yes

Enables disk drives redirection.

drivesused

string

ras/rdp

yes

160

Choose which drives to redirect.

redirdynamicdrives

bool

ras/rdp

yes

Enable this option to redirect disk drives that you will connect to your local computer later.

drivecachemode

int

ras/rdp

yes

0 = Disable
1 = Enable
2 = Fast mode

Enabling this option will make file browsing and navigation on the redirected drives much faster.

redirectreadonlydrives

bool

ras/rdp

yes

When set via policies, will redirect all drives in read-only mode.

videocapturingdevices

bool

ras/rdp

yes

Enable this to redirect video capture devices.

redirdynamiccameras

bool

ras/rdp

yes

Enable this option to redirect video capture devices that you will connect to your local computer later.

camerasused

string

ras/rdp

yes

500

Specifies which video capture devices to redirect from a user device to the remote session. See also listavailablecameras.

otherdevices

bool

ras/rdp

yes

Enable this option to redirect other devices that are connected to your local computer.

devicesused

string

ras/rdp

yes

500

Specifies which other devices to redirect from a user device to the remote session. See also listavailabledevices.

redirdynamicdevices

bool

ras/rdp

yes

Enable this option to redirect other devices that you will connect to your local computer later.

showpreviousdevices

bool

ras/rdp

yes

Enable this to show devices that were previously connected in the user interface.

serialports

bool

ras/rdp

yes

Enable this option to redirect serial ports.

smartcards

bool

ras/rdp

yes

Enable this option to redirect smart cards.

pentouchinput

int

ras/rdp

yes

0 = Disabled
1 = Enabled

Enables this option to redirect pen and touch input to the remote session.

multimediaforavd

bool

ras

yes

Enable this to accelerate video content played in a browser on a remote Azure Virtual Desktop host.

networktype

int

ras/rdp

yes

0 = Modem (56Kbps)
1 = Low speed broadband (256 Kbps - 2 Mbps)
2 = Satellite (2 Mbps - 16 Mbps with high latency)
3 = High speed broadband (2 Mbps - 16 Mbps)
4 = WAN (10 Mbps or higher with high latency)
5 = LAN (10 Mbps or higher)
6 = Detect connection quality automatically

Choose the network type used to optimize the performance of the connection with the remote server.

desktopbackground

bool

ras/rdp

yes

Enable this so that the remote session could use desktop backgrounds.

fontsmoothing

bool

ras/rdp

yes

Enable this option to make text smoother and easier to read.

menuandwindowanimation

bool

ras/rdp

yes

Enable this option to animate the movement of windows, menus, and lists.

desktopcomposition

bool

ras/rdp

yes

Enable this option to allow desktop composition. With desktop composition, individual windows are no longer drawn directly to the screen. Instead, their drawing is redirected to video memory, which is then rendered into a desktop image and presented on the display.

showcontentwhiledragging

bool

ras/rdp

yes

Enable this option to show the contents of the window while users move or resize the windows on their desktops.

themes

bool

ras/rdp

yes

Enable this option to set Windows themes in the remote session.

bitmapcaching

bool

ras/rdp

yes

Enable this option to improve performance by minimizing the amount of display information that is passed over a connection.

optimizewindowsplacement

bool

ras/rdp

yes

Enable this option to impriove user exoerience while moving or resizing a remote application window.

compression

bool

ras/rdp

yes

Enable this option to have a more efficient connection.

useproxy

bool

ras/rdp

yes

Enable this option to use a proxy server.

proxytype

int

ras/rdp

yes

0 = Socks4
1 = Socks4A
2 = Socks5
3 = HTTP 1.1

Choose the proxy server type.

proxyhost

string

ras/rdp

yes

255

Specify the proxy host domain name or IP address.

proxyport

int

ras/rdp

yes

65535

Specify the proxy port.

useproxyauth

bool

ras/rdp

yes

Enable this option if the proxy server requires authentication.

uselogoncredforproxy

bool

ras/rdp

yes

Enable this option if the credenitals required are the same as those of the current connection.

proxyusername

string

ras/rdp

yes

127

Specify the proxy username.

proxypassword

string

ras/rdp

yes

127

Specify the proxy password. This setting can only be set using setsettings.

serverauthmode

int

ras/rdp

yes

0 = Connect
1 = Do not connect
2 = Warn

Specify what action to take if the server authentication fails.

nla

bool

ras/rdp

yes

Use this option to enable network level authentication, which will require Parallels Client to authenticate before connecting to the server.

redirectpos

bool

ras/rdp

yes

Enable this option to redirect Point of Service (POS) devices such as bar code scanners or magnetic readers that are attached to the local computer to be used in the remote connection.

prewindows2000

bool

ras/rdp

yes

Enable this option to use legacy (pre-Windows 2000) login format.

connectiontimeout

int

ras/rdp

yes

999

Specify the amount of time during which Parallels Client will try to connect to Parallels RAS until the connection is aborted. While the connection is being established, the connection banner will be shown if configured.

connectionbannertimeout

int

ras/rdp

yes

999

Specifies the time period in seconds after which the connection banner will be displayed.

showdesktoptimeout

int

ras/rdp

yes

999

Specify the the time period to wait for a published application to be launched. If the application is not launched within this time, the server’s desktop will be shown.

reconnection

bool

ras/rdp

yes

Enable reconnection if a connection is dropped.

retries

int

ras/rdp

yes

Specifies the number of retires to reconnect.

reconnectionbannertimeout

int

ras/rdp

yes

999

Specifies the time period in seconds after which the connection banner will be displayed when reconnected.

prelaunchmode

int

ras/rdp

yes

0 = Off
1 = Basic
2 = Machine learning

Specifies session prelaunch mode. This will make a remote application appear to start faster.

uselocalproxy

bool

ras/rdp

yes

Enable this option to specify IP address 127.0.0.1 to bind the local RDP proxy.

computername

string

ras/rdp

yes

Specifies the name that your computer will use during a remote desktop session.

printertechnology

int

ras

yes

0 = None
1 = WIA
2 = TWAIN
3 = WIA and TWAIN

Select the technology to use when redirecting printers to a remote computer.

redirectprinter

int

ras

yes

0 = All
1 = Default
2 = Specific
3 = None

Select the printers to be redirected by RAS Universal Printing. If "Specific" is used, select the actual printers by using the printerlist setting.

printerlist

string

ras

yes

2048

Specify the specific printers to be redirected by RAS Universal Printing.

printingdataformat

int

ras

yes

0 = Print Portable Document Format (PDF)
1 = Enhanced Meta File (EMF)
2 = Bitmap (BMP)
4 = Print PDF with an external application
5 = View PDF with an external application

Specify which data format is to be used.

clientprinterpref

int

ras

yes

0 = Use server preferences for all printers
1 = Use client preferences for all printers
2 = Use client preferences for the specific printers

Specify how to use the printer preferences. If "Use client preferences for the specifc printers" is used, choose the spefic printers by using printerlistpref setting.

printerlistpref

string

ras

yes

2048

Select which printers will use a local printer preferences dialog when you click "Print"

defaultprinter

string

ras

yes

256

Specify the default printer in the remote session. **Format: **technology,namepattern.

matchname

bool

ras

yes

Enable this option when the remote printer must match the custom printer speficied in the defaultprinter setting.

forcetime

int

ras

yes

86400

Specify the time in milliseconds after the connection is established in which if the default printer is changed, the set printer is reset back to default.

updatedefprinter

bool

ras

yes

Enable this to change the remote default printer automatically when the local default printer is changed. Please note that the new printer must be already redirected.

scannertechonology

int

ras

yes

0 = None
1 = WIA
2 = TWAIN
3 = WIA and TWAIN

Select the technology to use when redirecting scanners to a remote computer.

scannerredirect

int

ras

yes

0 = All
1 = Specific
2 = None

Select the scanners to be redirected by RAS Universal Scanning. If "Specific" is used select the actual scanners by using the "scannerswia" and "scannerstwain"settings. See also listavailablescanners.

scannerswia

string

ras

yes

2048

Specify the specific scanners that use the WIA technology to be redirected by RAS Universal Scanning. See also listavailablescanners.

scannerstwain

string

ras

yes

2048

Specify the specific scanners that use the TWAIN technology to be redirected by RAS Universal Scanning. See also listavailablescanners.

mfarememberlastused

bool

ras

yes

Enable this to remember the last MFA authentication method used which will then used by default.

mfalastused

string

ras

yes

The last MFA action used. This setting is read only.

browsermode

int

ras

yes

0 = Internal
1 = External

Speficy which browser to open for web authentication. This can be the internal browser built into Parallels Client or any external browser installed on the computer.

extbrowserpath

string

ras

yes

260

Specify which external brower path to use. See also listavailablebrowsers.

incognitomode

bool

ras

yes

Enable this to use incognito mode in the external browser.

openbrowsetologout

bool

ras

yes

Enable this option to open a SAML sign out dialog in the built-in browser.

useclientcolors

bool

ras

yes

Enable this option to use Parallels Client system colors instead of those specified on the remote desktop.

useclientsettings

bool

ras

yes

Enable this option to use Parallels Client system settings instead of those specified on the terminal server.

createshortcuts

bool

ras

yes

Enable this option to create the shortcuts as instructed by the administrator configuration. Shortcuts can be created on Parallels Client's desktop and the Start menu.

registerfileext

bool

ras

yes

Enable this option to associate file extensions as instructed by the administrator which will automatically use the remote application.

redirecturl

bool

ras

yes

Enable this option to use the local browser when opening HTTP links in a remote session.

redirectmail

bool

ras

yes

Enable this option to use the local mail client when opening the links starting with "mailto:" in a remote session.

alwaysaskforcreds

bool

ras

yes

Enable this option to be prompted to enter their credentials when starting remote sessions.

allowservertosendcmds

bool

ras

yes

Enable this option to allow commands being received from the server to be executed by Parallels Client.

confirmservercmds

bool

ras

yes

Enable this option to have user confirmation before commands are executed from the server.

disablerdpudp

bool

ras

yes

Enable this option to disable UDP transport when connecting through a gateway.

desktopsize

string

rdp

yes

Specify the desktop size to use. **Format: **fullscreen/availablearea/width x height.

printers

bool

rdp

yes

Enable this to redirect printer in a standard RDP connection.

startonconnection

bool

rdp

yes

Enable this to start an application in a standard RDP connection.

programpath

string

rdp

yes

260

Specify the applicaiton target path when using startonconnection setting.

startfolder

string

rdp

yes

260

Specify the applicaiton start folder when using startonconnection setting.

consoleconnect

bool

rdp

yes

Enable this option to start the standard RDP connection with admin rights to perform tasks on a remote computer that require elevated privileges.

AppserverClient Command Line Interface

setsettings

Arguments

Return codes:

Examples:

Notes:

Global settings:

Connection settings:

See also: