Configure adapter or EDS component

Use EdgeCmd utility to add and remove adapter or Edge Data Store components, and to configure facets of the components.

Note: The examples in this topic are using the default port number 5590. If you specified a different port number for your adapter or Edge Data Store, you need to add it in the command. For example: edgecmd -port 5591 <RestOfTheCommand>

If a command contains backslashes, you must add escape characters. For example:

In Windows, add a second backslash.
Example: TestUser\OilCompany becomes TestUser\\OilCompany

In Linux, add three additional backslashes.
Example: TestUser\OilCompany becomes TestUser\\\\OilCompany

Add components

Complete the following steps to add a new component:

1. Access EdgeCmd utility through the command line.

2. Enter the following in the command line, replacing <componentType> and <componentId> with the values for the component.

   edgecmd add Components [-type <componentType>] [-id <componentId>]

   Note: The only valid component type is the adapter or Edge Data Store type. For example, if you are trying to register a new Modbus component, use Modbus. If you are trying to register an OPC UA component, use OpcUa. Refer to the specific adapter or Edge Data Store user guide for the component type.

Configure a facet of a component

Edge Data Store and adapters have different configurable facets. Complete the following steps to configure a facet:

3. Access EdgeCmd utility through the command line.

4. Enter the following in the command line, replacing <facetName> and <componentId> with their respective values.

   edgecmd set <facetName> -cid <componentId> [-file <filepath>]

   Example: Configuration of the data source facet of a Modbus adapter

   edgecmd set DataSource -cid Modbus1 -file C:\Users\TestUser\Modbus1\DataSource.json

   Note: For more information on adapter or Edge Data Store specific facets, see the respective adapter or Edge Data Store documentation.

Remove a component

Complete the following steps to remove a component from the adapter or EDS:

5. Access EdgeCmd utility through the command line.

6. Enter the following in the command line, replacing <componentId> with the ID of the component to remove. Edgecmd prompts with "Please Confirm [y/N]: " unless you include the optional -y parameter.

   edgecmd remove Components [-id <componentId] [-y]

   Example: Removal of the Modbus component

   edgecmd remove Components -id Modbus1

   Note: You cannot remove the OmfEgress from PI adapters or the Storage component from Edge Data Store. They are required for the products to operate.