Data endpoints EdgeCmd scripts
- Last UpdatedMay 01, 2025
- 1 minute read
- PI System
- Adapter for OPC UA 1.6
- Adapters
The following EdgeCmd commands configure specific facets of the data endpoints:
|
EdgeCmd command |
Description |
Examples |
|---|---|---|
|
edgecmd get DataEndpoints [-file <filepath>] |
Get the data endpoints configuration. |
edgecmd get DataEndpoints |
|
edgecmd set DataEndpoints [-file <filepath>] |
Import the data endpoints configuration. |
edgecmd set DataEndpoints -file C:\Users\TestUser\DataEndpoints\Configuration.json |
|
edgecmd add DataEndpoints [-id <endpointId>] [-Endpoint <endpointUrl>] [-UserName <userName>] [-Password <password>] [-ClientId <clientId>] [-ClientSecret <clientSecret>] [-TokenEndpoint <tokenEndpoint>] [-ValidateEndpointCertificate <true/false>] |
Add data endpoints. |
edgecmd add DataEndpoints -id PI Web Api -Endpoint https://pi_web_api_server/piwebapi/omf/ -UserName TestUser -Password TestPassword -ValidateEndpointCertificate false |
|
edgecmd edit DataEndpoints -id <string> [-Endpoint <endpointUrl>] [-UserName <userName>] [-Password <password>] [-ClientId <clientId>] [-ClientSecret <clientSecret>] [-TokenEndpoint <tokenEndpoint>] [-ValidateEndpointCertificate <true/false>] |
Change a data endpoint. |
edgecmd edit DataEndpoints -id PI Web Api -Endpoint https://pi_web_api_server/piwebapi/omf/ -UserName TestUser -Password TestPassword -ValidateEndpointCertificate true |
|
edgecmd remove DataEndpoints -id <string> [-y] |
Remove the specified data endpoint. |
edgecmd remove DataEndpoints -id PI Web API |
|
edgecmd remove DataEndpoints [-y] |
Remove all data endpoints. |
edgecmd remove DataEndpoints -y |
|
edgecmd help DataEndpoints |
Display help output for the data endpoints 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