AppserverClient Command Line Interface
AppserverClient Command Line Interface
AppServerClientCLI [command] [arguments] If no command is passed, the application you will enter the command shell which allows multiple inputs using the same process. In this mode you can use additional internal commands.
For additional help on each command, type "AppServerClientCLI help command".
Example:
AppServerClientCLI help listconnections
Command descriptions
help: provides information on the existing commands. generatehelptxt: generates documentation about the CLI interface in the plain text format. generatehelphtml: generates documentation about the CLI interface in the HTML format. generatehelpmd: generates documentation about the CLI interface in the Markdown format. version: provides version information for the CLI interface. checkforupdate: checks whether a new version of Parallels Client is available (also checks the AVD client). isssoenabled: checks whether the SSO component is enabled. enablesso: enables or disables the SSO component. listconnections: provides information on existing connections. addconnection: creates a new connection with or without showing the UI. updateconnection: changes credentials and (optionally) hardware ID. deleteconnection: deletes an existing connection. duplicateconnection: duplicates an existing connection. logonras: logs on to a RAS connection. logoffras: logs off from a RAS connection. disconnectras: disconnects an RDP session from a single RAS connection. disconnectallras: disconnects all RDP sessions from all RAS connection. logoffallras: logs off from all RAS connections. logoffrassession: logs off from a session created from a RAS connection. getpublicipinfo: retrieve the public IP information. clearpublicipinfo: clears the public IP information. connectrdpobj: starts an RDP connection. disconnectrdpobj: stops an RDP connection. disconnectallrdp: disconnects from all RDP connection. startrasobj: starts a published object from a RAS connection. showwnd: brings up the UI window. savefavorites: saves a comma separated list of the published items added to Favorites. createshortcut: creates a shortcut for an RDP connection or a published desktop or application. createfavoritesshortcuts: creates shortcuts for all applications added to Favorites in a RAS connection. deleteallshortcuts: deletes all shortcuts on the desktop. startnotifications: registers the CLI application as a receiver of notifications from the backend. stopnotifications: unregisters the CLI application as a receiver of notifications from the backend. setsmartsizing: changes smart-sizing runtime settings for an RDP connection session. getsmartsizing: retrieves smart-sizing runtime settings for an RDP connection session. sendkeys: sends keys to an active session. sendmouseevents: sends mouse events to the local system. This means that the mouse events will affect both local and remote applications. sendkeyboardevents: sends keyboard events to the local system. This means that the keyboard events will affect both local and remote applications. getsessionsinfo: returns the sessions information. disconnectsession: disconnects a session created from a RAS or RDP connection. getraspolicyinfo: returns information about the set policies. getsettings: fetches settings of a connection or generic to Parallels Client. setsettings: updates settings from a connection or generic to Parallels Client. settingsinfo: gets information about settings. iscanaction: checks whether an action command is available. getloggedrasinfo: gets information about an already logged on RAS connection. startclient: starts Parallels Client. restartclient: closes and restarts an active instance of Parallels Client. stopclient: closes Parallels Client. listavailablebrowsers: gets a list of available browsers to use as external browsers for web authentication. listavailablessoproviders: gets a list of available third-party credential providers to use with SSO wrapping. listavailabledisplays: gets a list of available displays. listavailablecameras: gets a list of available video capturing devices. listavailabledevices: gets a list of other supported devices. listavailablescanners: gets a list of available scanners. getshareddevice: retrieves information about shared device configuration. setshareddevice: updates the shared devcie configuration. clearshareddevice: clears the shared device configuration. exportsettings: exports the settings of Parallels Client. importsettings: imports previously exported settings to Parallels Client. factoryreset: deletes all connections and resets all settings to the default values or resets connection settings. clientviewlog: shows Parallels Client log file. clientreadlog: reads the contents of Parallels Client log file. clientclearlog: clears Parallels Client log file. clientversion: provides version information for Parallels Client. enablelog: enables log. All commands called after this will be logged into the log file. disablelog: disables log. clearlog: clears the log file. viewlog: shows the log file. clientreport: provides diagnostics information about Parallels Client. enableaudit: enables CLI usage audit. disableaudit: disables CLI usage audit. clearaudit: clears the CLI usage audit file. getaudit: retrieves the CLI usage audit file. uploadfile: upload a file to the remote session. downloadfile: download a file from the remote session. universalprintingmonitor: manages monitoring of universal printing jobs.
Internal command descriptions
quit: closes the CLI. cls: clears the CLI terminal window. useautoidon: enables the auto ID mode. When enabled, if the command return an ID, it can be automatically used in the next commands if an argument is not passed to them. useautoidoff: disables the auto ID mode. useautostartclienton: enables the auto start client mode. When enabled, Parallels Client starts automatically if a command requires it. useautostartclientoff: disables the auto start client mode. sleep: waits for a number of seconds. loop: executes the following command a number of times. recordon: enables the record mode. When enabled, all entered commands are saved in the memory and can be played back or saved. recordoff: disables the record mode. recordclear: clears the recorded commands. recordplay: replays the recorded commands. Optionally, you can load commands from a file before they are played. recordsave: saves records to a file. If no filename is passed, you will be prompted for one. recordload: loads records from a file. If no filename is passed, you will be prompted for one. recorddebugon: enables the record debug mode. When enabled, on the playback of the recorded commands the user is asked to press a key after each command. sleep and debugpause are automatically skipped. recorddebugoff: switches off record debug mode. debugpause: wait for user to press any key. state: shows the auto ID mode, auto start client mode, records mode, and record debug mode states. rem: anything following rem or // is treated as a comment.
Last updated