netbrain integrated edition internal release notes

66
Version 10.0a | Last Updated 2021-07-08 Copyright ©2004-2021 NetBrain Technologies, Inc. All rights reserved. NetBrain ® Integrated Edition 10.0a Release Notes

Upload: others

Post on 15-Oct-2021

5 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: NetBrain Integrated Edition Internal Release Notes

Version 10.0a | Last Updated 2021-07-08 Copyright ©2004-2021 NetBrain Technologies, Inc. All rights reserved.

NetBrain® Integrated Edition 10.0a

Release Notes

Page 2: NetBrain Integrated Edition Internal Release Notes

2 | NetBrain Integrated Edition 10.0a Internal Release Notes

Contents

1. Feature Index ...................................................................................................................................................................................................... 5

2. Simply and Enhance No Code Automation Workflow ....................................................................................................................... 7

2.1. Decision Tree 2.0 ...................................................................................................................................................................................... 7

2.1.1. Use Decision Tree ........................................................................................................................................................................ 8

2.1.2. Create Guidebook .................................................................................................................................................................... 10

2.1.3. Auto Created Guidebook ...................................................................................................................................................... 11

2.2. Runbook CLI Node Enhancements ................................................................................................................................................ 12

2.2.1. Delete and Edit Commands in Batches ............................................................................................................................ 17

2.2.2. Adjust the Command Note and Result Note Layout ................................................................................................. 18

2.2.3. Define the New Parser in a Dialog ..................................................................................................................................... 18

2.2.4. Support Highlighting Device and Interface ................................................................................................................... 19

2.2.5. Support Device and Interface Notes ................................................................................................................................. 20

2.2.6. Enhance Defining Alert UI ..................................................................................................................................................... 20

2.2.7. Support Pre-Qualification for Execute CLI Commands Node ................................................................................. 21

2.2.8. Programming Bar ..................................................................................................................................................................... 22

2.3. Data View Template Enhancements .............................................................................................................................................. 23

2.3.1. Enhance Programming Capability of DVT Editor ......................................................................................................... 23

2.3.2. Map DVT Pane Enhancement .............................................................................................................................................. 26

2.4. Visual Parser Enhancements ............................................................................................................................................................ 28

2.4.1. Support Nested Paragraph and Nested Table .............................................................................................................. 28

2.4.2. Add Definition for End of Paragraph ................................................................................................................................ 30

2.4.3. Use a Unified Interface to Define Qualification ............................................................................................................ 31

3. IBA Enhancements ......................................................................................................................................................................................... 33

3.1. IBA Dashboard and Execution Tree ............................................................................................................................................... 33

3.1.1. Customize IBA Dashboard .................................................................................................................................................... 34

3.1.2. Execution Tree ........................................................................................................................................................................... 35

Page 3: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 3

3.1.3. View Alert History ..................................................................................................................................................................... 36

3.1.4. View IBA Dashboard Results from a Map ....................................................................................................................... 37

3.1.5. Build Execution Tree ................................................................................................................................................................ 38

3.2. Adaptive Monitoring Enhancements ............................................................................................................................................ 39

3.2.1. Secondary Probe Triggered by Primary/External Probe of Other Devices ........................................................ 39

3.2.2. Add Table Change Rule Check ............................................................................................................................................ 40

3.2.3. Create Test Alert ....................................................................................................................................................................... 41

3.3. Feature Intent Template (FIT) Enhancements ............................................................................................................................ 42

3.3.1. Define Network Intent directly with analysis logic in YAML .................................................................................... 42

3.3.2. Create FIG Level DVT and RBT ............................................................................................................................................. 43

3.3.3. Support to Create Guidebooks with FIT .......................................................................................................................... 43

3.3.4. DVT/Qapp/OHM Support in Runbook Template ........................................................................................................ 43

3.3.5. Other Changes and Improvements ................................................................................................................................... 44

4. Map Related Enhancements ...................................................................................................................................................................... 45

4.1. L2 Map Layout Enhancements ........................................................................................................................................................ 45

4.2. Path Enhancements ............................................................................................................................................................................. 46

4.3. Device Group Enhancements ........................................................................................................................................................... 48

5. Other Enhancements .................................................................................................................................................................................... 49

5.1. Smart CLI Enhancements: Support Jumpbox and SSO .......................................................................................................... 49

5.2. Build Execution Tree Runbook Template Enhancements ..................................................................................................... 50

5.2.1. Use Runbook Template Document as Preview of Each Node ................................................................................ 51

5.2.2. Use a Unified Interface to Define Qualification ............................................................................................................ 52

5.2.3. Support Pre-qualification for Runbook Template ....................................................................................................... 54

5.2.4. Enhance the Usability of Save As Runbook Template Dialog ................................................................................. 55

5.2.5. Improve the Runbook Trace Node UI .............................................................................................................................. 57

5.3. Overall Health Monitor Enhancements ........................................................................................................................................ 58

5.3.1. Newly Provide Built-in Overall Health View DVT ......................................................................................................... 58

5.3.2. Support Users to Customize OHM Qapp or DVT ........................................................................................................ 59

5.4. Global Search Enhancements .......................................................................................................................................................... 59

5.4.1. Fuzzy Match IP ........................................................................................................................................................................... 59

Page 4: NetBrain Integrated Edition Internal Release Notes

4 | NetBrain Integrated Edition 10.0a Internal Release Notes

5.4.2. Incident and Guidebook Search ......................................................................................................................................... 59

5.4.3. Search Site via Site Properties ............................................................................................................................................. 60

5.5. Test API Service Stub ........................................................................................................................................................................... 60

5.6. Auto Refresh Map in Incident Portal ............................................................................................................................................ 62

5.7. Service Monitor Enhancements ...................................................................................................................................................... 62

5.8. Enhance UI of Editing User Privileges ........................................................................................................................................... 63

