ShellAPI

ShellAPI is a tool you can use for invoking the Agent to execute different actions and is also used by the Agent.

Actions

The following actions are available:
--refresh - Refreshes the Agent.
--trigger {eventName} - Triggers an event.
--distribute {package} - Distributes a package.
--install {package} - Installs a package.
--launch {package} - Launches a package.
--repair {package} - Repairs a package.
--uninstall {package} - Uninstalls a package.
--deploymentList - Displays the enabled deployments.
--deploymentRun - Displays the deployment dialog.
--deploymentStart {deployment} - Starts the deployment specified as an argument or in the Agent configuration .JSON file.

The available types of {eventName} are:

• LiquitLogon - Triggers when a user logs in to the Liquit Workspace.
• DeviceStartup - Triggers when the device is started.
• Refresh - Triggers when a refresh is triggered.
• SessionConnect - Triggers when a remote desktop session is connected/reconnected.
• SessionDisconnect - Triggers when a remote desktop session is disconnected/interrupted.
• SessionLock - Triggers when a desktop session is locked.
• SessionUnlock - Triggers when a desktop session is unlocked.
• AgentStartup - Triggers when the Agent service is started.
• DeviceShutdown - Triggers when the device is shutdown.
• UserLogin - Triggers when a user logs in to the device.
• UserLogout - Trigger when a user logs out of the device.
• NetworkChange - Triggers when a network (interface/adapter) change occurs.

Options

The following options are available:
--console - Prints messages to the console.
--silent - Does not display messages in any way (overrules --console).
--noRetry - When Agent is not available, it does not retry to connect to it.
--wait - Waits until the agent reports that the action is complete.
--noProgress - Does not display the progress of an action.
--cmdLine - Provide optional arguments to the package(s) execution. The option is valid for the distribute, install, launch, repair, uninstall, deploymentRun and deploymentStart actions.
--stage - Specify the stage of a package that should be used for the action to execute. The option is valid for the distribute, install, launch, repair and uninstall actions.
--shortcut - Specify a shortcut for executing a package. The option is valid for the Launch and Repair type of actions.