API Script Command: push_and_start_remote
The push_and_start_remote command attempts to push the customer client to a computer on a remote network through a Jumpoint in order to start a support session. This can also be described as a remote Jump.
Required Parameter for push_and_start_remote
|
target=[string] |
The hostname or IP address of the target machine. |
Optional Parameters for push_and_start_remote
|
jumpoint=[string] |
The Jumpoint through which to start the session. This Jumpoint must be on the same subnet as the target computer. If not specified and the user has access to only one Jumpoint, then that Jumpoint is used automatically. If not specified and the user has access to more than one Jumpoint, then a dialog will open from which the user must select a Jumpoint. |
| 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. |
Query Examples: push_and_start_local
| Jump to the remote computer "ABCDEF02" through the Jumpoint "Network01" |
https://support.example.com/api/client_script?type=rep&operation=generate&action=push_and_start_remote&target=ABCDEF02&jumpoint=Network01 |
| Jump to the remote computer "ABCDEF02" through the Jumpoint "Network01" and associate custom attributes with the session |
https://support.example.com/api/client_script?type=rep&operation=generate&action=push_and_start_remote&target=ABCDEF02&jumpoint=Network01&session.custom.custom_field1=Custom%20Value&session.custom.custom_field2=123 |