5.9. Support More Authentication Protocol for SNMP v3 ............................................................................................................ 64

6. Performance Enhancements ...................................................................................................................................................................... 66

Page 5: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 5

1. Feature Index

NetBrain R10 rev A (IEv10.0a) introduces the following new features and enhancements:

1. simplify and enhance the no-code automation workflow:

• Decision Tree 2.0New: groups NetBrain automation assets as a flow chart within Guidebook for the reactive

map-based automation troubleshooting (all the proactive and triggered automation are moved to

Execution Tree). The Guidebook is designed to replace user’s static troubleshooting playbook, including

Data View Template, Runbook Template, and Network Intent (linked by Hypothesis) to describe a

troubleshooting process for a specific network issue. Decision Tree 2 can be auto-created from a map to

include all qualified DVT, Network Intent, and Runbook Template (against the current map devices).

• Enhancement of the programming abilities of Runbook CLI Node: create the automation such as Qapp,

DVT, and NI directly from CLI output without coding; Integrates with the Visual Parser.

• Enhancements to Data View Template (DVT): redesign GUI to define DVT to be more intuitive and

reduce the complexity; allow adding a new variable via Visual Parser; Streamline UI to apply and view

DVT.

Enhancements to Visual Parser, including Support Nested Paragraph and Nested Table, Add Definition

for End of Paragraph and Use a Unified Interface to Define Qualification.

2. Enhance the Intent-Based Automation Module:

• IBA Dashboard and Execution Tree New: the IBA dashboard summarizes the number of probes, Network

Intents, and devices with alerts for the whole or partial network (a site or a group of devices); Drill into a

device to view its execution tree, which displays all proactive automation and results; View the alert

history for the probe and NI execution.

• Enhancements to Adaptive Monitoring — allowing the secondary probe triggered by the primary probe

and external probe of other devices, adding the table change rule check and a function to create test

alerts.

• Enhancements to Feature Intent Template — supporting to define Network Intent directly with analysis

logic in YAML, create guidebooks with the FIT (at FIG level or FIT level), etc.

3. Map-Related Enhancements:

• Enhancements to L2 Map Layout.

• Enhancements to Path Related Functions, including Support Reference Map for Path and Locate Path in

Path Browser.

• Device Group Enhancements —supporting create subfolders in the root folder, rename and delete

subfolders, and move device groups between folders.

Page 6: NetBrain Integrated Edition Internal Release Notes

6 | NetBrain Integrated Edition 10.0a Internal Release Notes

4. Other Enhancements:

• Enhancements to Smart CLI —supporting SSO users to login directly, allowing users to configure

jumpbox and SSH key for direct Telnet/SSH to an IP address and test the configuration of a jumpbox.

• Enhancements to Runbook Template — using Runbook Template document as a preview of each node,

unifying interface to define Qualification, supporting pre-qualification, etc.

• Enhancements to Overall Health Monitor — newly providing built-in Overall Health View DVT and

supporting users to customize Overall Health Monitor Qapp or DVT.

• Global Search Enhancements — supporting fuzzy match IP address by default (exact full word match by

default before), supporting incident and guidebook search, and searching site via all its properties.

• Test API Sub New — supporting Test function in API stub editor.

• Auto Refresh Map in Incident Portal — supporting auto-refreshing map and its data view in Incident

Portal.

• Service Monitor Enhancements — better support the case when the disk is full.

• Enhance UI of Editing User Privileges

• Support More Authentication Protocol for SNMP v3

Page 7: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 7

2. Simply and Enhance No Code Automation Workflow

Version 10.0a take a big step forward to simplify and enhance the no-code automation workflow with the following

new feature or enhancements:

• Consolidate all reactive automation into the streamlined operation of a map and decision tree (Guidebook).

• Enhance the CLI runbook node’s programming capabilities.

• Simplify the DVT creation with the Visual Parser.

• Enhance the Visual Parser.

2.1. Decision Tree 2.0

NetBrain provides different types of automation, such as Qapp/Gapp, Runbook Template, Data View Template (DVT),

and Network Intent (NI). For a large enterprise network, thousands of automation objects can be created, and it can

be challenging to find the right automation without the deep knowledge of these objects.

IE v10.0a introduces Decision Tree 2, which groups automation assets as a flow chart within the Guidebook for

interactive map-based automation troubleshooting. The Guidebook is designed to replace the user’s static

troubleshooting playbook with the knowledge represented by various types of automation associated with a

specific Hypothesis. A guidebook has the following key components:

• Pre-qualification: define the condition of whether a network device is applicable for the Guidebook. It can be the static such as the certain device R1, and the dynamic searching criteria, such as BGP is configured.

• DVT: DVT and its recommended automation are listed under DVT.

Page 8: NetBrain Integrated Edition Internal Release Notes

8 | NetBrain Integrated Edition 10.0a Internal Release Notes

• Hypothesis and Associated Runbook Template and NI: static hypothesis and its associated Runbook Template and NI.

The main flow of network troubleshooting will be:

1. Open or create a map for an incident or other types of tasks.

2. Open the Decision Tree. All prequalified Guidebooks applicable to the devices in the map are listed.

3. Find a guidebook suitable for your task and follow the Guidebook to execute the automation.

2.1.1. Use Decision Tree

The Decision Tree provides several functions to guide the user to use automation.

1. Modify Target Device

By default, the devices in the map are used as the target devices to filter the guidebooks. You can add and

remove the target devices. If the map is modified, you can sync the devices within the map.

Page 9: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 9

2. Filter Guidebooks

The Decision Tree provides several filters to allow the user to find the automation quickly.

3. Drill Down to the Automation Details in a Guidebook

With a guidebook, you can:

• apply the Data View Template on the map.

Page 10: NetBrain Integrated Edition Internal Release Notes

