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.
Install a collector
Follow these steps to install a collector:
Navigate to Setup > Account. The Account Details page is displayed.
Click the Collector Profiles tile. The Collector Profiles page is displayed.
Click +Add.
Enter following details in the gateway collector profile page:
Enter a profile name
Provide the short description (Optional)
Select a profile type
Select one of the collector from below as per your requirement:
Amazom Machine Image
Virtual Appliance (ISO)
Virtual Appliance (OVA)
Azure Blob Container
Google Image
Virtual Appliance (ISO) - NextGen
Virtual Appliance (OVA) - NextGen
Cloud-Native Application (Installer) - NextGen
Installer for Windows OS
Click Next.
Download the required file.
Follow the instructions to install and register the Gateway Collector.
Click Finish. The gateway is added to the collector profile.
After creating the collector profile and installing the gateway and registering it, you can see all the available collector profiles in the Collector Profiles listing page.
The Collector Profiles listing page consists of the following columns:
Column
Description
Name
Name of the Collector Profile.
Status
Displays the status of the collector profile:
Not Installed
Disconnected: It displays the time (in days, hours, and minutes) it has been in the disconnected status.
Connected: It displays the time (in days, hours, and minutes) the gateway is connected.
Gateway Resource Name
Name of the gateway.
Type
Type of gateway: NextGen, Classic, or Windows.
Installed Apps
Number of Apps or Integrations that are installed.
Discovery Profiles
Number of mapped Discovery Profiles.
Managed Resources
Number of resources that are managed by the gateway.
Version
Current gateway version.
Update State
Indicates the state of the gateway: Whether an update is available for the gateway, In-progress, Scheduled, or Up-to-date.
Update Status
Status of the gateway: In Progress, Success.
SIP Agent
Click the toggle button to enable or disable the SIP Agent.
Synthetics Agent
Click the toggle button to enable or disable the Synthetics Agent.
Model Number
Model number of installed gateways. (Example: Classic gateway model number starts with OG, NextGen starts with ONG, Windows starts with OWG).
Namespace
All NextGen Gateways show the Kubernetes namespace in which the gateway is deployed. For Classic and Windows Gateways, this field displays N/A.
Filter
You can use the Filter option to narrow down search results.
Navigate to Setup > Account. The Account Details page is displayed.
Click the Collector Profiles tile. A list of collector profiles is displayed.
Click Filter option.
Select Status, Type, and Collector Version from the dropdowns.
Click FILTER. The search result is displayed.
Actions on a collector profile
Action
Description
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.
Reconnect Tunnel
To reconnect tunnel:
Search for the collector profile.
Hover over the row and click the action menu (three dots).
Select Reconnect Tunnel. A confirmation popup appears, "Reconnecting the tunnel will cut off the current connection and start it up again. The gateway will be disconnected and monitoring will stop for a short while during this operation."
Click Reconnect Tunnel.
Upgrade
Note:
You can upgrade a gateway version to the latest available version.
You can upgrade a gateway that is in either the Connected or Disconnected status.
You can upgrade a gateway to the latest available version (n), the previous version (n-1), or the version before that (n-2).
To upgrade a gateway version:
Search for the collector profile.
Hover over the row and click the action menu (three dots).
Select Upgrade. Alternatively, you can select the collector profile and click Actions > Upgrade.
The Upgrade Gateway Version window is displayed.
Select a version you want the gateway to be upgraded to, from the dropdown.
You can upgrade the gateway version either immediately or on a scheduled basis. To upgrade the gateway version directly:
Select the collector profile and click Upgrade.
Note:
Pre-upgrade checks are done to verify if the gateway is eligible for an upgrade.
The checks are not available for some lower gateway versions.
The Pre-Upgrade Check Status column shows Skipped if there are no checks available for the current gateway version.To upgrade the gateway version on a scheduled basis:
Select the Upgrade on Schedule checkbox.
Select the date and time on which you want to upgrade the gateway version.
Click Apply.
Click Upgrade.
The upgrade process starts and the Update Status changes to In_Progress. Note: The Upgrade on Schedule functionality works for Gateway version 21.0.0 and above.
Bulk Upgrade: You can bulk upgrade gateways which are of same gateway type and model.
To bulk upgrade:
Select the collector profiles you want to upgrade.
Click Actions > Upgrade.
The Upgrade Gateway Version window is displayed.
Select the profiles and click Upgrade.
An error message is displayed, if you select multiple profiles with mixed gateway type and model. Note: If the profile has the latest gateway version, the Upgrade option will not be available in the Actions menu.
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.
