Use Jump Client Scripts from KACE Service Desk

The Jump Client script allows administrators to use the K1000's scripting functionality to automatically install Bomgar Jump Clients on any or all KACE-managed systems which do not yet have a Jump Client installed. To learn more about Jump Clients, refer to Bomgar's Jump Client Guide on bomgar.com/docs. The setup process consists of downloading a Jump Client installer package from Bomgar, loading it into a K1000 installation script, and configuring this script. Once done and tested, the script is duplicated and the copy adjusted to create a removal script.

With on-premises Bomgar Appliances, it is possible to create a Bomgar Support Team to control which Bomgar users have access to new, KACE-deployed Jump Clients by default. If it is acceptable for all Bomgar representatives to have access to newly-installed Jump Clients, there is no need to create a Support Team.

Note: kace.bomgar.com users do not have access to Jump Clients, so this feature is not available to these customers.

Note: The following steps are designed for Windows. To deploy Jump Clients to Mac OS X, refer to Bomgar's document titled Mass Deploying to Macs through Dell KACE.

Jump Client Installer

  1. Log into the Bomgar /login web portal as an admin and browse to Configuration > Jump Clients.
  2. Enter Installed by KACE in the Comments field of the Jump Client Mass Deployment Wizard, check the Start Customer Client Minimized When Session Is Started checkbox, and pick a desirable value from the This Installer Is Valid For dropdown list (make a note of the end-date for the validity period).

    Note: See the Jump Client Guide for details on the installer configuration options. The Jump Client installation file is valid only for the version of Bomgar for which it was downloaded. This version can be verified from the Status tab of Bomgar's /login interface. The installation file will only install and uninstall Jump Clients for its version. In addition, after the installer's validity period has expired, it will cease installing new clients, but it will continue to be able to remove them.

  3. Click Deploy, select Windows (x86) MSI from the Platform dropdown, and make a note of the KEY_INFO= key for use later.
  4. Click Download/Install and Save As to a convenient location and add the current Product Version of the Bomgar Appliance to the end of the file name (e.g. bomgar-scc-win32-ver1423.msi).

K1000 Install Script

  1. Log into the K1000 /admin interface and click Scripting.
  2. Click Choose Action, pick New from the dropdown, and configure it as follows.
    • Focus the Name field and enter Bomgar 14.2.3 - install Jump Client, where 14.2.3 is the version of your appliance.
    • Focus the Description field and enter the following:

      Installs a Jump Client from bomgar.example.com (14.2.3) until 09.17.2014. If the Bomgar Appliance is updated, this script's .msi dependency file, all references thereto, and the KEY_INFO key must be updated with a new .msi file and KEY_INFO string retrieved from https://support.example.com/login/pinned_sessions. Multiple Jump Clients *can be* installed on the same machine, so it is important to use Device Smart Labels during script runs to avoid this.

    • Replace 14.2.3 with your Bomgar Appliance's version, 09.17.2014 with the date on which the installer's validity period will end, and support.example.com with the hostname of the Bomgar Appliance.
    • Focus the Devices field, enter the hostname of a test machine, and click on it in the resulting dropdown list.

      Note: After the script has been tested, it is possible to use the "Labels" field to install Jump Clients on a select group of machines or all machines matching the "Jump Client not installed" label described below. Adding additional labels within the K1000 script is discouraged because additional labels are calculated inclusively such that machines matching any of the given labels will run the script. This means that if additional labels are added, it is possible KACE will by-pass the "Jump Client not installed" label resulting in duplicate Jump Client installations.

    • Un-check the Select Specific Operating Systems checkbox and select Microsoft Windows from the resulting list.
    • Scroll to Schedule and check the Allow to run without a logged-in user checkbox.

      Note: Once the script has been thoroughly tested, it can be updated with a schedule, but the schedule will not take effect until the "Enabled" checkbox is checked at the top of the script configuration page next to the Name field. Once the installer is pushed to the remote systems, it will be executed according to the "Schedule" parameters in the deployment script.

    • Click Add new dependency under the Dependencies section, Browse to the Jump Client MSI installation file, then select it and click Open.
  3. Click New Task under Tasks
    • Click Add under On Success, click the Add a new step dropdown menu, and pick Launch a Program.
    • Focus the Directory field and enter C:\Windows\System32.
    • Focus the File field and enter msiexec.exe.
    • Check the Wait for completion checkbox.
    • Focus the Parameters field and enter: /qn /i "$(KACE_DEPENDENCY_DIR)\[dependencyfile].msi" KEY_INFO=[key]
    • Replace [dependencyfile] with the name of the msi installer file and replace [key] with the key noted earlier from the Bomgar /login installer download page.
  4. Click Save Changes for the task, scroll to the bottom of the page, and click Save for the script.

