Deploying Agents on Windows

Provides instructions on deploying agents on Windows.

Leave Feedback

Prerequisites

System Requirements
OS VersionSystem Requirements
Windows 7 and above
Windows 2012 Server and above
  • Processor: 1 GHz CPU or greater
  • Memory: 2 GB RAM
  • Disk Space: 200 MB
  • Network Interface Card: One

Installing on a single server

To download an agent onto a server, from the console:

  1. From All Clients, select the client.
  2. Go to Setup > Downloads > Agent.
  3. From the Windows Agent EXE section:
    1. Review the Instructions information.
    2. Select either Installer or Email Download URL.

Click the downloaded Agent .exe file to install on the resource. The silent installation completes in a quick time and you can view installed Agent from

Deploying agents using the MSI file

For deploying agents, you can use the Windows Agent MSI.

Prerequisites

  • Be sure to log into OpsRamp with Partner/Client credentials.
  • Obtain the OpsRamp Key and Secret details.

Step 1: Download the MSI file from OpsRamp

To download MSI file:

  1. From All Clients, select a client.
  2. Go to Setup > Downloads > Agent.
  3. From the Windows Agent MSI section:
    1. Review the Instructions information.
    2. Click Download.

The installer file is now downloaded onto your system.

Step 2: Configure the MSI file

You can configure the MSI file either directly from the UI or by using the command line.

Configuring through user interface

To perform MSI configuration through the user interface:

  1. Once the Windows Agent MSI in downloaded, open the installed MSI file to start the wizard.
  2. Provide the following details and click Install.
    • API Server Name: (Mandatory) See Windows Agent MSI > Instructions: apiserver
    • Client Key: (Mandatory) See Windows Agent MSI > Instructions: key
    • Client Secret: (Mandatory) See Windows Agent MSI > Instructions: secret
    • Proxy Port: Optional
    • Proxy IP: Optional
    • Features: If no value is provided, all MSI features are enabled. Alternatively, you can also provide the following to install all the features. agent:RemoteConsole,agent:RemoteCommand,agent:PatchManagement,agent:Automation

To install a specific feature provide features list separated by commas:

  • Example 1:
    Provide the following features list to enable RemoteConsole and RemoteCommand features only:
    agent:RemoteConsole,agent:RemoteCommand
    
  • Example 2:
    To install only core functionality (Other than - RemoteConsole, RemoteCommand, PatchManagement, Automation) provide the following features list: agent:Core
  • In all the cases, the basic functionality and monitoring (if applied) are always enabled. With features list, you can only enable or disable only specific MSI features.

Configuring via the command line

To configure the MSI using command-line arguments.

  1. Open the command prompt as Administrator.
  2. Provide the following syntax:
    msiexec.exe **/i** ".msi file path" /quiet **WRAPPED_ARGUMENTS**="/silent /apiserver=apiserver /key=key /secret=Secret"
    
  3. (Optional) To connect through a proxy, use one of the following options:
    • append the following proxy information:
    msiexec.exe **/i** ".msi file path" /quiet **WRAPPED_ARGUMENTS**="/silent /apiserver=apiserver /key=key /secret=Secret /proxyip=proxyIP /proxyport=proxyport"
    
    • append the following proxy information 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>"
    
  4. Append the following MSI features switch (separated by commas).
    • agent:RemoteConsole
    • agent:RemoteCommand
    • agent:PatchManagement
    • agent:Automation
    /features=agent:RemoteConsole,agent:RemoteCommand,agent:PatchManagement,agent:Automation
    
  5. (Optional) Reboot the system.

Installation notes

To install a specific feature, append features switch list separated by commas:

  • Example 1: Enable the RemoteConsole and RemoteCommand features only.
    msiexec.exe **/i** ".msi file path"/quiet **WRAPPED_ARGUMENTS**="/silent /apiserver=apiserver /key=key /secret=secret /features=agent:RemoteConsole,agent:RemoteCommand"
    
  • Example 2: Install only core functionality (other than - RemoteConsole, RemoteCommand, PatchManagement, Automation), append the following features switch:
    msiexec.exe **/i** ".msi file path" /quiet **WRAPPED_ARGUMENTS**="/silent /apiserver=apiserver` `/key=key /secret=Secret /features=agent:Core"
    
  • Sample Example: MSI file path The following sample includes an MSI file path.
    msiexec.exe /i "C:\Users\Administrator\Downloads\OpsRampAgent.msi" /quiet WRAPPED_ARGUMENTS="/silent /apiserver=apiserverURL /key=key /secret=secret"
    

