Note: Before using any commands from Public API, you should enable it and initiate a connection to Cayosoft Administrator Service. Please see these articles:
Enumerating Cayosoft Automation Rules
Example 1: Enumerate Cayosoft Administrator rules
This command enumerates Cayosoft Administrator rules: call Get-CGraph command with object type rules as a parameter.
Note: By default, only the first 100 rules are displayed. To get all the rules, use -all flag.
Updating Cayosoft Automation Rules
Example 1: Execute a Cayosoft automation rule by rule name
Set-CGraph rules -Name "RuleName"
Note: Rule name must be unique otherwise you will get the error. It is recommended to run the rule by ID.
Example 2: Execute a Cayosoft automation rule by rule ID
Set-CGraph rules -Identifier "GUID"
Note: To get the rule Id:
- Switch to Design mode
- On Query tab find Rule ID setting
- Copy Rule ID value
Example 3: Execute a Cayosoft runbook by runbook name
Set-CGraph rules -Name "<runbook name>"
Example 4: Execute a Cayosoft runbook by runbook ID
Set-CGraph rules -Identifier <runbook ID>