.. include:: vars.rst .. _section-Admin: ********************* Remote Administration ********************* This section provides documentation on |RS| remote administration. .. Note:: |RS| remote administration is based on the |RAP| described in :numref:`section-Rap`. We recommend that you read that section before using |RS| remote administration. Below you will find an API reference for all the supported operations. Overview ======== Enabling Remote Administration ------------------------------ By default, remote administration is disabled in |RS|. To enable remote administration, you can use the ```` tag (see :numref:`section-config-routing-service`) or the ``-remoteAdministrationDomainId`` command-line parameter, which enables remote administration and sets the domain ID for remote communication (see :numref:`section-usage-executable`). Available Service Resources --------------------------- :numref:`TableRouterResources` lists the public resources specific to |RS|. Each resource identifier is expressed as a hierarchical sequence of identifiers, including parent and target resources. (See :numref:`section-Arm-ResourceId` for details.) In the table below, the elements ``(rs)``, ``(dr)``, ``(c)``, ``(s)``, ``(ar)``, ``(r)``, ``(i)``, and ``(o)`` 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: .. code-block:: xml ... The resource identifier is: .. code-block:: html /routing_services/MyRouter In the table, the resource identifier is written as /routing_services/(rs), where (rs) is the routing service name, (dr) is the domain route name, and so on. 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. .. list-table:: Resources and Their Identifiers in |RS| :name: TableRouterResources :widths: 20 80 :header-rows: 1 * - Resource - Resource Identifier * - |SERVICE| - /routing_services/(rs) * - |DOMAINROUTE| - /routing_services/(rs)/domain_routes/(dr) * - |CONNECTION| or *Participant* - /routing_services/(rs)/domain_routes/(dr)/connections/(c) * - |SESSION| - /routing_services/(rs)/domain_routes/(dr)/sessions/(s) * - |AR| or |ATR| - /routing_services/(rs)/domain_routes/(dr)/sessions/(s)/auto_routes/(ar) * - |ROUTE| or |TR| - /routing_services/(rs)/domain_routes/(dr)/sessions/(s)/routes/(r) * - |ROUTE| |INPUT| or DDS |INPUT| - /routing_services/(rs)/domain_routes/(dr)/sessions/(s)/routes/(r)/inputs/(i) * - |ROUTE| |OUTPUT| or DDS |OUTPUT| - /routing_services/(rs)/domain_routes/(dr)/sssions/(s)/routes/(r)/outputs/(i) Example ^^^^^^^ This example shows you how to address a resource of each possible resource class in |RS|, using the example configuration in :numref:`section-Admin-Example` as a reference. (For a complete reference of the available configuration tags used in |RS|, see :numref:`section-xml-tags-for-configuring-routing-service`.) .. rubric:: |SERVICE| Entity with name "MyRouter": .. code-block:: xml ... Resource identifier: .. code-block:: html /routing_services/MyRouter .. rubric:: |DOMAINROUTE| Entity with name "MyDomainRoute" in parent "MyRouter": .. code-block:: xml ... Resource identifier: .. code-block:: html /routing_services/MyRouter/domain_routes/MyDomainRoute .. rubric:: *Participant* Entity with name "MyParticipant" in parent "MyDomainRoute": .. code-block:: xml ... Resource identifier: .. code-block:: html /routing_services/MyRouter/domain_routes/MyDomainRoute/connections/MyParticipant .. rubric:: |SESSION| Entity with name "MySession" in parent "MyDomainRoute": .. code-block:: xml ... Resource identifier: .. code-block:: html /routing_services/MyRouter/domain_routes/MyDomainRoute/sessions/MySession .. rubric:: |ATR| (or |AR|) Entity with name "MyAutoTopicRoute" in parent "MySession": .. code-block:: xml ... Resource identifier (all on one line): .. code-block:: html /routing_services/MyRouter/domain_routes/MyDomainRoute/sessions/MySession/ routes/MyTopicRoute .. rubric:: |TR| (or |ROUTE|) Entity with name "MyTopicRoute" in parent "MySession": .. code-block:: xml ... Resource identifier (all on one line): .. code-block:: html /routing_services/MyRouter/domain_routes/MyDomainRoute/sessions/MySession/ routes/MyTopicRoute .. rubric:: |INPUT| Entity with name "MyInput" in parent "MyTopicRoute": .. code-block:: xml ... Resource identifier (all on one line): .. code-block:: html /routing_services/MyRouter/domain_routes/MyDomainRoute/sessions/MySession/ routes/MyRoute/inputs/MyInput .. rubric:: |OUTPUT| Entity with name "MyOutput" in parent "MyTopicRoute": .. code-block:: xml ... Resource identifier (all on one line): .. code-block:: html /routing_services/MyRouter/domain_routes/MyDomainRoute/sessions/MySession/ routes/MyRoute/outputs/MyOutput Resource Object Representations ------------------------------- .. list-table:: Resource Representations in |RS| :name: TableRouterResourceRepresentations :widths: 40 60 :header-rows: 1 :class: longtable * - Resource Representation - Format (all element type definitions are from the file rti_routing_service.xsd) * - *ddsObjectRepresentation* - .. code-block:: xml * - *routerObjectRepresentation* - .. code-block:: xml * - *domainRouteObjectRepresentation* - .. code-block:: xml * - *connectionObjectRepresentation* - .. code-block:: xml * - *participantObjectRepresentation* - .. code-block:: xml * - *sessionObjectRepresentation* - .. code-block:: xml * - *autoRouteObjectRepresentation* - .. code-block:: xml * - *autoTopicRouteObjectRepresentation* - .. code-block:: xml * - *routeObjectRepresentation* - .. code-block:: xml * - *topicRouteObjectRepresentation* - .. code-block:: xml * - *inputObjectRepresentation* - .. code-block:: xml * - *outputObjectRepresentation* - .. code-block:: xml * - *ddsInputObjectRepresentation* - .. code-block:: xml .. code-block:: xml * - *ddsOutputObjectRepresentation* - .. code-block:: xml .. code-block:: xml .. _section-Admin-ApiReference: API Reference ============= This section documents each remote operation, organized by service resource class. Remote API Overview ------------------- .. Note:: To improve readability, ```` is sometimes used in place of the service resource portion of the resource identifier (e.g., /routing_services/(rs) or /routing_services/MyService). It does not represent valid syntax. .. list-table:: Remote Interface Overview :name: TableRemoteAdminAPI :widths: 20 50 30 :header-rows: 1 :class: longtable * - Resource - Operation - Description * - |SERVICE| - :ref:`CREATE /routing_services/(rs)/domain_route ` - Creates a new |DOMAINROUTE|. * - - :ref:`CREATE /routing_services/(rs)/config ` - Loads a full service configuration. * - - :ref:`GET /routing_services/(rs) ` - Returns the |SERVICE| configuration. * - - :ref:`UPDATE /routing_services/(rs) ` - Updates a |SERVICE| object. * - - :ref:`UPDATE /routing_services/(rs)/state ` - Sets a |SERVICE| state. * - - :ref:`UPDATE /routing_services/(rs):save ` - Saves the |SERVICE| loaded configuration. * - - :ref:`DELETE /routing_services/(rs)/domain_routes/(dr) ` - Deletes a |DOMAINROUTE| object. * - - :ref:`DELETE /routing_services/(rs)/config ` - Returns the |SERVICE| configuration. * - - :ref:`DELETE /routing_services/(rs) ` - Shuts down the running |SERVICE|. * - |DOMAINROUTE| - :ref:`CREATE /routing_services/(rs)/domain_route/(dr)/sessions ` - Creates a new |SESSION|. * - - :ref:`UPDATE /routing_services/(rs)/domain_route/(dr) ` - Updates a |DOMAINROUTE|. * - - :ref:`UPDATE /routing_services/(rs)/domain_route/(dr)/state ` - Sets a |DOMAINROUTE| state. * - - :ref:`DELETE /routing_services/(rs)/domain_route/(dr)/sessions/(s) ` - Deletes a |SESSION|. * - |CONNECTION| - :ref:`UPDATE \/domain_route/connections(c):add_peer ` - Adds a list of peers in a |CONNECTION| (a *Participant* in DDS adapter). * - - :ref:`UPDATE \/domain_route/(dr)/connections(c) ` - Updates a |CONNECTION|. * - - :ref:`DELETE \/domain_route/(dr)/connections(c):remove_peer ` - Removes a list of peers in a |CONNECTION| (a *Participant* in DDS adapter). * - |SESSION| - :ref:`CREATE \/domain_route/(dr)/sessions/(s)/auto_routes ` - Creates a new |AR|. * - - :ref:`CREATE \/domain_route/(dr)/sessions/(s)/routes ` - Creates a new |ROUTE|. * - - :ref:`UPDATE \/domain_route/(dr)/sessions(s) ` - Updates a |SESSION|. * - - :ref:`UPDATE \/domain_route/(dr)/sessions(s)/state ` - Sets a |SESSION| state. * - - :ref:`DELETE \/domain_route/(dr)/sessions/(s)/auto_routes/(ar) ` - Deletes an |AR|. * - - :ref:`DELETE \/domain_route/(dr)/sessions/(s)/routes/(r) ` - Deletes a |ROUTE|. * - |AR| or |ATR| - :ref:`UPDATE \/domain_route/(dr)/sessions/(s)/auto_routes(ar) ` - Updates an |AR|. * - - :ref:`UPDATE \/domain_route/(dr)/sessions/(s)/auto_routes(ar)/state ` - Sets an |AR| state. * - |ROUTE| or |TR| - :ref:`UPDATE \/domain_route/(dr)/sessions/(s)/routes(r) ` - Updates a |ROUTE|. * - - :ref:`UPDATE \/domain_route/(dr)/sessions/(s)/routes(r)/state ` - Sets a |ROUTE| state. * - |INPUT| - :ref:`UPDATE \/domain_route/(dr)/sessions/(s)/routes(r)/inputs/(i) ` - Updates an |INPUT| (Connext DDS and non-Connext DDS). * - |OUTPUT| - :ref:`UPDATE \/domain_route/(dr)/sessions/(s)/routes(r)/outputs/(o) ` - Updates an |OUTPUT| (Connext DDS and non-Connext DDS). .. _section-RemoteAdmin-Api-Service: Service ------- .. _service-create-domain-route: .. function:: CREATE /routing_services/(rs)/domain_routes **Operation** ``create_domain_route`` Creates a |DOMAINROUTE| object from its *domainRouteObjectRepresentation* (see :numref:`TableRouterResourceRepresentations`). See :ref:`section-Rap-CommonOps-Create` (:numref:`section-Rap-CommonOps-Create`). - Example Create a |DOMAINROUTE| with name "NewDomainRoute" under |SERVICE| "MyRouter", with its configuration provided as a |SCHEME_STR| scheme. .. list-table:: :widths: 30 70 :header-rows: 1 * - Request Field - Value * - ``action`` - CREATE * - ``resource_identifier`` - /routing_services/MyRouter/domain_routes * - ``string_body`` - .. code-block:: xml str\://\" ... " The newly created object has the resource identifier: .. list-table:: :header-rows: 0 * - /routing_services/MyRouter/domain_routes/NewDomainRoute .... .. _service-load: .. function:: CREATE /routing_services/(rs)/config **Operation** ``load`` Loads a new configuration for the service from its *ddsObjectRepresentation* (see :numref:`TableRouterResourceRepresentations`). If the |SERVICE| is already loaded, this operation will unload it first. The provided configuration must contain a valid |SERVICE| configuration with the same name that the initial configuration used when the service was first instantiated. If the operation fails, the service will remain in an unloaded state. **Request body** - ``string_body``: a valid |SERVICE| XML configuration document provided as |SCHEME_FILE| or |SCHEME_STR|. **Reply body** - Empty. - Example Load a new configuration in |SERVICE| "MyRouter". .. list-table:: :widths: 30 70 :header-rows: 1 * - Request Field - Value * - ``action`` - CREATE * - ``resource_identifier`` - /routing_services/MyRouter/config * - ``string_body`` - .. code-block:: xml str://" ... ... ... ... " .... .. _service-get: .. function:: GET /routing_services/(rs) **Operation**: ``get`` Returns a snapshot of the currently loaded full XML configuration as *ddsObjectRepresentation* (see :numref:`TableRouterResourceRepresentations`). See :ref:`section-Rap-CommonOps-Get` (:numref:`section-Rap-CommonOps-Get`). - Example reply body: .. code-block:: xml ... " .... .. _service-set-state: .. function:: UPDATE /routing_services/(rs)/state **Operation**: ``set_state`` Sets the state of a |SERVICE| object. See :ref:`section-Rap-CommonOps-SetState` (:numref:`section-Rap-CommonOps-SetState`). Valid requested states: * ``STARTED`` * ``STOPPED`` * ``PAUSED`` * ``RUNNING`` - Example Enable a |SERVICE| with the name "MyRouter". .. list-table:: :widths: 30 70 :header-rows: 1 * - Request Field - Value * - ``action`` - UPDATE * - ``resource_identifier`` - /routing_services/MyRouter/state * - ``octet_body`` - .. code-block:: C to_cdr_buffer(RTI::Service::EntityStateKind::ENABLED) .... .. _service-save: .. function:: UPDATE /routing_services/(rs):save **Operation**: ``save`` Dumps the currently loaded XML configuration into a file. The output file is specified by the ``save_path`` configuration tag. The ``save`` operation will fail if the ``save_path`` has not been configured. **Request body** - Empty. **Reply body** - Empty. .... .. _service-delete-dr: .. function:: DELETE /routing_services/(rs)/domain_routes/(dr) **Operation** ``delete_domain_route`` Deletes the specified |DOMAINROUTE|. See :ref:`section-Rap-CommonOps-Delete` (:numref:`section-Rap-CommonOps-Delete`). .... .. _service-unload: .. function:: DELETE /routing_services/(rs)/config **Operation** ``unload`` Unloads the current configuration of the service. If the |SERVICE| is enabled, this operation will disable it first. Upon a successful request, the service will remain in an unloaded state and no other operations can be made until a configuration is loaded. **Request body** - Empty. **Reply body** - Empty. .... .. _service-shutdown: .. function:: DELETE /routing_services/(rs) **Operation** ``shutdown`` Initiates the shutdown sequence on the process where the |Service| object runs. - If |SERVICE| runs as a process executed by the shipped executable in the |RTI_CONNEXT| installation, the process will exit upon receipt of the command. - If |SERVICE| is instantiated as a library in your application, the service instance will notify the installed remote shutdown hook. In both cases, right before executing the shutdown sequence, |SERVICE| will send a reply indicating the result of the operation. Note that if the operation returns successfully, the reply may be lost and never received by remote clients, since all the contained entities are deleted, including the |RAP| entities. This operation can be invoked at any time during the lifecycle of the service. **Request body** - Empty. **Reply body** - Empty. .. _section-RemoteAdmin-Api-DomainRoute: DomainRoute ----------- .. _dr-create-session: .. function:: CREATE /routing_services/(rs)/domain_routes/(dr)/sessions **Operation**: ``create_session`` Creates a |SESSION| object from its *sessionObjectRepresentation* (see :numref:`TableRouterResourceRepresentations`). See :ref:`section-Rap-CommonOps-Create` (:numref:`section-Rap-CommonOps-Create`). - Example Create a |SESSION| with the name "NewSession" under the |DOMAINROUTE| "MyDomainRoute", with its configuration provided as a |SCHEME_STR| scheme. .. list-table:: :widths: 30 70 :header-rows: 1 * - Request Field - Value * - ``action`` - CREATE * - ``resource_identifier`` - /routing_services/MyRouter/domain_routes/MyDomainRoute/sessions * - ``string_body`` - .. code-block:: xml str://" ... " The newly created object has the resource identifier: .. list-table:: :header-rows: 0 * - \/domain_routes/NewDomainRoute/sessions/NewSession .... .. _dr-update: .. function:: UPDATE /routing_services/(rs)/domain_routes/(dr) **Operation**: ``update`` Updates the specified |DOMAINROUTE| object. See :ref:`section-Rap-CommonOps-Update` (:numref:`section-Rap-CommonOps-Update`). The expected XML configuration is a subset of *domainRouteObjectRepresentation* and contains only parameters valid for the update. - Example Update a |DOMAINROUTE| with the name "MyDomainRoute" under the |SERVICE| "MyRouter", with its configuration provided as a |SCHEME_STR| scheme. .. list-table:: :widths: 30 70 :header-rows: 1 * - Request Field - Value * - ``action`` - CREATE * - ``resource_identifier`` - /routing_services/MyRouter/domain_routes/MyDomainRoute * - ``string_body`` - .. code-block:: xml str://" ... " .... .. _dr-setState: .. function:: UPDATE /routing_services/(rs)/domain_routes/(dr)/state **Operation**: ``set_state`` Sets the state of a |DOMAINROUTE| object. See :ref:`section-Rap-CommonOps-SetState` (:numref:`section-Rap-CommonOps-SetState`). Valid requested states: - ``ENABLED`` - ``DISABLED`` - Example Enable a |DOMAINROUTE| with the name "MyDomainRoute" under the |SERVICE| "MyRouter". .. list-table:: :widths: 30 70 :header-rows: 1 * - Request Field - Value * - ``action`` - UPDATE * - ``resource_identifier`` - /routing_services/MyRouter/domain_routers/MyDomainRoute/state * - ``octet_body`` - .. code-block:: C to_cdr_buffer(RTI::Service::EntityStateKind::ENABLED) .... .. _dr-delete-session: .. function:: DELETE /routing_services/(rs)/domain_routes/(dr)/sessions/(s) **Operation** ``delete_session`` Deletes the specified |SESSION|. See :ref:`section-Rap-CommonOps-Delete` (:numref:`section-Rap-CommonOps-Delete`). **Request body** - Empty. **Reply body** - Empty. .. _section-RemoteAdmin-Api-Connection: Connection ---------- .. _connection-addPeer: .. function:: UPDATE \/domain_routes/(dr)/connections/(c):add_peer **Operation** ``add_peer`` Adds a list of peers to the specified |CONNECTION|. The |CONNECTION| implementation shall refer to a ```` object. **Request body** - ``string_body``: A comma-separated list of peer descriptors, as described in :link_locator_format:`peer descriptor format<>`. - Example peer descriptor list: .. code-block:: bash updv4://10.2.0.1,udpv4://239.255.0.1 **Reply body** - Empty. .... .. _connection-update: .. function:: UPDATE \/domain_routes/(dr)/connections/(c) **Operation**: ``update`` Updates the specified |CONNECTION| object. See :ref:`section-Rap-CommonOps-Update` (:numref:`section-Rap-CommonOps-Update`). The expected XML configuration is a subset of *connectionObjectRepresentation* or *participantObjectRepresentation*, and contains only parameters valid for the update. - Example Update a |CONNECTION| with the name "MyConnection" under the |DOMAINROUTE| "MyDomainRoute", with its configuration provided as a |SCHEME_STR| scheme. .. list-table:: :widths: 30 70 :header-rows: 1 * - Request Field - Value * - ``action`` - CREATE * - ``resource_identifier`` - /routing_services/MyRouter/domain_routes/MyDomainRoute/ connections/MyConnectiom * - ``string_body`` - .. code-block:: xml str://" ... " .... .. _connection-removePeer: .. function:: UPDATE \/domain_routes/(dr)/connections/(c):remove_peer **Operation** ``remove_peer`` Removes a list of peers from the specified |CONNECTION|. The |CONNECTION| implementation shall refer to a ```` object. **Request body** - ``string_body``: A comma-separated list of peer descriptors, as described in :link_locator_format:`peer descriptor format<>`. - Example peer descriptor list: .. code-block:: bash updv4://10.2.0.1,udpv4://239.255.0.1 **Reply body** - Empty. .. _section-RemoteAdmin-Api-Session: Session ------- .. _session-createAutoRoute: .. function:: CREATE \/domain_routes/(dr)/sessions/(s)/auto_routes **Operation**: ``create_auto_route`` Creates an |AR| or |ATR| object from its *autoRouteObjectRepresentation* or *autoTopicRouteObjectRepresentation* (see :numref:`TableRouterResourceRepresentations`). See :ref:`section-Rap-CommonOps-Create` (:numref:`section-Rap-CommonOps-Create`). - Example Create an |AR| with the name "NewAutoRoute" under the |SESSION| "MySession", with its configuration provided as a |SCHEME_STR| scheme. .. list-table:: :widths: 30 70 :header-rows: 1 * - Request Field - Value * - ``action`` - CREATE * - ``resource_identifier`` - /routing_services/MyRouter/domain_routes/MyDomainRoute/ sessions/MySession/auto_routes * - ``string_body`` - .. code-block:: xml str://" ... " The newly created object has the resource identifier: .. list-table:: :header-rows: 0 * - /routing_services/MyRouter/domain_routes/MyDomainRoute/ sessions/MySession/auto_routes/NewAutoRoute .... .. _session-createRoute: .. function:: CREATE \/domain_routes/(dr)/sessions/(s)/routes **Operation**: ``create_route`` Creates a |ROUTE| or |TR| object from its *routeObjectRepresentation* or *topicRouteObjectRepresentation* (see :numref:`TableRouterResourceRepresentations`). See :ref:`section-Rap-CommonOps-Create` (:numref:`section-Rap-CommonOps-Create`). - Example Create a |ROUTE| with the name "NewRoute" under the |SESSION| "MySession", with its configuration provided as a |SCHEME_STR| scheme. .. list-table:: :widths: 30 70 :header-rows: 1 * - Request Field - Value * - ``action`` - CREATE * - ``resource_identifier`` - /routing_services/MyRouter/domain_routes/MyDomainRoute/ sessions/MySession/routes * - ``string_body`` - .. code-block:: xml str://" ... " The newly created object has the resource identifier: .. list-table:: :header-rows: 0 * - /routing_services/MyRouter/domain_routes/MyDomainRoute/ sessions/MySession/routes/NewRoute .... .. _session-update: .. function:: UPDATE \/domain_routes/(dr)/sessions/(s) **Operation**: ``update`` Updates the specified |SESSION| object. See :ref:`section-Rap-CommonOps-Update` (:numref:`section-Rap-CommonOps-Update`). The expected XML configuration is a subset of *sessionObjectRepresentation* and contains only parameters valid for update. - Example Update a |SESSION| with the name "MySession" under the |DOMAINROUTE| "MyDomainRoute", with its configuration provided as a |SCHEME_STR| scheme. .. list-table:: :widths: 30 70 :header-rows: 1 * - Request Field - Value * - ``action`` - CREATE * - ``resource_identifier`` - /routing_services/MyRouter/domain_routes/MyDomainRoute/ sessions/MySession * - ``string_body`` - .. code-block:: xml str://" ... " .... .. _session-setState: .. function:: UPDATE \/domain_routes/(dr)/sessions/(s)/state **Operation**: ``set_state`` Sets the state of a |SESSION| object. See :ref:`section-Rap-CommonOps-SetState` (:numref:`section-Rap-CommonOps-SetState`). Valid requested states: - ``ENABLED`` - ``DISABLED`` - Example Enable a |SESSION| with the name "MySession" under the |DOMAINROUTE| "MyDomainRoute". .. list-table:: :widths: 30 70 :header-rows: 1 * - Request Field - Value * - ``action`` - UPDATE * - ``resource_identifier`` - /routing_services/MyRouter/domain_routers/MyDomainRoute/ sessions/MySession/state * - ``octet_body`` - .. code-block:: C to_cdr_buffer(RTI::Service::EntityStateKind::ENABLED) .... .. _session-deleteAutoRoute: .. function:: DELETE \/domain_routes/(dr)/sessions/(s)/auto_routes/(ar) **Operation** ``delete_auto_route`` Deletes the specified |AR|. See :ref:`section-Rap-CommonOps-Delete` (:numref:`section-Rap-CommonOps-Delete`). .... .. _session-deleteRoute: .. function:: DELETE \/domain_routes/(dr)/sessions/(s)/routes/(r) **Operation** ``delete_route`` Deletes the specified |ROUTE|. See :ref:`section-Rap-CommonOps-Delete` (:numref:`section-Rap-CommonOps-Delete`). .. _section-RemoteAdmin-Api-AutoRoute: AutoRoute --------- .. _ar-Update: .. function:: UPDATE \/domain_routes/(dr)/sessions/(s)/auto_routes/(ar) **Operation**: ``update`` Updates the specified |AR| or |ATR| object. See :ref:`section-Rap-CommonOps-Update` (:numref:`section-Rap-CommonOps-Update`). The expected XML configuration is a subset of *autoRouteObjectRepresentation* or *autoTopicRouteObjectRepresentation*, and contains only parameters valid for the update. - Example Update an |AR| with the name "MyAutoRoute" under the |SESSION| "MySession", with its configuration provided as a |SCHEME_STR| scheme. .. list-table:: :widths: 30 70 :header-rows: 1 * - Request Field - Value * - ``action`` - CREATE * - ``resource_identifier`` - /routing_services/MyRouter/domain_routes/MyDomainRoute/ sessions/MySession/auto_routes/MyAutoRoute * - ``string_body`` - .. code-block:: xml str://" ... " .... .. _ar-setState: .. function:: UPDATE \/domain_routes/(dr)/sessions/(s)/auto_routes/(ar)/state **Operation**: ``set_state`` Sets the state of an |AR| object. See :ref:`section-Rap-CommonOps-SetState` (:numref:`section-Rap-CommonOps-SetState`). Valid requested states: - ``ENABLED`` - ``DISABLED`` - ``RUNNING`` - ``PAUSED`` - Example Pause an |AR| with the name "MyAutoRoute" under the |SESSION| "MySession". .. list-table:: :widths: 30 70 :header-rows: 1 * - Request Field - Value * - ``action`` - UPDATE * - ``resource_identifier`` - /routing_services/MyRouter/domain_routers/MyDomainRoute/ sessions/MySession/auto_routes/MyAutoRoutestate * - ``octet_body`` - .. code-block:: C to_cdr_buffer(RTI::Service::EntityStateKind::PAUSED) .. _section-RemoteAdmin-Api-Route: Route ----- .. _r-update: .. function:: UPDATE \/domain_routes/(dr)/sessions/(s)/routes/(r) **Operation**: ``update`` See :ref:`section-Rap-CommonOps-Update` (:numref:`section-Rap-CommonOps-Update`). The expected XML configuration is a subset of *routeObjectRepresentation* or *topicRouteObjectRepresentation*, and contains only parameters valid for the update. - Example Update a |ROUTE| with the name "MyRoute" under the |SESSION| "MySession", with its configuration provided as a |SCHEME_STR| scheme. .. list-table:: :widths: 30 70 :header-rows: 1 * - Request Field - Value * - ``action`` - CREATE * - ``resource_identifier`` - /routing_services/MyRouter/domain_routes/MyDomainRoute/ sessions/MySession/routes/MyRoute * - ``string_body`` - .. code-block:: xml str://" ... " .... .. _r-setState: .. function:: UPDATE \/domain_routes/(dr)/sessions/(s)/routes/(r)/state **Operation**: ``set_state`` Sets the state of a |ROUTE| object. See :ref:`section-Rap-CommonOps-SetState` (:numref:`section-Rap-CommonOps-SetState`). Valid requested states: - ``ENABLED`` - ``DISABLED`` - ``RUNNING`` - ``PAUSED`` - Example Pause a |ROUTE| with the name "MyRoute" under the |SESSION| "MySession". .. list-table:: :widths: 30 70 :header-rows: 1 * - Request Field - Value * - ``action`` - UPDATE * - ``resource_identifier`` - /routing_services/MyRouter/domain_routers/MyDomainRoute/ sessions/MySession/routes/MyRoutestate * - ``octet_body`` - .. code-block:: C to_cdr_buffer(RTI::Service::EntityStateKind::PAUSED) .. _section-RemoteAdmin-Api-StreamPort: Input/Output ------------ .. _i-update: .. function:: UPDATE \/domain_routes/(dr)/sessions/(s)/routes/(r)/inputs(i) **Operation**: ``update`` See :ref:`section-Rap-CommonOps-Update` (:numref:`section-Rap-CommonOps-Update`). The expected XML configuration is a subset of *routeInputObjectRepresentation* or *topicRouteInputObjectRepresentation*, and contains only parameters valid for the update. - Example Update |INPUT| with the name "MyInput" under the |ROUTE| "MyRoute", with its configuration provided as a |SCHEME_STR| scheme. .. list-table:: :widths: 30 70 :header-rows: 1 * - Request Field - Value * - ``action`` - CREATE * - ``resource_identifier`` - /routing_services/MyRouter/domain_routes/MyDomainRoute/ sessions/MySession/routes/MyRoute/inputs/MyInput * - ``string_body`` - .. code-block:: xml str://" ... " .... .. _o-update: .. function:: UPDATE \/domain_routes/(dr)/sessions/(s)/routes/(r)/outputs(i) **Operation**: ``update`` See :ref:`section-Rap-CommonOps-Update` (:numref:`section-Rap-CommonOps-Update`). The expected XML configuration is a subset of *routeOutputObjectRepresentation* or *topicRouteOutputObjectRepresentation*, and contains only parameters valid for the update. - Example Update |OUTPUT| with the name "MyOutput" under the |ROUTE| "MyRoute", with its configuration provided as a |SCHEME_STR| scheme. .. list-table:: :widths: 30 70 :header-rows: 1 * - Request Field - Value * - ``action`` - CREATE * - ``resource_identifier`` - /routing_services/MyRouter/domain_routes/MyDomainRoute/ sessions/MySession/routes/MyRoute/outputs/MyOutput * - ``string_body`` - .. code-block:: xml str://" ... " .... .. _section-Admin-Example: Example: Configuration Reference ================================ This configuration example shows how individual commands would apply to a valid |RS| configuration. .. code-block:: xml 0 ... true ... ... ... ... ... true ... ... ... ... ... ... true ... ... ... ... ... ... ... true ... ... ... ... ... ... ... ... ...