API Script Command: start_vnc_session

The start_vnc_session command initiates a VNC session on the target machine using a Jumpoint.

Required Parameter for the start_vnc_session Command

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

Optional Parameters for the start_vnc_session Command


The Jumpoint through which to start the VNC 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 opens from which the user must select a Jumpoint.

port=[integer] The port number on which to connect. Defaults to 5900.
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_vnc_session

Start a VNC session with the computer "ABCDEF02"


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


Start a VNC session with the computer "ABCDEF02" and associate custom attributes with the session