10 | NetBrain Integrated Edition 10.0a Internal Release Notes

• Add the Runbook Template and Network Intent into Runbook for execution.

2.1.2. Create Guidebook

The system provides an intuitive GUI to create a guidebook easily.

• Section1: Define Guidebook name and category.

• Section2: Define pre-qualification rules.

• Section3: Add Runbook Template and Network Intent with a Hypothesis.

Page 11: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 11

• Section4: Add Data View Template. The recommended Runbook Template and Network Intent of the selected

Data View Template can also be added automatically.

To add Runbook Template or Network Intent into the Guidebook, you must add a hypothesis and a note

describing the reason along the connected line.

2.1.3. Auto Created Guidebook

The system will automatically create a guidebook when a map is opened. All Data View Template, Runbook

Template, and Network Intent will be displayed in auto-created Guidebook if the qualified devices match at least

one device in the map.

Page 12: NetBrain Integrated Edition Internal Release Notes

12 | NetBrain Integrated Edition 10.0a Internal Release Notes

2.2. Runbook CLI Node Enhancements

Runbook CLI node is a pivotal function, which serves as automation to retrieve the live data from the device without

logging in to a device and creating the different types of automation. Therefore, IEv10.0a redesign the CLI node to

improve its programming capability so that a network engineer can create many types of automation directly from

the CLI results he is familiar with no coding.

One usability issue of the earlier version is the packed space for CLI output and programming interface. Therefore,

IEv10.0a UI introduces the Command Zone and Programming Zone. Both Command Zone and Programming Zone

can be collapsed and expanded to provide more space for the programming and viewing results, and one zone can

be expanded.

Page 13: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 13

Also, IEv10.0a enhances each step of the Execute CLI Commands:

1. Enter CLI commands, retrieve data, browse the CLI output results, and compare CLI results with historical results.

The following improvements are made in this step:

• Support editing or deleting commands in batches.

• Adjust the layout of the command note and result note.

Page 14: NetBrain Integrated Edition Internal Release Notes

14 | NetBrain Integrated Edition 10.0a Internal Release Notes

2. Expand the Programming Zone and Define CLI automation, including Data View and alert. The following

enhancements are made in this step:

• Support defining highlights and notes in the Data View

Page 15: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 15

• Provide Text View and Variable View.

• Optimize the tip of the variable displayed in Text View to make the operation smoother and more

convenient.

Page 16: NetBrain Integrated Edition Internal Release Notes

16 | NetBrain Integrated Edition 10.0a Internal Release Notes

• Variable View can help solve the problem that the script parser cannot highlight in Text View.

• Support to define a new parser in a dialog instead of in a new tab to use the defined parsers after the

definition.

• Support defining notes and highlights for the device and interface.

• Optimize the alert definition.

• Display the helpful information about the programming process in the Programming Bar.

• Allow users to define device qualification here to restrict and refine the scope of the automation

executing.

3. Run defined CLI automation to troubleshoot network device issues. In this step, the automation execution is

changed from the front-end to background during repeat execution to continue after the map is closed.

4. Save as Qapp, DVT, and NI. The following improvements are made in this step:

Page 17: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 17

• All entrances of ‘Save As’ are integrated into one. The subsequent operations will be completed in the

pop-up dialog.

• Support to save as network intent.

• Provide the Add new node to the current Runbook check box for users. While enabled, save as

operation will also be the corresponding node to the current runbook.

2.2.1. Delete and Edit Commands in Batches

In the previous version, you can only delete or edit the command for one device. In IE10.0a, when deleting or modifying

a command on a device, a confirmation box will pop up, asking whether to delete (modify) the command on the device

with a check box for users to select it to delete (modify) the same command for all other devices.

Page 18: NetBrain Integrated Edition Internal Release Notes

18 | NetBrain Integrated Edition 10.0a Internal Release Notes

2.2.2. Adjust the Command Note and Result Note Layout

Command notes and result notes are displayed in two tabs. The node editing UI supports rich text. The

summary note will be synchronized to the Runbook Note pane.

2.2.3. Define the New Parser in a Dialog

In the prior version, you define a new parser in a new browser tab and refresh the CLI command node tab to see the

new parser. IE10.0a defines a new parser in a dialog instead of in a new tab. Therefore, the new parser can be used

after it is defined.

Page 19: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 19

2.2.4. Support Highlighting Device and Interface

To enhance the programming ability of the Execute CLI Commands node, IE10.0a supports highlighting devices and

interfaces on the map. In addition, users can specify the conditions (always or a certain condition).

• Definition of highlight device condition, $version is less than a certain version (to highlight the devices to be

upgraded), and the results on the map:

• Definition of highlight interface condition, the bandwidth is less than a certain number, and the results on the

map:

Page 20: NetBrain Integrated Edition Internal Release Notes

20 | NetBrain Integrated Edition 10.0a Internal Release Notes

2.2.5. Support Device and Interface Notes

To enhance the programming ability of the Execute CLI Commands node, IE10.0a supports defining device and

interface notes. Users can define the title, the content, and the conditions of the note.

• Display the AAA configurations in the device note if and only if it is configured in a device:

• Display the ACL configurations of an interface if and only if it is configured:

2.2.6. Enhance Defining Alert UI

IE 10.0a improves the display format, layout, operation details of the UI that defines alerts:

Page 21: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 21

• Provide different variable analysis operations according to different variable types.

• Optimize the definition of condition in the ‘If’ statement to be closer to the natural language.

• Support more methods for different types of variables in ‘Operation’ and expand the range of cases covered

by the alert.

The following example creates an alert if an interface MTU is larger than a certain number:

2.2.7. Support Pre-Qualification for Execute CLI Commands Node

Different vendors may have a different set of CLI commands to retrieve the same type of data. Likewise, for the same

vendor, different configurations enable or disable certain CLI commands. CLI command node does not have pre-

