Home > Get Started > Configure Scanner Agent

Download this article

Configure the Scanner Agent

To view and manage your file system resources in Insights, you need to install and configure the AvePoint Insights Scanner agent on your server. For details on downloading the AvePoint Insights Scanner agent, refer to Agent Management.

To complete the installation and configuration, refer to the following sections for instructions.

Create Certificate Files

To establish a secure connection between the agent and AvePoint Online Services, the following certificate files are required:

  • CER file: The CER file is used to register the AvePoint API application within AvePoint Online Services. For detailed steps on setting up the file, refer to Prepare a Certificate for the Custom Azure App.

    For steps on registering the AvePoint API application, refer to Register an AvePoint API App.

  • PFX file: The PFX file provides the agent's identity for authenticating to AvePoint Online Services and must be installed on the Windows server where the Insights Scanner agent will run.

    To install the PFX file on the Windows server, complete the following steps:

    1. Open the Certificate Import Wizard and select Local Machine as the store location.

      Select Local Machine

      Click Next.

    2. Select the PFX file to import by clicking Browse. Then, click Next.

      Select PFX file

    3. Enter the Password and select the import options.

      Private key protection

    4. In the Certificate Store step, select Place all certificates in the following store and then select Personal as the store location.

      Personal store

    5. When you click Next, the certificate is imported to the Personal store where you can verify the certificate's status.

      Certificate verification

Register an AvePoint API App

To connect your file system resources to AvePoint Online Services and Insights, you need to register an AvePoint API app in AvePoint Online Services.

Refer to the following table for the permissions required by the app.

ServicePermissionWhy this permission is required
AvePoint Online Serviceshybrid.readwrite.allAllows AvePoint Online Services to retrieve file system resources’ information.
Hybrid Servicehybridserver.common.readwrite.allAllows the AvePoint Online Services to synchronize information from/to Hybrid Agent Management.
Hybrid Servicehybridserver.agent.readwrite.allAllows AvePoint Online Services to retrieve data from Hybrid Agent Management.
Insightsinsights.graph.readwrite.allAllows the management of file system resources in Insights.

Install Insights Scanner Agent

To install Insights Scanner agent, complete the following steps:

  1. Go to AvePoint Online Services > Management > Agent management and click Download agent package.

  2. Click Download and select Download for Insights from the drop-down list.

  3. Find the ZIP file downloaded on your local device, copy the file to your designated Windows server and extract it.

    NOTE

    To install the agent, the HybridAgentEnvironment.config file must remain under the extracted folder.

  4. In the extracted folder, extract the AvePoint_Insights_Scanner_Serial_Number.zip file and find the Setup file.

  5. Run the Setup file as administrator.

  6. In the AvePoint Insights Scanner Installation tool, select a destination folder to install the agent and click Install.

    Installation folder

  7. When the installation completes, click Configure Now to complete the agent configuration to connect it to AvePoint Online Services. Or you can click Finish to exit and complete the configurations later.

Configure AvePoint Insights Scanner Agent

To connect the AvePoint Insights Scanner agent to AvePoint Online Services and Insights, complete the following steps:

  1. On the local device where the AvePoint Insights Scanner agent is installed, find the Nexus.Diag.Sdde.Sentinel.Agent.ConfigurationTool.exe file in the bin folder of the directory where you installed AvePoint Insights Scanner agent.

  2. Double-click the Nexus.Diag.Sdde.Sentinel.Agent.ConfigurationTool.exe file to run the configuration tool.

  3. In Connect to AOS step, complete the following settings:

    Connect to AOS

    • Data center – Select your AvePoint Online Services data center. To check your data center, go to AvePoint Online Services, and click your profile photo on the upper-right corner. Click Organization profile and your data center is displayed.

    • Customer ID – Enter your customer ID. To check your customer ID, go to AvePoint Online Services, and click your profile photo on the upper-right corner. Click Organization profile and your customer ID is displayed in the Tenant ID field.

    • AvePoint Online Services application(client) ID – Enter the client ID of your registered app.

      Your application (client) ID can be found in AvePoint Online Services > Administration > App registration.

      Find your application ID

    • Certificate thumbprint – Enter the certificate thumbprint you used for the app registration.

      The certificate thumbprint can be found either in AvePoint Online Services > Administration > App registration or in the Local Computer store.

      Find your thumbprint

      NOTE

      The certificate must be installed on the device that has AvePoint Insights Scanner agent installed.

    Click Next to proceed.

  4. In the Access Account step, enter the user name and password of the account that has the Read permission to the file system source path containing the objects you want to manage in Insights.

  5. Click Submit to save your configurations.