Introduction

OpsRamp supports the installation of a collector in both virtualized and cloud-native environments. The installation process in both environments is achieved in a single unified flow as shown below.

Add Gateway Collector Profile

Follow these steps to add a gateway collector profile:

1. Navigate to Setup > Account. The Account Details page appears.

2. Click the Collector Profiles tile. The Collector Profiles page appears.

3. Click +Add.

4. Enter following details in the gateway collector profile page:

   • Enter a profile name
   • Provide the short description (Optional)
   • Select a profile type
     
     

5. Select one of the collector from below as per your requirement:
   

   • Classic
     
     • Amazon Machine Image
     • Virtual Appliance (ISO)
     • Virtual Appliance (OVA)
     • Azure Blob Container
     • Google Image
       
   • NextGen
     
     • Virtual Appliance (ISO)
     • Virtual Appliance (OVA)
     • Cloud-Native Application (Installer)
       
   • Windows
     
     • Installer for Windows OS
       
       

6. Click Next. Based on the collector selected, the instructions in the Installation and Activation tabs differ.

   
   

7. Follow the instructions in the Installation tab.

8. Download the required file.

9. Click on Activation tab. Follow the instructions.
   Information like URL, System username, password, Admin username and password appears.
   

   • You can retrieve the default credentials (username and password) for System user and Admin user and change them when required.
     Note: Default passwords vary based on the gateway type and the installed gateway version.
     
     

   
   

10. Follow the instructions to install and register the Gateway Collector.

11. Click Finish. The gateway is added to the collector profile.

See Classic Gateways and NextGen Gateways for more information on installing a gateway.

After creating the collector profile and installing the gateway and registering it, you can see all the collector profiles in the Collector Profiles listing page.

• DOWNLOAD COLLECTOR: Click this option available at the top-right corner of the page, and follow the instructions on the GATEWAY COLLECTORS page to download the collector.
• REFRESH: Click the Refresh option to refresh the Collector Profiles listing page.

Collector Profiles table: Column reference

The Collector Profiles listing page consists of the following columns:

Collector Profile summary panel

The Collector Profile summary panel displays additional information about a selected collector profile, organized into three sections (Overview, Configurations, Capabilities) for better clarity and accessibility:

1. Navigate to Setup > Account. The Account Details page appears.
2. Click the Collector Profiles tile. The Collector Profiles listing page appears.
3. Search for the collector profile you want to view the summary.
4. Click anywhere on the row. The collector profile summary panel appears on the right side of the page.
   
   
   

Overview

Displays high-level details of the selected collector profile:

Configurations

Provides visibility into the configuration artifacts associated with the collector profile:

Capabilities

Displays supported capabilities along with their enabled/disabled states:

Note: You can directly manage the SIP Agent and Synthetics Agent from this section.

Filter

You can use the Filter option to narrow down search results.

1. Navigate to Setup > Account. The Account Details page appears.
2. Click the Collector Profiles tile. A list of collector profiles appears.
3. Click the FILTER option at the upper-right corner of the page.
   
   
   