qualification in the prior version, so CLI commands are pushed to all devices in the map even if the commands are

not valid for all devices on the map. IEv10.0a supports defining Qualification in the Execute CLI Commands node to

refine the scope of target devices during automation execution.

Page 22: NetBrain Integrated Edition Internal Release Notes

22 | NetBrain Integrated Edition 10.0a Internal Release Notes

2.2.8. Programming Bar

IE10.0a adds a programming bar in the Programming Zone to show helpful information in defining and executing

automation:

• When there is no definition, the text will be displayed: No Data View and Alert defined. Please choose

variables in Text View or Variable View.

Page 23: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 23

• Display the defined position, note, highlight, and the total number of alerts during the definition process.

2.3. Data View Template Enhancements

2.3.1. Enhance Programming Capability of DVT Editor

Data View Template is the key feature of the map-based interactive troubleshooting flow. After creating a map, a

user’s next step is to view the related DVT and execute the recommended automation of DVT. However, in the Prior

version, creating a DVT can be a challenge,

It is hard to read and understand a DVT logic and feature only with some variable name in positions.

The flow of DVT definition is not intuitive enough from the perspective of a network engineer.

It is hard to add new variables into DVT. The user needs to switch to another UI to define the variable.

To solve these issues, IEv10.0a adds the following features in DVT Editor:

Page 24: NetBrain Integrated Edition Internal Release Notes

24 | NetBrain Integrated Edition 10.0a Internal Release Notes

1. Support automation tag.

You can associate one or multiple automation tags, such as OSPF, Multicasting, NY_DC, with a DVT. The

automation tag is used to filter DVT in the DVT pane.

2. Move supporting variable from DVT level to Branch level.

3. Integrate with Visual Parser to add a new variable.

Directly from the DVT editor UI, a user can create a new parser and define the variables by following the

Visual Parser flow. The variables defined in the new parser can be added to the DVT device and interface

positions.

4. Support adding conditions by variables to display.

Page 25: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 25

In the prior version, the data is always displayed on the map without any condition by default. In IE 10.0a, a

user can define a dynamic condition to display the variable only when a criterion is satisfied. For example,

you can define a condition as a variable that is not null so that a null variable is not displayed.

5. Support adding hyperlink to the device/interface position.

The hyperlink can be added in the device or interface position. For example, in a DVT to pull the data from

the 3rd party tool such as monitoring tool, a hyperlink can be added to point back to the specific page of 3rd

party tool.

6. Support adding Network Intent (NI) as the recommended automation.

DVT supports two levels of drill-down automation, the position level and DVT level. Network Intent can be

added in both levels.

Page 26: NetBrain Integrated Edition Internal Release Notes

26 | NetBrain Integrated Edition 10.0a Internal Release Notes

2.3.2. Map DVT Pane Enhancement

IE 10.0a makes the following enhancements on the map DVT pane:

1. Change automatically refresh to refresh manually when map devices change.

Manually Refresh

Three Types of Filters

Preview DVT

Page 27: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 27

In the previous version, the DVT pane always auto refresh when map devices change, which can cause a

potential performance issue. Therefore, in this version, a user must manually refresh the DVT pane.

2. Add three types of filters:

• Filter by Map Devices: All map devices are selected as default to filter all qualified DVTs. Users can

modify the device scope to view appropriate DVTs. For instance, view the firewall-related DVTs by

selecting the Firewall devices only.

• Filter by DVT Filter: Users can organize the DVTs by customized DVT filter. For instance, DVTs for

Security Check, DVTs for different locations.

• Filter by Automation Tag: Automation Tag is used to identifying the purpose or technology of a

DVT. For instance, OSPF, Multicasting, etc.

3. Support previewing a DVT with cached data before applying it on the map.

Before applying a DVT to map devices and viewing data on the map, users can preview a DVT by selecting a

DVT from the DVT pane to understand the purpose and feature of this DVT.

Preview DVT

Switch Device

Switch Interface

Page 28: NetBrain Integrated Edition Internal Release Notes

28 | NetBrain Integrated Edition 10.0a Internal Release Notes

2.4. Visual Parser Enhancements

Visual Parser is the foundation for NetBrain no-code automation, which processes CLI command or configurations

into programmable variables for Data View, Qapp, Network Intent, etc. It allows network engineers with no coding

background to enjoy the fun of network automation easily.

IEv10.0a adds the following enhancements for Visual Parser:

1. Support nested paragraph and nested table – Add previously defined paragraph as parent paragraph to define

multi-layer nested paragraph and nested table.

2. Add a definition for the end of the paragraph – Narrow down the scope inside each paragraph to get more

accurate results.

3. Pre-qualification for visual parser – Use unified UI to qualify parser accurately based on criteria.

2.4.1. Support Nested Paragraph and Nested Table

Visual Parser in IEv10.0a enhances the support for different CLI output formats by adding the support for nested

paragraphs and nested tables. In the previous version, only a 2-layer nested paragraph is supported with a parent line;

In IEv10.0a, multi-layer nested and nested tables are supported with parent paragraph.

In IE10.0a, the user can add previously defined paragraphs as parent paragraphs to paragraph parser and table parser.

Then variables defined in parent paragraphs can be inherited and displayed as table columns in parser result. Moreover,

since the parent paragraph can be nested paragraphs, it is possible to create multi-layer nested paragraphs and tables.

An example of creating nested paragraphs for the command ‘show policy-map interface’ is given below:

1. Define parent paragraph ‘interface’.

Page 29: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 29

2. Define paragraph ’service_policy’,

3. Click ‘Add Parent’ to add a parent paragraph

4. Select paragraph ‘interface’ as parent paragraph from the drop-down menu.

5. Define Variable Lines for paragraph ‘service_policy’. You can inherit the variables from the Parent paragraph (Interface).

