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 Custom Plug-in Instances

For custom ingest plug-ins, you must configure key-value pairs in the Paragon Automation GUI.

To configure a custom ingest plug-in instance:

  1. Click Configurations > Data Ingest > Settings > BYO Ingest Plugins.
    The Bring Your Own Ingest Plugin page appears.
  2. Click the add icon (+) in the Custom tab.
    The Create Custom Plugins page appears.
  3. Enter the details as described in Table 1.
  4. Do one of the following:
    1. 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. See Commit or Roll Back Configuration Changes in Paragon Insights for more information.
    2. Save & Deploy—Save the custom plugin instance configuration and deploy the configuration in Paragon Automation.

Fields marked with an asterisk (*) are mandatory.

Table 1: Fields on the Create Custom Plugins Page
Fields Description
Name Enter the name of the custom ingest plug-in instance.
Plugin Name Enter the name given to the input ingest plugin that you created.
Service Name

Enter a name for the service.

The service name can be the same as the name of the custom plug-in.
Key

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

You can add one or more ingest parameters as a key using the + icon.
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 username for authentication.
Password

Enter a password.

The password must be 6 to 128 characters long and must contain a combination of uppercase and lowercase characters. It must also contain numbers and special characters.
TLS
CA Profile Name Enter the name of the trusted certificate authority (CA).
Local Certification Profile Name Enter the name of the self-signed certificate you created for Paragon Automation.
Skip Certification Chain and Host Verification

Toggle the switch on if you want to skip verifying the integrity of the CA certificate.

Note:

The connection between the ingest plug-in and the external data source is encrypted, even if you skip verification of the certificate.
After you configure a custom plug-in instance, you must create a rule with the BYOI ingest parameters. To collect data using the custom ingest plug-in, you must add this rule to a new playbook and run the playbook's instance on device groups or network groups.

Related Documentation