RemoteAccessProvider Thing Shape
The RemoteAccessProvider Thing Shape provides services that enable a Thing to know which remote server to use to initiate its remote sessions. In addition, it provides services to retrieve session information for a specific session from the appropriate Remote Access Server.
The sections below explain the services (and their parameters, as applicable) that are defined in the RemoteAccessProvider Thing Shape:
GetActiveServers Service
The GetActiveServers service retrieves a list of the active Remote Access Server names for this provider. For this service, the isAllowOverride parameter is set to true.
This
result returned by this service is of base type
INFOTABLE (
RemoteAccessServerName Data Shape) that contains the names of the active Remote Access Servers for this provider.
GetAllServers Service
The GetAllServers service returns a list of all the active Remote Access Services for this provider. For this service, the isAllowOverride parameter is set to true.
The result returned by this service is an INFOTABLE (RemoteAccessServerName Data Shape) that contains the names of the active Remote Access Servers for this provider.
GetRemoteServerConfiguration
The GetRemoteServerConfiguration services returns the remote server configuration data for the specified Thing and endpoint. The result of this service returns the JSON-formated configuration properties of the remote server.
This service takes the following parameters;
• agentDevice — This parameter is required. It references the
RemoteAccessible Thing Shape (base type
THINGNAME) and specifies the Thing that is configured to use the remote server.
• endpointName — This parameter specifies the name of the remote interface to use for remote sessions with the specified Thing.
GetSession Service
The GetSession service retrieves a remote session whose session ID matches the one specified as a parameter for this service. For this service, the isAllowOverride parameter is set to true.
This service takes the following parameters:
• sessionId — The unique identifier of the remote session to retrieve. The base type of this parameter is GUID.
• agentDevice — This parameter is required. It references the
RemoteAccessible Thing shape (base type
THINGNAME) and specifies the device to which the remote session belongs.
GetAllSessions Service
The
GetAllSessions service retrieves the remote sessions that this provider has assigned. For this service, the
isAllowOverride parameter is set to
true. This service returns the sessions as an
INFOTABLE, which references the
RemoteSession Data Shape.
This service has no input parameters.
EndSession Service
The EndSession service terminates the remote session that is associated with the specified identifier for the specified Thing. For this service, the isAllowOverride parameter is set to true.
This service takes the following input parameters:
• agentDevice — This parameter is required. It references the RemoteAccessible Thing Shape (base type THINGNAME) and specifies the device to which the remote session belongs.
• sessionId — This parameter is also required. It specifies the unique identifier of the remote session to be terminated. The base type of this parameter is GUID.
StartSession Service
The StartSession service initiates a remote session for the specified Thing. For this service, the isAllowOverride parameter is set to true.
This service takes the following input parameters:
• agentDevice — This parameter is required. It references the
RemoteAccessible Thing Shape (base type
THINGNAME) and specifies the device with which the remote session will be started.
• remoteSessionParameters — This parameter is also required. It specifies the parameters (as an
INFOTABLE) to use for the remote session. It references the
RemoteSessionParameters Data Shape to use pre-defined parameters for all remote sessions.
GetRemoteAccessibleEndpoint Service
The GetRemoteAccessibleEndpoint service retrieves the endpoints available on the specified device. For this service, the isAllowOverride parameter is set to true.
The result contains the endpoints available on the device It is a reference to the RemoteEndpoint Data Shape and is of base type INFOTABLE.
This service takes one input parameter:
• agentDevice — This parameter is required. It references the RemoteAccessible Thing Shape (base type THINGNAME) and specifies the device for which the endpoints are to be retrieved.