When the parent paragraph is selected, the sample data will be divided into paragraphs as defined in the parent

paragraph. Thus, the sample data is first divided into two paragraphs (Paragraph 1 and Paragraph 2). Then each

paragraph is further divided into two subparagraphs as defined by ID Line A.

Page 30: NetBrain Integrated Edition Internal Release Notes

30 | NetBrain Integrated Edition 10.0a Internal Release Notes

2.4.2. Add Definition for End of Paragraph

The end of a paragraph can be defined to narrow the scope of each paragraph for more accurate results. This is

especially useful to parse the configlets in paragraph parser. The diagram below shows the order in which parser

rules are applied:

Start/End Line to define scope

ID Line A to define paragraph

End of Paragraph inside each Paragraph to define scope

Define Scope for Raw Data

Define Scope Inside Each Paragraph

Page 31: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 31

When there is no end of paragraph defined, or there are no matched lines found for the end of the paragraph, the

matching scope for variables is the whole paragraph. Single-line rules or regular expressions can be used to define

the end of a paragraph. It is not recommended to define variables at the end of the paragraph as they will not be

parsed and treated as dummy variables.

2.4.3. Use a Unified Interface to Define Qualification

IEv10.0a supports pre-qualification for accurate parser applications. In addition, a unified UI to define the pre-

qualification criteria is provided in the advanced setting of the Parser Qualification area in the Visual Parser main

user interface. It allows users to customize qualification criteria to determine qualified devices for the parser.

Variable Lines to parse variables

Page 32: NetBrain Integrated Edition Internal Release Notes

32 | NetBrain Integrated Edition 10.0a Internal Release Notes

For Visual Parser, device type can be defined both in the main UI and in advanced settings. Qualified devices must

satisfy the device type defined in the main UI and advanced settings simultaneously.

Moreover, to improve performance and facilitate expansion, the pre-qualifications of all assets are uniformly

controlled and executed in the benchmark task.

Page 33: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 33

3. IBA Enhancements

3.1. IBA Dashboard and Execution Tree

NetBrain IEv10.0 offers a powerful module, Intent-based Automation (IBA), for the proactive automation via the probe

and the triggered network intents, which can detect abnormal activities before they become major network issues.

The detailed results of IBA can be viewed in Decision Tree 1.0, and alerts from IBA are listed in Event Console. However,

the system does not provide a central place for the users to view the general statistic of IBA for the whole or partial

network. Therefore, IE v10.0a introduces IBA Dashboard to provide an overview of the network health status and

statistics from the IBA module for the entire or partial network. Also, the IBA dashboard offers the ability to further

drill down to any device to view its alert and execution details.

The IBA dashboard has four key components:

• IBA Dashboard Summary

Page 34: NetBrain Integrated Edition Internal Release Notes

34 | NetBrain Integrated Edition 10.0a Internal Release Notes

The summary section shows IBA statistics: the number of devices, the number of probes, the number of triggered

Network Intents, and the number of devices with no alerts, probe alerts, and intent alerts. In addition, users can

customize the device scope (the whole network, a site, a device group, or the devices of the current map) and the time

range.

• Alert Distribution

This portion shows the total number of probes with alerts and NIs with alerts. In addition, users can select a specific

device to view its execution details from the following two categories: devices with Network Intent alerts and devices

with probe alerts.

• Execution Tree

The execution tree shows the detailed results of probes and triggered Network Intentions for a specified device. The

results are displayed with different color codes to highlight the network parameters in abnormal states.

• Alert History of Probe and NI

This portion shows all historical alert results. In addition, users can view all alerts generated by a probe or a Network

Intent.

3.1.1. Customize IBA Dashboard

By default, the IBA dashboard demonstrates the alert results for all devices of a domain. Users can specify the device

scope by the following filter conditions:

• Search Devices: use the hostname to search for specific devices.

• All Networks (default).

• Select Sites: select one or more sites.

• Select Devices: select certain devices.

• Current Map: select devices on the current map.

By default, the alert results that occurred during the last 24 hours will be displayed. However, users can customize the

time range.

Page 35: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 35

The results will be categorized based on the alert types:

• Intent Alerts: this represents the devices with network intent alerts during the selected time range.

• Probe Alerts: this represents the devices with only probe alerts during the selected time range.

• No Alerts: this represents the devices without any active alert during the selected time range.

Click each alert type in the pie chart, and the corresponding device info will be visualized in the alert distribution table:

A user can create his default IBA dashboard view by defining the default network and default period.

3.1.2. Execution Tree

Select a device from the alert distribution table, and the execution tree will be activated to display the detail of all

probes and triggered network intents for this device in a tree structure:

Page 36: NetBrain Integrated Edition Internal Release Notes

36 | NetBrain Integrated Edition 10.0a Internal Release Notes

The automation can be triggered by the current device or related devices such as its neighbor devices. Each row starts

with the Flash Probe with its results visualized by the different color codes (red indicating that an alert was generated,

green indicating no alert, and grey meaning that the probe is not executed), followed by one or multiple Hypothesis

and the triggered Network Intents visualized by the similar color codes.

A user can click a probe or a triggered Network Intent to view its detail.

3.1.3. View Alert History

The lower pane shows the alert history of a device during the selected time range. The alerts are sorted by execution

time. The triggered network intents are listed in the same row as the flash probe triggering it.

Page 37: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 37

Click a specific probe or network intent. Only alert history of this selected automation will be displayed.

3.1.4. View IBA Dashboard Results from a Map

After creating or opening a map, a user can select the device scope of the IBA dashboard to the current map and

view the alert distribution for all devices on this map.

The alert distribution table selects a device to pin the execution tree and the map side by side.

Page 38: NetBrain Integrated Edition Internal Release Notes

38 | NetBrain Integrated Edition 10.0a Internal Release Notes

Then add an NI into the current runbook to execute the NI interactively.

