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

Use Add-Ons

Before your start working with the add-on, go through its quick-start guide at Netwrix Documentation page. Each guide contains detailed instructions for deploying and running the add-on, as well as prerequisites and configuration settings. Generic steps are described below.

To use the add-on

  1. Check prerequisites. Since the add-ons work only in combination with Netwrix Auditor, make sure that Netwrix Auidtor and its Audit Database are configured, and roles are assigned properly.
  2. Specify parameters required for add-on operation. Before running or scheduling the add-on, you should define configuration details like Netwrix Auditor Server host, user credentials, etc.
  3. Choose appropriate deployment scenario, then install and start the add-on. For example, if the add-on is implemented as a service, you will need to run the installation file that will deploy and start that service automatically.
  4. If you are using a PowerShell-based add-on, run it 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. If necessary, modify the parameters as required.

  5. Review the add-on operation results. For example, if you are using the add-on that imports data to Netwrix Auditor, you can search Activity Records in the Netwrix Auditor client.

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

Go Up