This guide describes how to install the OpsRamp Agent on windows using Agent MSI file.

  • Step 1: Install the Microsoft Windows OS Integration
  • Step 2: Choose connection type (Direct or Proxy) and download the MSI file:
  • Step 3: Install the Agent using command line arguments

Permissions

Following are the required permissions to install the integration.

CategoryPermission TypePermission Value
Account AdministrationDevicesCreate
CollectorsManage Management ProfileView

Refer to the Permission Sets document for more details on obtaining the necessary permissions.

Download the Agent MSI File

  1. To select your client, navigate to All Clients, and click the Client/Partner dropdown menu.
    Note: You may either type your client’s name in the search bar or select your client from the list.
  2. Navigate to Setup > Account. The Account Details screen is displayed.
  3. Click Integrations. The Installed Integrations screen is displayed with all the installed applications.
    Note: If you do not have any installed applications, you will be navigated to the Available Integrations page with all the available applications.
  4. Click + ADD on the Installed Integrations page. It will redirect to the Available Integrations page.
  5. Search for the integration (Microsoft Windows OS) either by entering the name of the integration in the search bar or by selecting the category (Servers and VMs) from the All Categories dropdown list.
  6. Click ADD on the Microsoft Windows OS tile. The Install Windows Agent page appears.
  7. Select your agent connection type and platform to download and install agent on the machines you want to manage. Note: Do not modify the file name of the Agent installer during the installation. Agent installs in silent mode and does not require a reboot.
    • If you selected Agent Type as Direct, then
      • Click on Windows Agent MSI widget and then click Download Windows Agent MSI button to download the MSI file or copy SHA-256 checksum.
      • You can refer the instruction page to see the downloadable steps (optional).
    • If you selected Agent Type as Proxy, then
      • From the Primary proxy profile section, select the primary proxy profile.
      • To include the secondary proxy profile, enable the “Add Secondary Proxy” checkbox. (Optional)
      • Once enabled, select the secondary proxy profile from the dropdown list.
      • Now, click on Windows Agent MSI widget and then click Download Windows Agent MSI button to download the MSI file.
      • You can refer the instruction page to see the downloadable steps (optional).
        Note: Make sure that you verify the SHA-256 checksum of the downloaded file.
  8. The file is downloaded and saved in your local system.

Install the Agent using MSI File

  1. Navigate to the downloaded MSI file.
  2. Open the command prompt with administrator privileges.
  3. Using the authentication credentials from the Instructions page, run the following command to install the agent:
    • Enable all features
          msiexec.exe /i {.msi file path in quotes} /quiet WRAPPED_ARGUMENTS="/silent /apiserver={apiserver} /key={key} /secret={secret} /clientid={clientid} /installedappid={installedappid} /logmonitorable=true"
          
    • Enable all features with proxy
          msiexec.exe /i {.msi file path in quotes} /quiet WRAPPED_ARGUMENTS="/silent /apiserver={apiserver} /key={key} /secret={secret} /clientid={clientid} /installedappid={installedappid} /proxyip=proxyIP /proxyport=proxyport  /gatewayprofileuuid={profile_UUID_of_the_gate} /logmonitorable=true"
          
    • Specific features
          msiexec.exe /i {.msi file path in quotes} /quiet WRAPPED_ARGUMENTS="/silent /apiserver={apiserver} /key={key} /secret={secret} /clientid={clientid} /installedappid={installedappid} /features=agent:RemoteConsole,agent:RemoteCommand /logmonitorable=true"
          
    • Only core agent functionality
          msiexec.exe /i {.msi file path in quotes} /quiet WRAPPED_ARGUMENTS="/silent /apiserver={apiserver} /key={key} /secret={secret} /clientid={clientid} /installedappid={installedappid} /features=agent:Core /logmonitorable=true"
          
    • Install agent in custom path
          msiexec.exe /i {.msi file path in quotes} /quiet WRAPPED_ARGUMENTS="/silent /apiserver={apiserver} /key={key} /secret={secret} /clientid={clientid} /installedappid={installedappid} /features=agent:Core /logmonitorable=true /custominstallationpath={custominstallationpath}"
          

      Note: Provide your preferred path for /custominstallationpath parameter. If the preferred installation folder is not found, the installation process of the agent will stop and the agent will not be installed.

    • Install with default user(Non System Account)
          msiexec.exe /i {.msi file path in quotes} /quiet WRAPPED_ARGUMENTS="/silent /apiserver={apiserver} /key={key} /secret={secret} /clientid={clientid} /installedappid={installedappid} /features=agent:Core /logmonitorable=true /isnonadmin=YES"
          
    • Install with custom user
          msiexec.exe /i {.msi file path in quotes} /quiet WRAPPED_ARGUMENTS="/silent /apiserver={apiserver} /key={key} /secret={secret} /clientid={clientid} /installedappid={installedappid} /features=agent:Core /logmonitorable=true /isnonadmin=YES /domain={Domain Name} /username={user name} /password={user password}"
          

The server appears on the OpsRamp Infrastructure page within a few seconds.