Install a Jump Client on a Linux System

You can override certain installation parameters specific to your needs. These parameters can be specified using a systems administration tool or the command line interface. When you mark specific installation options for override during installation, you can use the following optional parameters to modify the Jump Client installer for individual installations. Note that if a parameter is passed on the command line but not marked for override in the /login administrative interface, the installation fails. If the installation fails, view the operating system event log for installation errors.

It is common to receive an error message during the install, regarding a layout or appearance issue. This can be disregarded.

Command Line Parameter Value Description
--install-dir <directory_path>

Specifies a new writable directory under which to install the Jump Client. 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:<username>
jumpgroup:<jumpgroup-code-name>

If override is allowed, this command line parameter overrides the Jump Group specified in the Mass Deployment Wizard.

--jc-public-site-address <public-site-address-hostname>

If override is allowed, this command line parameter associates the Jump Client with the public portal which has the given host name as a site address. If no public portal has the given host name as a site address, then the Jump Client reverts to using the default public site.

--jc-session-policy-present <session-policy-code-name>

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 <session-policy-code-name>

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 <jump-policy-code-name>

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 <tag-name>

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.

--silent  

If included, the installer shows no windows, spinners, errors, or other visible alerts.

Install a Linux Jump Client in Service Mode

To install a Jump Client in service mode on a Linux system, the Jump Client installer must be run by root, but the Jump Client service should not be run under the root user context. A service mode Jump Client allows the user to start a session even if no remote user is logged on, as well as to log off the current remote user and log on with different credentials. A Linux Jump Client installed in user mode cannot be elevated within a session.

Use the following syntax to add executable permissions to the file, wherein {uid} is a unique identifier consisting of letter and numbers:
  1. Add executable permissions to the file:
    sudo chmod +x ./Downloads/bomgar-scc-[uid].desktop
  2. Run the installer as the root user using the sudo command:

    sudo sh ./Downloads/bomgar-scc-[uid].desktop

The Jump Interface showing a specific Jump Client showing as being installed via service mode.

Remote Support Linux Jump Clients can be installed in service mode. The status of any Jump Client is shown in the info panel that appears when a Jump Client is highlighted in the representative console’s list of Jump Clients. If a Jump Client shows the Install Mode as Service, it is installed as a service; otherwise, this field reads User, indicating it is installed in single-user context.

A service-mode Jump Client allows the user to start a session even if no remote user is logged on, as well as to log off the current remote user and log on with different credentials. A Linux Jump Client installed in user mode cannot do this, nor can it be elevated to service mode within a session.

To install a Jump Client in service mode on a Linux system, the Jump Client installer must be by run by root, but we recommend that you not run the Jump Client service under the root user context. This causes the Jump Client to run as a system service. If a previous Jump Client was installed in user mode, uninstall the existing Jump Client and install a new one as root. The process for doing this varies slightly depending on the distribution of Linux being used, but what follows is typical.

  1. Log in to the representative console, right click the existing user mode Jump Client (if there is one), and click Remove.

Download Jump Client Linux Installer

  1. Log in to the /login admin web interface of the BeyondTrust site and download a Jump Client installer for Linux from the Jump > Jump Clients tab.

 

  1. Launch a terminal and add the executable permission to the installation file:
  2. sudo chmod +x ./Downloads/bomgar-scc-[uid].desktop
  3. Execute the installation file as the root user using the sudo command:
    sudo sh ./Downloads/bomgar-scc-[uid].desktop

Once the installation is complete, a new entry appears in the list of available Jump Clients displayed in the representative console. To test whether the Jump Client is installed as a service or not, you can Jump to the client and log out the active user. If you can still control the screen after logging out, this proves the client is running as a service.

Jump Clients installed in service mode are found in the /opt/bomgar/bomgar-scc-* folder.

Install a Jump Client on a Headless Linux System

To install a Jump Client on a remote Linux system with no graphical user interface, be sure you have downloaded the headless Linux Jump Client installer, and then follow these additional steps:

  1. Using your preferred method, push the Jump Client installer file to each headless Linux system you wish to access.
  2. Once the installer file is on the remote system, use a command interface to install the file and specify any desired parameters.
    • Install the Jump Client in a location to which you have write permission, using --install-dir <path>. You must have permission to write to this location, and the path must not already exist. Any additional parameters must also be specified at this time, as described below.
      sh ./bomgar-scc-{uid}.bin --install-dir /home/username/jumpclient
    • If you wish to install under a specific user context, you can pass the --user <username> argument. The user must exist and have rights to the directory where the Jump Client is being installed. If you do not pass this argument, the Jump Client installs under the user context that is currently running.
      sh ./bomgar-scc-{uid}.bin --install-dir /home/username/jumpclient --user jsmith

 

We do not recommend installing the Jump Client under the root context. If you attempt to install when the current user is root, you receive a warning message and are required to pass --user <username> to explicitly specify the user that the process should run as.

    • You can also override certain installation parameters specific to your needs. When you mark specific installation options for override during installation, you can use the following optional parameters to modify the Jump Client installer for individual installations. Note that if a parameter is passed on the command line but not marked for override in the /login administrative interface, the installation fails. If the installation fails, view the operating system event log for installation errors.

      sh ./bomgar-scc-{uid}.bin --install-dir /home/username/jumpclient --jc-jump-group team:"Linux Admins" --jc-tag "Headless Linux Systems"
      Command Line Parameter Value Description
      --jc-jump-group

      user:<username>
      jumpgroup:<jumpgroup-code-name>

      If override is allowed, this command line parameter overrides the Jump Group specified in the Mass Deployment Wizard.
      --jc-public-site-address <public-site-address-hostname> If override is allowed, this command line parameter associates the Jump Client with the public portal which has the given host name as a site address. If no public portal has the given host name as a site address, then the Jump Client reverts to using the default public site.
      --jc-session-policy-not-present <session-policy-code-name> 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 <jump-policy-code-name>

      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 <tag-name> 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.
  1. After installing the Jump Client, you must start its process. The Jump Client must be started for the first time within the time frame specified by This Installer Is Valid For.
    /home/username/jumpclient/init-script start

    This init script also accepts the stop, restart, and status arguments. You can use ./init-script status to make sure the Jump Client is running.

 

You must also arrange for init-script start to run at boot in order for the Jump Client to remain available whenever the system restarts.

Uninstall a Jump Client

To uninstall a Jump Client, remove it from the Representative Console.

  • If the client is not connected when it is removed from the console, the files are removed next time the client authorizes with the server.
  • Manual changes made for Service Mode Jump Client or Headless Jump Client to start on boot are not removed.

Jump Clients can be removed from a device using a script:

/home/username/jumpclient/uninstall

This will leave an entry in the Representative Console interface. The entry is automatically marked uninstalled or deleted, depending on your Jump Client Settings. Manual changes made for Service Mode Jump Client or Headless Jump Client to start on boot are not removed by the script.

For information about Jump Client settings, please see Configure Jump Client Settings