Start a Session through a Jump Client

Once a Jump Client has been installed on a remote computer, permitted representatives can use the Jump Client to initiate a session with that computer, even if the computer is unattended.

From the Representative Console

From the Jump interface of the representative console, click Refresh or enter a search phrase to see the Jump Clients available to you.

Note: In addition to Jump Clients, you may also see Jump shortcuts for remote Jumps, local Jumps, RDP sessions, Shell Jumps, and Intel® vPro sessions. For more information about Jump shortcuts, see the Jumpoint Guide.

Jump Clients Menu

Search Jump Clients

From the left pane, select the Jump group for which you want to view pinned Jump Clients. Jump Clients are grouped according to who can access them – only the representative who created them, a particular team, or all representatives. You may see Jump Clients pinned to your personal Jump group and to your team Jump group, as well as to other teams whose Jump Clients your team has been granted access to. Team Managers and Team Leads can also view Jump Clients that team members of a lower role have pinned to their personal Jump groups. If you are allowed to view Jump Clients for individual representatives who are part of a selected team Jump group, those representatives will appear in a second pane to the left.

If a Jump group contains tagged Jump Clients, an arrow will appear to the left of the Jump group name. Click the arrow to show or hide the tags.

In addition to browsing for Jump Clients, you can search based on multiple fields. Enter a string in the search field and then press Enter. To change the fields you are searching, click on the magnifying glass and check or uncheck any of the available fields. Searchable fields include comments, console user, group, Jump method, last accessed date, name, private IP, public IP, status, and tag.

To view additional statistics about a Jump Client, select the Jump Client. Available statistics will appear in the right pane.

To start a session, double-click the Jump Client or select the Jump Client and click the Jump button from:

  • above the Jump interface
  • the right-click menu of the Jump Client
  • the top of the Jump Client statistics pane

Attempt to Wake Up Jump Client

Depending on the permissions set by your administrator, you may also be able 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 will have an advanced option to provide a password for WOL environments that require a secure WOL password.

If you no longer need access to a remote system, select the Jump Client and click the Remove button, or right-click on the Jump Client and select Remove from the menu. You may select multiple Jump Clients to remove them all at the same time.

Note: If the remote user manually uninstalls a Jump Client, it will remain in your queue, along with the statistics from its last update, but you will not be able to access that computer. If a Jump Client goes offline and does not connect back to the Bomgar Appliance for 180 days, it will automatically be uninstalled from the target computer and will be removed from the Jump interface.

Jump Client Properties

Organize and manage existing Jump Clients by selecting one or more Jump Clients and clicking Properties.

Jump Client properties are described in the section Deploy Jump Clients During a Support Session or Prior to Support.

 

From the API

By integrating with the Bomgar API, you may programmatically connect to a Jump Client directly from your systems management tool or ticketing system. To start a session with a Jump Client from an external program, you will need to use a Bomgar Representative Console Script. A BRCS contains a sequence of commands to be executed by the representative console. Double-click a BRCS file to have it automatically executed by the representative console, or incorporate it into an external application to send commands to the representative console from that application.

One method of creating a BRCS is through the client scripting API. This API is located on your Bomgar Appliance at https://support.example.com/api/client_script, where support.example.com is your Bomgar site hostname.

Note: By default, access to the API is SSL-encrypted; however, you can choose to allow HTTP access by checking the Allow HTTP Access to XML API option on the Management > API Configuration page of the /login administrative interface. It is highly recommended that HTTP remain disallowed as a security best practice.

Optional Parameters for the start_pinned_client_session Command

search_string=[string]

If specified, then this is the search criteria used to select a Jump Client. The comments, hostname, private IP, public IP, and tag fields are matched against the search string.

This field has a maximum length of 1024 characters. Search is partial and case-insensitive.

client.comments

If specified, only Jump Clients with the given comments are included in the results.

This field has a maximum length of 255 characters. Search is partial and case-insensitive.

client.hostname

If specified, only Jump Clients with the given hostname are included in the results.

This field has a maximum length of 255 characters. Search is partial and case-insensitive.

client.private_ip

If specified, only Jump Clients with the given private IP address are included in the results.

This field has a maximum length of 255 characters. Search is partial and case-insensitive.

client.public_ip

If specified, only Jump Clients with the given public IP address are included in the results.

This field has a maximum length of 255 characters. Search is partial and case-insensitive.

client.tag

If specified, only Jump Clients with the given tag are included in the results.

This field has a maximum length of 255 characters. Search is partial and case-insensitive.

session.custom.[custom field]=[string]

The code name and value of any custom fields. These fields must first be configured in /login > Management > API Configuration.

Each attribute must be specified as a different parameter. Each custom field has a maximum length of 1024 characters. The maximum total size of all combined custom fields, including the external key, must be limited to 10KB.

IMPORTANT!

Either search_string or client.* parameters must be specified, but not both. It is an error to specify both the search_string and a client.* parameter. It is also an error to not specify either one.

If multiple client.* parameters are specified, then only pinned clients matching all criteria are returned.

Query Examples: start_pinned_client_session

Start a session with a Jump Client which has any field containing the string "ABC" https://support.example.com/api/client_script?type=rep&operation=generate&action=start_pinned_client_session&search_string=ABC
Start a session with a Jump Client whose hostname contains "ABCDEF02" https://support.example.com/api/client_script?type=rep&operation=generate&action=start_pinned_client_session&client.hostname=ABCDEF02
Start a session with a Jump Client whose comments contain "maintenance" and whose tag contains "server" https://support.example.com/api/client_script?type=rep&operation=generate&action=start_pinned_client_session&client.comments=maintenance&client.tag=server
Start a session with a Jump Client whose private IP address begins with "10.10.24" and associate custom attributes with the session

https://support.example.com/api/client_script?type=rep&operation=generate&action=start_pinned_client_session&client.private_ip=10.10.24&session.custom.custom_field1=Custom%20Value&session.custom.custom_field2=123

Note: If more than one Jump Client matches the search criteria, then a dialog will open, giving the user the option to select the appropriate Jump Client.

Sending one of the above requests to the API will prompt the representative to download a BRCS file. After downloading the file, the representative can run it to automatically open the representative console and start a session with a Jump Client.

In addition to generating a script from the API, you can run a BRCS via the command prompt. From the command prompt, go to the directory which contains the representative console. Enter the name of your Bomgar representative console (e.g., bomgar-rep.exe), followed by one of two commands:

--run-script "action=start_pinned_client_session&search_string=[string]"

--run-script-file [path to BRCS file]

Examples:

bomgar-rep.exe --run-script "action=start_pinned_client_session&search_string=Example%20Co"

bomgar-rep.exe --run-script-file C:\Users\admin\Desktop\rep-script.brcs-support_example_co

Jump Client Access from Script

All Jump Clients which this representative is permitted to access will be searched. If the search results in only one Jump Client, the session will start immediately. If multiple Jump Clients are returned, select one of the Jump Clients listed in the selection window and click OK.

For more information about Bomgar Representative Console Scripting, see the API Guide at www.bomgar.com/docs.