Prerequisites

OS VersionSystem Requirements
Windows 7 and above and
Windows 2012 Server and above
  • 1 GHz CPU or greater
  • 2 GB RAM
  • 200 MB available disk space
  • One Network Interface Card (NIC)

Make sure to verify the SHA-256 checksum of the downloaded file.

A Windows direct agent can be converted to a proxy agent and, conversely, a proxy agent can be converted to a direct agent.

Deploy the agent using an EXE file

  1. From All Clients, select a client.

  2. Navigate to Setup > Downloads > Agent.

  3. From the Windows Agent EXE tile, review the Agent Download Instructions, which are repeated here.

  4. To install the file on your local system, click Installer and follow the download instructions.

  5. To email a link to the installation file for deploying the agent on another system, click Email Download URL.

    Enter the destination email address and click Send. The download link expires in 24 hours.

    At the remote location, use the email link to download the agent within 24 hours and follow the download instructions.

    For security reasons, the following email restrictions apply:

    • A client can send an email to a maximum of 10 destination email addresses at one time, with each address comma-separated. More than 10 destination addresses are not permitted. Start a new email to send to additional destinations.
    • A client can send a maximum of two emails per day to the same destination email address. Additional emails to the same address within a 24-hour interval are not permitted.
  6. Open the downloaded agent .exe file to begin the installation.

Deploy the agent using an MSI file

Get authentication credentials and download the MSI installation file

  1. Log in using your Partner/Client credentials.
  2. Navigate to Setup > Downloads > Agent.
  3. In the Windows Agent MSI tile, click Instructions. Follow the instructions or continue with these instructions.
  4. Your authentication credentials are populated in the Syntax for command line argument example. Copy the values for the apiserver, key, and secret arguments.
  5. In the Windows Agent MSI tile, click Download and follow the download instructions.

You can use the command line or user interface to configure the MSI file for agent installation.

Configure the MSI file using the command line

  1. Open the command window with administrator privileges.

  2. Using the authentication credentials from the Instructions, run the following command to install the agent with core functionality and all features enabled. See the following command examples for other installation options:

        msiexec.exe **/i** ".msi file path" /quiet WRAPPED_ARGUMENTS="/silent /apiserver={apiserver} /key={key} /secret={secret}"
        

    To connect using a proxy, without credentials:

        msiexec.exe **/i** ".msi file path" /quiet WRAPPED_ARGUMENTS="/silent /apiserver=apiserver /key=key /secret=Secret /proxyip=proxyIP /proxyport=proxyport"
        

    To connect using a proxy, using credentials:

        msiexec.exe /i ".msi file path" /quiet WRAPPED_ARGUMENTS="/silent /apiserver=apiserver /key=key /secret=Secret /proxyip=proxyIP /proxyport=proxyport /proto=http/https /proxyusername=<proxy_server_username> /proxypassword=<proxy_server_b64encoding_password>"
        

    Specify the features you want to enable if you do not want all features enabled by default. Supported feature command line arguments, comma-separated, include:

    • agent:RemoteConsole
    • agent:RemoteCommand
    • agent:PatchManagement
    • agent:Automation

    The following command line example uses the feature argument to enable all features:

        /features=agent:RemoteConsole,agent:RemoteCommand,agent:PatchManagement,agent:Automation
        

    The following example installs the agent with RemoteConsole and RemoteCommand features, only:

        /features=agent:RemoteConsole,agent:RemoteCommand
        
  3. Optionally, reboot the system.

Configure the MSI file using the user interface

  1. Open the downloaded MSI file to start the MSI installation wizard.

  2. Enter the following parameters in the fields provided:

    ParameterRequiredDescription
    API Server NameyesClick **Instrutions** in the **Windows Agent MSI** tile and copy the pre-populated apiserver argument value.
    Client KeyyesClick **Instrutions** in the **Windows Agent MSI** tile and copy the pre-populated key argument value.
    Client SecretyesClick **Instrutions** in the **Windows Agent MSI** tile and copy the pre-populated secret argument value.
    Proxy PortnoProxy port number.
    Proxy IPnoProxy IP address.
    FeaturesnoIf no features are entered, all agent features are enabled:
    • agent:RemoteConsole
    • agent:RemoteCommand
    • agent:PatchManagement
    • agent:Automation
    To enable specific features only, enter those features, separated by commas.
  3. Click Install.

