Go Up
You are here: Integration APIAdd-OnsUse Add-Ons

Use Add-Ons

To use the add-on

  1. Check prerequisites. Since the add-ons work only in combination with Netwrix Auditor, make sure the product and its Audit Database are configured, roles are assigned in the product. Some add-ons may require additional components to be installed in your system or options configured.
  2. Define parameters. Before running or scheduling the add-on, you must define connection details: Netwrix Auditor Server host, user credentials, etc. You can skip or define parameters depending on your add-on, execution scenario, and security policies.
  3. Choose appropriate execution scenario. Select where and who is going to execute the add-on.
  4. Run the PowerShell-based add-on from a command line. Start Windows PowerShell and provide parameters. First provide a path to your add-on followed by script parameters with their values. Each parameter is preceded with a dash; a space separates a parameter name from its value. You can skip some parameters—the script uses a default value unless a parameter is explicitly defined.

    For add-ons implemented as a service, run the installation file that will deploy and start the service.

  5. Review the results. For add-ons that import data to the Audit Database, search Activity Records in the Netwrix Auditor client. For example:

  6. For PowerShell-based add-ons, schedule a daily task to ensure your audit data is always up-to-date.

Netwrix creates quick-start guides to help you incorporate add-ons in your daily routine. Each guide contains detailed instructions for running the add-on.

Go Up