R12.1-2025Jul03

Set Up API Server for Cisco ACI

The API Server allows you to define and manage the parameters required to access third-party systems through APIs.

In NetBrain, you can configure two types of API Servers:

  • SDN orchestrator, such as Cisco ACI APIC Server account.
  • Public cloud orchestrator, such as AWS Account, and other NMS (Network Management Systems), like Splunk or ServiceNow.

Add an API Server for Single Site

Follow the steps below to add a controller and specify the address and user credentials to access the Controller in the system.

  1. Click in your NetBrain desktop and select API Server Manager from the dropdown menu.

  2. In the API Server Manager tab, click Add API Server

    1. Enter a unique name in the Server Name field.
    2. Select Cisco ACI from the API Source Type drop-down menu. 
      Information

      Note: If you want to add an API server for MSO (Multi-site Orchestrator), you must select MSO in this field and then repeat other steps to add API servers for each ACI site.

      Information

      Note: Each source type mapping to a Techspec (Network Technology, Cisco ACI, AWS) or API Adapter (Splunk, ServiceNow). And each source type has its parameters that can be predefined in Techspec.

    3. In the Endpoints field, enter the URL of the Controller.
    4. Enter the Username and Password to access the Controller.
      Information

      Note: To support all features, your account needs the admin privilege for your APIC API Server.

    5. If more parameters are required when you access the controller or request data from the Controller, you can click Advanced to configure the keys (parameter names) and values.
    6. Select a Front Server or Front Server Group.
      Information

      Note: Make sure that port 7086 of your NetBrain Front Server is not occupied by other applications because this port is used by the service components of a Front Server to communicate with each other.

  3. Click OK.