5. Remote Administration¶

This section provides documentation on Routing Service remote administration.

Note

Routing Service remote administration is based on the RTI Remote Administration Platform described in Remote Administration Platform. We recommend that you read that section before using Routing Service remote administration.

Below you will find an API reference for all the supported operations.

5.1. Overview¶

5.1.1. Enabling Remote Administration¶

By default, remote administration is disabled in Routing Service. To enable remote administration, you can use the <administration> tag (see Routing Service Tag) or the -remoteAdministrationDomainId command-line parameter, which enables remote administration and sets the domain ID for remote communication (see Command-Line Executable).

5.1.2. Available Service Resources¶

Table 5.1 lists the public resources specific to Routing Service. Each resource identifier is expressed as a hierarchical sequence of identifiers, including parent and target resources. (See Resource Identifiers 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:

<routing_service name="MyRouter">...</routing_service>

The resource identifier is:

/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.

Table 5.1 Resources and Their Identifiers in *Routing Service*¶
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)
AutoRoute or AutoTopicRoute	/routing_services/(rs)/domain_routes/(dr)/sessions/(s)/auto_routes/(ar)
Route or TopicRoute	/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)

5.1.2.1. Example¶

This example shows you how to address a resource of each possible resource class in Routing Service, using the example configuration in Example: Configuration Reference as a reference. (For a complete reference of the available configuration tags used in Routing Service, see XML Tags for Configuring RTI Routing Service.)

Entity with name “MyRouter”:

<routing_service name="MyRouter">...</routing_service>

Resource identifier:

/routing_services/MyRouter

Entity with name “MyDomainRoute” in parent “MyRouter”:

<routing_service name="MyRouter">
    <domain_route name="MyDomainRoute">...</domain_route>
</routing_service>

Resource identifier:

/routing_services/MyRouter/domain_routes/MyDomainRoute

Entity with name “MyParticipant” in parent “MyDomainRoute”:

<routing_service name="MyRouter">
    <domain_route name="MyDomainRoute">
        <participant name="Session">...</participant>
    </domain_route>
</routing_service>

Resource identifier:

/routing_services/MyRouter/domain_routes/MyDomainRoute/connections/MyParticipant

Entity with name “MySession” in parent “MyDomainRoute”:

<routing_service name="MyRouter">
    <domain_route name="MyDomainRoute">
        <session name="MySession">...</session>
    </domain_route>
</routing_service>

Resource identifier:

/routing_services/MyRouter/domain_routes/MyDomainRoute/sessions/MySession

Entity with name “MyAutoTopicRoute” in parent “MySession”:

<routing_service name="MyRouter">
    <domain_route name="MyDomainRoute">
        <session name="MySession">
            <auto_topic_route name="MyAutoTopicRoute">...</auto_topic_route>
        </session>
    </domain_route>
</routing_service>

Resource identifier (all on one line):

/routing_services/MyRouter/domain_routes/MyDomainRoute/sessions/MySession/
routes/MyTopicRoute

Entity with name “MyTopicRoute” in parent “MySession”:

<routing_service name="MyRouter">
    <domain_route name="MyDomainRoute">
        <session name="MySession">
            <topic_route name="MyTopicRoute">...</topic_route>
        </session>
    </domain_route>
</routing_service>

Resource identifier (all on one line):

/routing_services/MyRouter/domain_routes/MyDomainRoute/sessions/MySession/
routes/MyTopicRoute

Entity with name “MyInput” in parent “MyTopicRoute”:

<routing_service name="MyRouter">
    <domain_route name="MyDomainRoute">
        <session name="MySession">
            <topic_route name="MyTopicRoute">
                <input name="MyInput">...</input>
            </topic_route>
        </session>
    </domain_route>
</routing_service>

Resource identifier (all on one line):

/routing_services/MyRouter/domain_routes/MyDomainRoute/sessions/MySession/
routes/MyRoute/inputs/MyInput

Entity with name “MyOutput” in parent “MyTopicRoute”:

<routing_service name="MyRouter">
    <domain_route name="MyDomainRoute">
        <session name="MySession">
            <topic_route name="MyTopicRoute">
                <output name="MyOutput">...</output>
            </topic_route>
        </session>
    </domain_route>
</routing_service>

Resource identifier (all on one line):

/routing_services/MyRouter/domain_routes/MyDomainRoute/sessions/MySession/
routes/MyRoute/outputs/MyOutput

5.1.3. Resource Object Representations¶

