Schedules 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 schedules:
|
EdgeCmd command |
Description |
Examples |
|---|---|---|
|
edgecmd get Schedules -cid <componentId> [-file <filepath>] |
Get the schedules configuration for the specified component. |
edgecmd get Schedules -cid OpcUa1 |
|
edgecmd set Schedules -cid <componentId> [-file <filepath>] |
Import the schedules configuration for the specified component. |
edgecmd set Schedules -cid OpcUa1 -file C:\Users\TestUsers\Schedules\Configuration.json |
|
edgecmd add Schedules -cid <componentId> -id <itemid> [-Period <period>] [-Offset <offset>] |
Add the schedules configuration for the specified component. |
edgecmd add Schedules -cid OpcUa1 -id Schedule1 -Period 125 -Offset 25 |
|
edgecmd edit Schedule -cid <componentId> -id <itemid> [-Period <period>] [-Offset <offset>] |
Change the schedules configuration for the specified component. |
edgecmd edit Schedule -cid OpcUa1 -id Schedule2 |
|
edgecmd remove Schedule -cid <componentId> [-id <itemid>] [-y] |
Remove the schedules configuration for an item in the specified component. |
edgecmd remove Schedule -cid OpcUa1 -id Schedule3 -y |
|
edgecmd remove Schedule -cid <componentId> [-y] |
Remove the schedules configuration for the specified component. |
edgecmd remove Schedule -cid OpcUa1 |
|
edgecmd help Schedule –cid <componentId> |
Display help output for the schedules facet. |
edgecmd help Schedule -cid OpcUa1 |
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