Driver Support Document

Cisco routers, Catalyst 4000 & 6000 series switches, L3 switches, IOS version 12.x, 15.x, 16.x & IOS-XE 3.x & 4.x

• Internal Driver Name: CiscoIOS_JS_Router
• Driver Package: CiscoIOS_JS_Router.rdp
  
• Driver Tier: 3
• Vendor: Cisco
• Family: Cisco IOS
• IPv6 Support: Yes

Show Tested Devices Grid

Driver Features Support Grid

General Access

Release Notes

Alternate enable level`

If the device requires a specified enable level (e.g. "enable 14"), set the device access variable enable_level to the level required (in this example, 14).

return to top

Modules and Inventory

Release Notes

Parsing extra serial numbers from show inventory raw

Some situations may require parsing inventory information that is not shown in the standard "show inventory" command. To switch this command to "show inventory raw", set the device access variable "raw_inventory" to "true"; parsing will continue based on the same output format, but will include the extra information.

return to top

Enhanced VLAN Parsing

Release Notes

VLAN provisioning for ASR devices

VLAN provisioning tasks are not supported on ASR devices with this driver.

return to top

Retrieve Running Configuration

Release Notes

Get the whole configuration

Many Cisco devices support a 'show running-config all' command that includes all default settings in the returned configuration. To retrieve this configuration, set the device access variable "showConfigAll" to "true". Note that the startup configuration and transport protocols do not support this argument, only the CLI running configuration will be altered, which can cause NA to show a difference between the startup and running configuration.

Password usage in SCP

Many Cisco devices support using the username:password format within the scp:// URL, but some devices can fail the transfer as a result. To revert to a username-only URL, set the device access variable "skip_password" to "true"; the password will still be used in the following prompts, to facilitate transfer. Configuration deployment transfers by SCP are also subject to this variable.

Serial number selection

Cisco devices return a number of different serial numbers. The driver selects them in a set order, but it is recognized that different customers may be interested in different serial numbers in particilar. To manually select which serial is parsed, set the device access variable "serial_source" to either "DeviceTable", "Processor", or "Inventory". DeviceTable refers to the table at the end of the 'show version' data, Processor referrs to the Processor board ID, and Inventory refers to the "Chassis" or "Switch" entries in 'show inventory'. This option can be further refined by setting the device access variable "single_serial" to "true", which will ensure that only the first serial number from that source is returned.

Restore series designation

Previous driver releases would identify the 'series' of a device, and append this to the Model name detected during snapshot. This behavior has been removed in current releases, but can be restored by setting the device access variable "add_series" to "true".

return to top

Routing Table

Release Notes

Routing Table diagnosic shows BGP summary if BGP enabled

If BGP is enabled then the Routing Table diagnostic will provide the results of the show ip bgp summary command. This prevents the product from requesting and storing a routing table that is likely to be extraordinarily large and time-consuming to capture. To enable capture of the regular routing table even when BGP is active, set the "all_routing" access variable to "true".

return to top

Configuration Deployment to Running

Release Notes

Deployment using configure replace

IOS 15.x supports the command 'configure replace' which allows direct installation of a running configuration, rather than the more customary merge operation using the 'copy' command. This driver implements that command for running configuration deployment by SCP and by TFTP. Startup configuration deployment and the TFTP+SNMP option use the 'copy' command and MIB, respectively, as the IOS 12.x drivers do.

return to top

Software Center

Release Notes

Command arguments for Archive Download-SW command

The Archive Download-SW command supports several command arguments. "/overwrite" is used by default, but can be omitted by setting the device access variable "noOverwrite" to "true". The argument "/imageonly" can be added to the command by setting the device access variable "imageOnly" to "true". The argument "/leave-old-sw" can be added by setting the device access variable "leaveOld" to "true". Also, the arguments "/no-version-check /allow-feature-upgrade" can be added if the device access variable "featureUpgrade" is set to "true".

Allow overwrite of existing image files

Normally, image update tasks will fail if the file already exists on the device. To allow the overwriting of an existing file, set the device access variable "allow_overwrite" to "true".

Verify option not possible on TAR software images

Cisco devices support installing TAR files that contain software images. However, the command used by IOS to install the file are atomic - no inspection of the software image's MD5 signature is possible, because the file is extracted and isntalled in one step. Clicking the 'verify' option for software images within a TAR file is not supported and will be ignored.

return to top

Driver Discovery

Release Notes

More prompt causes an unexpected disconnection

Discovery tasks for Javascript drivers handle More prompts by using timeouts, which can cause problems with the third-party SSH client code, which interprets the timeout as a disconnection. There are two options to work around the problem. Setting the RCX option [<option name="Driver/Discovery/UsePollRead">true</option>] in site_options.rcx will effect the workaround for all affected devices. Alternatively, it could be applied to a single device by setting the device access variable "PollRead" to "true".

Wakeup Ctrl-U character can cause discovery to fail

Discovery tasks for Javascript drivers use wakeup characters are sent during device connection, to ensure that the device is responding. Normally, these characters do not echo to the console, but some devices may echo them. In this case, this causes the prompt detection phase to fail, which in turn can cause More prompts to not be handled properly, and discovery may fail. If these characters are echoed from the device [check the session log to see this], then set the device access variable "skip_ctrl_u" to skip the sending of the wakeup characters. Note that setting this option on a previously working device could cause discovery tasks to fail, but it only affects CLI discovery. SNMP discovery is unaffected.

return to top

Syslog Triggering

Trigger Patterns

Devices supported by this driver trigger changes using the following patterns:
SYS-5-CONFIG_I
SYS-5-RESTART
SYS-5-RELOAD


User Patterns

These patterns are used to determine the username/IP responsible for a change:
/SYS-5-CONFIG.*onfigured from .* by ([\S ]+) on/
/SYS-5-CONFIG.*Configured from .* by vty.*\(([a-fA-F0-9:\.]+)\)/
/SYS-5-CONFIG.*Configured from tftp://([a-fA-F0-9:\.]+)/

return to top