This describes how to use the shell-based deployment script to install an agent. This is intended to supercede the legacy Python script deployment option, which can have Python package dependencies incompatible with your environment.

Check for supported operating systems.

Additional prerequisites

  • cURL or Wget should be available on the server.
  • The host machine should have access to the OpsRamp API server to download the installer.

The following subsections describe the available installation and uninstall options.

Install a root user agent

  1. From All Clients choose a client.

  2. Go to Setup > Download > Agent.

  3. In the Linux Agent Script tile, choose Shell Script.

  4. Download and save the deployAgent.sh script.

  5. Install the agent, enabling the features you want:

    • All features:

            sh deployAgent.sh
            
    • Specific features:

            sh deployAgent.sh -f "agent:RemoteCommand,agent:PatchManagement,agent:Automation,agent:RemoteConsole"
            

    Within a few seconds, the the Infrastructure page displays the installed server.

Install a default non-root user agent

The default, non-root agent installation automatically creates the default user.

  1. From All Clients choose a client.

  2. Go to Setup > Download > Agent.

  3. In the Linux Agent Script tile, choose Shell Script.

  4. Download and save the deployAgent.sh script.

  5. Install the agent, enabling the features you want:

    • All features:

            sh deployAgent.sh -n yes
            
    • Specific features:

            sh deployAgent.sh -n yes -f "agent:RemoteCommand,agent:PatchManagement,agent:Automation,agent:RemoteConsole"
            

    Within a few seconds, the Infrastructure page displays the installed server.

Install a non-root custom user agent

To install the agent as a custom user with non-root privilege, create a new user and group before installing the agent.

  1. Create a new user group:

        groupadd --system {username}
        
  2. Create a custom user:

        useradd -g {username} -d /opt/opsramp -m {username} -s /bin/sh --system
        
  3. Set the user password:

        echo {username}:{password} | chpasswd
        
  4. From All Clients choose a client.

  5. Go to Setup > Download > Agent.

  6. In the Linux Agent Script tile, choose Shell Script.

  7. Download and save the deployAgent.py script.

  8. Install the agent, enabling the features you want:

    • All features:

            sh deployAgent.sh -R {username}
            
    • Specific features:

            sh deployAgent.sh -R {username} -f "agent:RemoteCommand,agent:PatchManagement,agent:Automation,agent:RemoteConsole"
            

    Within a few seconds, the Infrastructure page displays the installed server.

View the installation logs in the /tmp/opsramp-agent_install.log file.

Uninstall an agent

  1. Remove the package, depending on your operating system:

    • Debian-based operating systems:

            dpkg -P opsramp-agent
            
    • Red Hat-based operating systems:

            rmp -e opsramp-agent
            
  2. Delete the folder:

        rmdir /opt/opsramp/agent
        

See the /tmp/opsramp-agent_uninstall.log file for uninstall progress.