You must write your own rules for BYOI custom plug-ins. You must deploy a custom rule in a
new playbook that you create for the BYOI plug-in ingest. You must also create a device
group that you add later in the BYOI playbook. Enter the rule and playbook configurations in
Paragon Automation management CLI.
The following steps provide the rule and playbook configurations that you enter in the Rule
Builder CLI in Paragon Insights.
-
Select Configuration>Rules in the Paragon Automation GUI.
The Rules page appears.
-
Click the Rule Builder CLI to open the management CLI.
The Rule Builder CLI terminal appears with the user@host configuration prompt. User
denotes a root or a non-root user.
-
Type
configure to enter the configuration mode.
You can see a message that confirms that you are in configuration mode.
-
Enter the following command to configure a new rule for the BYOI custom plug-in.
The following sample rule triggers an alert when the value of key is
greater than 5. The trigger alert frequency is set to 10 seconds.
set healthbot topic external rule r1 sensor sensor_a byoi plugin name example-plug-in
set healthbot topic external rule r1 field key sensor sensor_a path key
set healthbot topic external rule r1 field key type integer
set healthbot topic external rule r1 trigger trigger_789 frequency 10s
set healthbot topic external rule r1 trigger trigger_789 term Term_1 when greater-than "$key" 5
set healthbot topic external rule r1 trigger trigger_789 term Term_1 then status color red
set healthbot topic external rule r1 trigger trigger_789 term Term_1 then status message BAD
set healthbot topic external rule r1 trigger trigger_789 disable-alarm-deduplication
Note:
-
The example-plug-in in the sample rule refers to the plug-in
name you entered in the Name field, when creating an
instance of the custom plug-in.
-
The sensor_a in the sample rule refers to the value configured
for the key parameter in the Value field, when creating an
instance of the custom plug-in.
-
Type
commit.
You can see a message that confirms that the commit is complete.
-
Enter the following command to configure a new playbook.
Use the following sample command to create a playbook p1 for the ingest that uses the
sample rule r1 that you previously
created.
set healthbot playbook p1 rules external/r1
-
Type
commit.
You can see a message that confirms that the commit is complete.
-
Type
exit to exit the configuration mode.
-
In the operational mode, type
request healthbot deploy to deploy the
configuration.
The rules list on the Rules page refreshes automatically and shows the new rule you
deployed. To see the new playbook, see the Playbooks page using the
Configuration>Playbooks menu.
After you deploy the playbook, you can monitor the health of the BYOI ingest in the Network
Health page (Monitoring>Network Health).