Table 5.2 Resource Representations in *Routing Service*¶
Resource Representation	Format (all element type definitions are from the file rti_routing_service.xsd)
ddsObjectRepresentation	<xs:element name="dds" type="ddsRouter"/>
routerObjectRepresentation	<xs:element name="routing_service" type="routingService"/>
domainRouteObjectRepresentation	<xs:element name="domain_route" type="domainRoute"/>
connectionObjectRepresentation	<xs:element name="connection" type="domainRouteConnection"/>
participantObjectRepresentation	<xs:element name="participant" type="domainRouteParticipant"/>
sessionObjectRepresentation	<xs:element name="session" type="routerSession"/>
autoRouteObjectRepresentation	<xs:element name="auto_route" type="autoRoute"/>
autoTopicRouteObjectRepresentation	<xs:element name="auto_topic_route" type="autoTopicRoute"/>
routeObjectRepresentation	<xs:element name="route" type="route"/>
topicRouteObjectRepresentation	<xs:element name="topic_route" type="topicRoute"/>
inputObjectRepresentation	<xs:element name="input" type="routeStreamPort"/>
outputObjectRepresentation	<xs:element name="output" type="routeStreamPort"/>
ddsInputObjectRepresentation	<xs:element name="input" type="topicRouteInput"/> <xs:element name="dds_input" type="topicRouteInput"/>
ddsOutputObjectRepresentation	<xs:element name="output" type="topicRouteOutput"/> <xs:element name="dds_output" type="topicRouteOutput"/>

5.2. API Reference¶

This section documents each remote operation, organized by service resource class.

5.2.1. Remote API Overview¶

Note

To improve readability, <SERVICE> 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.

Table 5.3 Remote Interface Overview¶
Resource	Operation	Description
Service	CREATE /routing_services/(rs)/domain_route	Creates a new DomainRoute.
	CREATE /routing_services/(rs)/config	Loads a full service configuration.
	GET /routing_services/(rs)	Returns the Service configuration.
	UPDATE /routing_services/(rs)	Updates a Service object.
	UPDATE /routing_services/(rs)/state	Sets a Service state.
	UPDATE /routing_services/(rs):save	Saves the Service loaded configuration.
	DELETE /routing_services/(rs)/domain_routes/(dr)	Deletes a DomainRoute object.
	DELETE /routing_services/(rs)/config	Deletes the Service configuration.
	DELETE /routing_services/(rs)	Shuts down the running Service.
DomainRoute	CREATE /routing_services/(rs)/domain_route/(dr)/sessions	Creates a new Session.
	UPDATE /routing_services/(rs)/domain_route/(dr)	Updates a DomainRoute.
	UPDATE /routing_services/(rs)/domain_route/(dr)/state	Sets a DomainRoute state.
	DELETE /routing_services/(rs)/domain_route/(dr)/sessions/(s)	Deletes a Session.
Connection	UPDATE <SERVICE>/domain_route/connections(c):add_peer	Adds a list of peers in a Connection (a Participant in DDS adapter).
	UPDATE <SERVICE>/domain_route/(dr)/connections(c)	Updates a Connection.
	DELETE <SERVICE>/domain_route/(dr)/connections(c):remove_peer	Removes a list of peers in a Connection (a Participant in DDS adapter).
Session	CREATE <SERVICE>/domain_route/(dr)/sessions/(s)/auto_routes	Creates a new AutoRoute.
	CREATE <SERVICE>/domain_route/(dr)/sessions/(s)/routes	Creates a new Route.
	UPDATE <SERVICE>/domain_route/(dr)/sessions(s)	Updates a Session.
	UPDATE <SERVICE>/domain_route/(dr)/sessions(s)/state	Sets a Session state.
	DELETE <SERVICE>/domain_route/(dr)/sessions/(s)/auto_routes/(ar)	Deletes an AutoRoute.
	DELETE <SERVICE>/domain_route/(dr)/sessions/(s)/routes/(r)	Deletes a Route.
AutoRoute or AutoTopicRoute	UPDATE <SERVICE>/domain_route/(dr)/sessions/(s)/auto_routes(ar)	Updates an AutoRoute.
	UPDATE <SERVICE>/domain_route/(dr)/sessions/(s)/auto_routes(ar)/state	Sets an AutoRoute state.
Route or TopicRoute	UPDATE <SERVICE>/domain_route/(dr)/sessions/(s)/routes(r)	Updates a Route.
	UPDATE <SERVICE>/domain_route/(dr)/sessions/(s)/routes(r)/state	Sets a Route state.
