Cisco WAE 7.6.0 User Guide

NIMO Descriptions

Each NIMO has capabilities (derived from NETCONF protocol capabilities) that determine what it collects or deploys. The following table lists a description of each NIMO.

To list the capabilities of each NIMO, click the get-capabilities button (in the Expert Mode) after a NIMO is configured.

Note

If you wish to consolidate different data collections (NIMO collections) under a single network model, configure the aggregator before running any collections. For more information, see NIMO Collection Consolidation.


Collection or Capability	NIMO	Description	Prerequisite/Notes
Network Collection NIMOs
Topology Collection Using the IGP Database	topo-igp-nimo	Discovers IGP topology using login and SNMP.	This is a basic topology collection (topology NIMO). The resulting network model is used as the source network for other NIMOs.
Topology Collection Using SR-PCE	topo-bgpls-xtc-nimo	Discovers Layer 3 topology using BGP-LS via SR-PCE. It uses raw SR-PCE data as the source for the topology. Node and interface/port properties are discovered using SNMP.	SR-PCE agents must be configured before running this collection. See Configuring SR-PCE Agents Using the Expert Mode. This is a basic topology collection for networks using SR-PCE. The resulting network model is used as the source network for other NIMOs.
VPN Collection	topo-vpn-nimo	Discovers Layer 2 and Layer 3 VPN topology.	A network model with basic topology collection must exist.
BGP Peer Collection	topo-bgp-nimo	Discovers BGP peering using login and SNMP.	A network model with basic topology collection must exist.
Port, LSP, SRLG, and VPN Collection Using Configuration Parsing	cfg-parse-nimo	Discovers and parses information from router configurations in the network.	A network model with basic topology collection must exist. A Configuration Parsing agent must be configured before running this collection. See Configure the Configuration Parsing Agent Using the Expert Mode.
Multilayer (L3-L1) Collection	optical-nimo	In conjunction with other NIMOs, the final network collection discovers Layer 1 (optical) and Layer 3 topology.	There are configurations that must take place before configuring the optical-nimo. See Expert Mode—Multilayer Collection .
LSP Configuration Collection	lsp-config-nimo	Discovers LSPs using NEDs and the LSP binding SIDs via NETCONF.	A network model with basic topology collection must exist.
LSP Collection Using SNMP	lsp-snmp-nimo	Discovers LSPs using SNMP.	A network model with basic topology collection must exist.
LSP Collection Using SR-PCE	lsp-pcep-xtc-nimo	Discovers PCEP LSPs using SR-PCE.	The Topology Collection Using SR-PCE must be completed before running this collection.
Segment Routing Traffic Matrix Collection	sr-traffic-matrix-nimo	Discovers SR LSP traffic information.	A network model with basic topology collection must exist. Telemetry must be set up on the router.
NIMO Collection Consolidation	—	Aggregates various NIMO information into a single consolidated network model.	Configured network models with information you want to merge into one final network model.
Merge AS Plan Files	inter-as-nimo	Plan files from different Autonomous Systems (AS) can be merged using the inter-as-nimo. The inter-as-nimo resolves any conflicts across the plan files. Plan files in native format are also supported.	Confirm that collection has been completed on the individual AS network models that you want to merge. Any AS network models that use the topo-bgpls-xtc NIMO must each have an Autonomous System Number (ASN) assigned to it.
Additional NIMOs

Traffic Collection	traffic-poll-nimo	Collects traffic statistics (interface measurements) using SNMP polling.	A network model with basic topology collection. If collecting LSP traffic, a network model with LSP collection must exist. See LSP Collection Using SNMP. If collecting VPN traffic, a network model with VPN collection must exist. See VPN Collection.
Network Model Layout (Visualization)	layout-nimo	Adds layout properties to a source model to improve visualization.	A consolidated network model. After the layout-nimo is configured, a plan file containing layout properties must be imported back into the layout-nimo model.
Running External Scripts Against a Network Model	external-executable- nimo	Runs customized scripts to append additional data to a source network model.	A source network model and a custom script.

Basic Topology Collection

The network model resulting from basic topology collections (topology NIMOs) is used as the source network for additional data collections. To consolidate topology and other data collections, you must first set up the aggregator before running any collection. For more information on the aggregator, see NIMO Collection Consolidation.

Topology Collection Using the IGP Database

The IGP topology (topo-igp-nimo) discovers network topology using the IGP database with the collection of node properties and interface and port discovery using SNMP. This is typically the first NIMO that is configured before other NIMOs, because it provides the basic data collection needed. This NIMO provides full topology discovery. Collection of multi instances of OSPF and ISIS is also supported. All links collected from routers will have an associated IGP process ID.

The network model resulting from this topology discovery is used as the source network for additional collections. It provides the core node, circuit, and interface information used by other NIMOs.

Note

It is assumed that you are in the middle of creating a network model when performing the tasks described in this topic. For more information, see Create a Network Model.
Although this topic shows how to use the Expert Mode for configuration, it can be referred to for configuring options using the WAE UI or WAE CLI.

Before you begin

Device and network access profiles must be configured. See Configure Network Access.

Procedure

Step 1	Choose topo-igp-nimo as the NIMO type.
Step 2	Choose a network access profile.
Step 3	From the collect-interfaces field, choose true to discover the full network topology.
Step 4	Click the igp-config tab to configure seed routers.
Step 5	Click the plus (+) sign to add an IGP.
Step 6	Click Add and enter an index number. Enter the management IP address of the seed router. Select the IGP protocol that is running on the network. (Optional) Click the advanced tab to configure additional parameters for that IGP configuration. Hover the mouse pointer over fields to view descriptions.
Step 7	(Optional) To add more IGP configurations, navigate back to the igp-config tab and repeat the previous step for each IGP index.
Step 8	(Optional) To exclude or include individual nodes from collection, click the node-filter tab and select the node filter. If you have not defined the node-filter, see Configure the Node Filter using Cisco WAE UI
Step 9	Expert users can click the advanced tab for more options. Hover the mouse pointer over fields to view option descriptions.
Step 10	Click the Commit button.
Step 11	Click run-collection > Invoke run-collection.
Step 12	To verify that the collection ran successfully, navigate back to the network (/wae:networks/network/`<network-name>`) and click the model tab.
Step 13	Click nodes. A list of nodes and details appears, indicating a successful collection.

What to do next

Use this network model as the source network to configure additional collections. See NIMO Descriptions.

Topology Collection Using SR-PCE

Table 1. Feature History
Feature	Release Information	Description
Enhanced Model Updates Based on SR-PCE Notifications	Cisco WAE Release 7.6.0	The topo-bgpls-xtc-nimo is now enhanced to capture network updates for any changes in IGP-metric, Delay and Node Overload.

The topo-bgpls-xtc-nimo discovers Layer 3 topology using BGP-LS via SR-PCE. It uses raw SR-PCE data as the source for topology. Node and interface/port properties are discovered using SNMP. For testing purposes, you can also use BGPLS SR-PCE topology discovery using SR-PCE only (extended-topology-discovery disabled) when no SNMP access is available. The network model resulting from topology discovery is used as the source network for additional collections because it provides the core node/circuit/interface information used by other NIMOs.

The topo-bgpls-xtc-nimo also captures network updates for any changes in IGP-metric, Delay and Node Overload.

The topo-bgpls-xtc-nimo will populate the FlexAlgoAffinities, FlexAlgorithms, SRv6NodeSIDs, SRv6InterfaceSIDs, NodePrefixLoopbacks, and NodeSIDPrefixLoopbacks tables. It will not populate the table SRv6NodeSIDPrefixLoopbacks as the loopback address associated with SRv6 is not obtained using SR PCE.

Note

The default, the ISIS level is set to level2 for NodePrefixLoopbacks. The same will also be populated for an OSPF network.

WAE is not reflecting the update of non-null to null value in the flexalgo columns. The values will start reflecting after a dare re-sync.

The IPv4 metric value is populated in IGP metric table and the Ipv6 value is populated in IPv6-IGP metric table. The TE metric values will also be updated similarly.

The topo-bgpls-xtc-nimo reads the LocalDomainIndentifier column of NetIntXtcLinks and populate the IGP Process ID of Interfaces table.

BGPLS SR-PCE topology discovery using SR-PCE only (extended-topology-discovery disabled) is used as a source for only some NIMOs because it does not collect the necessary information needed by most NIMOs.

Before you begin

Device access and network access must be configured. For more information, see Configure Device Access Using the Expert Mode and Configure Network Access.
An SR-PCE agent must be configured and running. For more information, see Configuring SR-PCE Agents Using the Expert Mode.

Procedure

Step 1

From the Expert Mode, in Configuration editor, navigate to /wae:networks.

Step 2

Click the plus (+) sign and enter a network model name. We recommend a unique name that contains the NIMO name; for example, networkABC_bgpls_xtc.

Step 3

Click Add.

Step 4

Click the nimo tab.

Step 5

From the Choice - nimo-type drop-down list, choose topo-bgpls-xtc-nimo.

