Jump Items | RS Pathfinder
What are Jump Items?
Jump Items are individual systems or devices that are made available for remote access within a Jump Group, enabling administrators to organize and control access to remote systems in a secure manner.
How are Jump Items useful to my organization?
Jump Items allow support representatives to securely access and troubleshoot remote systems, ensuring efficient issue resolution while maintaining control over which systems can be accessed and when. Create Jump Shortcuts to start VNC sessions, Remote Desktop Protocol sessions, Shell Jump sessions, and Intel vPro.
How do I access the Jump Items page?
- Sign into app.beyondtrust.io.
The BeyondTrust Home page displays. - From the left menu, click Remote Support > Jump.
The Jump Clients page opens. - At the top of the page, click Jump Items.
The Jump Items page displays.
The Jump Items page
- Left menu: Easy access to all pages in Remote Support, including Status, Consoles & Downloads, My Account, Configuration, Jump, Vault, Console Settings, Users & Security, Reports, Public Portals, Dashboards, Management, and Appliance pages.
- Status: Opens the Status page.
- Header: Change your tenant site, manage your profile, and access documentation.
- Mass Import Wizard: Downloads a template for specified Jump Items.
- Configuration Help: Parameter values on the different types of Jump Items.
- Jump Item Settings: Use to set specific settings for Jump Items.
Jump Shortcuts Mass Import Wizard
You can use the Jump Shortcuts Mass Import Wizard to create Jump Shortcuts for anyone of the following sessions:
- Local VNC
- Remote VNC
- Remote RDP
- Local RDP
- Shell Jump
- Intel vPro
Important info
Linux Jumpoints can only be used for RDP, SSH/Telnet, and VNC sessions. Linux Jumpoints do allow for credential injection from user or Vault, as well as RemoteApp functionality and Shell Jump filtering. Clustered Jumpoints can only add new nodes of the same operating system.
You cannot mix Windows and Linux nodes.
When you create a large number of Jump shortcuts, it may be easier to import them via a spreadsheet than to add them one by one in the representative console.
Download a template suitable for importing Jump Shortcuts
To do this, use the templates via the Jump Shortcuts Mass Import Wizard and follow these steps:
- From the Download a Template Suitable for Importing Jump Shortcuts section, click the dropdown and select the type of Jump Item you wish to add.
- Click Download Template.
A comma-separated file (*.csv) is downloaded. - Use the text in the CSV template as column headers and add the information for each Jump shortcut you wish to import. Optional fields can be filled in or left blank.
Import Jump Shortcuts
Once you have completed filling out the template, click Import Jump Shortcuts to upload the CSV file containing the Jump Item information. The CSV file should use the format described in the tables below.
The maximum file sized allowed to be uploaded at one time is 5 megabytes (MB). Only one type of Jump Item can be included in each CSV file.
Jump Shortcut Help
Local VNC Jump Shortcut help
| Parameter | API Value | Required | Default Value | Description |
|---|---|---|---|---|
| Hostname | local_vnc_hostname | Yes | The hostname of the endpoint to be accessed by this Jump Item. This string has a maximum of 128 characters. | |
| Port | port | No | 5900 | A valid port number from 100 to 65535. |
| Name | name | Yes | The name of the endpoint to be accessed by this Jump Item. This string has a maximum of 128 characters. | |
| Jump Group | group | Yes | The code name of the Jump Group with which this Jump Item should be associated. | |
| Tag | tag | No | You can organize your Jump Items into categories by adding a tag. This string has a maximum of 64 characters. | |
| Comments | comments | No | You can add comments to your Jump Items. This string has a maximum of 1024 characters. | |
| Jump Policy | jump_policy | No | The code name of a Jump Policy. You can specify a Jump Policy to manage access to this Jump Item. | |
| Public Portal | public_portal | No | A Public Portal site address that the shortcut should use for any session started from that shortcut. If a value is not provided then the default public site will be used. | |
| Session Policy | session_policy | No | The code name of a Session Policy. You can specify a Session Policy to manage the permissions available on this Jump Item. |
Remote VNC Jump Shortcut help
| Parameter | API Value | Required | Default Value | Description |
|---|---|---|---|---|
| Hostname | remote_vnc_hostname | Yes | The hostname of the endpoint to be accessed by this Jump Item. This string has a maximum of 128 characters. | |
| Jumpoint | jumpoint | Yes | The code name of the Jumpoint through which the endpoint is accessed. | |
| Port | port | No | 5900 | A valid port number from 100 to 65535. |
| Name | name | Yes | The name of the endpoint to be accessed by this Jump Item. This string has a maximum of 128 characters. | |
| Jump Group | group | Yes | The code name of the Jump Group with which this Jump Item should be associated. | |
| Tag | tag | No | You can organize your Jump Items into categories by adding a tag. This string has a maximum of 64 characters. | |
| Comments | comments | No | You can add comments to your Jump Items. This string has a maximum of 1024 characters. | |
| Jump Policy | jump_policy | No | The code name of a Jump Policy. You can specify a Jump Policy to manage access to this Jump Item. | |
| Public Portal | public_portal | No | A Public Portal site address that the shortcut should use for any session started from that shortcut. If a value is not provided then the default public site will be used. | |
| Session Policy | session_policy | No | The code name of a Session Policy. You can specify a Session Policy to manage the permissions available on this Jump Item. |
Remote RDP Jump Shortcut help
| Parameter | API Value | Required | Default Value | Description |
|---|---|---|---|---|
| Hostname | remote_rdp_hostname | Yes | The hostname of the endpoint to be accessed by this Jump Item. This string has a maximum of 128 characters. | |
| Jumpoint | jumpoint | Yes | The code name of the Jumpoint through which the endpoint is accessed. | |
| Username | rdp_username | No | The username to sign in as. | |
| Domain | domain | No | The domain the endpoint is on. | |
| Quality | quality | No | best_performance | The quality at which to view the remote system. Can be black_white (Black & White for lowest bandwidth consumption), few_colors (8-bit color quality), more_colors (16-bit color for medium color quality performance), full_colors (32-bit for true color reproduction), best_performance (VP9 codec for more fluid video), or lossless (high definition for exact reproduction). This cannot be changed during the Remote Desktop Protocol (RDP) Session. |
| Console Session | console | No | 0 | 1: Starts a console session. 0: Starts a new session. |
| Ignore Untrusted Certificate | ignore_untrusted | No | 0 | 1: Ignores certificate warnings. 0: Shows a warning if the server's certificate cannot be verified. |
| Name | name | Yes | The name of the endpoint to be accessed by this Jump Item. This string has a maximum of 128 characters. | |
| Jump Group | group | Yes | The code name of the Jump Group with which this Jump Item should be associated. | |
| Tag | tag | No | You can organize your Jump Items into categories by adding a tag. This string has a maximum of 64 characters. | |
| Comments | comments | No | You can add comments to your Jump Items. This string has a maximum of 1024 characters. | |
| Jump Policy | jump_policy | No | The code name of a Jump Policy. You can specify a Jump Policy to manage access to this Jump Item. | |
| Public Portal | public_portal | No | A Public Portal site address that the shortcut should use for any session started from that shortcut. If a value is not provided then the default public site will be used. | |
| Session Policy | session_policy | No | The code name of a Session Policy. You can specify a Session Policy to manage the permissions available on this Jump Item. |
Local RDP Jump Shortcut help
| Parameter | API Value | Required | Default Value | Description |
|---|---|---|---|---|
| Hostname | local_rdp_hostname | Yes | The hostname of the endpoint to be accessed by this Jump Item. This string has a maximum of 128 characters. | |
| Username | rdp_username | No | The username to sign in as. | |
| Domain | domain | No | The domain the endpoint is on. | |
| Quality | quality | No | best_performance | The quality at which to view the remote system. Can be black_white (Black & White for lowest bandwidth consumption), few_colors (8-bit color quality), more_colors (16-bit color for medium color quality performance), full_colors (32-bit for true color reproduction), best_performance (VP9 codec for more fluid video), or lossless (high definition for exact reproduction). This cannot be changed during the Remote Desktop Protocol (RDP) Session. |
| Console Session | console | No | 0 | 1: Starts a console session. 0: Starts a new session. |
| Ignore Untrusted Certificate | ignore_untrusted | No | 0 | 1: Ignores certificate warnings. 0: Shows a warning if the server's certificate cannot be verified. |
| Name | name | Yes | The name of the endpoint to be accessed by this Jump Item. This string has a maximum of 128 characters. | |
| Jump Group | group | Yes | The code name of the Jump Group with which this Jump Item should be associated. | |
| Tag | tag | No | You can organize your Jump Items into categories by adding a tag. This string has a maximum of 64 characters. | |
| Comments | comments | No | You can add comments to your Jump Items. This string has a maximum of 1024 characters. | |
| Jump Policy | jump_policy | No | The code name of a Jump Policy. You can specify a Jump Policy to manage access to this Jump Item. | |
| Public Portal | public_portal | No | A Public Portal site address that the shortcut should use for any session started from that shortcut. If a value is not provided then the default public site will be used. | |
| Session Policy | session_policy | No | The code name of a Session Policy. You can specify a Session Policy to manage the permissions available on this Jump Item. |
Shell Jump Shortcut help
| Parameter | API Value | Required | Default Value | Description |
|---|---|---|---|---|
| Hostname | shelljump_hostname | Yes | The hostname of the endpoint to be accessed by this Jump Item. This string has a maximum of 128 characters. | |
| Jumpoint | jumpoint | Yes | The code name of the Jumpoint through which the endpoint is accessed. | |
| Username | shelljump_username | No | The username to sign in as. | |
| Protocol | protocol | Yes | Can either be "ssh" or "telnet". | |
| Port | port | No | SSH: 22, Telnet: 23 | A valid port number from 1 to 65535. Defaults to 22 if the protocol is SSH or 23 if the protocol is Telnet. |
| Terminal Type | terminal | No | xterm | Can be either xterm or vt100. |
| Keep-Alive | keep_alive | No | The number of seconds between each packet sent to keep an idle session from ending. Can be any number from 5 to 300 or blank to disable the feature. | |
| Name | name | Yes | The name of the endpoint to be accessed by this Jump Item. This string has a maximum of 128 characters. | |
| Jump Group | group | Yes | The code name of the Jump Group with which this Jump Item should be associated. | |
| Tag | tag | No | You can organize your Jump Items into categories by adding a tag. This string has a maximum of 64 characters. | |
| Comments | comments | No | You can add comments to your Jump Items. This string has a maximum of 1024 characters. | |
| Jump Policy | jump_policy | No | The code name of a Jump Policy. You can specify a Jump Policy to manage access to this Jump Item. | |
| Session Policy | session_policy | No | The code name of a Session Policy. You can specify a Session Policy to manage the permissions available on this Jump Item. | |
| Public Portal | public_portal | No | A Public Portal site address that the shortcut should use for any session started from that shortcut. If a value is not provided then the default public site will be used. |
Intel vPro Jump Shortcut help
| Parameter | API Value | Required | Default Value | Description |
|---|---|---|---|---|
| Hostname | vpro_hostname | Yes | The hostname of the endpoint to be accessed by this Jump Item. This string has a maximum of 128 characters. | |
| Jumpoint | jumpoint | Yes | The code name of the Jumpoint through which the endpoint is accessed. | |
| Name | name | Yes | The name of the endpoint to be accessed by this Jump Item. This string has a maximum of 128 characters. | |
| Jump Group | group | Yes | The code name of the Jump Group with which this Jump Item should be associated. | |
| Tag | tag | No | Organize Jump Items into categories by adding a tag. This string has a maximum of 64 characters. | |
| Comments | comments | No | Add comments to Jump Items. This string has a maximum of 1024 characters. | |
| Jump Policy | jump_policy | No | The code name of a Jump Policy. Specify a Jump Policy to manage access to this Jump Item. | |
| Public Portal | public_portal | No | A Public Portal site address that the shortcut should use for any session started from that shortcut. If no value is provided, the default public site is used. | |
| Session Policy | session_policy | No | The code name of a Session Policy. Specify a Session Policy to manage the permissions available on this Jump Item. |
Jump Item settings
Simultaneous Jumps
Simultaneous Jumps provide a way for multiple users to gain access to the same jump item without having to be invited to join an active support session by another user.
- By using the For Jump Client, Local Jump, Remote Jump, Remote VNC field, you can create new sessions. The options you can choose are the following:
| Value Name | Description |
|---|---|
| Join Existing Session | Provides a way for multiple users to gain access to the same Jump Item without an invitation to join an active session by another user. The first user to access the Jump Item maintains ownership of the session. Users in a shared Jump session see each other and can chat. Users can join a session that was started from another copy of a Jump Client in a different Jump Group. Session permissions are based on the original Jump Client that started the session. Once the first user is in a session, subsequent users will be able to enter the session. The first user will receive a notification that another user has joined the session, but the first user will not have an opportunity to deny access before other user joins. If this setting is not selected, a user cannot join a session that was started from another copy of a Jump Client, unless it is the same Jump Group. |
| Disallow Jump | Ensures only one user can Jump to a Jump Item at a time. Only an invitation by the user who originated the session can allow for a second user to access the session. |
- If you check Also apply this setting to copies of Jump Clients, a user will be allowed to join a session that was started from another copy of a Jump Client in a different Group. Session permissions will be based on the original Jump Client that started the session.
This setting is not checked, a user will not be allowed to join a session that was started from another copy of a Jump Client unless it is the same Group. - From the For Remote RDP field, you can create new sessions which jump to a specific RDP Jump item. The options you can choose are the following:
| Value Name | Description |
|---|---|
| Start a New Session | Provides a way for multiple users to gain access to the same Jump Item without an invitation to join an active session by another user. For RDP, a new independent session will start for each user which jumps to a specific RDP Jump Item, and the RDP configuration on the endpoint will control any further behavior regarding simultaneous RDP connections. |
| Disallow Jump | Ensures only one user at a time can Jump to a Jump Item. Only an invitation by the user who originated the session can allow for a second user to access the session. |
Updated 5 days ago
