NetBrain Technologies, Inc.
+1.800.605.7964 | email@example.com | www.netbraintech.com
NetBrain Consultant Edition (CE) Quick Start Guide
2004-2013. All rights reserved
1. Introduction 1) Install NetBrain Workstation
Consultant Edition 2) Start Workspace Wizard 3) Tune Discovery Results 4) NetBrain User Interfaces 5) Common Workflow
2. Dynamic Documentation 1) Map around a device 2) View and Annotate Design Details 3) Create Visio Map Instantly 4) Find relevant maps instantly 5) Map L2 Connection for an IP 6) Map L2 Connections of a LAN
segment 7) Define and Map a Dynamic Device
Group 8) Auto Update Maps 9) One Click Word Document From
the Map 10) Create an Asset Report
3. Visual Network Analysis 1) Visualize L3 Design 2) Visualize L2 Design 3) Configuration Analysis 4) Routing Analysis 5) Batch Compare Configurations
and Routings 6) Login to a network device
4. Visual Troubleshooting 1) Map an Application Path 2) Map L2 Connections along a Path 3) Monitoring 4) Batch Compare Configurations and
Routings 5) IP Accounting 6) IP SLA 7) NetFlow Traffic Analysis
5. Automation Procedure 1)Draw on-demand map 2)Automate the process of network troubleshooting 3)Check network device and interface health 4)Customize network inventory report 5)Verify network change 6. Network Change Management 1)Change Management workflow 2)Define network change task 3)Implement network change task 4)Verify network change results 5)Document
1.1 Setup NetBrain Workstation
1.1 Install NetBrain Workstation Consultant Edition
a) Download the software to your computer
Download the NetBrain software here. Unzip the file.
a) Run the setup file and follow the setup wizard
For Windows 7/2008, we recommend that you right click on the setup file and select the Run as Administrator option..
c) Activate your license Launch NetBrain Workstation Consultant Edition. The Welcome to NetBrain window opens. For trial license (POC user): Click on the Activate Trial License button. Fill in your Email and Password in the Register for Trial License window. (The Password has been sent to you in the Proof of Concept email) For permanent license (Customer): Click on the Activate Permanent License button. Fill in your License ID, password, name, and email address in the Activate License window and then click on the Activate Online button. (The license ID and password have been sent to you in the order delivery email) Note: If your license server is NOT connected to the Internet, please email firstname.lastname@example.org and we will send you instructions on how to activate the license offline.
1.2 Start Workspace Wizard
When you start NetBrain Workstation for the first time, the Workspace Wizard automatically starts up. For the first step,
1. Click the Telnet/SSH login tag. 2. Click the Add button. 3. Enter the corresponding values. 4. Repeat step 2 and 3 to add all possible
Telnet/SSH login credentials. 5. Click the other tabs in this window to add
Privilege Password, SNMP community, Network Server and Jumpbox.
6. Click the Next button to go to the next step of wizard.
Note: If Workstation can access your network directly, then you do NOT need set a Jumpbox. Otherwise you do need set a Jumpbox so that the Workstation can access the live network.
Wizard Step 1: Define Telnet/SSH/SNMP credentials and proxy
1.2 Start Workspace Wizard
Wizard Step 2: Discover your network from a seed router
1. Click the Telnet and SNMP field and select how system accesses your live network from the drop down menu. If you are not sure, select Telnet/SSH and SNMP safely.
2. Enter the IP address of a seed router. 3. Click the Start Discovery button. 4. Select an entry to view the log. 5. View the discovery statistics and summary here.
Note: This discovery process includes two steps:
discover the network devices and retrieves the live data from your live network; build L3/L2 topology. Depending on your live network, the time for each step varies, from a few minutes to 20 minutes.
6. Click the Finish button to exit the Wizard.
Note: The discovery statistics are updated and displayed at .
If you fail to discover some devices in your network, first
make sure that you enter all possible live network settings at step 1 Define Telnet/SSH/SNMP Credentials and Proxies and then you can try different seed routers.
1.3 Tune Discovery Results
a) Rediscover unknown IP 1. Go to the Workspace menu tab, click on the Manager icon. 2. Select Unknown IP at the left pane and then
Username/Password Mismatch. At the right pane, the system lists all IP addresses discovered as the neighbor IP address in the discovery process but was not accessible due to the fact that none of the defined username/password pairs worked.
3. Click the Rediscover button at the top right. Add the username/password pairs at the Live Network Settings window.
4. Close the Live Network Settings window and click the Start Discovery button in the Live Network Discovery window.
Note: Using a similar approach, you can also resolve unknown IPs due to Privilege Password Mismatch or others.
b) Rediscover devices that were discovered only by
1. Go to the Workspace menu tab, click on the Manager icon. 2. Select Discovered by SNMP at the left pane. At the right
pane the system lists all devices discovered by SNMP but not accessible by Telnet/SSH.
3. Right click a device and select Live Access Log menu to view why the system could not telnet/SSH to the device. If the Telnet/SSH login credentials were missing, click Workspace menu tag from the menu bar and then the Settings icon for Live Network Settings to add the credentials.
4. Select one or multiple devices (press the Shift or Ctrl key to select multiple devices) and from the right click menu select Discover Selected Devices.
1.4 NetBrain User Interface
1 Ribbon menu: e.g., enter any IP, hostname or string to search the workspace data and maps.
2 Search results pane: e.g., create a dynamic Q-map or open Visio maps.
3 Map area: e.g., extend neighbors to draw more devices.
4 Map floating menu: launch operations to analyze or troubleshoot a network here.
5 Operation pane: e.g., drag and drop an entry to a map and manage your maps in Map Center.
1.5 Common Workflow
1. Search Enter a keyword such as IP address, configuration keyword or model in the Search box and press the Enter key. Tip: check the Exact Match Only option or put double quotes around the keyword for exact matching.
2. Map the searched results
Mouse over a search result such as an end system. Select L2 Page and click on the map to create a dynamic Q-map.
3. Analyze from the map
Click on the blank space, a device or a path on the map and select the various operations from the map floating menu.
All-in-one Search Mapping Analyze From Map
Search NetBrain workspace, database and Visio maps on your PC using:
IP address or device hostname Text inside maps Configuration keywords Model, serial number, MAC, etc.
From the search results, Create a dynamic Q-map (L3 and L2)
instantly View the relevant Visio diagrams
Directly from the map, Visualize the network design Monitor Analyze configurations and routing Compare the historical data
2.1 Map around a Device
Objective: Map L3 connections around a device
Use Case: Troubleshoot a problematic router BGP neighbors are down
1. Search the device Enter the IP address or device name in the Search field and press the Enter key. Tip: check the Exact Match Only option or put the double quotation around the key word for the exact matching.
2. Map the searched result
Mouse over a device in the searched result . Click the View Larger Map link.
3. View the neighbors Click on the red plus sign to open the neighbor window.
4. Draw the neighbors Double click on all neighbors or one specific neighbor to draw the neighbor(s) in the map.
5. Draw the neighbor(s) of the neighbor(s)
Repeat steps 3 and 4 for more neighbors till all neighbor devices you are interested in are drawn in the map.
2.2 View and Annotate Design Details
Objective: Zoom in the map to view details Browse and annotate the design
Use Case: Create a design map for routing, multicasting, etc
1. Zoom in the map Scroll the wheel of mouse forward.
2. View the configurations of a network object
Mouse over a network object such as routing protocol, interface, or ACL.
3. Annotate a network design
Click on the Display in the Map button.
2.3 Create Visio Map Instantly
Objective: Export NetBrain Q-map to Visio format
Use Case: Share a map with someone without access to a NetBrain Workstation Generate static Visio maps for inventory or compliance reasons
1. Create a Visio map Click on the Export to Visio button in the map floating menu.
Note: There is a limitation on the trial license for this feature. You can
only export a map with 50 or fewer devices to Visio.
2.4 Find Relevant Maps Instantly