Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

Create a Playbook Using the Paragon Insights GUI

Paragon Insights operates on playbooks, which are a collection of rules for solving a specific customer use case. For example, the system-kpi-playbook monitors the health of system parameters such as the system-cpu-load-average, storage, system-memory, process-memory, and so on. The playbook also notifies the operator or takes corrective action in case any of the KPIs cross pre-set thresholds. Any single rule can be a part of 0, 1, or more playbooks. The playbook is the element that gets deployed on device groups. Rules that you do not include in any playbook are not deployed to any device.

Note:

Click the Name, Running, Paused, or Synopsis column headers in the Playbooks table to organize the data in ascending or descending order.

The icmp-outlier playbook earlier required that you enter the round trip time (RTT) XPath for each device (using device id). Starting with Release 21.3, Paragon Automation supports splat operator in ICMP outlier detection playbook. You can enter the splat operator (*) in regular expression format in the playbook so that, the rules are applied to all devices in the device group.

For example:

/device-group[device-group-name=core]/device[device-id=~/.*/]]/topic[topic-name=protocol.icmp]/rule[rule-name=check-icmp-statistics]/rtt-average-ms
Note:

If you delete or add a device in a device group on which an ICMP outlier playbook instance runs, you must pause the playbook instance, modify the XPath configuration to reflect the addition or deletion of devices, and re-apply the playbook instance for the device group.

To create a playbook using the Paragon Insights GUI:

  1. Click the Configuration>Playbooks icon in the left navigation bar.
  2. Click the create playbook button (+ Create Playbook).

    A new window appears with 4 fields: Name, Synopsis, Description, and Rules. We describe the use of each field in the following steps.

  3. Enter a name for the playbook in the Name field.
  4. Enter a short description for the playbook in the Synopsis field.

    This text appears in the Synopsis column of the table on the Playbooks page.

  5. (Optional) Enter a description of each rule added in this playbook in the Description field.

    This text can only be seen if you click on the playbook name on the Playbooks page.

  6. From the rules list, select the rules that make up this playbook.
  7. Select one of the following options:

    Save

    Save and add the playbook but do not deploy the updated configuration. You can use this option when, for example, you are making several changes and want to deploy all your updates at the same time.

    Save & Deploy

    Immediately deploy the configuration and save and add the playbook.

Related Documentation