Prerequisites

  • OpsRamp Classic Gateway(Linux) 14.0.0 and above.
  • OpsRamp Nextgen Gateway 14.0.0 and above.
    Note: OpsRamp recommends using the latest Gateway version for full coverage of recent bug fixes, enhancements, etc.

Application Migration

  1. Check for the gateway version as a prerequisite step - classic gateway-12.0.1 and above.
    Notes:

    • You only have to follow these steps when you want to migrate from sdk 1.0 to sdk 2.0.
    • For the first time installation below steps are not required.
  2. Disable all configurations associated with sdk 1.0 adaptor integration application.

  3. Install and Add the configuration to that sdk 2.0 application.
    Note: refer to Configure and Install the VMware NSX-T Integration & View the VMware NSX-T Details sections of this document.

  4. Once all discoveries are completed with the sdk 2.0 application, follow any one of the approaches.

    • Direct uninstallation of the sdk 1.0 adaptor application through the uninstall API with skipDeleteResources=true in the post request

      End-Point: https://{{host}}/api/v2/tenants/{tenantId}/integrations/installed/{installedIntgId}

      Request Body:
          {
          "uninstallReason": "Test",
          "skipDeleteResources": true
          }


      (OR)

    • Delete the configuration one by one through the Delete adaptor config API with the request parameter as skipDeleteResources=true

      End-Point: https://{{host}}/api/v2/tenants/{tenantId}/integrations/installed/config/{configId}?skipDeleteResources=true.

    • Finally, uninstall the adaptor application through API with skipDeleteResources=true in the post request.

      End-Point: https://{{host}}/api/v2/tenants/{tenantId}/integrations/installed/{installedIntgId}

      Request Body:
          {
          "uninstallReason": "Test",
          "skipDeleteResources": true
          }

Configure the VMware NSX-T

  1. From All Clients, select a client.
  2. Navigate to Setup > Account.
  3. Select the Integrations tab.
  4. The Installed Integrations page, where all the installed integrations are displayed. Click + ADD on the Installed Integrations page.
  5. If you do not have any installed applications, you will be navigated to the Available Integrations page. The Available Integrations page displays all the available applications along with the newly created application with the version.
    Note: Search for the application using the search option available. Alternatively, use the All Categories option to search.
  6. Click ADD in the VMware NSX-T application.
    Note: Select the version from the drop down menu.
  7. In the Configurations page, click + ADD. The Add Configuration page appears.
  8. Enter the following BASIC INFORMATION:


FunctionalityDescriptionField Type
NameEnter the name for the configuration.String
NSX-T Manager IP AddressIP address of the target.
Note: This IP address is accessible from Gateway.
Integer
PortSpecify the port number used for the connection. Default is 443.Integer
Is SecureSelect this checkbox if you want the communication between your system and the specified endpoint to be secured using protocols such as HTTPS (HTTP over SSL/TLS).
Default Selection: When selected, it signifies that the connection is encrypted, providing an added layer of security to the data being transmitted.
Checkbox
CredentialSelect the Credential from the drop-down list.

(Optional): Click + Add to create a credential. The ADD CREDENTIAL window is displayed. Enter the following information.
  • Name: Credential name.
  • Description: Brief description of the credential.
  • User Name: User name.
  • Password: Password.
  • Confirm Password: Confirm password
  • Port: Specify the port number used for communication with the NSX-T Manager.
  • Connection Timeout: Enter the maximum time (in milliseconds) to wait for a connection before timing out.
Dropdown
App Failure NotificationsWhen selected, you will be notified in case of an application failure such as Connectivity Exception, Authentication Exception.Checkbox
Availability ConfigurationDefines the availability settings for NSX-T Manager Cluster. This includes resource filters, availability conditions, and operator rules.JSON
Event/Alert PollingSelect this checkbox to allow polling of events and alerts from NSX-T Manager.Checkbox
Alert On Root ResourceSelect this checkbox to generate alerts for root-level resources.Checkbox
Event/Alert Cleared StatusSpecifies the statuses that indicate an event or alert has been cleared. Example: ["ACKNOWLEDGED", "SUPPRESSED", "RESOLVED"]Array
Event/Alert SeverityDefines the severity levels for events and alerts. Example: ["CRITICAL", "HIGH", "MEDIUM", "LOW"]Array
Event/Alert Severity MappingMaps NSX-T severity levels to OpsRamp severity levels. Example: {"CRITICAL":"Critical","HIGH":"Warning","MEDIUM":"Warning","LOW":"Info"}JSON
API TimeoutsEnable this option to configure API timeout settings.Boolean
Connection Timeout in SecsDefines the duration (in seconds) before an API connection attempt is timed out.Integer
Connection Request Timeout in SecsSpecifies the maximum time (in seconds) allowed for an API connection request.Integer
Socket Timeout in SecsDefines the duration (in seconds) before a socket connection is timed out.Integer
  1. Select the following Custom Attribute:
FunctionalityDescriptionField Type
Custom AttributeSelect the custom attribute from the dropdown list box.Dropdown
ValueSelect the value from the dropdown list box.Dropdown

Note: The custom attribute that you add here will be assigned to all the resources that are created by the integration. You can add a maximum of five custom attributes (key and value pair).

  1. In the RESOURCE TYPE section, select:
    • ALL: All the existing and future resources will be discovered.
    • SELECT: You can select one or multiple resources to be discovered.
  2. In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:
    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
  3. Click ADD.


Now the configuration is saved and displayed on the configurations page after you save it. From the same page, you may Edit and Remove the created configuration.

  1. Under the ADVANCED SETTINGS, Select the Bypass Resource Reconciliation option, if you wish to bypass resource reconciliation when encountering the same resources discovered by multiple applications.

    Note: If two different applications provide identical discovery attributes, two separate resources will be generated with those respective attributes from the individual discoveries.

  2. Click NEXT.

  3. (Optional) Click +ADD to create a new collector by providing a name or use the pre-populated name.

  4. Select an existing registered profile.

  5. Click FINISH.

The application is installed and displayed on the INSTALLED INTEGRATION page. Use the search field to find the installed integration.

Modify the Configuration

View the VMware NSX-T Details

To discover resources for VMware NSX-T

  1. Navigate to Infrastructure > Search > Software Defined Network > VMware NSX-T.
  2. The VMWARE NSX-T page is displayed, select the application name.
  3. The RESOURCE DETAILS page appears from the right.
  4. Click the ellipsis () on the top right and select View details.
  5. Navigate to the Attributes tab to view the discovery details.


  • Click the Metrics tab to view the metric details for VMware NSX-T.