Configure KACE Inventory & Distribution for Jump Clients

KACE provides a Managed Installation tool, designed to easily and consistently mass-deploy software to KACE-managed systems, as well as to monitor the status of this deployment. Bomgar can leverage this tool to mass-deploy Jump Clients on Windows and Mac. To learn more about Jump Clients, refer to Bomgar's Jump Client Guide.

NOTE: These instructions are for a Windows deployment using a fully licensed Bomgar site. For Mac deployment instructions, please see Mass Deploying Bomgar Software to Macs.

Users of kace.bomgar.com do not have the option to mass-deploy Jump Client software. Jump Client limits for fully licensed Bomgar systems are documented in Bomgar's Jump Client Guide.

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.

KACE Agent Installation

Jump Client installation through KACE requires the KACE Agent to be installed on all systems which will receive a copy of the Jump Client. If the Agent is not already installed, follow these steps to do this on a test machine.

NOTE: These steps will require admin access to the K1000 /admin web interface.

  1. Log into the K1000 /admin interface as an admin (e.g., http://k1000/admin).
  2. Browse to Settings > Security Settings.
  3. Check the Enable File Sharing box.
  4. Scroll to the bottom of the page and click Save.
  5. Wait for the K1000 appliance to reboot.
  6. Browse to \\k1000\client\agent_provisioning\windows_platform, and install the AMPagent MSI.

Once the KACE Agent is deployed to all the necessary machines, proceed with the following steps to set up the Jump Client installation.

Jump Client Installation

The first step is to create a Jump Client installation MSI, install it, and update the KACE Software Inventory with the new installation. You must:

  • Obtain admin access to the Bomgar /login web interface.
  • Use a Windows machine on which you can install software.
  • Install the KACE Agent on the above machine.

After this is done, take the following steps to install a Jump Client and post it to the KACE Software Inventory:

  1. Log into your Bomgar /login admin web interface (e.g., https://support.example.com/login).
  2. Make note of the Primary Hostname and Product Version.
  3. Browse to Configuration > Jump Clients.
  4. Configure a Jump Client Mass Deployment:
    • Select 1 Week or more for This Installer is Valid For.
    • Uncheck Prompt for Elevation Credentials if Needed and check Start Customer Client Minimized When Session is Started.
    • See Jump Clients to determine what other options to select, if any.
  5. Click Create, select Windows (x86) MSI for the Platform, and copy the KEY_INFO string.
  6. Click Download/Install, save the file, and install it:
    • Right-click the downloaded MSI file and click Create Shortcut.
    • Right-click the shortcut, click Properties, and paste your KEY_INFO string to the end of the Target field (e.g., "C:\Documents and Settings\bob\Desktop\bomgar-scc-win32.msi" KEY_INFO=w0dc30w8i18z711gggyjyjzizyefgieiffwzdfc40jc90).
    • Click OK, and launch the shortcut.
  7. Force Check-In with the KACE Software Inventory:
    • Open a command prompt and run Services.msc.
    • Open the Properties of the Dell KACE Agent service.
    • Copy the Path to executable.
    • Return to the command prompt and paste the path (e.g., C:\Program Files (x86)\Dell\KACE\AMPAgent.exe).
    • Replace AMPAgent.exe with runkbot.exe, add 4 0 to the end of the line (e.g., "C:\Program Files (x86)\Dell\KACE\runkbot.exe" 4 0), and hit Enter.

After a few minutes, the KACE Software Inventory should update with a record for the new Jump Client. Once this is done, it will be possible to create a Managed Installation to mass-deploy the Jump Client. It is important to note that Prompt for Elevation Credentials if Needed should be unchecked and Start Customer Client Minimized When Session is Started checked on the Jump Client options in order to ensure it will install silently.

Managed Installation

Once the Bomgar Jump Client MSI has been successfully created, tested, and posted to the KACE Software Inventory, KACE can be configured with a Managed Installation to deploy the Jump Client. In the following instructions, the /qn option is used on the Install command line to facilitate a silent install.

NOTE: These steps will require admin access to the K1000 /admin web interface.

  1. Log into your K1000 /admin web interface (e.g., http://k1000/admin).
  2. Click Distribution in the left nav-bar.
  3. Click Choose Action > New, and configure the software options:
    • Uncheck Only display records with an associated file.
    • Click Select software and enter Bomgar Jump Client followed by your Bomgar Primary Hostname (e.g., Bomgar Jump Client support.example.com).
    • Select the appropriate result based on the Bomgar Product Version noted earlier.
    • Click Browse under Upload and Associate New File.
    • Select your Jump Client MSI and click Open to upload it.
  4. Configure the Managed Installation:
    • Select Override Default Installation and enter the following in the Full command line: msiexec.exe /qn /i bomgar-scc-win32.msi KEY_INFO=w0idc306z7zgx7x58d6w8he5zge1h5iewwyiyyfc40jc90.
    • Replace w0idc306z7zgx7x58d6w8he5zge1h5iewwyiyyfc40jc90 with the KEY_INFO string used earlier.
    • Check Don't Prepend msiexec.exe.
  5. Name and deploy the Managed Installation:
    • Select the appropriate Labels and/or enter the Devices on which to install the Jump Client.
    • Scroll to the top of the page, and enter an appropriate Name for the Managed Installation based on your parameters (e.g., Bomgar Jump Client support.example.com (14.3.2.0)).
    • Select Anytime under Execution
    • Scroll to the bottom of the page and click Save.

KACE will now deploy the Jump Client MSI for your Bomgar site to all the systems specified in the Managed Installation. In order for this to occur, the K1000 Agent on each machine must report to the K1000. This event can be forced either from the Force Inventory button on the Device page for each device in the K1000 Inventory, or it can be forced from the local device using the runkbot.exe command described earlier.

The entire deployment can take 24-48 hours, depending on how quickly the K1000 Agents update the Inventory (among other factors). As this happens, the Managed Installation will show how many systems have installed the Jump Client, and how many have yet to complete the Installation. As the Jump Clients are installed, they will populate in the Bomgar representative console for the Bomgar site from which the Jump Client MSI was downloaded.

The Managed Installation will not install twice on the same machine, but it can be expected to continue installing Jump Clients on new machines until either the Jump Client MSI package reaches its expiration date or the Bomgar Appliance is updated. The expiration date is a value set by the admin in Bomgar immediately before generating and downloading the Jump Client MSI.

When the Jump Client MSI package expires and/or is outdated, existing Jump Clients will persist, but in order to continue installing new Jump Clients, it will be necessary to update the Managed Installation with a new Jump Client MSI and a new KEY_INFO string per the instructions in this guide.

Managed Uninstall

After a Jump Client has been installed, it will remain installed until such time as someone removes it. This can be done either from the Bomgar representative console, the local machine, or the Jump Client MSI using the /x msiexec command switch. This last option is the recommended method, and it can be done silently through a KACE Managed Installation. Because of this, it is best practice when using Managed Installation deployments to do two things:

  1. Disable the Bomgar user permission to Deploy, Remove and Modify Jump Clients (see Settings and Field Details: User Permissions in the User Accounts for Password Reset).
  2. Check Restrict Local Uninstall/Disable of Jump Clients in the Jump Client configuration of Bomgar (see Jump Clients).

NOTE: The following steps will require admin access to the K1000 /admin web interface.

  1. Locate and copy the Bomgar Jump Client Uninstall Command:
    • Log into your K1000 /admin web interface (e.g., http://k1000/admin).
    • Browse to Inventory > Software and search for Bomgar Jump Client followed by your Bomgar Primary Hostname (e.g., Bomgar Jump Client support.example.com).
    • Select the Name of the result which has the Version that matches the Bomgar Product Version noted earlier.
    • Copy the Uninstall Command (e.g., MsiExec.exe /I{58418483-BC6C-488C-A062-E7053C33B28D}).
  2. Duplicate the Managed Installation to create the Uninstall:
    • Click Distribution in the left nav-bar and select the Managed Installation created earlier.
    • Scroll to the bottom of the page and click Duplicate.
    • Open the newly created copy of the Managed Installation.
    • Paste the Uninstall Command into the Full command line, replacing /I with /qn /x (e.g., MsiExec.exe /qn /x{58418483-BC6C-488C-A062-E7053C33B28D}).
    • Check the boxes for Uninstall, Run Command Only (do not download file), and Don't Prepend msiexec.exe.
  3. Name and deploy the Uninstall:
    • Update the Managed Install Name to reflect the changes (e.g., Uninstall of Bomgar Jump Client support.example.com (14.3.2.0)).
    • Set the Install Execution, if you want to uninstall the Jump Client.
    • Scroll down to Deploy and select the appropriate Labels and/or enter the Devices from which you wish to remove the Jump Client, if any.
    • Scroll to the bottom of the page and click Save.

At this point, the Jump Client software will be removed from the system(s) specified in the Uninstall. Be careful never to have the Install Managed Installation active at the same time as the Uninstall Managed Installation.

NOTE: It is important to note that the GUID used in the command line of the Uninstall is unique to the Jump Client MSI package. If a new MSI package is used, this GUID can be expected to change. This means that the Uninstall Managed Installation is specific to the Jump Client MSI package which was used to create the KACE Software Inventory record from which the Uninstall Command was retrieved. This command should be updated if and when the MSI package is updated in the KACE Software Inventory.

Set Up 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.

For more information on team configuration, refer to Support Teams: Group Representatives into Teams.

  1. Add a Bomgar team for the Jump Clients (if such a team already exists, skip this step).
    • Log into the Bomgar /login web interface as an admin (e.g., https://support.example.com/login).
    • Browse to Configuration > Support Teams.
    • Click Add New Team, assign it a name, and configure any other settings as necessary.
    • Click Add Team when done.
  2. Create a Jump Client installer as described above but use the Pin Location dropdown menu to select the appropriate team.
  3. Complete the rest of the setup steps as described earlier.

Once these steps are complete, Jump Clients installed using the new installer will appear in the Bomgar representative console listed under the Jump Group 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. See Jump Clients Permissions in the Admin Interface for details.