Step 6

Enter the following information:

network-access—Choose the network access.
xtc-host—Choose an SR-PCE agent.
backup-xtc-host—Choose a backup SR-PCE agent. You can enter the same SR-PCE agent if you do not have a backup.
asn—Enter 0 to collect information from all autonomous systems in the network, or enter the autonomous system number (ASN) to collect information only from a particular ASN. For example, if the SR-PCE agent has visibility to ASN 64010 and ASN 64020, enter 64020 to collect information only from ASN 64020. You must enter an ASN if you plan to use the as-merger NIMO to consolidate different AS models into one network model.
igp-protocol—Choose the IGP protocol that is running on the network.
extended-topology-discovery—Choose true to discover the full network topology (node and interfaces).

Note

For more information on advanced options, see BGP-LS XTC Advanced Options. From the WAE UI, you can also hover your mouse over each field to view tooltips.

Step 7

Click reactive-network tab to subscribe to notifications from SR-PCE to update Node/Link addition or deletion. Enter the following information:

enable—Select true to enable notifications from SR-PCE to update Node/Link addition or deletion.
enable-triggering-collection—Select true to collect topology collection on new topology additions.
trigger-debounce-time—Set the time to wait for last trigger notification before triggering topology collection.

Step 8

Click the Commit button.

Step 9

Click run-xtc-collection > Invoke run-collection.

Step 10

To verify that the collection ran successfully, navigate to back to the network (/wae:networks/network/<network-name>) and click the model tab.

Step 11

Click nodes. A list of nodes and details appears, indicating a successful collection.

Example

For example, if using the WAE CLI (in config mode), enter:


# networks network <network-model-name> nimo topo-bgpls-xtc-nimo network-access <network-access-ID>
# networks network <network-model-name> nimo topo-bgpls-xtc-nimo xtc-host <XTC-agent>
# networks network <network-model-name> nimo topo-bgpls-xtc-nimo backup-xtc-host <XTC-agent-backup>
# networks network <network-model-name> nimo topo-bgpls-xtc-nimo asn <ASN-number>
# networks network <network-model-name> nimo topo-bgpls-xtc-nimo igp-protocol <IGP-protocol-type>
# networks network <network-model-name> nimo topo-bgpls-xtc-nimo extended-topology-discovery <true-or-false>

What to do next

After performing this task, you can use this network model as the source network to configure additional collections. For more information, see NIMO Descriptions.

BGP-LS XTC Advanced Options

This topic describes advanced options available when running BGP-LS topology collection using SR-PCE.