Test

The following test assumes there is access to a working Bomgar Rep Console and that the system whereon the script is to be run is included and online in the K1000 inventory.

This will require a working KACE agent must to be present on the machine which will run the script. Though there are several ways of installing the agent, a simple method for installation on a single system is given below.

  1. Log into the K1000 /admin interface as an admin, browse to Settings, and click Security Settings.
  2. Check the Enable File Sharing box, scroll to the bottom of the page, and click Save.
  3. Wait for the K1000 appliance to reboot, browse to \\k1000beta\client\agent_provisioning\windows_platform, and install the agent with the "ampagent" MSI file.

Once these steps are complete, the new agent's host should appear listed on the Inventory page of the K1000 in about one minute, depending on the network.

To test the Jump Client K1000 installation script, follow these steps:

  1. Log into the K1000 /admin interface and click Scripting.
  2. Click on the Bomgar 14.2.3 - install Jump Client script name, where "14.2.3" is the version of your Bomgar Appliance.
  3. Verify the appropriate test machine is listed in the script's Deploy parameters.
  4. Scroll to the bottom of the page, click Run Now, and wait for the script run to complete.

The script's run status will be shown on the Run Now Status page. Details of the script execution during and after its run can be seen by clicking on the timestamp of the appropriate entry in the Started field to load the Run Now Status Detail page. Once complete, the exact command which was run on the remote system can be reviewed from the View Logs link under either Failed Execution or Successful Execution, depending on whether or not the script succeeded. After the script completes, the local system may briefly flash a small command prompt window, and then a new Jump Client should appear in the local system tray and appear in the Bomgar Rep Console after refreshing the Jump Client list.

If the install fails, use the View Logs link in the Run Now Status Detail page to compare the script run logs against the On Success parameters of the installation script. Make sure the parameters match this documentation exactly, especially the quotation marks. If the parameters were copy-pasted from this guide into the KACE interface, manually replace the quotation marks to ensure they are encoded correctly. Sometimes copy-pasting will result in "fancy" quotes instead of straight quotes. If necessary, remove the /qn parameter from the installation script and re-run it. This will allow any MSI error messages to appear on the test machine instead of being suppressed.