Input	UPDATE <SERVICE>/domain_route/(dr)/sessions/(s)/routes(r)/inputs/(i)	Updates an Input (Connext DDS and non-Connext DDS).
Output	UPDATE <SERVICE>/domain_route/(dr)/sessions/(s)/routes(r)/outputs/(o)	Updates an Output (Connext DDS and non-Connext DDS).

5.2.2. Service¶

CREATE /routing_services/(rs)/domain_routes

Operation create_domain_route

Creates a DomainRoute object from its domainRouteObjectRepresentation (see Table 5.2).

See Create Resource (Create Resource).

Example

Create a DomainRoute with name “NewDomainRoute” under Service “MyRouter”, with its configuration provided as a str:// scheme.

Request Field	Value
`action`	CREATE
`resource_identifier`	/routing_services/MyRouter/domain_routes
`string_body`	str\://\"<domain_route name=\"NewDomainRoute\"> ... </domain_route>"

The newly created object has the resource identifier:

/routing_services/MyRouter/domain_routes/NewDomainRoute

CREATE /routing_services/(rs)/config

Operation load

Loads a new configuration for the service from its ddsObjectRepresentation (see Table 5.2).

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

Reply body

Example

Load a new configuration in Service “MyRouter”.

Request Field	Value
`action`	CREATE
`resource_identifier`	/routing_services/MyRouter/config
`string_body`	str://"<dds> ... <qos_library name="QosLibrary"> ... </qos_library> ... <routing_service name="MyRouter"> ... </routing_service> </dds>"

GET /routing_services/(rs)

Operation: get

Returns a snapshot of the currently loaded full XML configuration as ddsObjectRepresentation (see Table 5.2).

See Get Resource (Get Resource).

Example reply body:

<routing_service name="MyRouter>
    <administration>...</administration>
    ...
</routing_service>

UPDATE /routing_services/(rs)

Operation: update

Updates the specified Service object.

See Update Resource (Update Resource).

The expected XML configuration is a subset of routerObjectRepresentation and only contains the properties that are mutable and whose values have changed.

Example

Update a Service with the name “MyRouter”.

Request Field	Value
`action`	UPDATE
`resource_identifier`	/routing_services/MyRouter
`string_body`	str://\"<routing_service> <save_path>./service_snapshot.xml</save_path> </routing_service>"

UPDATE /routing_services/(rs)/state

Operation: set_state

Sets the state of a Service object.

See Set Resource State (Set Resource State).

Valid requested states:

Example

Enable a Service with the name “MyRouter”.

Request Field	Value
`action`	UPDATE
`resource_identifier`	/routing_services/MyRouter/state
`octet_body`	to_cdr_buffer(RTI::Service::EntityStateKind::ENABLED)

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

Reply body

DELETE /routing_services/(rs)/domain_routes/(dr)

Operation delete_domain_route

Deletes the specified DomainRoute.

See Delete Resource (Delete Resource).

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

Reply body

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 DDS 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 RTI Remote Administration Platform entities.

This operation can be invoked at any time during the lifecycle of the service.

Request body

Reply body

5.2.3. DomainRoute¶

CREATE /routing_services/(rs)/domain_routes/(dr)/sessions

Operation: create_session

Creates a Session object from its sessionObjectRepresentation (see Table 5.2).

See Create Resource (Create Resource).

Example

Create a Session with the name “NewSession” under the DomainRoute “MyDomainRoute”, with its configuration provided as a str:// scheme.

Request Field	Value
`action`	CREATE
`resource_identifier`	/routing_services/MyRouter/domain_routes/MyDomainRoute/sessions
`string_body`	str://"<session name="NewSession"> ... </session>"

The newly created object has the resource identifier:

<SERVICE>/domain_routes/NewDomainRoute/sessions/NewSession

UPDATE /routing_services/(rs)/domain_routes/(dr)

Operation: update

Updates the specified DomainRoute object.

See Update Resource (Update Resource).

The expected XML configuration is a subset of domainRouteObjectRepresentation and only contains the properties that are mutable and whose values have changed.

Example

Update a DomainRoute with the name “MyDomainRoute” under the Service “MyRouter”, with its configuration provided as a str:// scheme.

Request Field	Value
`action`	UPDATE
`resource_identifier`	/routing_services/MyRouter/domain_routes/MyDomainRoute
`string_body`	str://"<domain_route> ... </domain_route>"

UPDATE /routing_services/(rs)/domain_routes/(dr)/state

