Jump
What are Jump Clients?
Jump Clients are software agents installed on remote systems, enabling secure, unattended access to those systems for support or administrative tasks.
How are Jump Clients useful to my organization?
Jump Clients provide reliable, always-available access to remote systems, improving efficiency by allowing support teams to resolve issues without requiring user intervention. They enhance security through encrypted connections and customizable access controls.
How do I access the Jump Clients page?
- Use a Chromium-based browser to sign in to your Remote Support URL.
This URL is provided in the BeyondTrust welcome email and includes your site URL followed by /login. - From the left menu, click Jump.
The Jump Clients page opens and displays by default.
Jump Client installer list
This list shows all previously created Jump Client installers. Click the trash can icon to delete the installer. Click the clock icon to change how long the installer will be valid. Click the download icon to either download the installer or to copy the key needed for the generic installer.
A warning appears at the top of the list: Installing more than one Jump Client as the same user or more than one Jump Client as a service on the same system is being phased out in a future release. In the Representative Console you may use the copy action on a Jump Client to apply different policies to the same endpoint. Click Dismiss to hide the message.
Generic Jump Client installer download
The generic installer allows you to download a Jump Client installer package that is not tied to a specific Jump Client installer. Generic installers can be used for automated or ephemeral deployments on VM images and do not require authenticating and downloading the Jump Client-specific installer once deployed.
To use the generic Jump Client installer, select your desired platform and click Download. Copy the provided command into your command line interface (CLI), or double-click the downloaded installer. From the Jump Client installer list, select an installer and click the download icon to copy the key. If using a CLI, replace the text insert key info here with the key; otherwise, if running the Windows MSI through the user interface, enter the key when prompted.
Jump Client mass deployment wizard
To access the Jump Client Mass Deployment Wizard, click Add at the top of the Jump Client Installer List.
The Mass Deployment Wizard enables administrators and privileged users to deploy Jump Clients to one or more remote computers for later unattended access.
Jump Group
From the Jump Group dropdown, select whether to pin the Jump Client to your personal list of Jump Items or to a Jump Group shared by other users. Pinning to your personal list of Jump Items means that only you (and higher ranking roles on your team, such as Team Lead and Team Manager if you are a Team Member, and Team Manager if you are a Team Lead) can access this remote computer through this Jump Client. Pinning to a shared Jump Group makes this Jump Client available to all members of that Jump Group.
Allow override during installation
Some Mass Deployment Wizard settings allow override, enabling you to use the command line to set parameters that are specific to your deployment, prior to installation.
This installer is valid for
The installer remains usable only as long as specified by the This Installer is Valid For dropdown. Be sure to leave adequate time for installation. If someone should attempt to run the Jump Client installer after this time, installation fails, and a new Jump Client installer must be created. Additionally, if the installer is run within the allotted time but the Jump Client is unable to connect to the B Series Appliance within that time, the Jump Client uninstalls, and a new installer must be deployed. The validity time can be set for anywhere from 10 minutes to 1 year. This time does NOT affect how long the Jump Client remains active.
Once a Jump Client has been installed, it remains online and active until it is uninstalled from the local system either by a logged-in admin user with appropriate permissions, by a user from the Jump interface, or by an uninstall script. It can also be uninstalled, or extended, from the Jump Client Installer List. A user cannot remove a Jump Client unless the user is given appropriate permissions by their admin from the /login interface.
Public portal
Select the public portal through which this item should connect for a support session. If a session policy is assigned to this public portal, that policy may affect the permissions allowed in sessions started through this item.
Name
Enter a Name for the Jump Item. This name identifies the item in the session tabs. This string has a maximum of 128 characters.
Comments
Add Comments, which can be helpful in searching for and identifying remote computers. Note that all Jump Clients deployed via this installer have the same comments set initially, unless you check Allow Override During Installation and use the available parameters to modify the installer for individual installations.
Tag
Adding a Tag helps to organize your Jump Clients into categories within the representative console.
Jump Policy
You can apply a Jump Policy to this Jump Client. Jump Policies are configured on the Jump > Jump Policies page and determine the times during which a user can access this Jump Client. If no Jump Policy is applied, this Jump Client can be accessed at any time.
Customer present session policy and customer not present session policy
Choose session policies to assign to this Jump Client. Session policies assigned to this Jump Client have the highest priority when setting session permissions. The Customer Present Session Policy applies when the end user is determined to be present. Otherwise, the Customer Not Present Session Policy applies. The way customer presence is determined is set by the Use screen state to detect Customer Presence Jump Client setting. Customer presence is detected when the Jump Client session starts. The session policy used for the session does not change throughout the session, regardless of any changes in the customer's presence while the session is in progress.
Jumpoint Proxy
When a Jump Client is first deployed, if it cannot connect to the B Series Appliance, it searches the local network for a Jumpoint or Jumpoint cluster serving as a Jump Zone Proxy. This allows a Jump Client installed on a system without a native internet connection to use the Jumpoint to connect back to the B Series Appliance.
In the special case where the Jump Client and Jumpoint are not on the same local network or where a firewall blocks the Jump Client's attempt to connect to the Jumpoint, the Jumpoint Proxy setting allows you to set which Jumpoint the Jump Client should try to use as a proxy.
The Jumpoint selected here must be a standalone Jumpoint running as a Jump Zone Proxy. While Jump Clients can connect to clustered Jumpoints running as a Jump Zone Proxy, you cannot select a clustered Jumpoint in this wizard.
Maximum offline minutes before deletion
You can set the Maximum Offline Minutes Before Deletion of a Jump Client from the system. This setting overrides the global setting, if specified.
Customer client start mode
Select Minimized to start the customer client minimized. It does not take the focus, and appears only in the taskbar or dock when a session is started through this Jump Client.
Select Hidden to start the customer client hidden. It does not take the focus, and appears only as an icon in the system tray when a session is started through this Jump Client.
A warning appears: User Mode Jump Clients are deprecated and will be removed in a future release. Avoid changing the following controls when deploying a new jump client. The following settings only apply to MacOS Desktop and Linux Desktop. Click Dismiss to hide the message.
Attempt an elevated install if the client supports it
Note
User mode Jump Clients are deprecated and will be removed in a future release. This setting applies only to MacOS Desktop and Linux Desktop deployments. It does not apply to Windows deployments.
If Attempt an Elevated Install if the Client Supports It is selected, the installer attempts to run with administrative rights, installing the Jump Client as a system service. If the elevated installation attempt is unsuccessful, or if this option is deselected, the installer runs in user mode, installing the Jump Client in user mode.
Note
A Jump Client pinned in user mode is available only when that user is logged in. In contrast, a Jump Client pinned in service mode, with elevated rights, allows that system to always be available, regardless of which user is logged in.
Prompt for elevation credentials if needed
Note
User mode Jump Clients are deprecated and will be removed in a future release. This setting applies only to MacOS Desktop deployments. It does not apply to Linux or Windows deployments.
If Prompt for Elevation Credentials if Needed is selected, the installer prompts the user to enter administrative credentials if the system requires that these credentials be independently provided; otherwise, it installs the Jump Client with user rights. This applies only if an elevated install is being attempted.
Mass deploy help
For system administrators who need to push out the Jump Client installer to a large number of systems, the Windows MSI, the Mac DMG, or the Linux BIN can be used with your systems management tool of choice.
When using a command line or system management tool to install, you can override certain installation parameters. For any setting with Allow override during installation checked, you can modify the Jump Client installer with the following parameters for each installation.
Note
If a parameter is passed on the command line but the setting is not marked for override in the administrative interface, the installation fails. View the operating system event log for installation errors.
| Command line parameter | Value | Description |
|---|---|---|
| --install-dir | <directory_path> | Specifies a new writable directory under which to install the Jump Client. This is supported only on Windows and Linux. When defining a custom install directory, ensure that the directory you are creating does not already exist and is in a location that can be written to. |
| --jc-name | <name...> | If override is allowed, this command line parameter sets the Jump Client's name. |
| --jc-jump-group | user: jumpgroup: | If override is allowed, this command line parameter overrides the Jump Group specified in the Mass Deployment Wizard. |
| --jc-public-site-address | If override is allowed, this command line parameter associates the Jump Client with the public portal which has the given hostname as a site address. If no public portal has the given hostname as a site address, then the Jump Client reverts to using the default public site. | |
| --jc-session-policy-present | If override is allowed, this command line parameter sets the Jump Client's session policy that controls the permission policy during a support session if the customer is present at the console. | |
| --jc-session-policy-not-present | If override is allowed, this command line parameter sets the Jump Client's session policy that controls the permission policy during a support session if the customer is not present at the console. | |
| --jc-jump-policy | If override is allowed, this command line parameter sets the Jump Policy that controls how users are allowed to Jump to the Jump Client. | |
| --jc-tag | If override is allowed, this command line parameter sets the Jump Client's tag. | |
| --jc-comments | <comments…> | If override is allowed, this command line parameter sets the Jump Client's comments. |
| --jc-max-offline-minutes | If override is allowed, this command line parameter sets the number of minutes the Jump Client can be offline before being considered lost. | |
| --jc-ephemeral | None | If override is allowed on Maximum Offline Minutes, this command line parameter sets the Jump Client to ephemeral mode, marking it as uninstalled if it goes offline for more than 5 minutes. This is the same as setting --jc-max-offline-minutes 5. |
| --silent | None | If specified, the Jump Client performs a silent installation. No user interaction is requested and no user interface is displayed during the process. |
Note
When deploying an MSI installer on Windows using the msiexec command:
- The installation directory may be specified by passing a variable: INSTALLDIR=<path>
- The KEY_INFO= is optional as it is built into the filename.
- If you specify ONLINE_INSTALL=1, the installation fails if it cannot immediately reach the appliance. The default is blank.
- A silent installation can be done by specifying /quiet to the msiexec command.
- All of the --jc… parameters listed above may be specified as variables by:
- Removing leading dashes (-)
- Converting remaining dashes to underscores (_)
- Assigning a value using an equals sign (=)
Example:
msiexec /i bomgar-scc-win32.msi jc_jump_group=jumpgroup:general jc_tag=servers
Download or install the client now
Platform
Choose the operating system on which you wish to install this software. This dropdown defaults to the appropriate installer detected for your operating system.
Note
Unlike the representative console, Jump Clients installed from an MSI do auto-update.
Download/install
You can click the button to download the installer immediately if you plan to distribute it using a systems management tool or if you are at the computer to which you need later access. You can also copy the direct download link for later use, or you can copy the link to download with cURL, wget, or btapi.
Note
For system-specific installation details, see:
Note
Once the installer has run, the Jump Client attempts to connect to the B Series Appliance. When it succeeds, the Jump Client appears in the Jump interface of the representative console. If the Jump Client cannot immediately reach the B Series Appliance, then it continues to reattempt connection until it succeeds. If it cannot connect within the time designated by This Installer Is Valid For, then the Jump Client uninstalls from the remote system and must be redeployed.
Deploy to email recipients
Email
You can also email the installer to one or more remote users. Multiple recipients can install the client from the same link.
Jump Client statistics
An administrator can choose which statistics to view for all Jump Clients on a site-wide basis. These statistics are displayed in the representative console and include CPU, console user, disk usage, a thumbnail of the remote screen, and uptime.
Upgrade
Automatic Jump Client upgrades
Use the radio buttons below to control automatic Jump Client upgrades. You can:
- Permanently disable Jump Client upgrades.
- Temporarily enable Jump Client upgrades for the current upgrade cycle.
- Permanently enable Jump Client upgrades.
Note
In order to be able to manually update Jump Clients in the Web Rep Console, you must first disable Automatic Jump Client Upgrades.
Maintenance
Number of days before Jump Clients that have not connected are automatically deleted
If a Jump Client goes offline and does not reconnect to the B Series Appliance for the number of days specified by the Number of days before Jump Clients that have not connected are automatically deleted setting, it is automatically uninstalled from the target computer and is removed from the Jump interface of the representative console.
Note
This setting is shared with the Jump Client during normal operation so that even if it cannot communicate with the site, it uninstalls itself at the configured time. If this setting is changed after the Jump Client loses connection with the B Series Appliance, it uninstalls itself at the previously configured time.
Note
The setting must be configured for 15 days or more.
Number of days before Jump Clients that have not connected are considered lost
If a Jump Client goes offline and does not reconnect to the B Series Appliance for the number of days specified by the Number of days before Jump Clients that have not connected are considered lost setting, it is labeled as lost in the representative console. No specific action is taken on the Jump Client at this time. It is labeled as lost only for identification purposes, so that an administrator can diagnose the reason for the lost connection and take action to correct the situation.
Note
To allow you to identify lost Jump Clients before they are automatically deleted, set this field to a smaller number than the deletion field above.
Note
The setting must be configured for 15 days or more.
Uninstalled Jump Client behavior
Uninstalled Jump Client Behavior determines how a Jump Client deleted by an end user is handled by the representative console. Depending on the option made in the dropdown, the deleted item can either be marked as uninstalled and kept in the list or actually be removed from the list of Jump Items in the representative console. If the Jump Client cannot contact the B Series Appliance at the time it is uninstalled, the affected item remains in its offline state.
Restrict local uninstall/disable of Jump Clients
Restrict Local Uninstall/Disable of Jump Clients limits the remote user’s ability to uninstall or disable Jump Clients from the right-click context menu, reducing the need to reinstall Jump Clients that should not have been uninstalled. If this option is enabled, only users with appropriate privileges on the target machine may uninstall the Jump Client via the host system's uninstall programs mechanism.
Note
This setting does not apply to Windows. On Windows, the Add/Remove Programs functionality or msiexec /x must be used.
Miscellaneous
Allow representatives to attempt to wake up Jump Clients
Allow Representatives to attempt to wake up Jump Clients provides a way to wake up a selected Jump Client by broadcasting Wake-on-LAN (WOL) packets through another Jump Client on the same network. Once a WOL is attempted, the option becomes unavailable for 30 seconds before a subsequent attempt can be made. WOL must be enabled on the target computer and its network for this function to work. The default gateway information of the Jump Client is used to determine if other Jump Clients reside on the same network. When sending a WOL packet, the user has an advanced option to provide a password for WOL environments that require a secure WOL password.
Use screen state to detect customer presence
Use screen state to detect Customer Presence sets how customer presence is determined. Customer presence is used when choosing whether to use the Customer Present Session Policy or the Customer Not Present Session Policy. If checked, the customer is determined to be present only if a user is logged in, the screen is not locked, and a screen saver is not running. If unchecked, the customer is considered present if a user is logged in, regardless of screen state.
Allow ad-hoc sessions to be started from existing Jump Clients
If this option is checked, and there is already a Jump Client installed on the user's system, an elevated session launches from the existing Jump Client. This applies to both the portal and the session generation API.
Note
For the elevated session to start, a similar permission must be granted for each Public Portal. see Attempt to launch sessions from installed Jump Clients.
Note
You can set Jump Clients to allow or disallow simultaneous Jumps either through a Jump Policy on Jump > Jump Policies or by the global setting configured under Jump > Jump Items > Jump Item Settings. If allowed, multiple users can gain access to the same Jump Client without an invitation to join an active session by another user. If disallowed, only one user can Jump to a Jump Client at a time. Only an invitation by the user who originated the session can allow for a second user to access the session.
Note
For more information on simultaneous Jumps, see Jump Policies: Simultaneous Jumps and Jump Items: Simultaneous Jumps.
Updated 5 days ago