K1000 Removal Script

  1. Log into the K1000 /admin interface, click Scripting, and click the name of the installation script.
  2. Scroll to the bottom of the page and click Duplicate.
  3. Locate the "Copy of" Jump Client installation script, click on its name, and take these steps:
    • Update the Description field to read:

      Removes a Jump Client from bomgar.example.com (14.2.3). Jump Clients can be removed from Add/Remove Programs, from the context menu of the systray icon (potentially), and from the Rep Console; however, scripted removal is the preferred method. Please note that Jump Clients which are already deployed should automatically update when their Bomgar Appliance is updated, so manual removal and re-installation is not necessary for most upgrades. Please refer to [bomgar.com/upgrade](http://www.bomgar.com/docs/content/support/upgrade/quickguide.htm) for further information. This script is valid for all MSI-deployed clients for its same Bomgar site so long as they are on the same version as the removal script's MSI dependency file. This means the same removal script can be used to remove clients installed by multiple different MSI installation files so long as these files came from the same Bomgar product version as the removal script's MSI file.

    • Replace 14.2.3 with your Bomgar Appliance's version, 09.17.2014 with the date on which the installer's validity period will end, and support.example.com with the hostname of the Bomgar Appliance.
    • Scroll down to the On Success task, move the cursor over step "1", and click the Edit link which appears on the end of the line.
    • Replace /i with x.
  4. Click Save Changes and then click Save at the bottom of the script configuration page.
  5. Follow the testing procedure described above.

Once complete, the removal script should operate similarly to the installation script except for the fact that the Jump Client icon in the system tray will disappear and its status in the Rep Console Jump Client list will update to read "Uninstalled".

K1000 Smart Labels

Although multiple Jump Clients can be safely installed on a single system, in most cases this is unadvisable from a management perspective. If this is the case, use KACE Smart Labels to prevent the installation script from installing on systems which already have a Jump Client present.

  1. Log into the K1000 /admin interface, browse to Home > Labels > Smart Labels > Choose Action > New > Device Smart Label
  2. Configure the following:
    • Click the Agent Connection Time dropdown and pick Software Titles from the resulting list.
    • Click the = dropdown and pick does not contain from the resulting list.
    • Focus the text box to the right of "does not contain", enter Bomgar Jump Client 14.2.3 [bomgar.example.com], and replace 14.2.3 and bomgar.example.com with your appliance's version and DNS hostname, respectively.

      Note: Both the version and the hostname can be verified from the Status tab of the Bomgar /login interface.

    • Focus the Choose label field, enter Bomgar 14.2.3 - Jump Client not installed (where 14.2.3 is your appliance's version), and press Enter
  3. Click Test, confirm the results appear correct, and click Create once done.
  4. Repeat steps 1 - 3 picking does contain from the = dropdown and Bomgar 14.2.3 - Jump Client installed (where 14.2.3 is your appliance's version) for the label name.

Bomgar Team (Optional)

In larger environments, it may not be desirable to allow all logged-in Bomgar users to access newly-deployed Jump Clients installed by KACE. To restrict access, it is possible to designate a Bomgar Support Team to contain the Jump Clients. From here, they can be moved to different teams as necessary. The steps to configure this setup are given below. Note that the first step assumes that there is no existing team which should receive the installed Jump Clients. If there is already such a team, skip the first step.

  1. Add a Bomgar team for the Jump Clients.
    • Log into the Bomgar /login web interface as an admin and browse to Configuration > Support Teams.
    • Click Add New Team, assign it a name, then add users and configure any other settings as necessary. Once done, click Add Team.

      Note: Fore more information on team configuration, refer to the Bomgar Administrator's Guide: http://www.bomgar.com/docs/content/admin/support-teams.htm.

  2. Create a Jump Client installer as described above but use the Pin Location dropdown menu to select the appropriate team.

    Note: It is also possible to use the personal queue of a specific user. This user would then be responsible for Jump Client deployments by KACE and could move them to the appropriate queues after they come online from the deployment process.

  3. Complete the rest of the installation script setup steps as described above.

    Note: It is not necessary to create a separate removal script. Once one removal script has been created from a specific Bomgar Appliance product version, that script can be expected to successfully remove any and all Jump Clients deployed for that Bomgar product version regardless of what configuration options were selected for their original installation.

Once these steps are complete, Jump Clients installed using the new installer will appear in the Bomgar Rep Console listed under the queue of the team (or user) matching the "Pin Location" of the installer. At default settings, only Bomgar user accounts which are members of the appropriate team will be able to access the Jump Clients; however, it is possible for an administrator to grant certain users rights to access Jump Clients for all teams in the system. For more information on Jump Client permission settings, refer to the "Jump Client" settings described in the Bomgar Administrator's Guide here: http://www.bomgar.com/docs/content/admin/settings-and-field-details.htm.