Operation: set_state

Sets the state of a DomainRoute object.

See Set Resource State (Set Resource State).

Valid requested states:

Example

Enable a DomainRoute with the name “MyDomainRoute” under the Service “MyRouter”.

Request Field	Value
`action`	UPDATE
`resource_identifier`	/routing_services/MyRouter/domain_routers/MyDomainRoute/state
`octet_body`	to_cdr_buffer(RTI::Service::EntityStateKind::ENABLED)

DELETE /routing_services/(rs)/domain_routes/(dr)/sessions/(s)

Operation delete_session

See Delete Resource (Delete Resource).

Request body

Reply body

5.2.4. Connection¶

UPDATE \<SERVICE\>/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 <participant> object.

Request body

Reply body

UPDATE \<SERVICE\>/domain_routes/(dr)/connections/(c)

Operation: update

Updates the specified Connection object.

See Update Resource (Update Resource).

The expected XML configuration is a subset of participantObjectRepresentation or connectionObjectRepresentation and only contains the properties that are mutable and whose value is changed.

Example

Update a Connection with the name “MyParticipant” under the DomainRoute “MyDomainRoute”, with its configuration provided as a str:// scheme.

Request Field	Value
`action`	UPDATE
`resource_identifier`	/routing_services/MyRouter/domain_routes/MyDomainRoute/ connections/MyParticipant
`string_body`	str://"<participant> <participant_qos> <property> <value> <element> <name>property_name</name> <value>property_new_value</value> </element> </value> </property> </participant_qos> </participant>"

Example

Update a Connection with the name “MyConnection” under the DomainRoute “MyDomainRoute”, with its configuration provided as a str:// scheme.

Request Field	Value
`action`	UPDATE
`resource_identifier`	/routing_services/MyRouter/domain_routes/MyDomainRoute/ connections/MyConnection
`string_body`	str://"<connection> <property> <value> <element> <name>property_name</name> <value>property_new_value</value> </element> </value> </property> </connection>

DELETE \<SERVICE\>/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 <participant> object.

Request body

Reply body

5.2.5. Session¶

CREATE \<SERVICE\>/domain_routes/(dr)/sessions/(s)/auto_routes

Operation: create_auto_route

Creates an AutoRoute or AutoTopicRoute object from its autoRouteObjectRepresentation or autoTopicRouteObjectRepresentation (see Table 5.2).

See Create Resource (Create Resource).

Example

Create an AutoRoute with the name “NewAutoRoute” under the Session “MySession”, with its configuration provided as a str:// scheme.

Request Field	Value
`action`	CREATE
`resource_identifier`	/routing_services/MyRouter/domain_routes/MyDomainRoute/ sessions/MySession/auto_routes
`string_body`	str://"<auto_route name="NewAutoRoute"> ... </auto_route>"

The newly created object has the resource identifier:

/routing_services/MyRouter/domain_routes/MyDomainRoute/ sessions/MySession/auto_routes/NewAutoRoute

CREATE \<SERVICE\>/domain_routes/(dr)/sessions/(s)/routes

Operation: create_route

Creates a Route or TopicRoute object from its routeObjectRepresentation or topicRouteObjectRepresentation (see Table 5.2).

See Create Resource (Create Resource).

Example

Create a Route with the name “NewRoute” under the Session “MySession”, with its configuration provided as a str:// scheme.

Request Field	Value
`action`	CREATE
`resource_identifier`	/routing_services/MyRouter/domain_routes/MyDomainRoute/ sessions/MySession/routes
`string_body`	str://"<route name="NewRoute"> ... </route>"

The newly created object has the resource identifier:

/routing_services/MyRouter/domain_routes/MyDomainRoute/ sessions/MySession/routes/NewRoute

UPDATE \<SERVICE\>/domain_routes/(dr)/sessions/(s)

Operation: update

Updates the specified Session object.

See Update Resource (Update Resource).

The expected XML configuration is a subset of sessionObjectRepresentation and only contains the properties that are mutable and whose values have changed.

Example

Update a Session with the name “MySession” under the DomainRoute “MyDomainRoute”, with its configuration provided as a str:// scheme.

Request Field	Value
`action`	UPDATE
`resource_identifier`	/routing_services/MyRouter/domain_routes/MyDomainRoute/ sessions/MySession
`string_body`	str://"<session> <publisher_qos> <partition> <name> <element>MyNewPartition</element> </name> </partition> </publisher_qos> </session>"