3.1.5. Build Execution Tree

You can mouse over a probe from the execution tree and click the plus sign to add a network intent associated with

this probe.

Page 39: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 39

3.2. Adaptive Monitoring Enhancements

3.2.1. Secondary Probe Triggered by Primary/External Probe of Other Devices

In IE v10.0, the secondary probe can only be triggered by the primary probe of the same device. In the Revision A

release, the secondary probe can be triggered by primary probes or external probes of other devices. We can use a

simple example to illustrate why we made this improvement. A primary probe is defined to check the route summary

information. If there is any route change for the primary probe of the core device, it will trigger the execution of the

secondary probe of not only itself but also all other neighboring edge devices. This improvement saves time and effort

to set up primary probes for all these devices one by one.

Similarly, the alerts generated by the 3rd party monitoring tools can be leveraged to trigger the secondary probes of

other devices that may have neighboring/topology relationships.

Page 40: NetBrain Integrated Edition Internal Release Notes

40 | NetBrain Integrated Edition 10.0a Internal Release Notes

The following picture shows in the previous R10 version. Users will have to define the primary probe for each of these

devices.

3.2.2. Add Table Change Rule Check

IE v10.0a adds a new rule type for the table check to compare the current value with its last value. In addition, users

can select Is Changed when using the table to define the alert rule.

Page 41: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 41

Once the Is Changed rule is enabled, NetBrain will calculate the table's hash based on the parser variable compare

settings. Only the table columns selected in compare settings will be used for table comparison. Users can filter out

certain constantly changing columns.

The loop table rows function has been moved from the primary probe to the secondary probe to improve the

performance of calculating table alerts. If you want to use loop tables rows to check a table constantly, users can

define a primary probe to check the entire table to monitor the change and then trigger the secondary probe to

loop the entire table rows.

3.2.3. Create Test Alert

After setting up the probes and triggered intent, you may want to dry-run the system to test whether the network

intent can be executed as expected. In this case, you can leverage the Create Test Alert function to generate a test

alert for the current probe immediately without touching the live network. The Network Intent installed to this probe

will be executed, and you can view the results to see whether the Network Intent is executed as expected.

Page 42: NetBrain Integrated Edition Internal Release Notes

42 | NetBrain Integrated Edition 10.0a Internal Release Notes

3.3. Feature Intent Template (FIT) Enhancements

3.3.1. Define Network Intent directly with analysis logic in YAML

In IE v10.0, defining a network intent with analysis logic involves a complex set of steps, including defining a normal

network intent first and referencing the network intent from the FIT.

IE v10.0a has been improved to support defining Network Intent directly with analysis logic in YAML:

1. Define the analysis logic in the analysis_device section of the network intent YAML.

2. Import the visual parser and reference it in the YAML file.

Page 43: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 43

3.3.2. Create FIG Level DVT and RBT

In IEv10.0, both DVT and RBT can only be defined at the FIT level. In v10.0a, we have extended the support of defining

DVT and RBT at FIG Level, meaning FIG level instances can now be used to create DVT and RBT, allowing users to

create more granular features on specific devices. In addition, the variables extracted from the configlet can also be

directly applied to the automation.

3.3.3. Support to Create Guidebooks with FIT

In v10.0a, the concept of the Guidebook has been introduced to assist in building the decision tree. Users can easily

consolidate the troubleshooting know-hows into the Guidebook.

With the FIT, users can create guidebooks at either the FIG level or FIT level. The FIG-level Guidebook allows users to

create more specific network troubleshooting knowledge based on the characteristics of only several devices.

3.3.4. DVT/Qapp/OHM Support in Runbook Template

In v10.0, only defining CLI node is supported by Runbook Template. In v10.0a, we have extended the support to

DVT, Qapp, and Overall Health Monitor node, so users can easily define complex Runbook Template from the YAML

file.

Page 44: NetBrain Integrated Edition Internal Release Notes

44 | NetBrain Integrated Edition 10.0a Internal Release Notes

3.3.5. Other Changes and Improvements

Other major changes related to FIT are listed as below:

Add pre-qualification for Data View Template and Runbook Template

In v10.0a, we have added the pre-qualification function for Data View Template and Runbook Template to

qualify automation assets applied to devices. This support has also been extended to FIT.

Add Unique ID for resource update

To facilitate the resource update process, even when the FIT name is changed, we have introduced the ID to

identify the FIT file in 10.0a so that each FIT can be uniquely identified. Thus, users can now change the FIT name

at their will without worrying about losing the automation assets generated by the FIT.

Reference resources with label

To reference resources generated by the current FIT or other FITs, users can leverage the ref_label to label the

resources and reference the resources generated in the current FIT or another context, giving users the flexibility

to build hierarchy FITs instead of squeezing all automation logic into a single FIT.

Page 45: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 45

4. Map Related Enhancements

4.1. L2 Map Layout Enhancements

On an L2 map, users usually adjust the distance between links manually. However, if a new link is added, the system

automatically readjusts the distance and the position of the original links, which causes the map layout to change.

IEv10.0a resolves this issue. After extending the neighbors, the original position of devices and links and the map

layout remains unchanged.

Page 46: NetBrain Integrated Edition Internal Release Notes

46 | NetBrain Integrated Edition 10.0a Internal Release Notes

Tip windows always show up when users hover over on ports, which can be annoying. IEv10.0a provides an option for

the user to turn off the port tip.

4.2. Path Enhancements

IE v10.0a made the following enhancements on the A/B path function:

• Support Reference Map for Path

After the user maps an application path, the user may optimize the map layout, add network design notes to the

path, and even readjust the devices along the path. He may save this map as the golden path for this application for

future reference or share it with others. IEv10.0a allows a user to set a map to be a reference map for the saved

paths in the Path Browser and AAM. From the Path Browser or AAM, the user can create, change, delete, and view

