R12 Publication-2025July16

Set up the API Server

Create a SolarWinds API Server:

  1. Pre-requisites
  2. Create Solarwinds API Server Connection  

Pre-requisites

Application Version

Application Version
SolarWinds Orion NMP 12.2(or newer)
NetBrain R11.1

Network Connectivity

Client Server Ports
NetBrain Front Server SolarWinds Server

NetBrain > SolarWinds 17778 TCP

SolarWinds > NetBrain 49152 – 65535 TCP

User Account and Privileges

Application User Account Required Role Assignment(s)
NetBrain Required System Admin
SolarWinds Required Guest (or higher)

Create Solarwinds API Server Connection  

Information Note: If the environment has been deployed with multiple Front Servers, repeat this section for each of the Front Servers.
  1. Using a web browser, login to the NetBrain Desktop UI using the System Admin credentials.
    • http://<NetBrain Web Server IP>
  2. Navigate to the NetBrain API Server Manager.
    • Domain Management > API Server Manager
  3. In the API Server Manager screen, click Add.
  4. Complete the Add API Server dialog screen as follows:
    • Server Name: SolarWinds API Server <Front Server>
    • Description: SolarWinds
    • API Source Type: " SolarWinds API Adapter"
    • Endpoint: SolarWinds instance endpoint (ex "https://192.168.28.253")
    • Username: SolarWinds account's username
    • Password: SolarWinds y password
    • Front Server/Front Server Group: Select FS/FSG which would have reachability to SolarWinds instance endpoint
  5. Click Managed Devices: 0 to assign SolarWinds Search enabled devices to this API Server.
    • Click + Device.
    • Select "Device Type" radio button.
    • Select All Device Types.
    • Click ">>", then click OK two times to save the device assignment.
  6. Click Test to initiate a connectivity test between the NetBrain front server and the SolarWinds instance configured.
Test ResultsScreenshots
Successful Connection

Error Scenario: SolarWinds Orion SDK library isn’t available

Possible Resolution: Make sure NetBrain is upgraded to R11.1 or later, or contact NetBrain Support for a solution.

Error Scenario: The entered credentials are incorrect.

Possible Resolution: Confirm credentials specified in the Solarwinds API Adaptor configuration and retry.

Error Scenario: SolarWinds endpoint is unreachable.

Possible Resolution: Confirm that the NetBrain Front Server(s) can reach the SolarWinds platform using 3rd party tools (Ping, Traceroute, Wireshark)