UPDATE \<SERVICE\>/domain_routes/(dr)/sessions/(s)/state

Operation: set_state

Sets the state of a Session object.

See Set Resource State (Set Resource State).

Valid requested states:

Example

Enable a Session with the name “MySession” under the DomainRoute “MyDomainRoute”.

Request Field	Value
`action`	UPDATE
`resource_identifier`	/routing_services/MyRouter/domain_routers/MyDomainRoute/ sessions/MySession/state
`octet_body`	to_cdr_buffer(RTI::Service::EntityStateKind::ENABLED)

DELETE \<SERVICE\>/domain_routes/(dr)/sessions/(s)/auto_routes/(ar)

Operation delete_auto_route

Deletes the specified AutoRoute.

See Delete Resource (Delete Resource).

DELETE \<SERVICE\>/domain_routes/(dr)/sessions/(s)/routes/(r)

Operation delete_route

Deletes the specified Route.

See Delete Resource (Delete Resource).

5.2.6. AutoRoute¶

UPDATE \<SERVICE\>/domain_routes/(dr)/sessions/(s)/auto_routes/(ar)

Operation: update

Updates the specified AutoRoute or AutoTopicRoute object.

See Update Resource (Update Resource).

The expected XML configuration is a subset of autoRouteObjectRepresentation or autoTopicRouteObjectRepresentation and only contains the properties that are mutable and whose value is changed.

Note that AutoRoute or AutoTopicRoute don’t have any children resources. All the properties defined for the XML representation can be used for the update operation. Also the Route or TopicRoute created as part of an AutoRoute or AutoTopicRoute can be updated independently.

Example

Update an AutoRoute with the name “MyAutoRoute” under the Session “MySession”, with its configuration provided as a str:// scheme.

Request Field	Value
`action`	UPDATE
`resource_identifier`	/routing_services/MyRouter/domain_routes/MyDomainRoute/ sessions/MySession/auto_routes/MyAutoRoute
`string_body`	str://"<auto_route> <dds_input> <datareader_qos> <period> <sec>1</sec> <nanosec>0</nanosec> </period> </datareader_qos> </dds_input> </auto_route>"

UPDATE \<SERVICE\>/domain_routes/(dr)/sessions/(s)/auto_routes/(ar)/state

Operation: set_state

Sets the state of an AutoRoute object.

See Set Resource State (Set Resource State).

Valid requested states:

Example

Pause an AutoRoute with the name “MyAutoRoute” under the Session “MySession”.

Request Field	Value
`action`	UPDATE
`resource_identifier`	/routing_services/MyRouter/domain_routers/MyDomainRoute/ sessions/MySession/auto_routes/MyAutoRoutestate
`octet_body`	to_cdr_buffer(RTI::Service::EntityStateKind::PAUSED)

5.2.7. Route¶

UPDATE \<SERVICE\>/domain_routes/(dr)/sessions/(s)/routes/(r)

Operation: update

See Update Resource (Update Resource).

The expected XML configuration is a subset of routeObjectRepresentation or topicRouteObjectRepresentation and only contains the properties that are mutable and whose value is changed.

Example

Update a Route with the name “MyRoute” under the Session “MySession”, with its configuration provided as a str:// scheme.

Request Field	Value
`action`	UPDATE
`resource_identifier`	/routing_services/MyRouter/domain_routes/MyDomainRoute/ sessions/MySession/routes/MyRoute
`string_body`	str://"<route> <processor> <property> <value> <element> <name>property_name</name> <value>property_new_value</value> </element> </value> </property> </processor> </route>"

UPDATE \<SERVICE\>/domain_routes/(dr)/sessions/(s)/routes/(r)/state

Operation: set_state

Sets the state of a Route object.

See Set Resource State (Set Resource State).

Valid requested states:

Example

Pause a Route with the name “MyRoute” under the Session “MySession”.

Request Field	Value
`action`	UPDATE
`resource_identifier`	/routing_services/MyRouter/domain_routers/MyDomainRoute/ sessions/MySession/routes/MyRoutestate
`octet_body`	to_cdr_buffer(RTI::Service::EntityStateKind::PAUSED)

5.2.8. Input/Output¶

UPDATE \<SERVICE\>/domain_routes/(dr)/sessions/(s)/routes/(r)/inputs(i)

Operation: update

See Update Resource (Update Resource).

The expected XML configuration is a subset of routeInputObjectRepresentation or topicRouteInputObjectRepresentation and only contains the properties that are mutable and whose value is changed.

