Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

Configure Bring Your Own Ingest (BYOI) Custom Plug-ins

 

In custom ingest plug-ins, you must configure key-value pairs in the GUI. You must also write new rules and playbooks for custom ingest plug-ins.

To configure the custom ingest plug-in:

  1. Go to Configuration > Ingest > BYOI Plugins.
  2. Click +New Instance in the Custom tab.

    The Add a Custom Plugin Page appears.

  3. Enter the details as described in Table 1.

    Table 1: Attributes in Add a Custom Plugin Page

    Attributes

    Description

    Name

    Enter the name that identifies the custom ingest plug-in in Paragon Insights.

    Plugin Name

    Enter the name given to the input ingest plug-in.

    Service Name

    Enter a name for the service.

    Service name can be same as the Name of the custom ingest plug-in in Paragon Insights.

    Key

    Name of key parameters in the ingest plug-in. For example, sensor or frequency.

    You can add one or more ingest parameters as a key.

    Value

    Enter the value for the key parameter.

    For example, you must enter a sensor path as value if sensor is your key.

    Authentication

    SASL Username

    Enter the plain text username for authentication.

    Password

    Enter a password.

    Passwords must be 6 to 128 characters long. Your password must include uppercase and lowercase. It can also contain numbers and special characters.

    TLS

    CA Profile Name

    Enter the name of the trusted certificate authority.

    Local Certification Profile Name

    Enter the name of the self-signed certificate you created for Paragon Insights.

    Skip Certification Chain and Local Verification

    Enable this option if you want to skip verifying the integrity of the CA certificate.

    Connection between the input ingest plug-in and the external data source is encrypted even if you skip verification of the certificate.

  4. Do one of the following:
    • Save — Save your ingest mapping 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 later.

    • Save & Deploy — Save the ingest mapping configuration and deploy the configuration in your production environment.

After you configure a custom plug-in, you must create a new rule with the BYOI ingest parameters. To collect data using the custom ingest plug-in, this rule must be added to a new playbook and a playbook instance must be running on device or network groups. For more information see Paragon Insights Rules and Playbooks.