Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

Use Sample Rule and Playbook Configurations for BYOI Custom Plug-in Instances

Before you configure a custom rule, playbook, and device group for the Bring Your Own Ingest (BYOI) custom plug-in, you must create an instance of the custom plug-in. See Configure Bring Your Own Ingest Custom Plug-in Instances for more information.

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.

  1. Select Configuration>Rules in the Paragon Automation GUI.
    The Rules page appears.
  2. 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.
  3. Type configure to enter the configuration mode.
    You can see a message that confirms that you are in configuration mode.
  4. 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.

    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.

  5. Type commit.
    You can see a message that confirms that the commit is complete.
  6. 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.
  7. Type commit.
    You can see a message that confirms that the commit is complete.
  8. Type exit to exit the configuration mode.
  9. 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).