Data discovery EdgeCmd scripts
- Last UpdatedNov 10, 2025
- 2 minute read
The following EdgeCmd commands configure specific facets of the data discovery:
|
EdgeCmd command |
Description |
Examples |
|---|---|---|
|
edgecmd add discoveries -cid <componentId> |
Start a new discovery operation for the specified component and return the status object containing the generated Id of the discovery. |
edgecmd add discoveries -cid MQTT1 |
|
edgecmd get discoveries -cid <componentId> |
Get the active and completed discovery status information for the specified component. |
edgecmd get discoveries -cid MQTT1 |
|
edgecmd get discoveries -cid <componentId> -id <discoveryId> -result [-csv] [-file <filename>] |
Get the result of the specified discovery for the specified component. |
edgecmd get discoveries -cid MQTT1 -id 1 -result |
|
edgecmd add discoveries -cid <componentId> -query "<queryFilter>" -id <discoveryId> |
Start a new discovery operation for the specified component with the specified query. |
edgecmd add discoveries -cid MQTT1 -query "+/+/Device90" -id 1 |
|
edgecmd get discoveries -cid <componentId> -id <discoveryId> -result -query diff=<discoveryId> [-csv] |
Get the differences between two specified discoveries of the specified component |
edgecmd get discoveries -cid MQTT1 -id 1 -result -query diff=2 |
|
edgecmd add dataselection -cid <componentId> -select -query discoveryId=<discoveryId> |
Add the specified discovery result to the data selection and set all items to be selected. |
edgecmd add dataselection -cid MQTT1 -select -query discoveryId=1 |
|
edgecmd get dataselection -cid <componentId> -query diff=<discoveryId> [-csv] |
Compare the data selection against a discovery result. |
edgecmd get dataselection -cid MQTT1 -query diff=2 |
|
edgecmd remove discoveries -cid <componentId> -id <discoveryId> -result [-y] |
Remove only the result of the specified discovery from the specified component and cancel discovery if active. |
edgecmd remove discoveries -cid MQTT1 -id 2 -result -y |
|
edgecmd remove discoveries -cid <componentId> -id <discoveryId> [-y] |
Remove the discovery state and result from the specified component and cancel discovery if active. |
edgecmd remove discoveries -cid MQTT1 -id 2 -y |
|
edgecmd cancel discoveries -cid <componentId> -id <discoveryId> |
Cancel the discovery for the specified component. |
edgecmd cancel discoveries -cid MQTT1 -id 2 |
Use EdgeCmd utility to add and remove adapter, 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, you need to add it in the command. For example: edgecmd -port 5591 <RestOfTheCommand>
Note: If a command contains slashes, you must add escape characters as follows:
In Windows , add a second slash. style="box-sizing: inherit;">
Example: TestUser\OilCompany becomes TestUser\\OilCompany
In Linux , add three additional slashes. style="box-sizing: inherit;">
Example: TestUser\OilCompany becomes TestUser\\\\OilCompany