Opera Bug
Contents
|
Index
Welcome
System Overview
System Requirements
System Requirements for Two-Server Deployment
System Requirements for Distributed Deployment
System Requirements for High Availability
Deployment Prerequisites
How it Works
Getting Started
Glossary
Deploying and Installing System
Installing MongoDB Server
Installing MongoDB Server on Linux
Uninstalling MongoDB Server
Installing MongoDB Replica Set on Linux
Connecting to MongoDB Server
Restarting/Stopping MongoDB Service
Installing Index Server
Installing Index Server on Linux
Installing Index Server Cluster on Linux
Uninstalling Index Server
Collaborating with MongoDB Server
Synchronizing Data Manually with Script
Installing License Agent Server on Linux
Uninstalling License Agent Server
Installing NetBrain Database Server on Linux
Installing Application Server
Installing Cache Server
Uninstalling Cache Server
Installing Message Server
Uninstalling Message Server
Installing Web Server and Web API Server
Uninstalling Web Server and Web API Server
Installing Worker Server
Uninstalling Worker Server
Installing Task Engine
Modifying JVM Heap Size
Uninstalling Task Engine
Binding Worker Servers Manually
Installing Front Server Controller
Uninstalling Front Server Controller
Installing Front Server
Installing Front Server on Linux
Service Management
Uninstalling Front Server
Installing Front Server on Windows
Uninstalling Front Server
Installing Service Monitor Agent
Installing Service Monitor Agent on Linux
Uninstalling Service Monitor Agent
Installing Service Monitor Agent on Windows
Uninstalling Service Monitor Agent
Installing Update Server
Using OVA File to Install NetBrain Database Server
Using OVA File to Install NetBrain Application Server
Configuring NTP Client on NetBrain Servers
Exploring Your Domain
Signing Up
Logging into Your Domain
Selecting a Domain
Files
Desktop
Site
Device Group
Creating a Device Group
One-IP Table
Qapp Center
Parser Library
Network
Parser
Creating a CLI Command Parser
Creating a Configuration Parser
Creating an SNMP Parser
Creating an API Parser
Selecting a Parsing Method
Calling a Parser
Advanced Filter
Mapping Variables
Variable
Adding Variable Mappings for Multi-Vendor
Prioritizing Parsers for Same Data Source
Adding Variable Mappings for Multi-Source
Prioritizing Data Sources Globally
Exporting Variable Mapping
Event Console
Managing Events
Event Attributes
Live Device Data
Data Source
Device View
Device Properties
Built-in Device Properties
Interface Properties
Built-in Interface Properties
Interface Type
Module Properties
Built-in Module Properties
Configuration File
Topology
Topology Type
CLI Commands
Data Tables
Adding Device Note
Adding Device Image
Exporting Device Data
Comparing Historical Device Data
Retrieving Live Device Data
System Automation Manager
API Triggered Tasks
API Stub Manager
Task Manager
User Profile
Resetting Password
Changing Password
Tenant
Logging out
Setting Up Your Domain
Logging into Domain Management Page
Creating a Domain
Configuring Share Policy
Configuring Network Settings
Discovering Network Devices
Network Definition
Do-Not-Scan List
Discovering Meraki Devices by Using Dashboard API
Domain Manager
Resolving Unknown IP
SSH/Telnet Login Credentials Mismatch
Incorrect Privilege Passwords
Other Reasons
Viewing Discovered Devices
Resolving Decommissioned Devices
Resolving Devices Discovered by SNMP
Resolving Unknown SNMP sysObjectIDs
Resolving Unclassified Network Devices
MPLS Cloud
Context Menu in Domain Manager
Site Manager
Creating a Site Hierarchy by Importing a Spreadsheet
Adding a Container Site
Adding a Leaf Site
Rebuilding Sites
Exporting Sites
Deleting Sites
Backing Up Site Definition
Cleaning Up Unassigned Site Members
Scheduling Tasks
Scheduling Basic System Benchmark Task
Scheduling System Discovery Task
Creating a Benchmark Task
Creating a Discovery Task
Benchmark Task Settings
Verifying Benchmark Result
Tuning Live Access
Tuning Options
Tuning Private CLI Settings
Managing Domain Online Users
Configuring Domain Properties
CheckPoint OPSEC Manager
Scheduling Map Updates
Crawling Network Data
Customizing a Crawl Task
Enabling Built-in Crawl Tasks
Topology Stitching
Topology Link Manager
Browsing a Topology Link in Detail
Adding a Topology Link
Disabling a Topology Link
Locking a Topology Link
Rebuilding Topology
Resolving Duplicated IP and Subnet
Cleaning Domain Data
Configuring Desktop Profile
Tuning for Everyday Use
Managing Live Access Settings
Shared Device Settings
Configuring Shared Device Settings
Configuring Interactive CLI Prompts
Locking Shared Device Settings
Configuring Private Network Settings
Private CLI Settings
Configuring Private CLI Settings
Logging into a Device via CLI
Configuring More Live Access Settings
Searching
Search Patterns
Searching for Devices
Searching for Maps
Searching for Network Segments
Searching for Paths
Searching for Dashboards
Searching for Sites
Searching for Device Groups
Searching for Unknown End Systems
Semantic Search
Advanced Search
Dynamic Search
Working with Maps
Site Map
Opening the Overview Map
Opening a Site Map
Mapping Devices by Site
Mapping a Site
Device Group Map
Opening a Device Group Map
Mapping Devices by Device Group
Mapping a Device Group
Creating a Map
Map Page
Adding Device Notes to Map
Changing Device Style
Drawing Map Stencil on Map
Locking a Map
Extending Neighbors
Auto Layout
Creating a Layout Style
Applying a Layout Template on Map
Saving a Map Layout as Sample
Associating a Layout Template with Sites or Device Groups
Layout Types
Mapping Layer 2 Topology
Auto Link
Customizing Auto Link Options
Browsing Device Data on Map
Customizing View Options for Data Units
Design Reader
Saving a Map
Opening a Map
Exporting to Visio
Refreshing a Map
Highlighting a Map
Updating a Map
Exporting a Map
Importing a Map
Managing Map Data
Map Data View Manager
Embedding NetBrain Map in Your Portal
Map Tools and Keyboard Shortcut
Documenting Your Network
Inventory Report
Exporting Inventory Report
Customizing Inventory Report
Qapp-based Report
Network Documents
Exporting Dashboard to Word
Viewing Dashboard Snapshots
Adding a Word Template
Widget Settings for Dashboard Export
Using A-B Path to Analyze Network Traffic
Mapping a Path
Path Settings
Viewing Path Log
Browsing Saved Paths
Recalculating a Path
Adding a Path
Exporting Paths
Importing Paths
Mapping a Historical Path
Running Qapp on a Path
Using Context-Driven Automation
Predefining a Network Context
Using Context to Understand Network Design and Troubleshoot
Predefining a Context Action
Using Runbook to Document Map-Based Activities
Executing a Runbook Template
Creating a Runbook
Running a Qapp
Running a Gapp
Executing CLI Commands
Retrieving Live Data
Comparing Network Data Changes
Comparing Data on the Same Device
Comparing Data between Two Devices
Browsing Comparison Results
Ping
Traceroute
Runbook Template
Default Runbook
Sending Alerts
Adding a Note
Alert Console
Saving as Runbook
Data Retrieval Result
Using Instant Qapp to Decode Network Design
Running an Instant Qapp
Instant Qapp Control Panel
Using Gapp to Automate Multistage Troubleshooting
Creating a Gapp
Running a Gapp
Gapp Center
Elements of a Gapp
Scheduling Qapp/Gapp for Problem-Based Monitoring
Editing a Built-in Schedule
Enabling Built-in Schedules
Viewing Monitoring Results
Using Data View to Decode Network Design
Data View Category
Data View Pane
Default Data View
Data Unit
Data View Overlay
Applying Data Views
Editing a Data View
Sharing a Data View
Clearing Applied Data Views from Map
Deleting a Data View
Saving as Data View
Data View Template
Applying a Data View Template
Creating a Data View Template
Variable Display Settings
Creating a Data View Template for Multiple Node Types
Creating a Data View Template for Multiple Device Types
Working with Data View Manager
Using Dashboard to Visualize Multi-Dimensional Data
Creating a Dashboard from Template
Customizing Favorite Dashboard Templates
Creating a Dashboard from Scratch
Saving as Dashboard Template
Dashboard Widget and Template
Creating a Dashboard Template
Creating a Widget
Dashboard Settings
Generic Widgets
Collaborating with Your Team
Viewing Notifications
Sharing a Map
Sharing a Dashboard
Sharing a Runbook
Editing Rights
Releasing Editing Rights
Transferring Editing Rights
Approving or Rejecting a Request
Getting Editing Rights
Requesting Editing Rights
Managing Network Changes
Creating a Network Change Task
Defining the Change Node
Defining the Benchmark Before Node
Defining the Execute Node
Defining the Approval Node
Defining the Benchmark After Node
Defining the Compare Node
Adding and Defining a Note Node
Approving a Network Change Task
Executing a Network Change Task
Executing a Network Change Task on Demand
Executing Benchmark Before Network Change
Implementing Network Change
Executing Benchmark After Network Change
Comparing After and Before
Executing a Network Change Task on Schedule
Archiving a Network Change Task
Browsing Change Tasks
Network Change Templates
Managing Configuration Templates
Managing Network Change Credentials
Access Controls
Writing Your First Qapp
Elements of a Qapp
Qapp Description
Global Table
Filter Criteria
Start
Input Variables
Canvas
Device Queue
Device
Command
Table
Table Operator
Output
Basic Output
Monitor Output
Script Output
If-condition
Operating on Qapp Nodes
Creating a Qapp
Creating a Qapp to Monitor Interface Errors
New a Qapp
Defining Canvas to Retrieve and Parse Data
Defining Device Queue and Device
Defining Command and Parser
Defining Analysis and Alert
Saving and Running a Monitor Qapp
Creating a Qapp to Annotate OSPF Routing Design
Using Configuration Command to Obtain OSPF Configuration
Defining Output to Highlight Devices with OSPF Configuration
Creating a Qapp to Check Device IOS Version
New a Qapp
Defining Canvas to Retrieve and Parse Data
Defining Analysis and Output
Creating a Qapp to Export Network Data to Local CSV File
Defining Target Variables
Using Convert Operator to Convert Table
Exporting CSV File
Creating a Qapp to Retrieve Customized Device Property Value
Creating a Qapp to Check Neighbour Inconsistency
Building Device Pairs in Device Queue
Retrieving MTU and Bandwidth Data of Device Pairs
Configuring Neighbor Join Operator
Creating a Qapp to Troubleshoot Connection Problems
Defining a Ping Command
Defining Ping Result Analysis and Output
Locking a Qapp
Customizing Qapp Functions
Qapp APIs
Enum
Module APIs
Class APIs
Extension Library
Python Scripting
Basic Knowledge of Python Scripts
If Conditions
Basic Regular Expressions
Discovering and Visualizing Software-Defined Network
Visualizing Cisco ACI Networks
Discovering ACI Data in NetBrain Domain
Viewing Nodes and Node Maps of an ACI Fabric
Understanding Network Structure of an ACI Fabric
Understanding Application Deployment Over an ACI Fabric
Calculating Paths Across ACI Fabric
Applying Data View to Visualize More Fabric Data
Visualizing VMware vCenter Networks
Discovering vCenter Data in NetBrain Domain
Understanding Host and Cluster Deployment
Understanding VMware Networks
Context Maps of vCenter Nodes
Visualizing VMware NSX-v Networks
Discovering NSX-v Network in NetBrain Domain
Viewing NSX-v Network Components in NetBrain
View Context Maps and Details of an NSX Node
Context Maps of NSX-v Network Nodes
Auto-Updating SDN Data in NetBrain through Benchmark
Network Pane Settings
Integrating with Third-Party Systems
Visualizing Third-Party Data on Map
Workflow
Defining an API Plugin
Adding an API Server
Creating an API Parser
Creating a Qapp
Using API Data in NetBrain
Writing an API Plugin
Event-Triggered Diagnosis
API Triggered Task Stub
Adding API-Triggered Tasks in NetBrain
Calling Tasks in Third-Party Systems
Viewing Task Results
Use Case - Return Map URL of a Calculated Path to Third-party System
Pop-up API Stub
Adding an API Vendor
RESTful API
Authentication and Initialization
Log in to get an authentication token
Get all accessible tenants
Get all accessible domains of a tenant
Specify a domain to work on
Log out from a session
Discovery
Get all 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 status of a discovery task
Get the results of discovered devices
Get the live access logs of devices
Device Information
Get all devices in a domain
Get the value of a device attribute
Get all interfaces of a device
Get the value of an interface attribute
Get all modules of a device
Get the value of a module attribute
Get the neighbors of a device by topology type
Get the connected switch ports of an end system
Get device configuration
Device Management
Get devices in a device group
Get the Front Server of a device
Remove devices from a domain in batch
Get device group list
Attribute Management
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
Site Information
Get the basic information of a site
Get child sites of a specific site
Get devices in a specific site
Site Modification
Create a transaction to start site modification
Remove a site transaction
Keep 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
Commit modifications to rebuild a site
Path
Calculate a Path
Get Path Calculation Result
Get the gateway information of a device
Stop a path
Get path calculation status
System Management
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 L2 topology
Build L3 topology
Get the status of topology building
Get One-IP Table
Network Settings
Add network credentials
Edit network credentials
Delete network credentials
Map
Export a map
Delete a map
Get the file list
Get device groups
Benchmark
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 run records of a benchmark task
Tuning Devices
Tune devices
Get the results of tuning devices
Users
Add users
Update users
Delete users
Get the usage report of users
Get user information
API Status Code List
Device Type Name and ID
Best Practices and Use Cases for NetBrain Rest APIs
Best Practice to Use NetBrain as CMDB via APIs
Using NetBrain Data to Populate Other CMDBs
Using Other CMDB Data to Populate NetBrain
Use Case - Manage Your NetBrain Data via APIs
Triggering NetBrain to Discover or Remove Devices
Re-discovering Hostname-Changed Devices
Synchronizing Site Structure to NetBrain from Third-party System
Synchronizing Site Updates from Third-party System
Use Case - Return Hop List of a Path in Third-party System
Monitoring Servers and Services
Monitoring Server and Service Metrics
Changing Password
Cleaning Aged Monitoring Data
Monitored Metrics
Tenant Management
Logging into Tenant Management Page
Authorizing Users to Create Domains
Browsing Domains under a Tenant
Managing Multi-Vendor Support
Device Type
Device Driver
Device Driver Properties
Vendor Model
Multi-Vendor Support List
OUI Information
Port to Protocol List
Platform Management
Configuring Global Data Repository
Adding a Device Property
Adding an Interface Type
Interface Name Translation
Redirecting to System Management Page
System Management
Logging into System Management Page
Allocating Tenants to Front Server Controller
Adding a Front Server to a Tenant
Registering a Front Server
Adding a Front Server Group for Load Balancing
License Activation
Activating a Trial License
Activating a Permanent License
Unbinding Permanent License
Creating a Tenant
Managing System Users Accounts
Creating a User Account
Featured Management Privileges
Creating a Role
External User Authentication
Configuring LDAP Authentication
Configuring AD Authentication
Configuring TACACS+ Authentication
Configuring SSO Authentication
Approving Register Applications
Configuring Password Policy
Roles and Privileges
Filtering Users
Auto-Updating Built-in Resources
Customizing Update Schedule
Configuring Email Server Settings
Managing System Online Users
Configuring Email Domain Whitelist
Terminating System Tasks
Exporting Usage Report
Enabling Audit Log
Configuring Session Timeout
Customizing Login Logo and Banner
Redirecting to Tenant Management page