The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
The following sections are partial examples that identify the options required or useful when discovering specific features. These examples focus on requirements and anomalies. They do not represent all the possible tasks and CLI options. All examples assume you have defined the environment variables and called other tasks in snapshot.txt, and that you have properly configured the snapshot.inc file for all other tasks.
Step 1 In snapshot.txt, confirm that the following tasks are enabled (uncommented):
Step 2 In snapshot.inc, add or set the following options:
This example shows how to insert data into an external archive where the information is available for all applications to use.
Step 1 In the snapshot.txt, point the default
archive_dir
to point to the external archive. Best practice is to keep the default.
Example:
archive_dir $(home_dir)/archives
Step 2 In snapshot.txt, enable the ARCHIVE_INSERT task (uncomment it).
Step 3 In snapshot.inc, use
archive_insert
to insert WAE Live plan files into the external archive during the collection process.
This example provides the workflow for enabling WAE Collector to get BGP LS from the Open SDN Controller (OSC).
Step 1 Configure OSC to collect BGP LS. For information, see the BGP LS PCEP User Guide :
https://wiki.opendaylight.org/view/BGP_LS_PCEP:User_Guide
Step 2 Configure the snapshot.txt file to specify an environment variable for the BGP LS server URL and to turn on the BGL LS Discovery task.
a. Specify the
bgpls_url
environment variable. The default BGP LS server port on which it listens is 8181.
Example:
bgpls_url http://localhost:8181
b. Uncomment the FIND_BGPLS task in the snapshot.txt file.
Step 3 Configure the snapshot.inc file to specify how you want to collect the BGP LS data. The default is to collect OSPF, area 0. This example demonstrates how to collect using both IS-IS levels.
Step 4 On the Automation server, start or restart the wae-osc service.
Step 1 In snapshot.txt, confirm that the following tasks are enabled (uncommented):
This example shows how to discover and poll eBGP peers by MAC address using manual snapshots. This feature provides more granular traffic collection for networks that establish BGP peering with a large number of ASNs through switch interfaces at public Internet exchange points (IXPs).
Note MAC accounting must be enabled on the routers.
Step 1 In snapshot.inc, use
find-bgp
with the
-get-mac-address
option set to
true
. This enables discovery of eBGP peers by MAC addresses.
Step 2 In snapshot.inc, use
snmp_poll
with the
-poll-function
option set to a value that specifies both
interface
and
mac
. This collects interface traffic statistics by MAC addresses.
Step 3 In snapshot.txt, ensure that <FIND_BGP> and <SNMP_POLL> are enabled.
For Explore and Analytics components, this example shows how to set up the collection of the statistics that are put into the data store.
Step 1 In snapshot.txt, ensure the following are enabled:
Step 2 In snapshot.inc, set the
-perf-data
option to true for
snmp_find_nodes
.
Step 3 In snapshot.inc, set the
-perf-data
option to true for either
snmp_poll
or
snmp_poll_interfaces
.
Step 4 If analyzing LAGs in WAE Live, set the
snmp_find_interfaces
-lag
option to
true
. See Collect LAG Membership and Traffic.
This example shows how to insert data directly into the WAE data store and Map archive, rather than storing on a server or in an external archive.
Step 1 In snapshot.txt, enable the ML_INSERT task (uncomment it).
Step 2 In snapshot.inc, use <ML_INSERT> to insert plan files into the WAE Live data store during the collection process.
This is only applicable if using
ml_insert_plan
and if using the WAE Live Map component. The location specified must be the location of the Map archive directory. This is not the same as the external archive.
Step 1 In the snapshot.txt, create an environment variable that specifies the location of the Map archive.
Example:
map_archive_dir $(home_dir)/data/mldata/archive
Step 2 In snapshot.txt, add an MAP_ARCHIVE_INSERT task.
Step 3 In snapshot.inc, add <MAP_ARCHIVE_INSERT> to insert WAE Live plan files into the internal Map archive during the collection process.
Step 1 In snapshot.txt, ensure both <SNMP_FIND_INTERFACES> and <SNMP_POLL> are enabled.
Step 2 In snapshot.inc, use
snmp_find_interfaces
to discover LAG ports with the
-lag true
option. This populates the <Ports> and <PortCircuits> tables. The latter is based on a best-match rule according to ascending port names and numbers.
Use the
-lag-port-match
option to specify how ports are matched in port circuits. Here, the
complete
value is used to tell WAE Collector that if a port is up, match it deterministically based on LACP, and if a port is down, use the
guess
mode to match as many ports as possible.
Step 3 In snapshot.inc, use
snmp_poll
to poll all LAG and bundle ports for traffic measurements with the
-poll-function ports
option. Ports are polled with the same parameters as interfaces.
Step 1 In snapshot.txt, ensure both <SNMP_FIND_NODES> and <SNMP_POLL> are enabled.
Step 2 In snapshot.inc, use
snmp_find_nodes
to discover interface queues with the
-read-qos-queues true
option.
Step 3 In
snapshot.inc
, use
snmp_poll
to poll all interface queues with the
-qos-queues '*'
option.