Remote Access Extension (RAE) Entity Reference > RAE Data Shapes > RemoteSessionParameters Data Shape
RemoteSessionParameters Data Shape
The RemoteSessionParameters Data Shape contains fields that describe a remote session to be launched. As of 3.0.0 of the Remote Access Extension (RAE), this Data Shape has an additional metadata (JSON) field that supports a "description" key/value pair.
The following table lists and briefly describes the fields of this Data Shape:
Name
Base Type
Description
remoteEndpoint
STRING
The name of one of the remote endpoints that this Thing supports. For example, SSH or VNC.
providerConfig
JSON
JSON-formatted set of properties that are specific to the Remote Access Provider.
metadata
JSON
JSON-formatted description key/value pair. This description is sent to the Remote Access Client when the session is started. It is useful when Policy Server is in use to control remote session activity.
Was this helpful?