API Script Command: start_rdp_session

The start_rdp_session command initiates a Microsoft Remote Desktop Protocol session on the target machine using a Jumpoint.

Required Parameter for the start_rdp_session Command

target=[string] The hostname or IP address of the machine targeted for an RDP session.

Optional Parameters for the start_rdp_session Command


The Jumpoint through which to start the RDP 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.

username=[string] The username to use when authenticating. If not specified, the representative must enter the username.
display_size=[string] May be one of primary_display (default), all_displays, or <width>x<height>, where <width> and <height> are integers representing a standard resolution.
quality=[string] May be one of low, performance (default), performance_quality, or quality.

Either no (default) or yes. If yes, the RDP session connects to the physical console.

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_rdp_session

Start an RDP session with the computer "ABCDEF02"


Start an RDP session with the computer "ABCDEF02" through the Jumpoint "Network01"


Start an RDP session with the computer "ABCDEF02" through the Jumpoint "Network01". Authenticate with "jsmith", set the resolution to 1024x768, set the quality to "quality", and create a console session


Start an RDP session with the computer "ABCDEF02" and associate custom attributes with the session