Registering the gateway infers connecting the gateway with the console after deploying the virtual machine.

Create a management profile

To create a management profile:

  1. Go to Setup > Resources > Management Profiles.

  2. Click +Add.

  3. From Management Profile, provide details for the following:

    • Client Name: Select the client for gateway registration.
    • Profile Type: Select Gateway.
    • Profile Name: Enter a unique name.
    • Description: Enter a brief description of the management profile.

  4. Click Submit.

    The activation token is automatically generated.

  5. Copy the API server and activation token.

Register the gateway

After creating the management profile, initiate gateway registration using one of the following methods:

  • Gateway serial user interface
  • Gateway web user interface

Register using the serial user interface

To configure the gateway using the serial user interface:

  1. Log into the gateway Virtual Machine(VM) using the username and password.
    For default login credentials, use the user name and password displayed in Setup > Downloads > Gateway to log into the gateway administration account.

    The gateway console prompts you to change the default password after the first login.

  2. From the left pane, click General.

  3. Verify that the Registration Status is Not Registered and the Tunnel Status is Not Established.

  4. Go to the Network tab. Ensure that the IP address and network settings are properly configured.

  5. To configure the gateway using a proxy server, use CTRL+P to navigate to Proxy Settings. By default, Direct connection to the Internet is selected.

  6. Go to the Registration tab.

  7. Enter an API server and activation token. Copy the API server and activation token from Management Profile.

  8. Click Update Now to register the gateway to the console.

The registration process takes a few minutes to complete. After the registration process, from the console, go to Setup > Resources > Management Profiles to verify the gateway connection status.

Register using the web user interface

To configure the gateway using the web user interface:

  1. From the web browser, enter the URL using the following syntax: https://<enter Gateway IP address>:5480.

  2. From the gateway login screen, provide a default username and password. The gateway console prompts you to change the default password after the first login.

  3. From the Appliance Administration Panel page, go to Administration Menu > Network. Ensure that the IP address and network settings are correctly configured.

  4. From Network, go to Network Connection Settings to configure the gateway using Proxy server. By default, Direct connection to the Internet is selected.

  5. From the Administration Menu > Registration , provide details for the following, copying the API server and activation token from Setup > Resources > Management Profiles:

    • Activation Key
    • OpsRamp Server

  6. Click Activate.

  7. Verify that the Registration Status displays a Registered and Success status.

The registration process takes a few minutes to complete. After the registration process, from the console, go to Setup > Resources > Management Profiles to verify the gateway connection status.

Detach gateway

If you decide to detach the gateway from the cloud, use the Setup > Resource > Management profile > Detach Gateway procedure.

After detaching the gateway, the following occurs:

  • The gateway stops monitoring resources and disconnects from the cloud.
  • The gateway is reset to factory defaults, including network settings, static IP, routes, proxy setting, and date and time.
  • If you are using the gateway as a proxy for agents, connectivity is lost.
  • Passwords are reset to the default values.
  • SIP and SYNTHETICS monitoring is stopped.

Agent is uninstalled on the gateway.

Note: When you detach the gateway, OpsRamp will generate a critical Gateway Deregister Alert. This alert is not mapped to the gateway resource, and you will need to locate these alerts in the alert browser. The alert contains the hostname of the detected gateway.

Gateway Management Profile Deletion Process

This document provides information related to deletion of Gateway Management Profile for (Classic Apps/SDK 1.0 Apps).

Prerequisite

While performing these actions, the gateway must be attached to the specific management profile.

Follow the steps mentioned below:

  1. Navigate to Setup > Integrations > Integrations.

  2. Search for the installed integration and click the integration name.

  3. From the Configuration/Discovery Profile section, select the configuration/discovery profile and click Remove.

  1. From the confirmation dialog box, click Yes to delete the configuration.

  2. After removing all the configurations from the Integration (SDK or Classic app), uninstall the integration.

  1. Click Uninstall and provide the reason in the Uninstall Integration(s) dialog box.

  2. Click Ok to uninstall the integration.

  3. After uninstalling the Integration, wait for some time (10 to 15 mins).

  4. Navigate to Setup > Resources > Management Profiles

  1. Click Detach Gateway from the management profile. This will detach the gateway from the management profile.

  2. Click Delete Profile to delete the management profile.

Note: Before deleting the management profile, the connected devices and mapped discovery profiles counts must be zero.