Feedback
Contents
RCMD Commands
This module describes the commands used to configure and diagnose RCMD.
For detailed information about RCMD concepts, configuration tasks, and examples, see the Implementing RCMD module in the Routing Configuration Guide for Cisco NCS 6000 Series Routers.
- router-convergence
- monitor-convergence (IS-IS)
- monitor-convergence (OSPF)
- collect-diagnostics (RCMD)
- event-buffer-size (RCMD)
- max-events-stored (RCMD)
- monitoring-interval (RCMD)
- node disable (RCMD)
- priority (RCMD)
- protocol (RCMD)
- storage-location
router-convergence
To configure route convergence monitoring and enter router convergence monitoring and diagnostics (rcmd) configuration mode, use the router-convergence command in XR Config mode. To remove all router convergence monitoring configurations and exit the rcmd mode, use the no form of this command.
Syntax Description
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.
Task ID
Examples
This example shows how to configure router-convergence command and enable rcmd configuration mode:
RP/0/RP0/CPU0:router#configure RP/0/RP0/CPU0:router(config)#router-convergence RP/0/RP0/CPU0:router(config-rcmd)#monitor-convergence (IS-IS)
To enable route convergence monitoring for IS-IS protocol, use the monitor-convergence command in address family configuration mode. To disable, route convergence monitoring, use the no form of this command.
Command Modes
Address family IPv4 unicast
Address family IPv4 multicast
Address family IPv6 unicast
Address family IPv6 multicast
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.
Task ID
Examples
This example shows how to configure route convergence monitoring for IS-IS under IPv6 multicast SAFI:
RP/0/RP0/CPU0:router#configure RP/0/RP0/CPU0:router(config)#router isis isp RP/0/RP0/CPU0:router(config-isis)#address-family ipv6 multicast RP/0/RP0/CPU0:router(config-isis-af)#monitor-convergencemonitor-convergence (OSPF)
To enable OSPF route convergence monitoring, use the monitor-convergence command in router OSPF configuration mode. To disable OSPF route convergence monitoring, use the no form of this command.
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.
Task ID
Examples
This example shows how to enable route convergence monitoring for an OSPF process:
RP/0/RP0/CPU0:router#configure RP/0/RP0/CPU0:router(config)#router ospf 100 RP/0/RP0/CPU0:router(config-ospf)#monitor-convergencecollect-diagnostics (RCMD)
To collect diagnostics on specified node, use the collect-diagnostic command in router-convergence configuration mode. To disable collection of diagnostics, use the no form of this command.
Syntax Description
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.
For enabling diagnostics collection on specific line-card locations, you can user can specify partially qualified semantics. However, it is not allowed to configure over-lapping locations so as to avoid errors. The following combinations of Rack and Slot are accepted: If a wildcard combination for any location is already disabled, then any other combination that overlaps with it would be rejected. For example,Task ID
Examples
This example shows how to enable RCMD diagnostics collection on node 0/3/CPU0:
RP/0/RP0/CPU0:router#configure RP/0/RP0/CPU0:router#router-convergence RP/0/RP0/CPU0:router(config-rcmd)#collect-diagnostics 0/3/CPU0event-buffer-size (RCMD)
To specify event buffer size (in terms of number of events) for storing event traces, use the event-buffer-size command in router-convergence configuration mode. To disable buffer size configuration, use the no form of this command.
Syntax Description
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.
The event-buffer-size configuration controls the ltrace buffer size. Ltraces will be stored for only the configured number of events. The default is 100 events and can be set based on the expected churn in the network. Value for event buffer impact memory usage on all RPs and monitored LCs.
Task ID
Examples
This example shows how to configure event buffer size as 500 events:RP/0/RP0/CPU0:router#configure RP/0/RP0/CPU0:router(config)#router-convergence RP/0/RP0/CPU0:router(config-rcmd)#event-buffer-size 500max-events-stored (RCMD)
To configure maximum number of events to be stored in the RCMD server, use the max-events-stored command in router-convergence configuration mode. To remove the number of events to be stored, use the no form of this command.
Syntax Description
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.
The max-events-stored configuration controls the number of events that are stored in RCMD server, before the older events are deleted. The default is 100 events and can be set based on the expected churn in the network. Value for events stored impact memory usage by RCMD server.
Task ID
Examples
This example shows how to configure 500 number of events to be stored in RCMD server:RP/0/RP0/CPU0:router#configure RP/0/RP0/CPU0:router(config)#router-convergence RP/0/RP0/CPU0:router(config-rcmd)#max-events-stored 500monitoring-interval (RCMD)
To configure interval (in minutes) in which to collect logs, use the monitoring-interval command in router-convergence configuration mode. To disable monitoring interval configuration, use the no form of this command.
Syntax Description
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.
The monitoring-interval timer controls the collection, processing, and archival (optional) of convergence data by RCMD server.
Periodic processing can get triggered if number of events detected exceed configured sizing parameters to prevent loss of data . However, this is not guaranteed since the mechanism is throttled.
To collect logs manually, use the rcmd trigger-data-collect command. Syslogs are generated when high churn is detected and collection mechanism is getting throttled. This indicates possible loss of data for some events. Throttling mechanism is for one processing every minute.
Task ID
Examples
This example shows how to configure monitoring interval as 5 minutes:RP/0/RP0/CPU0:router#configure RP/0/RP0/CPU0:router(config)#router-convergence RP/0/RP0/CPU0:router(config-rcmd)#monitoring-interval 5node disable (RCMD)
To disable monitoring of route convergence on specified location, use the node disable command in router-convergence configuration mode. To reinstate, monitoring on specified location, use the no form of this command.
Syntax Description
node-id Specifies line card locations for which RCMD monitoring be disabled. Disables RCMD monitoring on the specified node. No data from this node will be available in the reports that are generated. You can enter specific LCs or use wild cards.
Command Default
Update times are gathered and reported for all LCs. Diagnostic mode is disabled on all LCs.
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.
Disable monitoring on specific LCs or racks for better scalability. Disable monitoring on LCs whose update times is not going to impact the core IGP/LDP convergence that RCMD is measuring.
On LCs where monitoring is enabled, the diagnostic mode can be enabled (with threshold value) for triggering script using EEM infra for debug data collection from the router. Use diagnostic mode only for debugging purpose since it is more CPU intensive as compared to normal RCMD monitoring.
Only the following combinations of Rack and Slot are acceptable: If a wildcard combination for any location is already disabled, then any other combination that overlaps with it would be rejected. For example,Task ID
Examples
This example shows how to disable monitoring on all nodes with Rack 0 and any slot (used wild card *) :RP/0/RP0/CPU0:router#configure RP/0/RP0/CPU0:router(config)#router-convergence RP/0/RP0/CPU0:router(config-rcmd)#node 0/*/* disablepriority (RCMD)
To configure RCMD reporting parameters for low/high/critical/medium priority updates, use the priority command in RCMD protocol configuration mode. To disable setting up priority use the no form of this command.
priority { Critical | High | Low | Medium } [disable] [ leaf-network leaf-network-number ] [ threshold value ]
no priority { Critical | High | Low | Medium }
Syntax Description
Critical Configures the monitoring of route convergence for critical routes.
High Configures the monitoring of route convergence for high priority routes.
Low Configures the monitoring of route convergence for low priority routes.
Medium Configures the monitoring of route convergence for medium priority routes.
disable Disables the monitoring of route convergence for specified priority.
leaf-network Configures the monitoring of route convergence for leaf networks. Lists up to 100 leaf networks that were added or deleted as part of SPF.
leaf-network-number Specifies the maximum number of leaf networks monitored. The range is 10 to 100.
threshold Sets the threshold value for convergence in milliseconds. If the convergence time exceeds this configured value, diagnostics collection will be triggered.
value Specifies the threshold value (in msec). The range is 0 to 4294967295.
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.
Use the priority command for collecting data and applying threshold for particular protocol and prefix priority.
Maximum of 100 leaf networks can get logged because of scalability reasons. No default value available for threshold and this needs to be determined with deployment experience for specific network. Threshold specification is required for triggering diagnostics collection. Disable monitoring for medium and or low priority routes to help scale better. No specific order is guaranteed for leaf networks and first N prefixes that change are logged.
Task ID
Examples
This example shows how Configures the monitoring of route convergence for critical routes for 100 leaf networks and at a threshold value of 1 millisecond for OSPF protocol:RP/0/RP0/CPU0:router#configure RP/0/RP0/CPU0:router(config)#router-convergence RP/0/RP0/CPU0:router(config-rcmd)#protocol OSPF RP/0/RP0/CPU0:router(config-rcmd-proto)#priority high RP/0/RP0/CPU0:router(config-rcmd-proto-prio)#leaf-network 100 RP/0/RP0/CPU0:router(config-rcmd-proto-prio)#threshold 1protocol (RCMD)
To specify the protocol for which to configure RCMD parameters, use the protocol command in router-convergence configuration mode. To remove the protocol from RCMD, use the no form of this command.
Syntax Description
ISIS Configures parameters related to OSPF protocol within RCMD
OSPF Configures parameters related to IS-IS protocol within RCMD
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.
RCMD monitoring needs to be enabled for a specific OSPF or ISIS protocol instance.
Task ID
Examples
This example shows how to enable RCMD parameters for OSPF protocol:RP/0/RP0/CPU0:router(config)#router RP/0/RP0/CPU0:router(config)#router-convergence RP/0/RP0/CPU0:router(config-rcmd)#protocol OSPF RP/0/RP0/CPU0:router(config-rcmd-proto)#priority high RP/0/RP0/CPU0:router(config-rcmd-proto-prio)#leaf-network 100 RP/0/RP0/CPU0:router(config-rcmd-proto-prio)#threshold 1storage-location
To specify where to store the extended routing-diagnostics that are collected when threshold exceeds, use the storage-location command in router-convergence configuration mode. To disable storing routing-diagnostics to a specific location, use the no form of this command.
storage-location [ diagnostics directory-path | diagnostics-size maximum-directory-size | reports directory-path | reports-size maximum-directory-size ]
no storage-location
Syntax Description
diagnostics Specifies an absolute directory path for storing diagnostic reports.
directory-path Specifies the path of the absolute directory for storing diagnostic reports.
diagnostics-size Specifies the maximum size of diagnostics directory.
maximum-directory-size Specified the size of the diagnostics directory. The range is 5% to 80%.
reports Specifies an absolute directory path for storing reports.
directory-path Specifies the path of the absolute directory for storing reports.
reports-size Specifies the maximum size of the reports directory. The range is 5% to 80%.
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.
The storage location can be local disk or remote tftp space.
RCMD server can periodically archive reports in XML format for persistency. This mechanism is enabled when archival location is configured. Debug data collected in diagnostics mode is dumped to the configured diagnostic location (else it would get lost). When using local disk, the percentage of disk space to be used can be specified, and RCMD server will delete older reports on reaching the limit. Archival (specifically on local disk) is CPU intensive. Use a remote XML server to periodically collect reports from the router and archive on the server’s local storage.
Task ID
Examples
This example shows how to configure storage location as tftp://202.153.144.25/auto/tftp-chanvija-blr/rcmd/dump/reports for reports and /harddisk:/rcmd_logs for diagnostics:RP/0/RP0/CPU0:router#configure RP/0/RP0/CPU0:router(config)#router-convergence RP/0/RP0/CPU0:router(config-rcmd)#storage-location RP/0/RP0/CPU0:router(config-rcmd-store)#diagnostics /harddisk:/rcmd_logs RP/0/RP0/CPU0:router(config-rcmd-store)#reports tftp://202.153.144.25/auto/tftp-chanvija-blr/rcmd/dump/reports