the reference map for a path.

Page 47: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 47

• Locate Path in Path Browser

IE10.0a adds a function, Locate this path in path browser, in the tip of the path drawn on the map, to locate it in

the path browser.

Page 48: NetBrain Integrated Edition Internal Release Notes

48 | NetBrain Integrated Edition 10.0a Internal Release Notes

4.3. Device Group Enhancements

For a large network, users may create hundreds or even thousands of device groups. It is hard to manage so many

device groups in a flat list without the hierarchy or folder structure. IE10.0a supports organizing the device groups in

the folder structure. A user can create a subfolder in the root nodes My Device Groups, Shared Device Groups, Policy

Device Group, and any subfolder. The folder can be renamed, deleted, and moved to other folders. Users can view

the folder structures in all the features involving device groups, such as in the Select Devices dialog.

Page 49: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 49

5. Other Enhancements

5.1. Smart CLI Enhancements: Support Jumpbox and SSO

Smart CLI provides a convenient tool for a user to document and share the network troubleshooting knowledge

besides the traditional telnet/SSH functions. Usually, Smart CLI is installed on a user’s desktop, which may not directly

access the live network. IEv10.0a supports the jumpbox and SSH key for the direct connection and adds a test function

for the jumpbox. Also, it supports SSO login.

• Support Jumpbox and SSH Key for Direct Connection

When using Smart CLI to connect to users’ network devices, if jumpbox and SSH private key are used in the customer

environment, these two configurations are also required even though the Direct Connect mode is used; otherwise, it

may not be possible to log in to the corresponding devices.

IEv10.0a provides the following enhancements:

If Protocol uses SSH Public Key, IEv10.0a provides the ability to select the jumpbox and private key.

If Protocol uses SSH, IEv10.0a provides the ability to define the jumpbox and username.

If Protocol uses Telnet, IEv10.0a provides the ability to select jumpbox.

Page 50: NetBrain Integrated Edition Internal Release Notes

50 | NetBrain Integrated Edition 10.0a Internal Release Notes

• Test Jumpbox

Add a test function in the Jumpbox configuration page to ensure the correct jumpbox configuration.

• Support SSO Login in Smart CLI

The login UI is adjusted to distinguish NetBrain Account and SSO Login.

After a user enters the NetBrain IE server URL, the system will obtain all SSO Servers configured in IE. The user can

choose an SSO server to log in to Smart CLI.

5.2. Build Execution Tree Runbook Template Enhancements

IEv10.0a has improved the overall usability of the runbook as follows:

• Remove the existing preview function of each node and display the information of the runbook document

instead.

• Use a unified UI to define the pre-qualification and unify the timing and flow of calculation.

Page 51: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 51

• Support filtering runbook template based on pre-qualification in Runbook Template Manager and the

‘select runbook template’ dialog.

• Improve the UI design of ‘save as runbook template’ and allow users to modify or edit the runbook template

information, such as description and qualification devices.

5.2.1. Use Runbook Template Document as Preview of Each Node

The IEv10.0 provides a runbook template document for users to browse the primary information of the runbook

template, such as description and Qualification, and each node has its own preview UI. To display information

uniformly and drive users to learn more about runbook templates based on a document, IEv10.0a uses the document

to preview each node. The corresponding information will be highlighted when clicking on different nodes.

Page 52: NetBrain Integrated Edition Internal Release Notes

52 | NetBrain Integrated Edition 10.0a Internal Release Notes

5.2.2. Use a Unified Interface to Define Qualification

To enable users to use automation assets based on the appropriate assets acquired accurately from the devices,

IEv10.0a supports pre-qualification for most automation assets. In addition, a unified UI for defining the pre-

qualification is provided to facilitate users to learn and understand between different assets.

Page 53: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 53

Moreover, to improve performance and facilitate expansion, the pre-qualifications of all assets are uniformly

controlled and executed in the benchmark task.

Page 54: NetBrain Integrated Edition Internal Release Notes

54 | NetBrain Integrated Edition 10.0a Internal Release Notes

5.2.3. Support Pre-qualification for Runbook Template

To help users select runbook templates more relevant to the current map for use, IEv10.0a provides an option for

both Runbook Template Manager and the ‘select runbook template’ dialog to determine whether to perform

qualification filtering based on map devices.

Page 55: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 55

If users select the Show Template for Current Map check box in Runbook Template Manager or check the

Qualified Only option in the ‘select runbook template’ dialog, only the runbook templates whose qualifications

match the map devices can be displayed.

5.2.4. Enhance the Usability of Save As Runbook Template Dialog

Runbook is the primary way to generate a runbook template. In the ‘save as runbook template’ process, users need to

define or modify the primary information of qualification/description to facilitate knowledge transfer. The previous

version does not support defining or modifying such information. The following enhancements are introduced in

IEv10.0a:

• All information can be modified and edited at the Start node. Users can also define the target device

qualification of the runbook template.

Page 56: NetBrain Integrated Edition Internal Release Notes

56 | NetBrain Integrated Edition 10.0a Internal Release Notes

• All other nodes support modifying and editing the description and the target device qualification at the

node level.

Page 57: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 57

5.2.5. Improve the Runbook Trace Node UI

In the previous version, it is hard to find the traceroute function. Therefore, IE10.0a added the traceroute function at

the top bar.

Also, adjust the traceroute UI to make the Map button and the Map Traceroute Result button more visible.

Page 58: NetBrain Integrated Edition Internal Release Notes

58 | NetBrain Integrated Edition 10.0a Internal Release Notes

5.3. Overall Health Monitor Enhancements

5.3.1. Newly Provide Built-in Overall Health View DVT

For a hybrid network that contains legacy network devices, Cisco ACI network, and AWS/Azure cloud network, the

overall health monitoring metrics are very different. For example, users may want to see the tunnel data in/out in the