Deploy an agent on multiple servers with group policy

The following steps invoke Group Policy to install the agent on selected servers after a reboot.

Download the Windows Agent MSI installer to deploy the agent using Active Directory Group Policy.

  1. From All Clients, select a client.
  2. Navigate to Setup > Downloads > Agent.
  3. In the Windows Agent MSI tile, click Download. Follow the download instructions.
  4. Log into the server domain controller and copy the downloaded MSI file to the NETLOGON folder.
  5. Click the Start button
  6. Click Run, and enter the active directory domain name: \\{yourdomain.com}\NETLOGON.
  7. Open the Group Policy Management console.
  8. Click the Start button.
  9. Click Run, and enter gpmc.msc.
  10. To create a new Group Policy object, right-click Group policy object.
  11. Select New, and enter a group name.
  12. Right-click Group Policy Object OpsRamp Installation and click Edit.
  13. Expand Policies and click Software Setting.
  14. Right-click Software Installation > New > Package and enter the location the downloaded .msi file. File Name: \yourdomain.com\NETLOGON.
  15. Select OpsRamp Agent File and click Open.
  16. Select Assigned and click OK. On Active Directory Users and Computers, create a Security Group.
  17. Click the Start button.
  18. Xlick Run, and enter dsa.msc.
  19. Right-click Users > New > Group1.
  20. Enter a group name.
  21. Right-click the Group > Properties > Members Tab, and click Add.
  22. Click Object Types > Select Computers.
  23. Add all of the servers on which you want to install the agent.
  24. Click Apply, followed by OK.
  25. In the Open Group Policy Management console, click the Start button
  26. Click Run and enter gpmc.msc.
  27. Select the Group Policy object created initially: OpsRamp Agent Installation.
  28. Select and remove the default Authentication Users.
  29. Click Add and Search for the previously created OpsRampAgentDeploy security group and click OK.
  30. Right-click Domain and select Link an Existing Group Policy Object.
  31. Select OpsRamp Agent Installation and click OK.

Deploy an agent on multiple servers using the Windows agent deployment tool

Make sure to:

  • ensure that all the servers are accessible from a jump server.

  • ensure that the agent installation file is downloaded and saved on a jump server.

    A jump server refers to the main server that serves as the launchpad for installing the agent on multiple servers.

  • ensure that the same set of credentials are configured on all devices where the agent is to be installed.

To configure the Windows agent deployment tool:

  1. Navigate to Setup > Downloads > Agent.
  2. In the Windows Agent Deployment Tool section, click Download and follow the download instructions.
  3. Copy the downloaded deployment tool to the jump server.
  4. Run the Windows Agent Deployment Tool file and enter the Input Discovery IPs information.
  5. Click Next.
  6. From the list of Available Devices, select the devices where you want to install the agent
  7. In Selected Devices, click Browse Agent Installer.
  8. Select the downloaded agent file and click Next.
  9. Click Install.

Uninstall the agent

This describes how to uninstall an agent on single or multiple servers, with the option to manage or un-manage the server.

Uninstall the agent on a single server and manage the server

Use the device control panel to uninstall the agent.

Uninstall the agent on multiple servers and manage the server

Use Active Directory Group Policy to uninstall the agent.

Uninstall the agent and un-manage the server

  1. Navigate to the Infrastructure page
  2. From the list of devices, select the device where you want to uninstall the agent.
  3. Click Unmanage Devices.
  4. Click OK.

The agent is uninstalled and the device is visible in the unmanaged tab.