Skip to main content

Add-On Parameters

To configure the add-on parameters, you need to edit the settings.xml file in the add-on folder. You must define connection details: Auditor Server host, user credentials, etc.

Most parameters are optional; the service uses the default values unless you explicitly define them (<parameter>\*\*\_value_\*\*</parameter>). You can skip or define parameters depending on your execution scenario and security policies.

ParameterDefault valueDescription
NetwrixIntegration
NetwrixAuditorEndpointhttps://localhost: 9699/netwrix/api/ v1/activity_recordsAuditor Server IP address and port number followed by endpoint for posting Activity Records. Assumes that the add-on runs on the computer hosting Auditor Server and uses default port 9699. If you want to run the add-on on another machine, provide a name of the computer where Auditor Server resides (e.g., 172.28.6.15, EnterpriseNAServer, WKS.enterprise.local). To specify a non-default port, provide a server name followed by the port number (e.g., WKS.enterprise.local:9999). Don't modify the endpoint part (/netwrix/api . . . . )
NetwrixAuditor CertificateThumbprintNOCHECKAuditor Certificate Thumbprint Property. Possible values: - AB:BB:CC.—Check Auditor server certificate thumbprint identifier. - NOCHECK—Don't check Auditor certificate. ensure to select this parameter if you plan to specify servers by their IP.
NetwrixAuditorDateTimeFormatyyyy-MM-ddTHH:mm:ssZAuditor time format. By default, set to zero offset.
NetwrixAuditorPlan—By default, the add-on writes data to the Netwrix_Auditor_API database and doesn't associate it with a specific monitoring plan. Specify a name of associated monitoring plan in Auditor. In this case, the add-on writes data to a database linked to that plan. If you select a plan name in the add-on, create a dedicated plan in Auditor, add the Netwrix API data source to the plan, and enable the data source for monitoring. Otherwise, the add-on can't write data to the Audit Database.
NetwrixAuditorPlanItem—By default, the add-on doesn't associate data with a specific plan, so you can't filter it by item name. Specify an item name. ensure to create a dedicated item in Auditor in advance.
NetwrixAuditorUserNameCurrent user credentialsBy default, the add-on runs with the current user credentials. If you want the add-on to use another account to connect to Auditor Server, specify the account name in the DOMAIN\username format. The account must be assigned the Contributor role in Netwrix Auditor.
NetwrixAuditorUserPasswordCurrent user credentialsBy default, the add-on runs with the current user credentials. Provide a different password if necessary.
DataCollection
DataCollectionServer(empty)Specify SCVMM server to collect data from. You can use IP address, FQDN, or NETBIOS name. For localhost, leave this parameter empty.
DataCollectionUserName(empty)Specify user account that will be used for data collection from SCVMM server. To use the account logged in, leave this parameter empty. ensure the account has administrative rights on that server (see the Accounts and Rights topic for additional information).
DataCollectionPasswordSpecify user account password.
ShortTermFolderShortTermSpecify path to the short-term archive (Netwrix Auditor working folder). You can use full or relative path.

Remember to save settings.xml after editing is complete.