4. Select the filters based on your requirement:
   
   

   Field	Values
   Status	Installed, Not Installed, Connected, Disconnected
   Type	Classic, NextGen, Windows
   Collector Version	N, N-1 and N-2
   Profile Type	Standard, Elastic
   Model Number	Example: ONG, OGV, OGA
   Upgrade State	Not Available, Up-to-date, Update Available, Update on Schedule, Not Allowed
   Gateway Managed OTel Collector	Enabled, Disabled
   SIP Agent	Enabled, Disabled
   Synthetics Agent	Enabled, Disabled
   Traffic Director	Enabled, Disabled

   5. Click FILTER. The search result appears.

   Actions on a collector profile

   Following are the options that appear on the Collector Profiles listing page. The options appear based on the Gateway status.

   Action	Description
   Run remote command	This option appears only if the Gateway is in the Connected or Disconnected state (The SNMP Walk cannot be executed when the Gateway is down). The Run Remote Command is used to execute SNMP commands on remote devices. To run a remote command: Search for the collector profile. Hover over the row and click the action menu (three dots). Select Run remote command. The RUN REMOTE COMMAND window appears. The command type is SNMP Full Walk, by default. Enter the target device IP address. Select an existing SNMP Credential from the dropdown or add a credential. Click EXECUTE SNMP FULL WALK. This triggers the remote command execution. The SNMP FULL WALK section displays the following information: IpAddress Column: Shows the IP address of the device queried. Status Column: Displays the execution status of the command. Refresh: Click Refresh to refresh the results without re-executing.
   Rename	To rename a collector profile: Search for the collector profile. Hover over the row and click the action menu (three dots). Select Rename. Enter a name and click Rename.
   Detach	To detach a collector profile: Search for the collector profile. Hover over the row and click the action menu (three dots). Select Detach. A confirmation message appears, The detach gateway will disconnect from the OpsRamp and stop monitoring the resources. The gateway will be reset to factory defaults. Click Detach.
   Reinstall	To reinstall a collector profile: Search for the collector profile. Hover over the row and click the action menu (three dots). Select Reinstall. A confirmation popup appears. Click Install. Follow the instructions to install and register the gateway.
   Remove	To remove a collector profile: Search for the collector profile. Hover over the row and click the action menu (three dots). Select Remove. A confirmation popup appears. The Gateway Collector profile will not be deleted if the profile has Installed App, Discovery Profiles, or Managed Resources. Note: The Remove button is disabled, if there are installed apps, discovery profiles, or managed resources. Click Remove.
   Scale Up	Scale Up is available only for Elastic type collector profile. To scale up: Search for the collector profile. Hover over the row and click the action menu (three dots). Select Scale Up. A confirmation popup appears, The Scale Up action will create one more gateway child profile, and this action will increase the capacity of the gateway profile. You need to run Re-balance after doing the Scale Up action to distribute the load equally. Click Scale Up.
   Reboot Gateway	To reboot the gateway: Search for the collector profile. Hover over the row and click the action menu (three dots). Select Reboot Gateway. A confirmation popup appears. Click Reboot Gateway. The gateway is restarted.
   Reset Password	To reset the gateway password: Search for the collector profile. Hover over the row and click the action menu (three dots). Select Reset Password. A confirmation popup appears. Click Reset Password. The gateway password is set to default password.
   Copy Id	To copy gateway UUID: Search for the collector profile. Hover over the row and click the action menu (three dots). Select Copy Id. A confirmation popup appears, ID copied successfully. The gateway UUID is copied to the clipboard.

   Edit Collector Profile

   Below are the allowed modifications on a collector profile based on gateway state:

   • NOT INSTALLED: All fields can be modified.
   • CONNECTED/DISCONNECTED: Only profile name and description can be modified.

   Follow these steps to edit Collector Profile details:

   1. Navigate to Setup > Account. The Account Details page appears.
   2. Click the Collector Profiles tile. The Collector Profiles listing page appears.
   3. Search for the collector profile you want to make changes.
   4. Click the collector profile name. The EDIT GATEWAY COLLECTOR PROFILE page appears.
   5. Make the necessary changes. Follow the steps in the Add Gateway Collector Profile section.
   6. Click SAVE.

   Collector Profile management - Connected state

   When the gateway is in a CONNECTED state, the following actions are available on the collector profile details page:
   
   
   

   Column	Description
   Reset Password	The gateway password is reset to default password.
   Reboot Collector	The gateway will restart.
   Sync SNMP Definitions	Synchronizes all the SNMP Definitions between the cloud and the selected gateway.
   Enable/Disable SIP Agent	Select to enable or disable the SIP Agent.
   Enable/Disable Synthetics Agent	Select to enable or disable the Synthetics Agent.
   Remove	Click to Remove the profile. Note: Gateway Collector profile will not be deleted, if the profile has Installed App, Discovery Profiles, Managed Resources, or Syslog Monitor Configurations.

   
   
   
   

   
   
   
   
   

   Related Topics

   • SIP
   • Synthetic Monitoring
   ×