Secrets EdgeCmd scripts
- Last UpdatedSep 08, 2025
- 1 minute read
- PI System
- Adapter for OPC UA 1.6
- Adapters
The following EdgeCmd commands configure specific facets of the secrets:
|
EdgeCmd command |
Description |
Examples |
|---|---|---|
|
edgecmd get secrets |
Returns the entire secrets configuration. |
|
|
edgecmd get secrets -id <secretId> |
Returns a single secret. |
edgecmd get secrets -id exampleSecret |
|
edgecmd set secrets -file <filePath> |
Creates/Updates the entire secret configuration. |
edgecmd set secrets -file C:\Users\TestUser\Secrets\Configuration.json |
|
edgecmd set secrets -id <secretId> -value <secretValue> [-description <description>] [-expirationDate <expirationDate>] |
Updates an existing secret or adds a single secret into the current configuration. |
edgecmd set secrets -id exampleSecret -value secretValue -description secretDescription -expirationDate 2025-06-19T00:00:00 |
|
edgecmd remove secrets [-y] |
Deletes the entire secrets configuration. |
|
|
edgecmd remove secrets -id <secretId> [-y] |
Deletes a single secret. |
edgemcd remove secrets -id exampleSecret |
|
edgecmd help secrets |
Returns secrets help information. |
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