Single Source of Truth

Authentication and Initialization

Initialize and Authenticate user information before querying system data.

▪Log in to get an authentication token

▪Log out from session

▪Get all accessible tenants

▪Get all accessible domains of a tenant

▪Specify a domain to work on

Discovery

Manage and view discovery tasks.

▪Get a list of discovery tasks in a domain

▪Add IPs as seeds to a discovery task

▪Remove IPs from a discovery task

▪Get all IPs added to a discovery task

▪Run a discovery task now

▪Get the running status of a discovery task

▪Get the discovery results of devices

▪Get the live access logs of devices

Site Information

Get the information of a site.

▪Get the basic information of a site

▪Get child sites of a specific site

▪Get devices in a specific site

Site Modification

Make modifications to a site.

▪Create a transaction to start site modification

▪Remove a site transaction

▪Commit modifications to rebuild a site

▪Send heartbeat call to keep site transaction alive

▪Create a parent site

▪Create a leaf site

▪Create sites

▪Delete a site

▪Add devices to a site

▪Replace devices in a site

▪Remove devices from a site

Device Management

View devices and device data, add devices to a domain or remove devices from a domain.

▪Get devices by IP addresses

▪Get devices in a device group

▪Get the front server of a device

▪Remove devices from a domain in batch

▪Get device group list

Device Information

Get information about devices.

▪Get all devices in a domain

▪Get the value of a specified device attribute

▪Get all interfaces of a device

▪Get the value of a specified interface attribute

▪Get all modules of a device

▪Get the value of a specified module attribute

▪Get the neighbors of a device by topology type

▪Get the connected switch ports of an end system

▪Get device configuration

Device and Interface Attribute Management

Manage device and interface attributes, such as put delete or create an attribute.

▪Create a customized device attribute

▪Set value for a specified device attribute

▪Delete a device attribute

▪Create a customized interface attribute

▪Set value for a specified interface attribute

▪Delete an interface attribute

▪Create a customized module attribute

▪Set value for a specified module attribute

▪Delete a module attribute

Path

Calculate paths and view path results.

▪Calculate a path

▪Get path calculation result

▪Get the gateway information of a device

▪Stop a path

▪Get path calculation status

System Management

Manage your NetBrain system.

▪Add a tenant

▪Update a tenant

▪Delete a tenant

▪Assign users to a tenant

▪Add a domain

▪Update a domain

▪Delete a domain

▪Assign users to a domain

▪Remove users from a domain

▪Add a role

▪Update a role

▪Delete a role

▪Get role information

Topology Building

Build Layer 2 and Layer 3 topology in a domain.

▪Build L2 topology

▪Build L3 topology

▪Get the running status of a topology building task

▪Get One-IP Table

Network Settings

Manage credentials in a network setting.

▪Add network credentials

▪Edit network credentials

▪Delete network credentials

Map

Export a map or delete a map.

▪Export a map

▪Delete a map

▪Get the file list (Embedded Map)

▪Get device group (Embedded Map)

Benchmark

Manage benchmark tasks in a domain.

▪Add a benchmark task

▪Update a benchmark task

▪Delete a benchmark task

▪Run a benchmark task immediately

▪Get the status of a benchmark task

▪Get the execution history of a benchmark task

Users

Manage user accounts.

▪Add users

▪Update users

▪Delete users

▪Get the usage report of users

▪Get user information

Tuning devices

Tune network devices and get the tuning result.

▪Tune devices

▪Get the results of tuning devices