Example

Update Input with the name “MyInput” under the TopicRoute “MyRoute”, with its configuration provided as a str:// scheme.

Request Field	Value
`action`	UPDATE
`resource_identifier`	/routing_services/MyRouter/domain_routes/MyDomainRoute/ sessions/MySession/routes/MyRoute/inputs/MyInput
`string_body`	str://"<input> <datareader_qos> <period> <sec>1</sec> <nanosec>0</nanosec> </period> </datareader_qos> </input>"

Example

Update Input with the name “MyInput” under the Route “MyRoute”, with its configuration provided as a str:// scheme.

Request Field	Value
`action`	UPDATE
`resource_identifier`	/routing_services/MyRouter/domain_routes/MyDomainRoute/ sessions/MySession/routes/MyRoute/inputs/MyInput
`string_body`	str://"<input> <property> <value> <element> <name>property_name</name> <value>property_new_value</value> </element> </value> </property> </input>"

UPDATE \<SERVICE\>/domain_routes/(dr)/sessions/(s)/routes/(r)/outputs(i)

Operation: update

See Update Resource (Update Resource).

The expected XML configuration is a subset of routeOutputObjectRepresentation or topicRouteOutputObjectRepresentation and only contains the properties that are mutable and whose value is changed.

Example

Update Output with the name “MyOutput” under the TopicRoute “MyRoute”, with its configuration provided as a str:// scheme.

Request Field	Value
`action`	UPDATE
`resource_identifier`	/routing_services/MyRouter/domain_routes/MyDomainRoute/ sessions/MySession/routes/MyRoute/inputs/MyInput
`string_body`	str://"<output> <datawriter_qos> <period> <sec>1</sec> <nanosec>0</nanosec> </period> </datawriter_qos> </output>"

Example

Update Output with the name “MyOutput” under the Route “MyRoute”, with its configuration provided as a str:// scheme.

Request Field	Value
`action`	UPDATE
`resource_identifier`	/routing_services/MyRouter/domain_routes/MyDomainRoute/ sessions/MySession/routes/MyRoute/outputs/MyOutput
`string_body`	str://"<output> <property> <value> <element> <name>property_name</name> <value>property_new_value</value> </element> </value> </output> </input>"

5.3. Example: Configuration Reference¶

This configuration example shows how individual commands would apply to a valid Routing Service configuration.

<?xml version="1.0"?>
<dds>
    <routing_service name="MyRouter">
        <domain_route name="MyDomainRoute">
            <participant name="MyParticipant">
               <domain_id>0</domain_id>
            </participant>
            <connection name="MyConnection">
            </connection>
            ... <!-- other connections/participants -->

            <session name="MySession">
                <auto_route name="MyAutoRoute">
                <publish_with_original_timestamp>true</publish_with_original_timestamp>
                    ...
                    <input name="MyInput">
                        ...
                        <property>
                            ...
                        </property>
                    </input>
                    <output name="MyOutput">
                        ...
                        <property>
                            ...
                        </property>
                    </output>
                </auto_route>
                <auto_topic_route name="MyAutoTopicRoute">
                    <publish_with_original_info>true</publish_with_original_info>
                    ...
                    <input name="MyInput">
                        ...
                        <datareader_qos>
                            ...
                        </datareader_qos>
                    </input>
                    <output name="MyOutput">
                        ...
                        <datawriter_qos>
                            ...
                        </datawriter_qos>
                    </output>
                </auto_topic_route>
                ... <!-- other auto (Topic) routes -->
                <route name="MyRoute">
                    <route_types>true</route_types>
                    <input name="MyInput">
                        ...
                        <property>
                            ...
                        </property>
                    </input>
                    ... <!-- other inputs -->
                    <output name="MyOutput">
                        ...
                        <property>
                            ...
                        </property>
                    </output>
                    ... <!-- other outputs -->
                </route>
                ... <!-- other (Topic) routes -->
                <topic_route name="MyTopicRoute">
                    <route_types>true</route_types>
                    ...
                    <input name="MyInput">
                        ...
                        <datareader_qos>
                            ...
                        </datareader_qos>
                    </input>
                    ... <!-- other inputs -->
                    <output name="MyOutput">
                        ...
                        <datawriter_qos>
                            ...
                        </datawriter_qos>
                    </output>
                    ... <!-- other outputs -->
                </topic_route>
            </session>
            ... <!-- other sessions -->
        </domain_route>
        ... <!-- other domain routes -->
    </routing_service>
</dds>