API Script Command: start_jump_item_session
The start_jump_item_session command attempts to start a session with a BeyondTrust Jump Item. Users may run this command for all Jump Items they are permitted to access via the Jump management interface in the representative console.
Optional Parameters for the start_jump_item_session Command
| jump.method |
If specified, only Jump Items using the designated Jump method are included in the results. Acceptable values for this field are push (remote push), local_push, pinned (Jump Client), rdp, vnc, and shelljump. |
| credential_id |
If specified, only a Jump Item with that specific credential ID associated is returned. This field has a maximum length of 255 characters. |
| search_string |
Identifies the search criteria used to select and return specific Jump Items as results. This parameter is required only if no of the client fields below are specified. |
| client.comments |
If specified, only Jump Items 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 Items 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 search field applies only to Jump Clients. 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 search field applies only to Jump Clients. This field has a maximum length of 255 characters. Search is partial and case-insensitive. |
| client.tag |
If specified, only Jump Items 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. |
At least one client.* parameter must be specified. If multiple client.* parameters are specified, then only clients matching all criteria are returned.
Query Examples: start_jump_item_session
| Start a session with a Jump Item whose hostname contains "ABCDEF02" | https://support.example.com/api/client_script?type=rep&operation=generate&action=start_jump_item_session&client.hostname=ABCDEF02 |
| Start a session with a Jump Item whose comments contain "maintenance" and whose tag contains "server" | https://support.example.com/api/client_script?type=rep&operation=generate&action=start_jump_item_session&client.comments=maintenance&client.tag=server |
| Start a session with a pinned 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_jump_item_session&client.private_ip=10.10.24&jump.method=pinned&session.custom.custom_field1=Custom%20Value&session.custom.custom_field2=123 |
If more than one Jump Item matches the search criteria, then a dialog opens, giving the user the option to select the appropriate Jump Item.
