Configure system components

This section includes steps to configure your system components as well as a list and description of the available system component parameters.

To configure your system components:

1. To initialize the configuration, use the PUT method in conjunction with the http://localhost:5590/api/v1/configuration/system/components REST endpoint.

2. Create an empty text file using a text editor.

3. Copy and paste a sample configuration for system components into the file. For example:

   [

   {

   "ComponentId": "OmfEgress",

   "ComponentType": "OmfEgress"

   }

   ]

   If you are configuring an adapter with two adapter instances, you can use the following example:

   [

   {

   "ComponentId": "DNP3-1",

   "ComponentType": "DNP3"

   },

   {

   "ComponentId": "DNP3-2",

   "ComponentType": "DNP3"

   },

   {

   "ComponentId": "OmfEgress",

   "ComponentType": "OmfEgress"

   }

   ]

4. Using the available parameters, update the example JSON parameters for your environment.

   Available parameters include ComponentId and ComponentType

   Note: The OmfEgress component is required to run the adapter. Both its ComponentId and ComponentType are reserved and should not be modified.

5. Save the file. For example, ConfigureComponents.json.

6. Open a command line session. Change directory to the location of ConfigureComponents.json.

7. Enter the following cURL command (which uses the PUT method) to initialize the system components configuration.

   curl -d "@ConfigureComponents.json" -H "Content-Type: application/json" -X PUT "http://localhost:5590/api/v1/configuration/system/components"

   Note: If you installed the adapter to listen on a non-default port, update 5590 to the port number in use.

REST URLs