4.3. Remote Administration¶
This section provides documentation on Replay Service remote administration. A control client (such as RTI Admin Console) can use this interface to remotely control a Replay Service.
Replay Service remote administration is based on the RTI Remote Administration Platform described in Section 6.2. Please refer to that manual for a detailed discussion on the workings of remote administration in Replay Service.
Below you will find an API reference for all the supported operations.
4.3.1. Enabling Remote Administration¶
By default, remote administration is disabled in Replay Service.
To enable remote administration you can use the
<administration> XML tag
(see Section 4.2) or the
-remoteAdministrationDomainId command-line parameter (see
Section 4.1). Both of these methods enable remote
administration and set the domain ID for remote communication.
4.3.2. Available Service Resources¶
Table 4.18 lists the public resources specific to Replay Service. Each resource identifier is expressed as a hierarchical sequence of identifiers, including parent and target resources. (See Section 184.108.40.206 for details.)
In the table below, the elements
(st) refer to the name of
an entity of the corresponding class as specified in the configuration in the
name attribute. For example, in the following configuration:
The resource identifier is:
In the table, the resource identifier is written as /replay_service/(rs), where (rs) is the service name. This nomenclature is used in the table to give you an idea of the structure of the resource identifiers. For actual (example) resource identifier names, see the example section that follows.
This example shows you how to address a resource of each possible resource class in Replay Service.
Entity with name “MyReplay”:
4.3.3. Remote API Overview¶
|ReplayService||DELETE /replay_services/(rs)||Shuts down a running Replay Service|
|UPDATE /replay_services/(rs)/state||Sets a Replay Service state|
4.3.4. Replay Service¶
Causes Replay Service to shutdown.
Valid requested states:
To pause a replay service with the name “MyReplay”:
Request Field Value