This section explains how to access the different configurable parameters in an external locator list configuration. The scope of this section does not include explaining the usage of these specific parameters. Please, refer to Fast DDS documentation for that information.
The external locator list configuration is accessed through the external_locators element which is a complex parameter list according to the :ref:`fastdds_qos_profiles_manager_element_classification`.
The external locator list configurable <subelements> are explained in the table below.
subelement |
CLI access | :ref:`fastdds_qos_profiles_manager_element_classification` | Valid set values |
|---|---|---|---|
| Address element | external_locators.<external_locator_type>[(index)].address |
Simple parameter | IP or DNS address |
| Externality attribute | external_locators.<external_locator_type>[(index)].externality |
Simple parameter | uint8_t |
| Port element | external_locators.<external_locator_type>[(index)].port |
Simple parameter | uint16_t |
Note
As explained in the :ref:`fastdds_qos_profiles_manager_element_classification` section, this collection should be accessed by means of a given integer index between brackets to select the specific collection element.
Both positive and negative indexes are allowed to access the collection from both ends.
If no index is provided, the complete collection is selected (either to be printed or cleared, for instance).
To push a new element into the collection, no index should be provided to the set command.
The <external_locator_type> element is defined for each specific element.
The list below includes the currently supported <external_locator_type> elements:
- :ref:`Participant builtin metatraffic external unicast locators configuration <fastdds_qos_profiles_manager_cli_participant_builtin_element>`.
- :ref:`Participant default external unicast locators configuration <fastdds_qos_profiles_manager_cli_participant_elements>`.
Warning
Any other <external_locator_type> is not yet supported.