Option	Description
nodes
remove-node-suffix	Remove node suffixes from node names if the node contains this suffix. For example, 'company.net' removes the domain name for the network.
nodes \| interfaces
net-recorder	If set to 'record', SNMP messages to and from the live network are recorded in the net-record-file as discovery runs. Used for debugging.
net-record-file	Directory in which to save the SNMP record. Used for debugging.
interfaces
find-parallel-links	Find parallel links that aren't in the IGP database (when IS-IS TE extensions aren't enabled).
ip-guessing	Level of IP address guessing to perform for interfaces that are not present in the topology database. (Used when IS-IS TE extensions aren't enabled.) off—Perform no guessing. safe—Choose guesses that have no ambiguity. full—Make best-guess decisions when there is ambiguity.
lag	Enable LAG discovery of port members.
lag-port-match	Determine how to match local and remote ports in port circuits. exact—Match based on LACP. none—Do not create port circuits. guess—Create port circuits to match as many ports as possible. complete—Match based on LACP first, and then try to match as many as possible.
cleanup-circuits	Remove circuits that don't have IP addresses associated to interfaces. Circuit removal is sometimes required with IS-IS databases to fix IS-IS advertising inconsistencies.
copy-descriptions	Copy physical interface descriptions to logical interfaces if there is only one logical interface and its description is blank.
get-physical-ports	Collect L3 physical ports for Cisco. Collect physical ports if there is an L1 connection underneath.
min-prefix-length	Minimum prefix length to allow when finding parallel links. All interfaces with equal or larger prefix lengths (but less than 32) are considered.
min-guess-prefix-length	Minimum IP guessing prefix length. All interfaces with equal or larger prefix lengths are considered.

NIMO Collection Consolidation

The aggregator uses the Delta Aggregation Rules Engine (DARE) to combine user-specified NIMOs into a single consolidated network model. The aggregator reads the capabilities of source NIMOs. For more information on aggregator functions, see Network Models.

Note

For networks using SR-PCE, you can get automated network updates to obtain real-time network models that can be used for automation applications. For more information, see Automation Applications.
Adding multiple networks of same nimo type under an aggregator is not supported. If the external executable nimo is configured, nimo type must specified under aggregator/sources/source/nimo.
resync-aggregator-net does a fresh aggregatioiin of all the NIMO and populates the DARE and SAGE network afresh. reset-final-network only populates the SAGE network afresh.

Before you begin

Configure NIMOs that you want to include in the final network model.
It is important not to run a collection or execute these NIMOs until after the initial configuration. If collection is run before configuring DARE, then the DARE network should be rebuilt from scratch (/wae:wae/components/aggregators/aggregator <network_name> and click resync-aggregator-net.
Configuration of NIMO aggregation is simplified when using the Network Model Composer. For more information, see Use the Network Model Composer and Consolidate NIMO Collections Using the Network Model Composer topics.

Procedure

Step 1

Create an empty network. This will be the final consolidated network model. From the Expert Mode, in Configuration editor, navigate to /wae:networks, click the plus (+) sign, and enter a final network model name.

Step 2

Navigate to /wae:wae/components/aggregators and select the aggregator tab.

Step 3

Click the plus (+) sign.

Step 4

From the drop-down destination list, select the final network and click Add.

Step 5

Click the source link.

Step 6

Click the plus (+) sign to add source NIMOs and enter the following information:

nimo—Enter NIMO type.
direct-source—If set to false, changes to this model will not be aggregated into the final model. By default, this is set to true.
filter-capabilities—Sets whether or not the capability filter is applied before aggregation. If set to false, all changes will be included for aggregation. For example, the external-executable-nimo does not expose capabilities so this field would be set to false.

Note

Configure sr-traffic-matrix-nimo for Bandwidth on Demand and Bandwidth Optimization. See Segment Routing Traffic Matrix Collection.

Step 7

(Optional) Continue to add all source NIMOs you want to consolidate collections for under the final network model.

Step 8

(Optional) To configure aging parameters, navigate to /wae:wae/components/aggregators and click the aging tab.

aging-enabled— Select true to enable aging.
l3-node-aging-duration—Enter the time duration for which an L3 node must be kept in the network after it becomes inactive.
l3-port-aging-duration—Enter the time duration for which an L3 port must be kept in the network after it becomes inactive.

l3-circuit-aging-duration—Enter the time duration for which an L3 circuit must be kept in the network after it becomes inactive.

Note

The time duration for l3-node-aging-duration must be greater than l3-port-aging-duration which in turn must be greater than l3-circuit-aging-duration.

l1-node-aging-duration—Enter the time duration for which an L1 node must be kept in the network after it becomes inactive.
l1-port-aging-duration—Enter the time duration for which an L1 port must be kept in the network after it becomes inactive.

l1-link-aging-duration—Enter the time duration for which an L1 link must be kept in the network after it becomes inactive.

Note

The time duration for l1-node-aging-duration must be greater than l1-port-aging-duration which in turn must be greater than l1-link-aging-duration.

Step 9

Click the Commit button.

Step 10

Run the source NIMOs. The final network model will update with the latest information from the source network models. See also Aggregator and Multilayer Collection Configuration Example.

Example

If using the WAE CLI (in config mode), enter:


# wae components aggregators aggregator <final-network-model>
# sources source <nimo_1>
# sources source <nimo_2>
# dependencies dependency <demands-network>
# dependencies dependency <inventory-network>
# dependencies dependency <layout-network>
# dependencies dependency <traffic-network>
# final-network <sage-network>
# commit

After the aggregator is configured, then run the source NIMOs.

Aggregator and Multilayer Collection Configuration Example

This example shows how to configure the aggregator to combine Layer 3 and Layer 1 network model information using the CLI.

The following shows that L1 (optical) and L3 (topo-igp-nimo) network models have been configured on the network. For more information on how to configure the optical NIMO and topo-igp-nimo, see the following topics: Topology Collection Using the IGP Database, Configure Multilayer Collection Using the EPN-M Agent.

Layer 1 network model:


networks network l1-network
    nimo optical-nimo source-network l3-network
    nimo optical-nimo network-access cisco_access
    nimo optical-nimo optical-agents cisco_network
        advanced use-configure-l3-l1-mapping true
        advanced l3-l1-mapping    bg1_mapping
    !

Layer 3 network model:


    
networks network l3-network
    nimo topo-igp-nimo network-access bgl-lab-access
    nimo topo-igp-nimo igp-config 1
    seed-router 10.225.120.61
    igp-protocol isis
    !
    nimo topo-igp-nimo collect-interfaces true    
    nimo topo-igp-nimo advanced interfaces lag true
    !

Note

Collection has not yet been done on the configured L1 and L3 network models.

Configure the aggregator.

# config
# wae components aggregators aggregator l1-l3-final-model
# sources source l1-network
# sources source l3-network
# dependencies dependency dmd-network
# dependencies dependency inv-network
# dependencies dependency lyt-network
# dependencies dependency traffic-network
# final-network sage-1
# commit

After the aggregator is configured, run the L3 and L1 collections.

# networks network l3-network nimo topo-igp-nimo run-collection

Run the L1 network collection.

# networks network l1-network nimo optical-nimo build-optical-topology

Open WAE Design to view the final network model (File > Open from > WAE Automation Server and select the final network model to verify data collection.

Segment Routing Traffic Matrix Collection

Segment Routing (SR) Traffic Collection (sr-traffic-matrix-nimo) discovers SR traffic. This NIMO enables the generation of demands between external interfaces of a network from collected telemetry data.

Before you begin

A basic topology network model must exist. See Topology Collection Using the IGP Database or Topology Collection Using SR-PCE.
Telemetry must be configured. See the Configure Telemetry in WAE topic.

Procedure

Step 1

From the Expert Mode, in Configuration editor, navigate to /wae:networks.

Step 2

Click the plus (+) sign and enter a network model name. We recommend a unique name that contains the source network and NIMO names; for example, networkABC_sr_traffic_matrix.

Step 3

Click Add.

Step 4

Click the nimo tab.

Step 5

From the Choice - nimo-type drop-down list, choose sr-traffic-matrix-nimo.

Step 6

Click sr-traffic-matrix-nimo and enter the source network, collection period.

Note

The source network must be an aggregated network with all LSP data in it if LSP demands are to be generated.

Step 7

Click the Commit button.

Step 8

Click run-collection > Invoke run-collection.

Example

If using the WAE CLI (in config mode), enter:


# networks network <network-model-name> nimo sr-traffic-matrix-nimo source-network <source-network>

# networks network <network-model-name> nimo sr-traffic-matrix-nimo run-collection
# commit

VPN Collection

The VPN Collection (topo-vpn-nimo) discovers Layer 2 and Layer 3 VPN topology.

Note

Currently, only P2P-VPWS xconnect discovery is supported for Layer 2 VPN.

Before you begin

Network topology collection must be complete. For more information, see Create a Network Model.

Procedure

Step 1	From the Expert Mode, in Configuration editor, navigate to /wae:networks.
Step 2	Click the plus (+) sign and enter a network model name. We recommend a unique name that contains the source network and NIMO names; for example, networkABC_vpn.
Step 3	Click Add.
Step 4	Click the nimo tab.
Step 5	From the Choice - nimo-type drop-down list, choose topo-vpn-nimo.
Step 6	Click topo-vpn-nimo and enter the following: source-network—Choose the applicable network model that contains basic topology information. network-access—Choose the network access.
Step 7	Click the vpn-types tab.
Step 8	Click the plus (+) icon to add at least one VPN type: VPWS—Add this type when Virtual Private Wire Service is being used in the network. L3VPN—Add this type when Layer 3 VPN is being used in the network.
Step 9	Click the Commit button.
Step 10	Navigate back to the topo-vpn-nimo tab and click run-collection > Invoke run-collection.

LSP Configuration Collection

LSP configuration information in the network is collected using the LSP Configuration NIMO (lsp-config-nimo) and the LSP NSO Agent (cisco-wae-nso-agent). The LSP NSO Agent manages interactions between NSO instances, retrieves LSP information, and converts it into a WAE network model representation.

The LSP NSO Agent also keeps a history and diagnostic files of network models in <wae_run_directory>/packages/cisco-wae-nso-agent/res/files:

merged-full.xml – Contains data collected on the most recent network model.
merged-full-last.xml – Contains data collected on the previous network model.
patch.xml - Contains only the content differences (delta) from the previous network model to the most recent network model.
filtered_<network_name>.xml – Contains a filtered version of the merged-full.xml using only nodes from the specified network <network_name>.
Temporary diagnostic files from the last NETCONF query:
- nso_config_address_last.xml
- nso_config_explicit_path_last.xml
- nso_config_segment-list.last.xml
- nso_config_tunnels_last.xml

Before you begin

A basic topology network model must exist. For more information, see Basic Topology Collection.

Procedure

Step 1

From the WAE CLI, configure NSO instances so that the LSP NSO Agent knows where to collect from under wae/agents/nso-agent/nso-servers.

admin@wae# config
Entering configuration mode terminal
admin@wae(config)# wae agents nso-agent nso-servers <NSO_instance_name> host <host_ip_address> port <netconf_ssh_port> user <user> password <password>
admin@wae(config)# commit

The following fields must be configured:

NSO instance name—This can be any unique string identifier for the NSO instance.
host—The NSO instance IP address or hostname.
port—The NETCONF SSH port that the NSO instance uses. This is found in netconf-north-bound/transport/ssh/port/ncs.conf. The default value is 2022.
user—The NSO user that is authorized to access the NETCONF API. The default user is "admin".
password—The NSO user password.

Step 2

Collect LSP information from the NSO instances.

admin@wae# wae agents nso-agent get-config-netconf

Note

Typically, this should be a scheduled task to periodically collect LSP information.

Step 3

From the Expert Mode, in Configuration editor, navigate to /wae:networks.

Step 4

Click the plus (+) sign and enter a network model name. We recommend a unique name that contains the source network and NIMO names; for example, networkABC_lsp_config.

Step 5

Click Add.

Step 6

Click the nimo tab.

Step 7

From the Choice - nimo-type drop-down list, choose lsp-config-nimo.

Step 8

Click lsp-config-nimo and enter the source topology network.

Note

The lsp-config-nimo must follow a topology NIMO. For example, you cannot choose a layout network (layout-nimo) as the source network.

Step 9

Click the Commit button.

Step 10

Click run-collection > Invoke run-collection.

LSP Collection Using SR-PCE

LSP discovery using SR-PCE (lsp-pcep-xtc-nimo) uses the data collected from the bgpls-xtc-nimo and appends LSP information, thus creating a new network model.

Before you begin

Confirm that BGP-LS topology collection using SR-PCE (bgpls-xtc-nimo) has been completed for a network. You will need to use this model as the source network for collecting LSPs. For more information, see Topology Collection Using SR-PCE.

Procedure

Step 1	From the Expert Mode, in Configuration editor, navigate to /wae:networks.
Step 2	Click the plus (+) sign and enter a network model name. We recommend a unique name that contains the source network and NIMO names; for example, `networkABC_lsp_pcep_xtc`.
Step 3	Click Add.
Step 4	Click the nimo tab.
Step 5	From the Choice - nimo-type drop-down list, choose lsp-pcep-xtc-nimo.
Step 6	Click lsp-pcep-xtc-nimo and enter the source network. This is the network model that contains topology information collected using the bgpls-xtc-nimo.
Step 7	Click the xtc-hosts tab.
Step 8	Click the plus (+) icon and enter the following: name—Enter an SR-PCE hostname. This can be any arbitrary name. xtc-host—From the drop-down list, choose one of the SR-PCE hosts that was previously configured. For more information, see Configuring SR-PCE Agents Using the Expert Mode.
Step 9	Click reactive-network tab to subscribe to notifications from SR-PCE to update LSPs based on addition or deletion. Enter the following information: enable—Select true to enable notifications to modify network topology. enable-triggering-index-collection—Select true to trigger collection of tunnel indexes, through SNMP, on new tunnels. trigger-debounce-time—Set the time to wait for last trigger notification before triggering tunnel index collection. network-access—Enter the network access profile for the network. connect-timeout—Enter timeout in minutes. verbosity—Enter the log verbosity level. net-recorder—Select the SNMP record action. Default is off. net-record-file—Enter SNMP record filename.
Step 10	Click the Commit button.
Step 11	Click run-xtc-collection > Invoke run-collection.
Step 12	To verify that the collection ran successfully, navigate to back to the network (/wae:networks/network/`<network-name>`) and click the model tab.
Step 13	Click nodes. A list of nodes and details appears, indicating a successful collection.
Step 14	Choose one of the nodes that you know has an LSP and click the lsps tab.
Step 15	Click the lsp link. A table with a list of discovered LSPs appears.

Port, LSP, SRLG, and VPN Collection Using Configuration Parsing

This topic covers the cfg-parse-nimo NIMO.

Note

cfg-parse-nimo NIMO is not a base topology collector. It must only be used to augment details missing from other methods of collection like SNMP and SR-PCE.

Before you begin

A topology network model must exist. See Create a Network Model.
The Configuration Parsing agent must be configured and running. For more information, see Configure the Configuration Parsing Agent Using the Expert Mode.

Procedure

Step 1

From the Expert Mode, in Configuration editor, navigate to /wae:networks.

Step 2

Click the plus (+) sign and enter a network model name. We recommend a unique name that contains the source network and NIMO names; for example, networkABC_port-cfg-parse.

Step 3

Click Add.

Step 4

Click the nimo tab and choose cfg-parse-nimo as the NIMO type.

Step 5

Click NIMO link and enter the following information:

source-network—Choose the applicable network model that contains topology information.
source—Choose between cfg-parse-agent or directory. If you have used cfg-parse-agent to get the configs select cfg-parse-agent option, and then choose a configuration parse agent. Else, if you have the configs in a directory, select directory option and enter the directory where the configurations are stored

Step 6

Click the parse tab.

Step 7

Enter configuration parse values. To view field descriptions, hover the mouse pointer over the field name. More information on some of the fields are described below:

igp-protocol—Choose which interfaces are part of the topology: IS-IS and/or OSPF-enabled interfaces. The default is ISIS.
ospf-area—The agent can read information for single or multiple areas. The ospf-area option specifies the area ID or all. The default is area 0.
isis level—The agent can read IS-IS Level 1, Level 2, or both Level 1 and Level 2 metrics. If both are selected, the agent combines both levels into a single network. Level 2 metrics take precedence.
asn—ASN is ignored by default. However, for networks that span multiple BGP ASNs, use this option to read information from more than one IGP process ID or instance ID in an ASN.

Click include-object to add collection types: lag, srlg, rsvp, vpn, frr, sr_lsps, lmp, and sr_policies.

Note

l2vpn config parse is not supported.
When l3vpn information is collected by cfg-parse NIMO, it is assumed that all VPNs are connected to each other.
If cfg-parse NIMO is collecting VPN information and topo-vpn NIMO is also being run, make sure that topo-vpn NIMO is before cfg-parse NIMO in the NIMO chain.
Single ended SRLGs with other end missing will be collected via SR-PCE. SRLGSCircuits table is not updated for the same though.

Step 8

Click the Commit button.

Step 9

Click run-collection > Invoke run-collection.

What to do next

After performing this task, you can use this network model as a source network to configure additional collections. For more information, see NIMO Descriptions.

BGP Peer Collection

The topo-bgp-nimo discovers BGP topology via SNMP and login. It uses a topology network (typically an IGP topology collection model) as its source network and adds BGP links to external ASN nodes.

Before you begin

A topology network model must exist. See Create a Network Model.

Procedure

Step 1	From the Expert Mode, in Configuration editor, navigate to /wae:networks.
Step 2	Click the plus (+) sign and enter a network model name. We recommend a unique name that contains the source network and NIMO names; for example, networkABC_topo_bgp.
Step 3	Click Add.
Step 4	Click the nimo tab.
Step 5	From the Choice - nimo-type drop-down list, choose topo-bgp-nimo.
Step 6	Click topo-bgp-nimo and enter the following information: source-network—Choose the applicable network model that contains basic topology information. network-access—Choose a network access profile that was previously configured. min-prefix-length—(Optional) Enter the min-prefix-length to control how restrictive IPv4 subnet matching is in discovering interfaces as BGP links. min-IPv6-prefix-length—(Optional) Enter the min-IPv6-prefix-length to control how restrictive IPv6 subnet matching is in discovering interfaces as BGP links. login-multi-hop—(Optional) Choose whether to disable login-multihop if you do not want to log in to routers that potentially contain multihop peers. For more information on advanced options, see BGP Topology Advanced Options.
Step 7	Click the peer-protocol tab and select the type of peer discovery to be used. Choose between IPv4, IPv6 or both.
Step 8	Click the Commit button.
Step 9	Click run-collection > Invoke run-collection.

BGP Topology Advanced Options

This topic describes advanced options available when running BGP topology collection.

Option

Description

force-login-platform

Override platform detect and use the specified platform. Valid values: cisco, juniper, alu, huawei.

fallback-login-platform

Fallback vendor in case platform detection fails. Valid values: cisco, juniper, alu, huawei.

try-send-enable

When logging in to a router, send an enable password if the platform type is not detected. This action has the same behavior as '-fallback-login-platform cisco'.

internal-asns

Specify internal ASNs. If used, the specified ASNs are set to internal; all others are set to external. The default is to use what is discovered.

Note: This option is available only in WAE CLI.

asn-include

Specify external ASNs of interest. If specified, BGP peer discovery from the source network is restricted to the listed external ASNs. If no asn-include is configured, topo-bgp-nimo will discover BGP peers with all external ASNs from the current source network.

Note: This option is available only in WAE CLI. You can configure multiple ASNs as comma separated values. For example:

admin@wae(config)#networks network TOPO-BGP nimo topo-bgp-nimo 
advanced asn-include 1111,2222

find-internal-asn-links

Find links between two or more internal ASNs. Normally this action is not required because IGP discovers these links.

find-non-ip-exit-interface

Search for exit interfaces that are not represented as next-hop IP addresses, but rather as interfaces (which are rare).

Note

This action increases the amount of SNMP requests for BGP discovery, which affects performance.

find-internal-exit-interfaces

Collect exit interfaces to internal ASNs.

get-mac-address

Collect source MAC addresses of BGP peers connected to an Internet Exchange public peering switch. This action is required only for MAC accounting.

use-dns

Whether to use DNS to resolve BGP IP addresses.

force-check-all

Check all routers even if there is no indication of potential multi-hop peers. This action could be slow.

net-recorder

If set to 'record', SNMP messages to and from the live network are recorded in the net-record-file as discovery runs. Used for debugging.

net-record-file

Directory in which to save the SNMP record. Used for debugging.

login-record-mode

Record the discovery process.

If set to 'record', messages to and from the live network are recorded in the login-record-dir as the tool runs. Used for debugging.

login-record-dir

Directory in which to save the login record. Used for debugging.

LSP Collection Using SNMP

The lsp-snmp-nimo discovers LSP information using SNMP.

Before you begin

A basic topology network model must exist. See Basic Topology Collection.

Note

Nokia devices are not enabled for LSP stats collection using SNMP by default. They must be enabled for successful collection. Please consult a Nokia representative to enable this option.

Procedure

Step 1	From the Expert Mode, in Configuration editor, navigate to /wae:networks.
Step 2	Click the plus (+) sign and enter a network model name. We recommend a unique name that contains the source network and NIMO names; for example, networkABC_lsp_config.
Step 3	Click Add.
Step 4	Click the nimo tab.
Step 5	From the Choice - nimo-type drop-down list, choose lsp-snmp-nimo.
Step 6	Click lsp-snmp-nimo and enter the following: source-network—Choose the applicable network model that contains basic topology information. network-access—Choose a network access profile that was previously configured. get-frr-lsps—Choose true if you want to discover Multiprotocol Label Switching (MPLS) Fast Reroute (FRR) LSP (backup and bypass) information.
Step 7	Click the Commit button.
Step 8	Click run-collection > Invoke run-collection.

Inventory Collection

The Inventory Collection (inventory-nimo) collects hardware inventory information.

Collected Hardware

The get_inventory tool creates a series of NetIntHardware* tables that store the collected hardware information based on hardware type. While these tables are not directly usable by WAE Live, four of them are processed by build_inventory for use in WAE Live. Each of the following objects are defined by node IP address and SNMP ID.

NetIntHardwareChassis—Router chassis objects identified by node IP address and SNMP ID.
NetIntHardwareContainer—Each entry represents a slot in a router (anything that can have a field replaceable unit (FRU) type device installed into it). Examples include chassis slots, module slots, and port slots.
NetIntHardwareModule—Hardware devices that can be installed into other hardware devices. Generally, these devices directly support traffic such as linecards, modules, and route processors, and do not fall into one of the other function-specific hardware tables.
NetIntHardwarePort—Physical ports on the router.

Hardware Hierarchy

The hardware has a parent-child relationship based on where the object resides within the router. The chassis has no parent and is considered the root object . Other than the chassis, each object has one parent and can have one or more child objects. Objects with no children are called leaf objects , such as ports and empty containers. This hierarchy generally reflects how hardware objects are installed within other objects. For instance, a module representing a linecard might have a parent object that is a container representing a slot.

The parent is identifiable in the NetIntHardware* tables by the ParentTable and ParentId columns. Using these two columns along with the Node (node IP address) column, you can find the parent object for any hardware object.

Example: This NetIntHardwareContainer entry identifies that container 172.23.123.456 has a chassis as a parent. In the NetIntHardwareChassis, there is an SnmpID entry that matches the container’s ParentId of 2512347.


NetIntHardwareContainer
Node	SnmpID	ParentID	Model	Name	NumChildren	ParentTable	SlotNumber
172.23.123.456	2503733	2512347		slot mau 0/0/0/5	0	NetIntHardwareChassis	0

Tracing the hierarchy from each leaf object to its corresponding root object based on the parent-child relationships results in a series of object types that form its hardware hierarchy. It is this trace that the build_inventory tool uses to determine how to process the hardware devices. This is also the process you must use if adding an entry to the HWInventoryTemplates table.

Example: Chassis-Container-Module-Module-Container-Port

Tables for Processing Inventory

The build_inventory tool constructs the NetIntNodeInventory table by processing the NetIntHardware* tables. The tool requires two configuration files and can additionally use an optional one. If not specified, the files included in the <run_directory>/packages/cisco-wae-inventory-nimo/priv/etc/inventory are used.

master_inventory_templates.txt (required)—This file contains these tables.
- HWInventoryTemplates entries categorize the devices in the final NetIntNodeInventory table, as well as prune from inclusion.
- HWNameFormatRules entries format hardware object names to make them more usable, as well as correct unexpected SNMP results.

master_exclude_list.txt (required)—Contains the ExcludeHWList table that prevents (blocked lists) hardware objects from being included in the final NetIntNodeInventory table. This can be useful when for excluding hardware that does not forward or carry traffic.
master_hw_spec.txt (optional)—Contains the HardwareSpec table that can be used to adjust collected data in terms of the number of slots in a specified device when the slots returned by SNMP is inaccurate.

If you modify the template or choose to exclude files, you will want these changes to persist across software upgrades.

Configure Hardware Templates

The build_inventory -template-file option calls a file containing both the HWInventoryTemplates and the HWNameFormatRules tables, which by default are in the <run_directory>/packages/cisco-wae-inventory-nimo/priv/etc/inventory/master_inventory_templates.txt file.

HWInventoryTemplates Table

The HWInventoryTemplates table tells the build_inventory tool how to interpret hardware referenced by the NetIntHardware* tables. It enables build_inventory to categorize objects into common, vendor-neutral hardware types, such as chassis, linecards, and slots, as well as to remove hardware types that are not of interest.

Inventory hardware is categorized as a chassis, slot, linecard, module slot, module, port slot, port, or transceiver. A container is categorized as either a slot, module slot, or port slot. A module is categorized as either a module or a linecard. All other hardware objects are categorized by their same name. For instance, a chassis is categorized as a chassis. These categorized hardware objects are available through the WAE Live application for use in inventory reports.

The build_inventory tool looks at the following columns of the HWInventoryTemplates table for matches in the NetIntHardware* tables in this order.

DiscoveredHWHierarchy, Vendor, Model
DiscoveredHWHierarchy, Vendor, * (where * means all entries in the Model column)

You can further enhance the search using the -guess-template-if-nomatch true option. In this instance, if no matches are found using the first two criteria, WAE Collector then looks for matches only for DiscoveredHWHierarchy and Vendor, and does not consider Model.

If a match is found, the subsequent columns after DiscoveredHWHierarchy tell build_inventory how to categorize the hardware. These latter columns identify hardware object types: chassis, slot, linecard, module slot, module, port slot, port, or transceiver. Each column entry has the following format.

Type,Identifier,Name

Type is the discovered hardware type, such as “container.”
Identifier specifies which object (of one or more of the same type) in the hierarchy is referenced (0, 1, ...).
Name specifies a column heading in the NetIntHardware* table. This is the name that appears in for that object in the NetIntNodeInventory table and thus, in WAE Live inventory reports.

Example: Module,0,Model

(Model is a column heading in the NetIntHardwareModule table)

Multiple name source columns can be specified with a colon.

Example: Container,0,Model:Name

If a hardware category does not exist or is empty, build_inventory does not include it in the final NetIntNodeInventory table.

Example

Using the first row of the default master_inventory_templates.txt file, WAE Collector searches the NetIntHardware* tables for ones that have entries that match the Vendor, Model, and DiscoveredHWHierarchy columns, as follows.

Cisco ASR9K Chassis-Container-Module-Port-Container-Module

Thereafter, it categorizes each entry in the hardware hierarchy (DiscoveredHWHierarchy column), and defines its location in the hardware types columns.

The first Module entry is defined as a linecard, it is identified as #0, and the name that appears in the NetIntNodeInventory table is the one appearing in the Model column of the NetIntHardwareModule table. The second module is defined as a transceiver object and is identified as #1. It uses the same name format.

Notice that there are two containers in the hierarchy, but there is only one defined as a Type. This means that the second container would not appear in the NetIntNodeInventory table.

Add HWInventoryTemplates Entries

If WAE Collector encounters an inventory device that is not in the HWInventoryTemplates table, it generates a warning that specifies pieces of the hardware hierarchy, including the SNMP ID of the leaf object and the IP address of the router. You can use this information to manually trace the objects from the leaf to the root and derive an appropriate entry in the HWInventoryTemplates table. For information on tracing hardware hierarchies, see Hardware Hierarchy.

Step 1 Copy the warning message for reference, and use it for Step 2.

Step 2 Using the router’s IP address, as well as the SNMP ID, name, and model of the leaf object, find the leaf object referenced in the warning in either the NetIntHardwarePort or the NetIntHardwareContainer table.

Step 3 Use the leaf object’s ParentTable and ParentId columns to trace the leaf back to its parent. For each successive parent, use its ParentTable and ParentId columns until you reach the root object (chassis) in the NetIntHardwareChassis table.

Step 4 Once each object in the hardware hierarchy is found, add it to the DiscoveredHWHierarchy column of the HWInventoryTemplates table. Also complete the Vendor and Model columns.

Step 5 For each object in the hardware hierarchy (DiscoveredHWHierarchy column), classify it into one of the standard hardware types, which are the columns listed after the DiscoveredHWHierarchy column.

HWNameFormatRules Table

The HWNameFormatRules table specifies how to format the names in the NetIntNodeInventory table. This is useful for converting long or meaningless names to ones that are easier to read and clearer for users to understand.

For each entry in the HWInventoryTemplates table, the HWNameFormatRules table is searched for a matching vendor, hardware type (HWType), name (PatternMatchExpression). Then, rather than using the name specified in the HWInventoryTemplates table, the NetIntNodeInventory table is updated with the name identified in the ReplacementExpression column.

If multiple matches apply, the first match found is used. Both the PatternMatchExpression and the ReplacementExpression can be defined as a literal string in single quotes or as a regular expression.

Example: The entries in the table work as follows.

Replaces all Cisco chassis name with 7507 if the name has four characters where A is the beginning of the string and Z is the end of the string.
Replaces all Cisco linecard names that match 800-20017-.* with 1X10GE-LR-SC.
Replaces all Juniper chassis named “Juniper (MX960) Internet Backbone Router” with MX960.


HWNameFormatRules
Vendor	HWType	PatternMatchExpression	ReplacementExpression
Cisco	Chassis	\A4\Z	‘7507’
Cisco	Linecard	800-20017-.*	‘1X10GE-LR-SC’
Juniper	Chassis	Juniper (MX960) Internet Backbone Router	$1

Note

SNMP returns many slot names as text, rather than integers. It is a best practice to remove all text from slot numbers for optimal use in WAE Live inventory reports.

Exclude Hardware by Model or Name

The build_inventory -exclude-file option calls a file containing the ExcludeHWList table, which by default is in the <run_directory>/packages/cisco-wae-inventory-nimo/priv/etc/inventory/master_exclude_list.txt file. This table enables you to identify hardware objects to exclude from the NetIntNodeInventory table based on model, name, or both. This is useful, for instance, when excluding management ports and route processors. The model and names can be specified using regular expressions or they can be literals.

Example: The entries in the table work as follows.

Exclude all objects in the NetIntHardwarePort table where the vendor is Cisco and the name ends with CPU0/129.
Exclude all objects in the NetIntHardwareModule table where the vendor is Cisco and the model is 800-12308-02.
Exclude all objects in the NetIntHardwarePort table where the vendor is Cisco and the name is Mgmt.


ExcludeHWList
HWTable	Vendor	Model	Name
NetIntHardwarePort	Cisco		\/CPU0\/129$
NetIntHardwareModule	Cisco	800-12308-02
NetIntHardwarePort	Cisco		Mgmt

HardwareSpec

The build_inventory -hardware-spec-file option calls a file containing the HardwareSpec table, which by default is in the <run_directory>/packages/cisco-wae-inventory-nimo/priv/etc/inventory/master_hw_spec.txt file. This table enables you to adjust data returned from SNMP. You can adjust both the total number of slots (TotSlot) and the slot numbering range (SlotNum). For instance, SNMP might return 7 slots for a chassis when there are actually 9, including route processors.

This table looks only for hardware that contains slots, module slots, or port slots, and thus, the hardware type (HWType column) must be chassis, linecard, or module. SlotNum indicates the slot number range. For instance, some routers start with slot 0, whereas others start with slot 1.

Example: This table entry sets the Cisco 7609 chassis to have a total of 9 slots and to start the slot numbering with 9.


HardwareSpec
Vendor	HWType	Model	TotSlot	SlotNum
Cisco	Chassis	7609	9	1-9

Configure Inventory Collection

Before you begin

Network topology collection must be complete. For more information, see Create a Network Model.

Procedure

Step 1	From the Expert Mode, in Configuration editor, navigate to /wae:networks.
Step 2	Click the plus (+) sign and enter a network model name. We recommend a unique name that contains the source network and NIMO names; for example, networkABC_inventory.
Step 3	Click Add.
Step 4	Click the nimo tab.
Step 5	From the Choice - nimo-type drop-down list, choose inventory-nimo.
Step 6	Click inventory-nimo and enter the following: source-network—Choose the applicable network model that contains basic topology information. network-access—Choose the network access.
Step 7	(Optional) Click the advanced > get-inventory-options. The `get-inventory` tool collects the network hardware and creates NetIntHardware tables that contain every device collected from MIB walks segregated by object type. The tool uses SSH and NETCONF to collect data that is not available in MIBs. login-allowed—If set to true, allows logging in to the router to collect inventory data. net-recorder—This option is typically used for debugging. Set to record to record SNMP messages to and from the live network in the net-record-file when discovery is running. net-record-file—Enter the filename where recorded SNMP messages are saved.
Step 8	(Optional) Click the advanced > build-inventory-options. The `build-inventory` tool processes the raw hardware data information in the NetIntHardware* tables) to categorize and remove unwanted objects in the final NetIntNodeInventory table. login-allowed—If set to true, allows logging in to the router using Netconf to collect inventory data. Required only for Juniper transceiver collection. guess-template-if-nomatch—If set to true, broadens the search when processing raw inventory data. template-file—Hardware template file containing HWInvetory Templates and HWNameFormatRules tables. hardware-spec-file—File containing HardwareSpec table that defines slot counts for specific types of hardware to verify SNMP data returned from outers.
Step 9	Click the Commit button.
Step 10	Navigate back to the inventory-nimo tab and click run-collection.

Example

WAE CLI (config mode):

# networks network <network-model-name> nimo inventory-nimo source-network
<source-network> network-access <network_access_name>
# networks network <network-model-name> nimo inventory-nimo advanced get-inventory-options login-allowed <false_or_true>
# networks network <network-model-name> nimo inventory-nimo run-collection
# commit

Create auth.enc

The auth.enc has credentials for SNMPv2c, SNMPv3, or both. SNMPv2c uses a less secure security model, passing community strings in clear text. SNMPv3 provides a strong security model that supports authentication, integrity, and confidentiality.

To generate this file, do the following in the WAE CLI (config mode):

# wae nimos network-access generate-auth-file network-access <network_access_name> 
file-path <directory>/auth.enc

where <directory> is where you want to save the auth.enc file. For example:

# wae nimos network-access generate-auth-file network-access test_lab file-path /home/wae/auth.enc 
message Successfully generated authfile at /home/wae/auth.enc

The authorization file password and default seed router login credentials consist of the following.

primary password—Password for viewing file contents
login username—Default username for login access to the routers
login password—Default password for login access to the routers
login enable password—Default enable password for login access

The SNMPv2c information is defined using a single value.

community—Default community string

The SNMPv3 information defines authentication and encryption details.

Security level
- noAuthNoPriv—Authenticates by username, but does not validate the user and does not encrypt data.
- authNoPriv—Authenticates by username, validates the user using MD5 or SHA, but does not encrypt data.
- authPriv—Authenticates by username, validates the user using MD5 or SHA, and encrypts data using DES or AES.

SNMPv3 username—Username for authentication
Authentication protocol type—MD5 or SHA
Authentication password—Password for authentication
Encryption protocol type—DES or AES
Encryption password—Password for encryption
Context name—Name of a collection of management information accessible by an SNMP entity

After you have created the initial encrypted authentication file, you can manually edit the contents to add multiple profiles or communities and map routers to them. Each profile contains a complete set of SNMPv3 authentication and encryption information. Multiple profiles or communities are necessary when different groups of routers use different authentication credentials.

Traffic Collection

The traffic-poll-nimo collects traffic statistics (interface measurements) using SNMP polling.

Before you begin

This NIMO requires the following:

Basic topology network model.
If collecting VPN traffic, a VPN network model must exist. See VPN Collection.
If collecting LSP traffic, an LSP network model must exist. See LSP Collection Using SNMP.
Maximum number of open files (ulimit -n): 1,000,000

Limitations

Node traffic information from external interfaces is not collected.

Procedure

Step 1

From the Expert Mode, in Configuration editor, navigate to /wae:networks.

Step 2

Click the plus (+) sign and enter a network model name. We recommend a unique name that contains the source network and NIMO names; for example, networkABC_traffic_polling.

Step 3

Click Add.

Step 4

Click the nimo tab.

Step 5

From the Choice - nimo-type drop-down list, choose traffic-poll-nimo.

Step 6

Click traffic-poll-nimo and enter the following:

source-network—Choose the applicable network model.
network-access—Choose the network access.

Note

If you modify the selected network access after starting the traffic poller, you must restart the traffic poller for the network access changes to take effect.

Step 7

To run continuous traffic collection for interfaces, click the iface-traffic-poller tab and enter the following:

enabled—Set to true.
period—Enter the polling period, in seconds. We recommend starting with 60 seconds. See Tuning Traffic Polling to tune the polling period.
qos-enabled—Set to true if you want to enable queues traffic collection.
vpn-enabled—Set to true if you want to enable VPN traffic collection. If set to true, confirm that the source network model has VPNs enabled.

Step 8

To run continuous traffic collection for LSPs, click the lsp-traffic-poller tab and enter the following:

enabled—Set to true.
period—Enter the polling period, in seconds. We recommend starting with 60 seconds. See Tuning Traffic Polling to tune the polling period.

Step 9

To run continuous traffic collection for MAC accounting, click the mac-traffic-poller tab and enter the following:

enabled—Set to true.
period—Enter the polling period, in seconds. We recommend starting with 60 seconds. See Tuning Traffic Polling to tune the polling period.

Note

If mac-traffic-poller is enabled, make sure that the source network model has MAC addresses.

Step 10

Click the Commit button.

Step 11

Navigate back to the traffic-poll-nimo tab and click run-snmp-traffic-poller > Invoke run-snmp-poller. To stop continuous collection in the future, click stop-snmp-traffic-poller.

Traffic Poller Advanced Options

This topic describes advanced options available when configuring traffic collection (traffic-poll-nimo).


Option	Description
snmp-traffic-poller
stats-computing-minimum- window-length	Enter the minimum window length for traffic calculation, in seconds. The default is 300 seconds.
stats-computing-maximum- window-length	Enter the maximum window length for traffic calculation, in seconds. The default is 450 seconds.
raw-counter-ttl	Enter how long to keep raw counters, in minutes. The default is 15 minutes.
net-recorder	This option is typically used for debugging. Set to record to record SNMP messages to and from the live network in the net-record-file when discovery is running.
log-file	Traffic poller log file.
net-record-file	Enter the filename where recorded SNMP messages are saved.
verbosity	Set the poller logging level. The default is 30. 40—INFO 50—DEBUG 60—TRACE
snmp-traffic-population
scheduler-interval	Enter the interval to perform traffic population, in seconds. The default is 300 seconds. It will send traffic statistics to the configuration database (CDB). If set to 0 (typically set when using the Bandwidth on Demand application), the continuous poller does not calculate and populate traffic automatically. It only calculates and populates the model when `nimo traffic-poll-nimo advanced snmp-traffic-population` is executed. WMD pulls the traffic statistics from RPC API. The traffic statistics are not sent to CDB.
connect-timeout	Enter the maximum execution time for traffic population, in minutes.
kafka-config
broker-url	URL of Kafka broker.
zookeeper-url	URL of Kafka zookeper.

Tuning Traffic Polling

Traffic poller collects raw traffic counters from the network. Collection time depends on network size, network latency and response time from individual nodes.

To run traffic polling efficiently, do the following:

Set the traffic poller logging level to 40.

Start with the default options and run continuous collection for several hours. The default values are:


iface-traffic-poller/period = 60
lsp-traffic-poller/period = 60
advanced/snmp-traffic-poller/stats-computing-minimum-window-length = 300
advanced/snmp-traffic-poller/stats-computing-maximum-window-length = 450
advanced/snmp-traffic-poller/raw-counter-ttl = 15
advanced/snmp-traffic-population/scheduler-interval = 300

View the poller.log file. By default, the file is located in <wae_run_time_directory>/logs/<network_name>-poller.log.
Search for actual collection times. For example:
```
Info [40]: LSP Traffic Poller: Collection complete. Duration: 43.3 sec
Info [40]: Interface Traffic Poller: Collection complete. Duration: 42.7 sec
```
The fastest pace at which the poller can poll network in the example above is around 40-50 secs. This is the minimum value for iface-traffic-poller->period and lsp-traffic-poller->period. Since traffic poller populates traffic for both interfaces and lsps at the same time, it is recommended to set both values to the same value.
Traffic Poller calculates traffic by collecting raw traffic counters c1, c2, ..., cn. It requires at least two counters to calculate traffic.
```
(c2.counter - c1.counter)/(c2.timestamp - c1.timestamp)
```
A sliding window namely stats-computing-minimum-window-length is used to sample two counters. It looks for two counters which are farthest apart, that is, latest and earliest for a specified period. The average traffic is calculated for this period. Since the poller requires at least 2 counters, the smallest value for stats-computing-minimum-window-length is 2 * polling period. To accomodate for variations, add 25% or more.

In case stats-computing-minimum-window-length fails to find counters for the specified period due to increased network latency or node response time, it will report traffic as N/A. To avoid empty traffic, there is an insurance window, namely stats-computing-maximum-window-length which has a minimum value equal to 2 * polling period. To accomodate for longer polling period, add 50% or more. For unresponsive nodes add 100% or more.
Traffic poller stores raw counters in memory for traffic calculation. This takes up RAM space. Once in a while traffic poller cleans up old counters stored in memory. Anything older than raw-counter-ttl (mins) is cleaned up. Therefore given above constraints, minimum value for raw-counter-ttl is stats-computing-maximum-window-length or more.
Traffic population in traffic poller is the process of calculating traffic in the network and populating the plan file/CDB/WMD. The duration it takes depends on network size and target (plan file/CDB/WMD). The fastest target is the plan file (native mode). The actual time it takes to populate traffic can be found in wae-java-vm log file. For example:
```
TrafficCalculatorRfs Did-52-Worker-46: - Traffic calculation took (ms) 379976
TrafficCalculatorRfs Did-52-Worker-46: - Traffic calculation took (ms) 391953
TrafficCalculatorRfs Did-52-Worker-46: - Traffic calculation took (ms) 388853
```
In the above example the fastest rate at which traffic can be populated (and consumed by other tools) is about 400 secs.
Sometimes in wae-java-vm log file you can also see Invalid counter warnings to indicate that counter values do not make sense, for example, c1.counter is greater than c2.counter (which would result in negative traffic). This happens when counters reset or overflow. It is common for 32-bit counters. If there are a lot of them seen, increase the sliding window sizes to process more counters and reduce chances of failure.

However it is not recommended to poll network at a faster rate than populating traffic. In the example above the most aggressive setting for traffic polling is 50 secs, but population takes around 400 secs. This amounts to 8 network polls which are wasted. Therefore traffic polling period can be increased (along with sliding window sizes and raw-counter-ttl). Here is configuration recommended for the above network:

nimo traffic-poll-nimo iface-traffic-poller period 180
nimo traffic-poll-nimo lsp-traffic-poller enabled
nimo traffic-poll-nimo lsp-traffic-poller period 180
nimo traffic-poll-nimo advanced snmp-traffic-poller stats-computing-minimum-window-length 400
nimo traffic-poll-nimo advanced snmp-traffic-poller stats-computing-maximum-window-length 800
nimo traffic-poll-nimo advanced snmp-traffic-poller raw-counter-ttl 15
nimo traffic-poll-nimo advanced snmp-traffic-population scheduler-interval 400
nimo traffic-poll-nimo advanced snmp-traffic-population connect-timeout 60

Note

snmp-traffic-population connect-timeout is adjusted to 60 mins for traffic population. This timeout is not used generally and should be just high enough.

Sample configuration above is most aggressive in terms of traffic polling and population. These numbers can be adjusted to be less aggressive to save CPU resources and network bandwidth, for example:

nimo traffic-poll-nimo iface-traffic-poller period 240
nimo traffic-poll-nimo lsp-traffic-poller enabled
nimo traffic-poll-nimo lsp-traffic-poller period 240
nimo traffic-poll-nimo advanced snmp-traffic-poller stats-computing-minimum-window-length 600
nimo traffic-poll-nimo advanced snmp-traffic-poller stats-computing-maximum-window-length 1200
nimo traffic-poll-nimo advanced snmp-traffic-poller raw-counter-ttl 20
nimo traffic-poll-nimo advanced snmp-traffic-population scheduler-interval 600
nimo traffic-poll-nimo advanced snmp-traffic-population connect-timeout 60

Network Model Layout (Visualization)

The layout-nimo adds layout properties to a source network model to improve visualization when importing the plan file into Cisco WAE Design. The NIMO automatically records changes to the layout properties. When the source network model changes, the layout of the destination model is updated.

The layout in the destination network serves as a template that is applied to the source network. The resulting network is saved as the new destination network. If the source layout contains no layout information, the layout from the destination network is simply added to the source network. If the source network contains layout information, that layout is maintained unless there is a conflict with the layout in the destination network. If a conflict exists, the layout information in the destination network takes precedence over the information in the source network.

For example, assume that a new L1 node is added to the source network with a corresponding site assignment. This L1 node is then added to the destination network with its site assignment. Now assume that an existing L1 node has a different site assignment in the source and destination networks. In this case, the site assignment in the destination network is retained.

There are two steps:

Create a new network model using the layout-nimo.
Add a layout template to the new network model using WAE Design and then send a patch. For more information, see the Cisco WAE Network Visualization Guide.

Before you begin

Make sure that the Cisco WAE Design version is same or higher than Cisco WAE version on the server.
A basic topology network model must exist. See Basic Topology Collection.

Procedure

Step 1	From the Expert Mode, in Configuration editor, navigate to /wae:networks.
Step 2	Click the plus (+) sign and enter a network model name. We recommend a unique name that contains the source network and NIMO names. This procedure uses networkABC_layout as an example.
Step 3	Click Add.
Step 4	Click the nimo tab.
Step 5	From the Choice - nimo-type drop-down list, choose layout-nimo.
Step 6	Click layout-nimo and enter the following: source-network－Enter the source network for the network to use. template-plan-file-path－Enter the template plan file path from where layout details wiil be copied from.
Step 7	Click the Commit button.
Step 8	Launch WAE Design and choose File > Open From > WAE Automation Server.
Step 9	Enter the appropriate details, choose the plan file for the network model you just created (networkABC_layout), and click OK.
Step 10	Edit the layout. See the "Using Layouts" chapter in the Cisco WAE Network Visualization Guide.

Step 11	Save the modified plan file to template-plan-file-path (see step 6) on the collector server using the option File > Save To > WAE Automation Sever .
Step 12	Click run-layout > Invoke run-layout.
Step 13	Open a plan from layout network in Cisco WAE Design and confirm if the visual layout is as expected.

Example

WAE CLI (config mode) using the external-executable-nimo:

1. Open the plan file from Cisco WAE design for a network. In this example the source network is NetworkABC_demands.

2. Update the layout.

3. Save the file. In this example, the plan file is named template_01.pln

networks network networkABC_layout
nimo layout-nimo source-network NetworkABC_demands
nimo layout-nimo template-plan-file-path /home/centos/plan_files/template_01.pln
nimo layout-nimo advanced advanced-options -method
value visual
!
!

Multicast Flow Data Collection

Multicast NIMO collects multicast flow data from a given network. It is a collection of the following NIMOs:

snmp-find-multicast-nimo—Collects multicast data for multicast flows using SNMP.
snmp-poll-multicast-nimo—Collects traffic data rate for multicast flows using SNMP.
login-find-multicast-nimo—Logs in to router to fetch or parse multicast flow data.
login-poll-multicast-nimo—Logs in to router to get multicast traffic rate

Before you begin

A topology network model must exist. See Create a Network Model.

Procedure

Step 1	From the Expert Mode, in Configuration editor, navigate to /wae:networks.
Step 2	Click the plus (+) sign and enter a network model name. We recommend a unique name that contains the source network and NIMO names; for example, networkABC_multicast.
Step 3	Click Add.
Step 4	Click the nimo tab.
Step 5	Choose the applicable NIMO as the NIMO type. Choose between snmp-find-multicast-nimo, snmp-poll-multicast-nimo, login-find-multicast-nimo, login-poll-multicast-nimo.
Step 6	Click NIMO link and enter the following information: network-access—Choose the network access profile for the network. source-network—Choose the applicable network model that contains topology information.
Step 7	Click advanced tab and enter the information. Hover your mouse over the fields to get more details.
Step 8	Click the Commit button.
Step 9	Click run-collection > Invoke run-collection.

Example

If using WAE CLI, use the following commands:

Configure Multicast NIMO as follows with one NIMO as source to next one.

networks network snmp_find_mc
nimo snmp-find-multicast-nimo network-access network_access
nimo snmp-find-multicast-nimo source-network dare_network
!
networks network login_find_mc
nimo login-find-multicast-nimo network-access network_access
nimo login-find-multicast-nimo source-network snmp_find_mc
!
networks network snmp_poll_mc
nimo snmp-poll-multicast-nimo network-access network_access
nimo snmp-poll-multicast-nimo source-network login_find_mc
!
networks network login_poll_mc
nimo login-poll-multicast-nimo network-access network_access
nimo login-poll-multicast-nimo source-network snmp_poll_mc
!

In aggregator configuration, mark snmp-find and snmp-poll multicast networks as indirect (direct-source as False).

wae components aggregators aggregator  dare_network
sources source mcast-topo
  nimo topo-igp-nimo
!
dependencies dependency login_find_mc
  nimo login-find-multicast-nimo
!
dependencies dependency login_poll_mc
  nimo login-poll-multicast-nimo
!
dependencies dependency snmp_find_mc
  nimo          snmp-find-multicast-nimo
  direct-source false
!
dependencies dependency snmp_poll_mc
  nimo          snmp-poll-multicast-nimo
  direct-source false
!
final-network mcast-final
!

Traffic Demands Collection

traffic-demands-nimo collects information regarding traffic demands from the network.

Before you begin

A basic topology network model must exist. See Basic Topology Collection.

Procedure

Step 1	From the Expert Mode, in Configuration editor, navigate to /wae:networks.
Step 2	Click the plus (+) sign and enter a network model name. We recommend a unique name that contains the source network and NIMO names; for example, networkABC_traffic_demands_config.
Step 3	Click Add.
Step 4	Click the nimo tab.
Step 5	From the Choice - nimo-type drop-down list, choose traffic-demands-nimo.
Step 6	Click traffic-demands-nimo and enter the following: source-network—Choose the applicable network model that contains basic topology information. connection-timeout—Enter connection timeout in minutes.
Step 7	In the demand-mesh-config tab, click demand-mesh-steps.
Step 8	Click + to add a step. Enter a name to the step and click add.
Step 9	Click the step you just created. Select a tool from Choice-tool drop down menu.
Step 10	Click the tool and enter the necessary details.
Step 11	Click advanced tab and enter the details. Hover the mouse pointer over fields to view option descriptions. Repeat steps 9 to 11 to add more steps to the configuration.
Step 12	Click the Commit button.
Step 13	Click run-collection > Invoke run-collection.

Merge AS Plan Files

Plan files from different Autonomous Systems (AS) can be merged using the inter-as-nimo. The inter-as-nimo resolves any conflicts across the plan files. Plan files in native format are also supported.

Each AS can be on a different WAE server.

Note

Only Autonomous Systems (AS), Circuits, Nodes, Interfaces, EExternal Endpoints, External Endpoint Members with virtual nodes and unresolved interfaces are
The following demands are resolved:
- Source or Destination associated with virtual node that are resolved with real node.
- Source or Destination associated with the interface in a specific format.
- Source or Destination associated with the External Endpoints.
The following demands are not resolved:
- Source or Destination associated with ASN number only.
For a given plan file, the internal AS number must match what other plan files see as an external AS number, and all the Autonomous Systems that are going to be merged need to be discovered in all the plan files.

Before you begin

Collect topology and traffic information for different Autonomous Systems (AS).
The plan files from different AS have to be present on the same WAE server and the path to the plan files must be mentioned.

Procedure

Step 1	From the Expert Mode, in Configuration editor, navigate to /wae:networks.
Step 2	Click the plus (+) sign and enter a network model name. We recommend a unique name that contains the source network and NIMO names; for example, networkABC_merge_as_plan.
Step 3	Click Add.
Step 4	Click the nimo tab.
Step 5	From the Choice - nimo-type drop-down list, choose inter-as-nimo.
Step 6	Click inter-as-nimo and enter the following details: retain-demands—Select true to merge the demands. tag-name—Enter a tag name to help identify the updated rows in .pln file. The tag column in the .pln file gets updated with the tag name for rows that are modified. path-to-report-file—Enter path to a report file where dropped rows after merge are reported.
Step 7	In the sources tab, click + and enter the network. Click Add.
Step 8	Enter the plan-file-path. If this field is left blank, the NIMO looks up for source with the given name.
Step 9	Click Commit.
Step 10	Click merge-inter-as > Invoke merge-inter-as. To merge AS plan files using CLI, use the following commands: `networks network <network-name> nimo inter-as-nimo retain-demands true nimo inter-as-nimo tag-name <tag-name> nimo inter-as-nimo path-to-report-file <report-file-path> nimo inter-as-nimo sources <source1> plan-file-path <source1-plan-file-path> ! nimo inter-as-nimo sources <source2> plan-file-path <source2-plan-file-path> ! !`

Running External Scripts Against a Network Model

The external-executable-nimo lets you run a customized script against a selected network model. You might want to do this when you want specific data from your network that existing Cisco WAE NIMOs do not provide. In this case, you take an existing model created in Cisco WAE and append information from a custom script to create a final network model that contains the data you want.

For more information, see the following topics:

Configure Inventory Collection
Network Model Layout (Visualization)

An example is documented in the Running External Scripts Example topic.

Before you begin

The configuration of this NIMO is also available in the Cisco WAE UI using the Network Model Composer.

Procedure

Step 1	From the Expert Mode, in Configuration editor, navigate to /wae:networks.
Step 2	Click the plus (+) sign and enter a network model name. It is recommended to use a name to match the nimo type or use any existing nimo names to match its capability.
Step 3	Click the nimo tab.
Step 4	From the Choice - nimo-type drop-down list, choose external-executable-nimo.
Step 5	Click external-executable-nimo and select the source network and network access.
Step 6	Click the advanced tab and enter the following: input-file-version—Enter the plan file version of the source network model, such as 6.3, 6.4, and so on. Default is the current version. input-file-format—Specify the plan file format of the source network model. The default is db. The available options are txt, pln, and db. argv—Enter arguments (in order) that are required for the script to run. Enter $$input for the source network model, $$output for the resulting network model (after the script runs) and $$authfile for auth file if you are running one of WAE CLI tools (network-access must be configured). It is important to note that $$input, $$output, and other argv arguments must be listed in the order that is required by the script. For an example, see Running External Scripts Example. action-timeout—Specify the action timeout. The default is 30.
Step 7	From the external-executable-nimo tab, click run.
Step 8	Click Commit.

Example

If using the WAE CLI (in config mode), enter:


networks network <network-model-name> nimo external-executable-nimo source-network <source-network> 
advanced argv "<command[s]> <arguments>"
admin@wae(config-network-<network-model-name>)# commit
Commit complete.
admin@wae(config-network-<network-model-name>)# exit
admin@wae(config)# exit

admin@wae# networks network <network-model-name> nimo external-executable-nimo run

Running External Scripts Example

This example describes how to use the external-executable-nimo with the WAE CLI. The sample python script (ext_exe_eg.py) appends a description to every interface in the network with "My IGP metric is <value>." For another example, see the Configure Inventory Collection topic.

Contents of ext_exe_eg.py:

import sys
from com.cisco.wae.opm.network import Network

src  = sys.argv[1]
dest = sys.argv[2]

srcNet =  Network(src)

for node in srcNet.model.nodes:
    cnt = 1
    for iface in node.interfaces:
        iface.description = 'My IGP metric is ' + str(iface.igp_metric)
        cnt = cnt + 1    

srcNet.write(dest)

In the WAE CLI, enter:

admin@wae(config)# networks network net_dest nimo external-executable-nimo source-network net_src 
advanced argv "/usr/bin/python3 /home/user1/srcs/br1/mate/package/linux/run/ext_exe_eg.py $$input $$output"
admin@wae(config-network-net_dest)# commit
Commit complete.
admin@wae(config-network-net_dest)# exit
admin@wae(config)# exit

admin@wae# networks network net_dest nimo external-executable-nimo run
status true
message Changes successfully applied.

Confirm the script succeeded by checking the network plan file in Cisco WAE Design.

Bias-Free Language

Results

Chapter: Network Interface Modules (NIMOs)

Network Interface Modules (NIMOs)

NIMO Descriptions

Basic Topology Collection

Topology Collection Using the IGP Database

Before you begin

Procedure

What to do next

Topology Collection Using SR-PCE

Before you begin

Procedure

Example

What to do next

BGP-LS XTC Advanced Options

NIMO Collection Consolidation

Before you begin

Procedure

Example

Aggregator and Multilayer Collection Configuration Example

Segment Routing Traffic Matrix Collection

Before you begin

Procedure

Example

VPN Collection

Before you begin

Procedure

LSP Configuration Collection

Before you begin

Procedure

LSP Collection Using SR-PCE

Before you begin

Procedure

Port, LSP, SRLG, and VPN Collection Using Configuration Parsing

Before you begin

Procedure

What to do next

BGP Peer Collection

Before you begin

Procedure

BGP Topology Advanced Options

LSP Collection Using SNMP

Before you begin

Procedure

Inventory Collection

Configure Inventory Collection

Before you begin

Procedure

Example

Create auth.enc

Traffic Collection

Before you begin

Procedure

Traffic Poller Advanced Options

Tuning Traffic Polling

Network Model Layout (Visualization)

Before you begin

Procedure

Example

Multicast Flow Data Collection

Before you begin

Procedure

Example

Traffic Demands Collection

Before you begin

Procedure

Merge AS Plan Files

Before you begin

Procedure

Running External Scripts Against a Network Model

Before you begin

Procedure

Example

Running External Scripts Example

Was this Document Helpful?

Contact Cisco