System components EdgeCmd scripts
- Last UpdatedMay 07, 2025
- 1 minute read
- PI System
- Adapter for RDBMS 1.1
- Adapters
The following EdgeCmd commands configure specific facets of the system components:
|
EdgeCmd command |
Description |
Example |
|---|---|---|
|
edgecmd get Components [-file <filepath>] |
Get the component configuration. |
edgecmd get Components |
|
edgecmd set Components [-file <filepath>] |
Import the components configuration. |
edgecmd set Components -file C:\Users\TestUser\Components\Configuration.json |
|
edgecmd add Components [-type <type>] [-id <componentId>] |
Add a component to the components configuration. |
edgecmd add Components -type RDBMS -id OpcUa1 |
|
edgecmd remove Components [-id <componentId>] [-y] |
Remove the specified component from the configuration. |
edgecmd remove Components -id OpcUa1 |
|
edgecmd help Components |
Display help output for the components configuration. |
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>
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