Obtain the OpsRamp key and secret

To get the OpsRamp Key and Secret:

  1. Go to Setup > Downloads and click Agent.
  2. From the Agent screen, go to Windows Agent MSI on the displayed download options.
  3. Click Instructions.
  4. From the Instructions page, copy API Server Name, Key and Secret.

Deploying Agent on multiple servers with group policy

The Active Directory (AD) Group Policy is used to deploy agents onto multiple servers. Deployment is accomplished by downloading Windows Agent MSI and deploying the agent through Active Directory Group Policy.

To download the Windows Agent MSI:

  1. From All Clients, select the client.
  2. Go to Setup > Downloads > Agent.
  3. Select Windows Agent MSI > Installer to download.
  4. Deploy the Windows Agent MSI file through Active Directory Group Policy to install Agents on specified servers and desktops.

To deploy the agent through Active Directory group policy:

  1. Log into server Domain Controller and copy the OpsRamp Agent MSI file to the NETLOGON folder.
  2. Click Start button, click Run, and enter \\yourdomain.com\NETLOGON
    Note: Replace yourdomain.com with the active directory domain name.
  3. Open Group Policy Management console.
  4. Click Start button, then click Run, and enter gpmc.msc.
  5. Create a new Group Policy object. Right-click on Group policy object, select New, and provide a name. Example: OpsRamp Installation.
  6. Right-click on Group Policy Object OpsRamp Installation and click Edit.
  7. Expand Policies and click Software Setting.
  8. Right-click on Software Installation> New> Package and provide location of OpsRamp .MSI file. File Name: \yourdomain.com\NETLOGON.
  9. Select OpsRamp Agent File and click Open,
  10. Select Assigned and click OK.
    On the Active Directory Users and Computers, create a Security Group.
  11. Click Start button, click Run, and enter dsa.msc.
  12. Right-click on Users, click New, and click Group1.
    Provide a name to the Group Example: OpsRampAgentDeployment.
  13. Right-click on Group, click Properties, Members Tab, and then click Add.
  14. Click Object Types and Select Computers.
  15. Add all the servers on which Agent needs to be installed. 
  16. When all the devices are added, click Apply and OK.
  17. Open Group Policy Management console.
  18. Click Start button, click Run, and enter gpmc.msc.
  19. Select Group Policy object that was created initially. (OpsRamp Agent Installation)
  20. Select and Remove Authentication Users that comes by default.
  21. Click Add and Search for the previously created Security Group (OpsRampAgentDeploy) and click OK.
  22. Right-click on Domain and select Link an Existing Group Policy Object.
  23. Select the previously created Group Policy Object (OpsRamp Agent Installation) and click OK. This invokes Group Policy to Install Agent on Selected Servers after every reboot.

Deploy on multiple servers using the Windows agent deployment tool

Windows Agent deployment tool is used deploy the Windows Agent in bulk across Windows servers.

  • Ensure that all the servers are accessible from a Jump server.
  • Ensure that OpsRamp Agent is downloaded and saved on a Jump server. A Jump server refers to the main server that acts as launchpad to install agent on multiple servers.
    Note: OpsRamp recommends to have the same set of credentials for all the devices on which Agent needs to be installed.

To configure the Windows agent deployment tool:

  1. Go to Setup > Downloads > Agent.
  2. Click Download in the Windows Agent Deployment Tool section.
  3. Download and copy the OpsRamp Windows Agent deployment tool to the jump Server.
  4. Open Windows Agent Deployment Tool and provide Input Discovery IPs details and click Next.
  5. From the list of Available Devices, select the devices on which you want to install Agent, and move to Selected Devices.
  6. Click Browse Agent Installer, select the OpsRamp Windows Agent file that is downloaded from OpsRamp, and click Next.
  7. Click Install.

Windows Agent is installed on the selected devices.

Uninstalling agents

You can uninstall an agent with the options to manage or unamanage the server.

Uninstalling agents but manage the Server

  • For Single Server: To uninstall Agent, but manage the server, uninstall Agent from the control panel of the device.
  • For Multiple Servers: To uninstall Agents but manage the servers, use Active Directory Group Policy.

Uninstalling agents and unmanage the server

To uninstall Agent and unmanage the server, follow these steps:

  1. Navigate to the Infrastructure page and from the list of devices, select the devices to uninstall the agent.
  2. Click Unmanage Devices.
  3. Click OK for confirmation. Agent is successfully uninstalled and the device is visible in the unmanaged tab.

External references