last 5 minutes of an AWS VPN gateway and monitor the CPU/memory utilization of a legacy router at the same time.

Since monitoring Qapp does not support different data views for different network devices, and Data View Template

can support it via multiple Data View branches, IEv10.0a provided a built-in DVT, Overall Health View, to support

monitoring hybrid network devices. However, the previous built-in OHM (Overall Health Monitoring) Qapp is still

available for legacy networks and Cisco ACI switches. Overall, Health View can be executed from the Map DVT pane,

map toolbar, context menu, and Runbook node.

Page 59: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 59

5.3.2. Support Users to Customize OHM Qapp or DVT

For different types of network devices, the SNMP MIB provided by different vendors shows a big difference. The built-

in Multi-Vendor Support may not cover the needs of a particular customer's network. Moreover, users may also have

a different device and interface metrics supported by overall health monitoring.

IEV10.0a allows users to customize the overall health monitoring themselves, whether it is OHM Qapp or OHM DVT.

A user can configure using the built-in DVT/Qapp or a customized DVT/Qapp.

5.4. Global Search Enhancements

5.4.1. Fuzzy Match IP

There are three frequently used types of search input: hostname, IP, and configuration text. The previous version

only supports fuzzy matching of the hostname by default. For example, to find IP address 10.10.10.25, the user

needs to search by "10.10.1*", not just “10.10.1”. IEv10.0a supports fuzzy matching of the IP address in interface IP,

One-IP table, and configuration file by default, so users do not need input "*" for IP addresses.

If the input format is two to four numbers separated by a dot (.), and each number is less than 255, the input will be

treated as an address. For example, searching192.168 is equal to searching 192.168*.

5.4.2. Incident and Guidebook Search

Incident and Guidebook are the key functions for the collaboration and automation process. IEv10.0a allows users to

search incident and Guidebook by their ID, name/subject, or description.

Page 60: NetBrain Integrated Edition Internal Release Notes

60 | NetBrain Integrated Edition 10.0a Internal Release Notes

5.4.3. Search Site via Site Properties

In the previous version, the site search only supports searching name, description, and the contained device

hostname. IEv10.0a allows users to search the site via more site properties, including region, location, address,

contact name, phone number, email, type, and customized properties.

5.5. Test API Service Stub

To validate if an API Service Stub definition can work as expected without a 3rd party integration environment

deployed, IE V10.0A adds the Test function in the API Service Stub interface.

Page 61: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 61

The test results are displayed on the map.

Page 62: NetBrain Integrated Edition Internal Release Notes

62 | NetBrain Integrated Edition 10.0a Internal Release Notes

5.6. Auto Refresh Map in Incident Portal

The map or its data view in the Incident Portal may change, and it is not convenient for a user to manually refresh

the data, especially when users put a map on a big screen to monitor.

To provide users with real-time data, IEv10.0 supports automatically refreshing on the incident portal. The user can

select only refresh the data view or refresh the map and data view.

5.7. Service Monitor Enhancements

IEv10.0a sends the alert via e-mail when the PostgreSQL disk usage is high. The user can disable this function.

Page 63: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 63

Another enhancement is to add the self-protection mechanism for the Front Server. When the disk is full, the Front

Server may not provide service. In addition, IEv10.0a provides the ability to automatically clear the data if the disk

usage reaches 90% until the usage drops to 80%.

5.8. Enhance UI of Editing User Privileges

For external user authentication, the user privileges can be locked or unlocked in the previous version. If the setting is

unlocked, the user can still modify the setting although the system does not use these settings.

In IEv10.0a, the form of the button switch is changed to a checkbox for better understanding. When users select the

Overwrite with External Server Settings check box, all options will be disabled, and modifications are not allowed

to avoid misunderstandings.

Page 64: NetBrain Integrated Edition Internal Release Notes

64 | NetBrain Integrated Edition 10.0a Internal Release Notes

5.9. Support More Authentication Protocol for SNMP v3

The previous version only supports MD5 and SHA for the Authentication Protocol of SNMP v3. IEv10.0a expands to

support SHA224, SHA256, SHA384, and SHA512 based on the latest protocol standards.

Authentication Protocol Encryption Protocol

MD5 DES

SHA AES

SHA224NEW AES192NEW

Page 65: NetBrain Integrated Edition Internal Release Notes

NetBrain Integrated Edition 10.0a Internal Release Notes | 65

Authentication Protocol Encryption Protocol

SHA256NEW AES256NEW

SHA384NEW N/A

SHA512NEW N/A

Page 66: NetBrain Integrated Edition Internal Release Notes

66 | NetBrain Integrated Edition 10.0a Internal Release Notes

6. Performance Enhancements

The following performance improvements have been implemented in v10.0a:

Feature Test Scenario IEv10.0 IEv10.0a

Runbook -CLI *

Execute CLI with parser on demand 19.6 seconds 10.1 seconds

Run Qapp * Execute Qapp on demand 19.8 seconds 9.2 seconds

Run DVT * Execute DVT on demand 10.7 seconds 7.6 seconds

Run Overall Health DVT with SNMP failure 2 minutes 3 seconds

Run Overall Health DVT on map Map each device data view once the single device data is ready

Map device data view until all devices’ data are ready

Run NI * Execute NI on demand 4.4 seconds 3 seconds

Schedule DVT Run Overall Health View once via scheduled DVT on 1,000 devices with 100,000+ interfaces

18 minutes 119 seconds

Public Cloud Render AWS (Account, Region and VPC) context map

7-9 seconds < 4 seconds

Render Azure (Tenant, Subscription and Location) context map

> 10 seconds < 4 seconds

Render Azure (VM) context map > 30 seconds < 4 seconds

*Note: CLI, Qapp, DVT, and NI are all manually defined and include the following commands:

• show version

• show interface

• show interfaces status