Configuring SolarWinds Connector Sources

Use SolarWinds Connector to connect to SolarWindsQRadar® REST-compliant services. SolarWinds Connector is a built-in connector and uses REST API for data retrieval.

Before you begin

  • Ensure that the SolarWinds system that you want to connect is up and running.
  • For the sample request, if you need to provide custom headers, then ensure that you have that information available with you. Custom headers are request headers that are needed to retrieve REST API information from a SolarWinds system. For example, Authorization request headers or Accept-Charset request headers. Authorization request headers contain authorization information that is required by the SolarWinds system. Accept-Charset indicates the acceptable data characters that the response must contain.

Procedure

Complete the following steps to add SolarWinds XI REST-compliant services by using SolarWinds Connector:

  1. Open Dashboard Designer.
  2. In the navigation pane, go to Connector & Sources > Connector Sources.
  3. On the All Connector Sources page, click Add Source.

    An Add Connector Source window is displayed.

  4. From the Connector Type list, select SolarWinds Connector.
  5. In the Connector Source Name field, enter a name for the SolarWinds Source.

    Source name can contain alphanumeric characters and underscores.

  6. In the Endpoint URL field, enter URL details for the SolarWinds system in the following format:

    https://server_IP_or_HOSTNAME:port

    Where:
    • server_IP_or_HOSTNAME is the IP address or hostname where SolarWinds application is installed.
    • port is the default port for SolarWinds.

      The default port is 17778.

  7. From the Authentication Type list, select None or Basic Authentication based on whether username and password are configured during the installation of the REST service.
    If you select Basic Authentication, then you must complete the following steps:
    1. In the User Name field, enter a username that is used during the configuration of the REST service.
    2. In the Password field, enter a password that is used during the configuration of the REST service.
  8. Click Next.
  9. From the Method list, select a method and complete any of the following steps based on the method that you select:
      • For GET method, in the URI field, enter the uniform resource identified (URI) for the source.
      • For POST method, in the URI field, enter the URI for the source, and in the Request Body field, enter the post request.
    For example,
    • URI for GET method:

      /SolarWinds/InformationService/v3/Json/Query?query=QUERY

    • URI POST method:

      /SolarWinds/InformationService/v3/Json/Query

      Request body for POST method:
       {
        "query":QUERY_WITH_PARAM",
        "parameters":{
        "PARAM_NAME":"PARAM_VALUE"
       }
      }
    Following are the variables that are used in the examples:
    • QUERY is the query in SolarWinds Query Language (SWQL) format.
    • QUERY_WITH_PARAM is the SWQL query with parameters.
    • PARAM_NAME is the parameter name that is used in the QUERY_WITH_PARAM query.
    • PARAM_VALUE is the parameter value for the parameter that is used in the QUERY_WITH_PARAM query.

    For more information about URL formats, see https://github.com/solarwinds/OrionSDK/wiki/REST.

  10. Optional: Under Custom Headers, complete the following steps:
    • In the Name field, enter the request header name that is provided by the REST API service provider.
    • In the Value field, enter the request header value that is provided by the REST API service provider.

    To add more custom headers, click Add Another, and repeat the earlier steps.

  11. To make sure that the connection to SolarWinds data source is successful, click Test Connection.
    If the source details and the sample request are valid and complete, then a message indicating that the connection is successful is displayed. For connection failure messages, you must fix the errors that are mentioned in the messages and test the connection again.
    Note: Even if the source details are valid, a connection failure message might be displayed due to an invalid response received for the sample request.
  12. Click Save.

Results

The All Connector Sources page displays the following details for each connector source:
  • Connector source name
  • Connector type
  • Date and time when the connector source was first created, and the username of the user who first created the source.
  • Date and time when the connector source was last modified, and the username of the user who last modified the connector source. Only the latest record is displayed.
The SolarWinds REST service is added and can be used to create your custom data definitions.