How to register the Merge1 Agent

Description

Follow these instructions to register the Merge1 Agent during a new installation of Merge1 version 7 or higher, or when upgrading from v6 to v7. 

Ensure the following prerequisites are installed:

• .NET Framework 4.8.  This can be verified by running the following PowerShell script:
  • Get-ItemProperty "HKLM:\SOFTWARE\Microsoft\NET Framework Setup\NDP\v4\Full"
• .NET 6.0 Runtime, ASP.NET Core 6.0 Runtime
• Later versions require .NET 8.0 Runtime, ASP.NET Core 8.0 Runtime
• Microsoft Visual C++ 2017 Redistributable 64bit installed on the machine.

Install the Agent, which comes with the installation package, then run the following: 

C:\Program Files\Veritas Technologies LLC\Merge1 Agent\agentConfiguratorGUI.exe

More information is found in the User Guide.

• Merge1 URL:
  • This value can be found in the UserSettings.config file located in the installation directory.
     
• Client Id:
  • This is the application ID created and copied from the Merge1 UI (portal).
    • Open Merge1 and go to the API Clients section.
    • Click on 'Add Application' and enter a name for the application (any name can be provided).
    • Ensure to check the 'Agent Manager Role' checkbox.
    • The API CLIENT will appear, and under the Name and Role, find the Application ID. 
    • Copy this ID and use it in the script instead of 'app_id'.
       
• Secret:
  • This value is created from the API Clients section in Merge1.
    • Open Merge1 and go to the API Clients section.
    • Select Go to Secrets button next to the Application ID from the client application created in the above section.
    • On the next screen select NEW SECRET”
    • A pop-up window called Add Client Secret will appear.
    • Fill out the Description field. 
    • For the Expiration field, expand it and select Custom Set the Expiration Date to a future year, such as 2099 .
    • Click the ADD button.
    • Copy the Client secret and use it in the script instead of “client_secret”
    • Please note that the Client secret in the Merge1 User Interface is only visible once. If you refresh the page, it will no longer be visible. We recommend saving this value somewhere secure.

• Default Agent Pool: This is a friendly name that will be displayed Merge1 UI, and does not need to be changed.
• Agent Name: This is a friendly name that will be displayed in Services.msc, and does not need to be changed.
• Service Username:
  • To register the Agent, a service account that has specific permissions is needed. The customer should also use the Fully Qualified Domain Name (FQDN) in the script for this value.
  • The service account needs to have the following permissions:
    • Log on as a service.
    • Log on as a batch job.
    • Local admin.
• Service Password: Use the Service Account’s password in the script.
• No SSL Verify - Enable the checkbox to skip SSL validation both for the configurator and the Agent. Otherwise, keep it disabled. 

Click Run to perform the operation.