Jump Client Guide

Jump Client Guide
Jump Client Guide
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
TC:5/2/2017
JUMP CLIENT GUIDE
Table of Contents
Remote Support Jump Client Guide: Unattended Access to Systems in Any Network
3
Set Jump Client Permissions
4
Deploy Jump Clients During a Support Session or Prior to Support
9
During a Support Session
Prior to Support
9
10
Installation on Windows, Linux, or Mac Systems
12
Installing a Linux Jump Client in Service Mode
14
Installation on Headless Linux Systems
15
Configure Jump Client Settings
Active vs. Passive Jump Clients
Create Jump Policies to Apply to Jump Clients
Create a Jump Policy
Manage Jump Client Access
Jump Client Access Use Cases
Start a Support Session through a Jump Client
17
18
19
19
20
20
21
From the Representative Console
21
From the API
23
Appendix: Jump Client Error Message Reference
26
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
2
TC: 5/2/2017
JUMP CLIENT GUIDE
Remote Support Jump Client Guide: Unattended Access to
Systems in Any Network
With Bomgar Jump Technology, a user can access and control remote, unattended computers in any network. Jump Technology is
integral to the Bomgar software offerings. Because Bomgar Remote Support is licensed per active representative and not per
remote system, Jump Technology is a cost-effective way to reach every device in your enterprise.
A Jump Client is an installable application that enables a user
to access a remote computer, regardless of its location. The
remote computer does not need to reside on a known network.
Jump Clients are persistently connected to the appliance, thus
helping you reach systems on remote networks anywhere in
the world. By pre-installing Jump Clients on remote systems, a
user can establish sessions with unattended Windows, Mac,
and Linux computers.
Bomgar Jump Clients are not limited by license count; instead,
they are limited by hardware as described below.
Appliance Comparison
B200
B300
B400
Up to 1,000 Active Jump
Clients
Up to 10,000 Active Jump
Clients
Up to 25,000 Active Jump
Clients
Up to 50,000 Passive Jump
Clients
Up to 50,000 Passive Jump
Clients
Up to 50,000 Passive Jump
Clients
Virtual Appliance
Depends on allocated resources.
See the Virtual Appliance Sizing
Guidelines.
If more Jump Clients are needed, contact Bomgar Technical Support.
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
3
TC: 5/2/2017
JUMP CLIENT GUIDE
Set Jump Client Permissions
Allow Users to Access and Modify Jump Clients
To pin a Jump Client, you must have permission to deploy,
remove, and modify Jump Items in at least one Jump Group.
Jump Groups associate Jump Clients with representative
accounts. A representative who is a member of a Jump Group
can start sessions with or modify the Jump Items in that group,
assuming the representative has the appropriate permissions.
Jump Group membership is assigned either from the Team
Members section of the /login > Configuration > Support
Teams page or from the Support Teams section of the /login >
Users & Security > Group Policies page.
To grant an individual user permission to start Jump Client
sessions, edit the account on the /login > Users & Security >
Users page, scroll down to Allowed Jump Methods, and
check Jump Clients.
To grant a group of users permission to start Jump Client
sessions, edit the group policy on the /login > Users &
Security > Group Policies page, scroll down to Allowed Jump
Methods, and check Jump Clients.
Just because a user can start Jump Client sessions does not
mean that they can automatically pin and modify Jump Clients.
An administrator still must specify which Jump Clients the user
can modify, if any. Permission to modify Jump Clients always
includes the ability to deploy them, to remove them, and to
modify their parameters after installation.
A user with permission to modify Jump Items in All Jump
Groups within the System can deploy, edit, and remove all
Jump Items, regardless of which Jump Group they are in.
A user with permission to modify Jump Items in Team and
Team Members' Personal Queues can deploy, edit and remove Jump Items in any teams to which they belong, as well as in the
personal Jump Groups of any team members of a lower role.
A user with permission to modify Jump Items in their Personal Queue can deploy, edit, and remove Jump Items only in their own
Jump Group. They cannot modify Jump Items for any other users in the system.
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
4
TC: 5/2/2017
JUMP CLIENT GUIDE
Allow Users to Pin Jump Clients
Permission to deploy, remove, and modify Jump Items always grants the user permission to download and install Jump Clients
prior to support as described in "Deploy Jump Clients During a Support Session or Prior to Support" on page 9. However, this does
not necessarily mean that the user has permission to pin Jump Clients during a support session. To pin a Jump Client during a
support session, the user must have the permission Jump Clients Pinning/Unpinning. This permission can be defined in any of the
three following locations in /login:
l
Users & Security > Users
l
Users & Security > Group Policies
l
Users & Security > Session Policies
If you need to assign the permission only to one or two users,
do so from the Users page.
If you need to assign the permission to one or two groups of
users, do so from the Group Policies page.
If you need to assign the permission to three or more groups of
users, to specific Jump Clients, or to one or more of your public
portals, do so from the Session Policies page.
Regardless of where you set this permission, the configuration
works the same. Locate the Jump Clients Pinning/Unpinning
permission and select Allow.
Note: Selecting Deny prevents pinning/unpinning of Jump Clients. Selecting Not Defined falls back to a lower priority session
policy or the global session policy.
If you allow this permission for a specific user on the Users page, then that user can pin/unpin any session they start.
If you allow this permission for a specific Group Policy, then any members of that policy can pin/unpin any session they start.
However, if you allow this permission for a specific Session Policy, no change occurs until you assign this policy to one or more
users, group policies, Jump Items, or public portals.
Assign a Session Policy to a User or Group
To assign a session policy to a user account, group policy, or
public portal, set the Availability of the session policy to allow
Users.
Note: Making the pin/unpin permission available to rep
invite is meaningless. External representatives cannot
have ownership of sessions, and only the owner of a
session can pin/unpin Jump Clients.
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
5
TC: 5/2/2017
JUMP CLIENT GUIDE
To assign a session policy to a user or a group policy, edit the
user or group, scroll down to the Session Permissions
section, and select the session policy you want from the
dropdown.
Assign a Session Policy to a Public Portal
Public portals allow you to assign additional DNS hostnames to your Bomgar Appliance and specify a different look and feel for
each one, along with different behavior and permissions. You can define public portals on the /login > Public Portals > Public Sites
page.
If you allow pinning/unpinning for a public portal, then all sessions started through that portal allow the representative to pin/unpin,
regardless of any permissions assigned to the representative's user account or group policy.
To assign a session policy to a public portal:
1. Go to /login > Public Portals > Customer Client.
2. At the top of the page, check the Select a different
public site to edit dropdown to make sure you have the
right portal selected.
3. Under Customer Client :: Session Policy, use
dropdown to select a policy.
Assign a Session Policy to a Jump Item
To assign a session policy to a Jump Item, set the Availability
of the session policy to allow Jump Items. While Jump Items
include more than just Jump Clients, the pin/unpin permission
applies only to Jump Clients.
When a session policy which allows pinning/unpinning is
assigned to a Jump Client, then any user who starts a session
with that Jump Client can unpin it, even if that user is denied
permission to unpin Jump Clients in all other sessions.
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
6
TC: 5/2/2017
JUMP CLIENT GUIDE
To assign a session policy to a Jump Client, the user must
have permission to change the session policies associated
with Jump Items.
When a user has this permission, they can right-click any Jump
Client they are allowed to modify, click Properties, and assign
a session policy to the Jump Client using the Customer
Present Session Policy and Customer Not Present Session
Policy dropdowns.
Note: The way customer presence is determined is set
by Use screen state to detect customer presence on
the /login > Jump > Jump Clients page under Jump
Client Settings. If checked, the customer is determined to
be present only if a user is logged in, the screen is not
locked, and a screen saver is not running. If unchecked,
the customer is considered present if a user is logged in,
regardless of screen state.
Troubleshoot Settings with the Session Policy Simulator
If a specific user is unable to pin/unpin Jump Clients during a session, you can use the session policy simulator to troubleshoot the
issue.
1. Log into /login as an admin and go to Users & Security > Session Policies.
2. Scroll to the Session Policy Simulator section and enter the Representative and Session Start Method in question.
3. Click the Simulate button and check the result for the permission Jump Clients Pinning/Unpinning.
If the simulator indicates that the user should be able to pin/unpin for a given session, and yet in practice this is not the case, then
verify that the user has permission to modify Jump Clients:
1. Log into /login as an admin and go to Users & Security > Users.
2. Edit the user in question and locate the Allowed to Deploy, Remove, and Modify Jump Items permission.
3. Ensure that at least one of the available options is checked.
4. If the page does not allow you to modify this permission, then locate the Group Policy Memberships field on the page and
update the group policy which is controlling the modify Jump Items permission.
a. There may be multiple policies involved, so you may need to check each one.
b. If the same permission is defined in multiple policies, you may need to reorder them or change the option Allow this
policy to be overridden? for the modify Jump Items permission.
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
7
TC: 5/2/2017
JUMP CLIENT GUIDE
c. If you reorder policies or allow override, remember that a group policy listed further down in the list of policies
overrides policies further up in the list only when the permission in question allows override on the first/topmost
group policy; otherwise, the first group policy takes precedence.
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
8
TC: 5/2/2017
JUMP CLIENT GUIDE
Deploy Jump Clients During a Support Session or Prior to
Support
There are two ways to install a Jump Client. During a Bomgar support session, a Jump Client can be installed ad-hoc by the
representative. Alternatively, an administrator can mass-deploy Jump Clients for a larger rollout. These two methods of installation
are outlined below.
During a Support Session
A Jump Client may be installed ad-hoc during a support session. This will allow the support representative to access this computer
at a later time, even if the computer is unattended. This method of installation is also known as session pinning and is achieved by
clicking the Pin as Jump Client button.
Note: A Jump Client pinned in user mode is available only when that user is logged in. In contrast, a Jump Client pinned in
service mode, with elevated rights, will allow that system to always be available, regardless of which user is logged in.
Note: Support representatives can access unattended Android devices through session pinning. To learn more, please see
Initiate an Android Support Session at wwww.bomgar.com/docs/remote-support/getting-started/customerclient/android/android-support.htm.
1. From within a support session, click the Pin as Jump Client button in the session
toolbar at the top right corner of the representative console.
2. From the dropdown, you may select to customize the Jump Client before deploying
it.
a. Change a Jump Client's mode from the Connection Type dropdown. Active
Jump Clients send statistics to the Bomgar Appliance on a defined interval.
Passive Jump Clients send statistics to the Bomgar Appliance once a day or
upon a manual check in. Based on the options your administrator sets,
these statistics may include the remote computer’s logged-in console user,
operating system, uptime, CPU, disk usage, and a screen shot from the last
update.
b. Once a Jump Client has a password set, its icon will show that it is locked,
and its screen shot will also be locked. In order to Jump to a locked Jump
Client, you must provide its password. Also, you must provide the password
to remove a locked Jump Client via the Jump Client interface; you do not
need the password to unpin from within a session, as you would already
have provided the password to Jump into the session.
c. If Starts Quietly is checked, the customer client will not take focus and will
remain minimized in the taskbar or dock when a session is started.
d. You also have the option to set when the Jump Client expires. This can be never, at a specific time and date, or after
a certain length of time. An expired Jump Client automatically uninstalls from the remote system and is removed from
the list in the Jump Client interface.
e. Move Jump Clients from one Jump Group to another using the Jump Group dropdown. The ability to move Jump
Clients to or from different Jump Groups depends upon your account permissions.
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
9
TC: 5/2/2017
JUMP CLIENT GUIDE
Note: Multiple support teams and embassies may be able to access Jump Clients pinned to one Jump Group,
depending on rules set by your Bomgar software administrator.
Note: Prior to 15.1, Jump Groups were called queues.
f. Further organize Jump Clients by entering the name of a new or existing Tag. While the selected Jump Clients will
be grouped together under the tag, they will still be listed under the Jump Group where each is pinned. To move a
Jump Client back into its top-level Jump Group, leave this field blank.
Note: Prior to 15.1, tags were called groups.
g. Select the Public Portal through which this Jump Client should connect. If a session policy is assigned to this public
portal, that policy may affect the permissions allowed in sessions started through this Jump Client. The ability to set
the public portal depends on your account permissions.
h. Jump Clients include a Comments field for a name or description, which makes sorting, searching, and identifying
Jump Clients faster and easier.
i. To set when users are allowed to access this Jump Client, choose a Jump Policy. These policies are configured by
your administrator in the /login interface.
j. Choose session policies to assign to this Jump Client. Session policies assigned to this Jump Client have the
highest priority when setting session permissions. The Customer Present Session Policy applies when the end
user is determined to be present. Otherwise, the Customer Not Present Session Policy applies. The way customer
presence is determined is set by the Use screen state to detect Customer Presence Jump Client setting. When
enabled, a customer will be considered present only if a user is logged in, the system is not locked, and a screen
saver is not running. When disabled, a customer will be considered present if a user is logged in, regardless of the
screen state. Customer presence is detected when the Jump Client session starts. The session policy used for the
session does not change throughout the session, regardless of any changes in the customer's presence while the
session is in progress. The ability to set a session policy depends on your account permissions.
3. Alternatively, you can simply select a Jump Group to which to pin the Jump Client, not setting any properties. From the
dropdown, select whether to pin the Jump Client to your personal Jump Group, to a team Jump Group, or to the general
Jump Group. Pinning to your personal Jump Group means that only you can access this remote computer through its Jump
Client. Pinning to a team Jump Group makes this Jump Client available to all members of teams which are allowed to
access this team's Jump Clients. Pinning to the general Jump Group allows access to all representatives.
4. Depending on the session permissions, the customer may receive a message that you are requesting to install a Jump
Client. The customer will be asked to allow or refuse the request.
5. Once the Jump Client is installed, the remote computer will appear in the Jump interface of the representative console. You
may have to refresh the interface to see the new Jump Client.
Prior to Support
Jump Clients can be pre-installed on remote computers in anticipation of the need for remote access. This method of installation
may be applied to one system or multiple systems simultaneously. You can easily automate the mass deployment of your Jump
Client network by allowing customization during installation. The Jump Client command line installer has switches which allow a
script to modify a variety of Jump Client parameters when executed. This allows you to create custom mass deployment scripts to
pull in variables from other sources and use the variables to modify the Jump Client parameters at install time.
1. From the /login administrative interface, go to Jump > Jump Clients.
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
10
TC: 5/2/2017
JUMP CLIENT GUIDE
2. From the dropdown, select whether to pin the Jump
Client to your personal Jump Group, to a team Jump
Group, or to the general Jump Group. Pinning to your
personal Jump Group means that only you can access
this remote computer through its Jump Client. Pinning
to a team Jump Group makes this Jump Client
available to all members of teams which are allowed to
access this team's Jump Clients. Pinning to the general
Jump Group allows access to all representatives.
3. Select the Public Portal through which this Jump Client
should connect. If a session policy is assigned to this
public portal, that policy may affect the permissions
allowed in sessions started through this Jump Client.
4. Choose session policies to assign to this Jump Client. Session policies assigned to this Jump Client will have the highest
priority when setting session permissions. The Customer Present Session Policy applies when the end user is determined
to be present. Otherwise, the Customer Not Present Session Policy applies. The way customer presence is determined is
set by the Use screen state to detect Customer Presence Jump Client setting. Customer presence is detected when the
Jump Client session starts. The session policy used for the session does not change throughout the session, regardless of
any changes in the customer's presence while the session is in progress.
5. You may apply a Jump Policy to this Jump Client. Jump Policies are configured on the Jump > Jump Policies page and
determine the times during which a user can access this Jump Client. If no Jump Policy is applied, this Jump Client can be
accessed at any time.
6. Adding a Tag helps to organize your Jump Clients into categories within the representative console.
7. Set the Connection Type to Active or Passive for the Jump Clients being deployed. For more information on active versus
passive Jump Clients, see "Active vs. Passive Jump Clients" on page 18.
8. If you have one or more Jumpoints set up as proxies, you can select a Jumpoint to proxy these Jump Client connections.
That way, if these Jump Clients are installed on computers without native internet connections, they can use the Jumpoint to
connect back to your Bomgar Appliance. The Jump Clients must be installed on the same network as the Jumpoint selected
to proxy the connections. For more information on setting up Jumpoints as proxies, see the Jumpoint Guide.
9. Add Comments, which can be helpful in searching for and identifying remote computers. Note that all Jump Clients
deployed via this installer will have the same comments set initially, unless you check Allow Override During Installation
and use the available parameters to modify the installer for individual installations.
10. The installer will remain usable only as long as specified by the This Installer is Valid For dropdown. Be sure to leave
adequate time for installation. If someone should attempt to run the Jump Client installer after this time, installation will fail,
and a new Jump Client installer will have to be created. The validity time can be set for anywhere from 10 minutes to 1 year.
This time does NOT affect how long the Jump Client remains active.
In addition to expiring after the period given by the This Installer is Valid For option, Jump Client mass deployment
packages invalidate when their Bomgar Appliance is upgraded. The only exception to this rule is live updates which change
the license count or license expiration date. Any other updates, even if they do not change the version number of the
appliance, invalidate the Jump Client installers from before the upgrade. If these installers are MSI packages, they can still
be used to uninstall Jump Clients if necessary.
Once a Jump Client has been installed, it remains online and active until it is uninstalled from the local system either by a
logged-in user, by a representative from the representative console's Jump interface, or by an uninstall script. A
representative cannot remove a Jump Client unless the representative is given appropriate permissions by their admin from
the /login interface.
11. If Attempt an Elevated Install if the Client Supports It is selected, the installer will attempt to run with administrative rights,
installing the Jump Client as a system service. If the elevated installation attempt is unsuccessful, or if this option is
deselected, the installer will run with user rights, installing the Jump Client as an application. This option applies only to
Windows and Mac operating systems.
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
11
TC: 5/2/2017
JUMP CLIENT GUIDE
Note: A Jump Client pinned in user mode is available only when that user is logged in. In contrast, a Jump Client pinned
in service mode, with elevated rights, will allow that system to always be available, regardless of which user is logged in.
Note: This option does not apply to headless Linux Jump Clients.
12. If Prompt for Elevation Credentials if Needed is selected, the installer will prompt the user to enter administrative
credentials if the system requires that these credentials be independently provided; otherwise, it will install the Jump Client
with user rights. This applies only if an elevated install is being attempted.
Note: This option does not apply to headless Linux Jump Clients.
13. By selecting Start Customer Client Minimized When Session Is Started, the customer client will not take focus and will
remain minimized in the taskbar or dock when a session is started through one of these Jump Clients.
Note: This option does not apply to headless Linux Jump Clients.
14. You can also set a Password for these Jump Clients. If a password is set, this password must be provided to modify or use
any one of these Jump Clients.
15. Once you click Create, you can download the Jump
Client installer immediately if you plan to distribute it
using a systems management tool or if you are at the
computer that you need to later access. You can also
email the installer to one or more remote users.
Multiple recipients can install the client from the same
link. The Platform option defaults to the appropriate
installer for your operating system. You can select a different platform if you plan to deploy the Jump Client on a different
operating system.
Note: Once the installer has run, the Jump Client attempts to connect to the appliance. When it succeeds, the Jump
Client appears in the Jump interface of the representative console. If the Jump Client cannot immediately reach the
appliance, then it continues to reattempt connection until it succeeds. If it cannot connect within the time designated by
This Installer Is Valid For, then the Jump Client uninstalls from the remote system and must be redeployed.
Installation on Windows, Linux, or Mac Systems
Note: To install a Jump Client in service mode on a Linux system, the Jump Client must be installed as root. This will NOT
cause the Jump Client to run as root. 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.
For system administrators who need to push out the Jump Client installer to a large number of systems, the Windows, Mac, or Linux
executable or the Windows MSI can be used with your systems management tool of choice. You can include a valid custom install
directory path where you want the Jump Client to install. You can also override certain installation parameters specific to your
needs. These parameters can be specified for both the MSI and the EXE 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
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
12
TC: 5/2/2017
JUMP CLIENT GUIDE
marked for override in the /login administrative interface, the installation will fail. If the installation fails, view the operating system
event log for installation errors.
Command Line Parameter
Value
Description
--install-dir
<directory_path>
Specifies a new writable directory under which to install the
Jump Client. This is supported only on Windows and Linux.
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-jump-group
user:<username>
team:general
team:<team-code-name>
embassy:<embassy-codename>
If override is allowed, this command line parameter overrides
the Jump Group specified in the Mass Deployment Wizard.
<public-site-addresshostname>
If override is allowed, this command line parameter associates
the Jump Client with the public portal which has the given
hostname as a site address. If no public portal has the given
hostname as a site address, then the Jump Client will revert to
using the default public site.
<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-notpresent
<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.
--jc-public-site-address
--jc-session-policy-present
--silent
If included, the installer shows no windows, spinners, errors, or
other visible alerts.
Note: The parameters --jc-location and --jc-group have been deprecated as of 15.1 and have been replaced with the
parameters --jc-jump-group and --jc-tag, respectively.
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
13
TC: 5/2/2017
JUMP CLIENT GUIDE
Note: When deploying an MSI installer on Windows using an msiexec command, the above parameters can be specified by:
1. Removing leading dashes (-)
2. Converting remaining dashes to underscores (_)
3. Assigning a value using an equal sign (=)
Example:
msiexec /i bomgar-scc-win32.msi KEY_INFO=w0dc3056g7ff8d1j68ee6wi6dhwzfefggyezh7c40jc90 jc_
jump_group=team:general jc_tag=servers
The only exception to this rule is installdir, which has a dash in the EXE version but no dashes in the MSI version.
There are two exceptions to this rule:
l
installdir has a dash in the EXE version but no dashes in the MSI version.
l
/quiet is used for the MSI version in place of --silent in the EXE version.
Installing a Linux Jump Client in Service Mode
In Bomgar Remote Support 15.2.1 and above, Linux Jump
Clients may be installed in service mode. The current 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 must be installed as root. This does not cause the
Jump Client to run as root, but it does 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 into the representative console, right click the
existing user mode Jump Client (if there is one), and
click Remove.
2. Log into the /login admin web interface of the Bomgar
site and download a Jump Client installer for Linux
from the Jump > Jump Clients tab.
3. Launch a terminal and add the executable permission
to the installation file:
sudo chmod +x ./Downloads/bomgar-pec-w0dc30djf57y7f6yy6wfwfhhjyg8ggx6jz8i1ic40jc90.desktop
4. Execute the installation file with sh as the root user using the sudo command:
sudo sh ./Downloads/bomgar-pec-w0dc30djf57y7f6yy6wfwfhhjyg8ggx6jz8i1ic40jc90.desktop
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
14
TC: 5/2/2017
JUMP CLIENT GUIDE
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.
Installation on Headless Linux Systems
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.
a. 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
b. 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
IMPORTANT!
It is not recommended to install 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.
c. You can also override certain installation parameters specific to your needs. These parameters can be specified for
both the MSI and the EXE 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 will fail. 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
"Linux Admins" --jc-tag "Headless Linux Systems"
Command Line
Parameter
--jc-jump-group
Value
user:<username>
team:general
team:<team-code-name>
embassy:<embassy-codename>
Description
If override is allowed, this command line parameter
overrides the Jump Group specified in the Mass
Deployment Wizard.
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
15
TC: 5/2/2017
JUMP CLIENT GUIDE
--jc-public-site-address
<public-site-addresshostname>
If override is allowed, this command line parameter
associates the Jump Client with the public portal which
has the given hostname as a site address. If no public
portal has the given hostname as a site address, then
the Jump Client will revert to using the default public
site.
--jc-session-policy-notpresent
<session-policy-codename>
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.
3. 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.
IMPORTANT!
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.
4. If you wish to uninstall the Jump Client, you must run its uninstall script.
/home/username/jumpclient/uninstall
Note: Separately and in addition to running the uninstall script, you must remove the Jump Client via the representative
console. Otherwise, the Jump Client will remain in the representative console, though it will not be accessible. Likewise,
removing the Jump Client only via the representative console prevents it from being accessed but leaves the Jump
Client files on the Linux system.
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
16
TC: 5/2/2017
JUMP CLIENT GUIDE
Configure Jump Client Settings
An administrator can choose which statistics to view for all
Jump Clients on a site-wide basis. These statistics are
displayed in the representative console and include operating
system, uptime, console user, CPU, disk usage, and a
thumbnail of the remote screen. Existing Jump Clients will
reflect changes to Jump Client statistics at the next update
interval.
The Active Jump Client Statistics Update Interval
determines how often these statistics are updated. Managing
which statistics are viewed and how often can help to regulate
the amount of bandwidth used. The more active Jump Clients
you have deployed, the fewer the statistics and the longer the
interval may need to be.
Also set the maximum number of Jump Clients to upgrade at
the same time. Note that if you have a large number of Jump
Clients deployed, you may need to limit this number to
regulate the amount of bandwidth consumed.
You may further regulate the bandwidth used during upgrades
by setting Maximum bandwidth of concurrent Jump Client
upgrades.
Note: Neither of these settings affects representative console upgrades or Bomgar Button deployments.
The option Allow simultaneous representative access to a single Jump Client provides a way for multiple representatives to
gain access to the same Jump Client without having to be invited to join an active support session by another representative. The
first representative to access the Jump Client maintains ownership of the session. Representatives in a shared Jump session will
see each other and be able to chat.
Restrict Local Uninstall/Disable of Jump Clients limits the remote user’s ability to uninstall or disable Jump Clients from the rightclick context menu, reducing the need to reinstall Jump Clients that should not have been uninstalled. If this option is enabled, only
users with appropriate privileges on the target machine may uninstall the Jump Client via the host system's "uninstall programs"
mechanism.
Allow Representatives to attempt to wake up Jump Clients provides a way 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.
Use screen state to detect Customer Presence sets how customer presence is determined. Customer presence is used when
choosing whether to use the Customer Present Session Policy or the Customer Not Present Session Policy. If checked, the
customer is determined to be present only if a user is logged in, the screen is not locked, and a screen saver is not running. If
unchecked, the customer is considered present if a user is logged in, regardless of screen state.
Set whether ad-hoc Jump Clients pinned during a session should by default be active or passive.
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
17
TC: 5/2/2017
JUMP CLIENT GUIDE
The Passive Jump Client Port specifies which port a passive Jump Client will use to listen for a "wake up" command from the
appliance. The default port is 5832. Ensure that firewall settings allow inbound traffic on this port for your hosts with passive Jump
Clients. Once awake, Jump Clients always connect to the appliance on port 80 or 443 outbound.
Active vs. Passive Jump Clients
Jump Clients allow for one of two modes of behavior, active or passive. The default mode can be set from the Jump > Jump Clients
page, and the mode can be switched from the Jump interface of the representative console.
A Jump Client in active mode maintains a persistent connection to the Bomgar Appliance, waiting for session requests. It sends
statistics updates as frequently as once per minute, as defined in the Jump Client Settings on the Jump > Jump Clients page.
A passive Jump Client does not maintain a connection to the appliance but rather listens for connection requests. It sends statistics
updates only once per day or upon manual check-in. By setting Jump Clients to passive mode, you can have a larger number of
deployed Jump Clients without markedly increasing the appliance load.
Note: If Console User is checked in Jump Clients > Jump Client Statistics, passive Jump Clients will check in whenever they
detect a new console user and report the user’s name.
In order to use a passive Jump Client, the appliance must be able to initiate contact with the computer on which the passive Jump
Client is installed. This requirement may necessitate that you modify firewall rules to allow incoming connections to the target
computer through the configured listen port. By default, this port is 5832; this can be modified from the Jump > Jump Clients page.
Passive mode may best be used on internal systems rather than external ones, although with correct firewall configurations, it may
be used in either implementation. The following table presents key differences between the two modes.
Active and Passive Jump Clients
Active Jump Client
Passive Jump Client
Maintains a persistent connection to the Bomgar Appliance.
Listens for a remote access request from the Bomgar Appliance.
Note: Some firewall configuration may be required.
Sends statistics to the Bomgar Appliance at regular intervals.
Sends statistics to the Bomgar Appliance once a day, upon
manual check-in, or when a new user logs in (if this feature is
enabled).
Enables remote access to any desktop operating system
supported by Bomgar.
Enables remote access to any desktop operating system
supported by Bomgar.
Number of installable clients is limited by your Bomgar
Appliance model.
50,000 passive Jump Clients supported on all Bomgar
Appliance models.
B200
Up to 1,000 Active
Jump Clients
B300
Up to 10,000
Active Jump
Clients
B400
If you need more passive Jump Clients, visit
www.bomgar.com/help.
Up to 25,000
Active Jump
Clients
Note: The maximum number of Jump Clients available to a Virtual Appliance is based on allocated resources. See the Virtual
Appliance Sizing Guidelines at www.bomgar.com/docs.
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
18
TC: 5/2/2017
JUMP CLIENT GUIDE
Create Jump Policies to Apply to Jump Clients
To control access to particular Jump Clients, create Jump Policies. Jump Policies are used to control when certain Jump Clients
can be accessed by implementing schedules.
Create a Jump Policy
1. From the /login administrative interface, go to Jump > Jump Policies.
2. Click Add New Jump Policy.
Note: A Jump Policy does not take effect until you
have applied it to at least one Jump Client.
3. Create a unique name to help identify this object. This
name should help users identify this policy when
assigning it to Jump Clients.
4. Set a code name for integration purposes. If you do not
set a code name, one will be created automatically.
5. Add a brief description to summarize the purpose of
this object.
6. If you want to enforce an access schedule, check
Enable. If it is disabled, then any Jump Clients that use
this policy can be accessed without time restrictions.
l
l
l
Set a schedule to define when Jump Clients under this policy can be accessed. Set the time zone you want to use for
this schedule, and then add one or more schedule entries. For each entry, set the start day and time and the end day
and time.
If, for instance, the time is set to start at 8 am and end at 5 pm, a user can start a session using this Jump Client at
any time during this window but may continue to work past the set end time. They will not, however, be allowed to reaccess this Jump Client after 5 pm.
If stricter access control is required, check Force session to end. This forces the session to disconnect at the
scheduled end time. In this case, the user receives recurring notifications beginning 15 minutes prior to being
disconnected.
7. When you are finished configuring this Jump Policy, click Save Jump Policy.
After the Jump Policy has been created, you can apply it to Jump Clients either from the /login interface or from the representative
console. For details, see "Deploy Jump Clients During a Support Session or Prior to Support" on page 9.
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
19
TC: 5/2/2017
JUMP CLIENT GUIDE
Manage Jump Client Access
You can manage which teams have access to which Jump Clients by configuring a support team or embassy. Go to /login >
Configuration > Support Teams or /login > Users & Security > Embassy.
Edit the team or embassy whose Jump Client access you wish
to manage. Then scroll down to the Jump Client Access
section.
By default, the only team which has access to this team's Jump
Clients is this team itself. However, you can allow other teams
and embassies to access and modify Jump Items pinned to
this team's Jump Group. You could also remove this team's
access to its own pinned Jump Clients.
When you have finished managing Jump Client access, save
the changes to the support team or embassy.
Jump Client Access Use Cases
Two-way Shared Jump Client Access
In this use case, your organization has multiple groups of users who perform different functions and who need to be on separate
teams. However, two of these groups regularly need to access the same computers. You can grant Team A access to Team B's
Jump Clients, and you can also grant Team B access to Team A's Jump Clients. This way, whichever Jump Group a Jump Client is
pinned to, both teams can access it.
One-way Shared Jump Client Access
In this use case, your organization has one team, Team A, which manages all types of computers, both desktops and servers.
However, a second team, Team B, manages only servers. You can grant Team A access to Team B's Jump Clients. Then, pin only
servers to Team B's Jump Group, so that both Team A and Team B can access these servers. Pin desktops to Team A's Jump
Group, so that only Team A but not Team B can access these desktop clients.
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
20
TC: 5/2/2017
JUMP CLIENT GUIDE
Start a Support Session through a Jump Client
Once a Jump Client has been installed on a remote computer, permitted users 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, and Shell
Jumps. Collectively, Jump Clients and Jump shortcuts are referred to as Jump Items. For more information about Jump
shortcuts, see the Jumpoint Guide.
From the left pane, select the Jump Group for which you want to view pinned Jump Clients.
Jump Items are grouped according to who can access them – only the user who created
them, a particular team, or all users. You may see Jump Items pinned to your personal
Jump Group and to your team Jump Group, as well as to other teams whose Jump Items
your team has been granted access to. Team Managers and Team Leads can also view
Jump Items that team members of a lower role have pinned to their personal Jump Groups.
From the Jump Client search feature, you can search for Jump Clients based on specific
criteria, such as Group, Last Accessed, Name, IP address, etc. For example, the
Console User selection allows you to search for the individual who is currently logged into
a remote system. If you are allowed to view Jump Clients for individual users who are part
of a selected team Jump Group, those users appear in a second pane to the left.
If a Jump Group contains tagged Jump Clients, an arrow appears 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:
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
21
TC: 5/2/2017
JUMP CLIENT GUIDE
l
above the Jump interface
l
the right-click menu of the Jump Client
l
the top of the Jump Client statistics pane
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 a Jump Client goes offline and does not reconnect to the Bomgar Appliance for 180 days, it is automatically uninstalled
from the target computer and is removed from the Jump interface.
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
22
TC: 5/2/2017
JUMP CLIENT GUIDE
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" on page 9.
From the API
By integrating with the Bomgar API, you may programmatically connect to a Jump Item directly from your systems management tool
or ticketing system. To start a session with a Jump Item 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 caseinsensitive.
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
23
TC: 5/2/2017
JUMP CLIENT GUIDE
If specified, only Jump Clients with the given comments are included in the results.
client.comments
This field has a maximum length of 255 characters. Search is partial and caseinsensitive.
If specified, only Jump Clients with the given hostname are included in the results.
client.hostname
This field has a maximum length of 255 characters. Search is partial and caseinsensitive.
If specified, only Jump Clients with the given private IP address are included in the
results.
client.private_ip
This field has a maximum length of 255 characters. Search is partial and caseinsensitive.
If specified, only Jump Clients with the given public IP address are included in the
results.
client.public_ip
This field has a maximum length of 255 characters. Search is partial and caseinsensitive.
If specified, only Jump Clients with the given tag are included in the results.
client.tag
This field has a maximum length of 255 characters. Search is partial and caseinsensitive.
The code name and value of any custom fields. These fields must first be
configured in /login > Management > API Configuration.
session.custom.[custom field]=[string]
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
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
24
TC: 5/2/2017
JUMP CLIENT GUIDE
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 prompts the user to download a BRCS file. After downloading the file, the user 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
All Jump Clients which this representative is permitted to
access are searched. If the search results in only one Jump
Client, the session starts 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/remotesupport/how-to/integrations/api/.
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
25
TC: 5/2/2017
JUMP CLIENT GUIDE
Appendix: Jump Client Error Message Reference
This appendix provides a reference for error messages that may occur while working with Jump Clients. Below is a list of actions
that may take place with Jump Clients along with error messages that may occur during each action. Each error message is
accompanied by a brief description.
Action
Pinning a Jump Client
from within a Session
Deploying a Jump
Client from the Mass
Deployment Wizard
Error Message
Explanation and Reproduction Notes
The total number of deployable Jump Clients for
this site has been reached.
The build limit has been reached.
The total number of deployable active Jump
Clients for this site has been reached.
The build limit has been reached.
The total number of deployable passive Jump
Clients for this site has been reached.
The build limit has been reached.
The support session already has a pending
request to pin.
Race condition (Reproduction is UI-limited).
The support client is already pinned.
Race condition (Reproduction is UI-limited).
No customer could be found within the support
conference.
Race condition (Reproduction is UI-limited).
The customer within the support conference is not
online.
Race condition (Reproduction is UI-limited).
The total number of deployable Jump Clients for
this site has been reached.
The build limit has been reached.
The total number of deployable active Jump
Clients for this site has been reached.
The build limit has been reached.
The total number of deployable passive Jump
Clients for this site has been reached.
The build limit has been reached.
The associated Jumpoint is not currently online.
The Jumpoint designated as the Jumpoint Proxy
is offline before mass deployment is generated.
The associated Jumpoint-proxy no longer exists.
The Jumpoint designated as the Jumpoint Proxy
is deleted before mass deployment is generated.
Bad Password: The password must contain at
least __ characters and contain at least one
uppercase letter, one lowercase letter, one
number, and one special character.
The password designated for the Jump Client
does not meet security standards. (Reproduction
is UI-limited.)
Bad Password: The password must contain at
least __ character(s).
The password designated for the Jump Client
does not meet security standards. (Reproduction
is UI-limited.)
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
26
TC: 5/2/2017
JUMP CLIENT GUIDE
Action
Taking an Action on a
Jump Client besides
Jumping (Set
Comments, etc.)
Jumping
Error Message
Explanation and Reproduction Notes
The Jump Client does not exist.
Race condition: A Jump Client has been deleted,
but another representative console has attempted
to Jump to that Jump Client before being notified.
The Jump Client is offline.
Race condition: A Jump Client has gone offline,
but an representative console has attempted to
Jump to that Jump Client before being notified.
The specified Jump Client has been uninstalled.
Race condition: A Jump Client has been
uninstalled, but an representative console has
attempted to Jump to that Jump Client before
being notified.
The password is incorrect.
The provided password is incorrect.
The number of active Jump Clients has been
reached.
The build limit has been reached when changing
from passive to active.
The number of passive Jump Clients has been
reached.
The build limit has been reached when changing
from active to passive.
Bad Password: The password must contain at
least __ characters and contain at least one
uppercase letter, one lowercase letter, one
number, and one special character.
The password designated for the Jump Client
does not meet security standards.
Bad Password: The password must contain at
least __ character(s).
The password designated for the Jump Client
does not meet security standards.
Permission denied joining existing support
session.
Simultaneous representative access to a Jump
Client is disabled while Jumping into a Jump
Client which already has a session. This
permission is controlled by the Allow
simultaneous representative access to a single
Jump Client setting under /login > Jump > Jump
Clients :: Jump Client Settings.
The server is currently too busy. Please try again
later.
More than twenty users are starting sessions at
the same time on different Jump Clients.
An internal error occurred while spawning the
support session.
Internal for active Jump Client starts.
An internal operation was taking too long while
trying to spawn a support session.
Internal for active Jump Client starts.
The active Jump Client is not connected.
Race condition: An active Jump Client
disconnected before the representative console
was notified.
Timeout while trying to connect to the Jump
Client.
Took too long to connect to any of the hostnames
or IPs.
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
27
TC: 5/2/2017
JUMP CLIENT GUIDE
Action
Error Message
Explanation and Reproduction Notes
Failed to connect to the Jump Client.
Could not connect to any IP address or hostname
of a passive Jump Client.
Timeout while communicating with the Jump
Client.
Timeout during a passive connect handshake.
The Jump Client sent a bad protocol version.
The Jump Client has informed the server of a
protocol version error during a passive connect
handshake.
The Jump Client identification check failed. This
may indicate that a new system has obtained the
network address of the Jump Client you are
attempting to access. Or, there is possibly more
than one passive Jump Client deployed to the
system, and only one of them can acquire the
listen port (____) at a time.
The server was able to connect and handshake,
but the Jump Client gave the wrong identification
token, meaning that it is not the Jump Client you
are attempting to reach or that the Jump Client
has lost its token.
The Jump Client has been disabled by the user
and will not allow a session to start at this time.
The Jump Client has been disabled on the remote
computer.
The Jump Client is running a different version and
will not attempt to upgrade. Please try again after
the upgrade completes.
Bomgar version mismatch. This should cause a
check-in, which causes an upgrade.
The Jump Client does not exist.
Race condition: A Jump Client has been deleted,
but another representative console has attempted
to Jump to that Jump Client before being notified.
The Jump Client is offline.
Race condition: A Jump Client has gone offline,
but an representative console has attempted to
Jump to that Jump Client before being notified.
The specified Jump Client has been uninstalled.
Race condition: A Jump Client has been
uninstalled, but an representative console has
attempted to Jump to that Jump Client before
being notified.
The password is incorrect.
The provided password is incorrect.
CONTACT BOMGAR info@bomgar.com | 866.205.3650 (US) | +44 (0) 1628 480 210 (UK/EMEA) BOMGAR.COM
© 2017 Bomgar Corporation. All rights reserved worldwide. BOMGAR and the BOMGAR logo are trademarks of Bomgar Corporation; other trademarks shown are the property of their respective owners.
28
TC: 5/2/2017
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertising