API Script Command: start_vpro_session

The start_vpro_session command initiates a vPro session on the target machine using the specified Jumpoint.

Required Parameters for the start_vpro_session Command


The hostname or IP address of the machine targeted for a vPro session.


The Jumpoint through which to start the vPro session. This Jumpoint must be on the same subnet as the target computer and must be configured for vPro support.

To initiate a vPro session using BeyondTrust Client Scripting, you must specify the target machine's hostname or private IP. (If Kerberos is used for vPro authentication, then the fully qualified domain name must be specified.) The Jumpoint name must also be specified. See the query examples below.

Optional Parameter for the start_vpro_session Command

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: start_vpro_session

Start a vPro session with the computer "ABCDEF02" through the Jumpoint "Network01"


Start a vPro session with the computer "ABCDEF02" through the Jumpoint "Network01" and associate custom attributes with the session