Scripted Sessions

In this section, a Dell KACE script will be created which will allow a technician to automatically start a Bomgar session with KACE-managed Windows or Mac systems. Windows systems do not require a user to be logged-in for the script to work, but Mac systems will require a logged-in user.

  1. Configure a Bomgar Support team for scripted sessions.
    1. Login to the Bomgar Appliance's /login web interface as an administrator and browse to Configuration > Support Teams.

      Note: kace.bomgar.com customers should skip this step and begin configuration with step 2.

    2. Click Add New Team, name it Scripted KACE Sessions (or something similar), add users and configure any other settings as necessary and then click Add Team.

      Adding Scripted KACE Session Support Team

    3. Switch to the Issues page and click Add New Support Issue. Add a description such as Dell KACE Script, then Route To the Team created above and click Add Support Issue.

      Adding Scripted KACE Session Support Issue

    4. In the address bar of the web browser, enter https://bomgar.example.com/api/command?username=admin&password=password&action=get_support_teams where bomgar.example.com is the URL of the Bomgar Appliance, admin is the username of an admin user for the site and password is the password for the admin user.

      Note: As of 14.2, the file extension .ns has been deprecated from the command API call. However, it is still available for backward compatibility.

    5. Locate the issue id for the Dell KACE team created previously in the resulting page and make note of it.

Locating Issue ID

  1. Configure the InitiateBomgarSession.vbs script.
    1. Download the VBScript and SH Script files from the Bomgar Self Service Center and save them to a convenient location.
    2. Edit the InitiateBomgarSession.vbs script with a text editor, locate WScript.Arguments(0) on line 14 and paste over it with https://bomgar.example.com/api/start_session?issue_menu=1&id=x where bomgar.example.com is the URL of the Bomgar Appliance and x is the issue id noted above.

      Note: Kace.bomgar.com users should use their K1000 Run Now Script URL from their Dell KACE Configuration page for this step.

      Initiate Session Script

      Note: As of 14.2, the file extension .ns has been deprecated from the start_session API call. However, it is still available for backward compatibility.

    3. Save the script and close the text editor.
  2. Configure the Dell KACE Bomgar Initiate Session script.
    1. Login to the Dell KACE K1000 Management Center as an admin and click Scripting in the top navigation bar.
    2. Click Choose Action and select Add New Item.
    3. Configure the fields as indicated below, replacing bomgar.example.com with the Bomgar Appliance's address as necessary:
      • Name: Bomgar Initiate Session (bomgar.example.com).
      • Description: Initiate a Bomgar support session to a remote Windows or Mac system from bomgar.example.com.
      • Check Enabled.

        Configure Bomgar Script

      • Uncheck Pick Specific OS Versions.
      • Shift-click Microsoft Windows and MAC OS X.

        Configure Bomgar Script Op Systems

      • Click Add new dependency..., then Choose File and Open the InitiateBomgarSession.vbs script.
      • Repeat the above step for the InitiateBomgarSession.sh script.

        Configure Bomgar Session .sh Script

    4. Add a task section for Windows systems.
      • Click Add Task Section... and set On Failure to Continue.
      • Under the Verify section, click Add..., select Verify a directory exists, enter C:\Program Files and click Save Changes.
      • Under the On Success section, click Add..., select Log message..., enter Detecting operating system... and click Save Changes.
      • Click Add..., select Log message..., enter This is a Windows system and click Save Changes.
      • Click Add... again, select Launch a program..., enter C:\Windows\System32 for the Directory, enter wscript.exe for the File: and enter "$(KACE_DEPENDENCY_DIR)\InitiateBomgarSession.vbs" for the Parameters and click Save Changes.

        Configure Task Section

    5. Add a task section for Mac systems.
      • Click Add Task Section... again and set On Failure to Continue.
      • Under the Verify section, click Add..., select Verify a directory exists..., enter /usr/bin for the Directory and click Save Changes.
      • Under the On Success section, click Add..., select Log message..., enter Detecting operating system... for the Message, and click Save Changes.
      • Click Add..., select Log message..., enter This is a Mac system and click Save Changes.
      • Click Add..., select Launch a program, enter "$(KACE_DEPENDENCY_DIR)" for the Directory, InitiateBomgarSession.sh for the File, https://bomgar.example.com/api/start_session?issue_menu=l&id=x for the Parameters and click Save Changes.

        Note: kace.bomgar.com users should use their K1000 Run Now Script URL from their Dell KACE Configuration page for this step.

        Configure Mac Task Section

        Note: As of 14.2, the file extension .ns has been deprecated from the start_session API call. However, it is still available for backward compatibility.

    6. Scroll to the bottom of the script configuration page and click Save.
  3. Test the script.
    1. Login to the Bomgar Representative Console.
    2. Browse to the Scripting tab in top navigation bar and select Run Now.
    3. Select the Bomgar Initiation Session Script (bomgar.example.com) script using either the dropdown menu or the filter.
    4. Select the desired test machine using either the dropdown or the filter and click Add All.
    5. Click Run Now and wait for the job to complete.
  4. Once the script completes successfully, a new session should appear in the Bomgar Rep Console under the tab for the team which was previously assigned to receive Dell KACE Script sessions. If all this occurs, setup is complete.