Script Argument

Description

-rf <filename>

List of routers or IP Address/(DNS hostname) to run script against (REQUIRED -rf or -ipaddr)

NOTE: Cannot use the -ipaddr and the -rf option at the same time!

-ipaddr <ip_address or routername>

IP address or router/switch name (if defined in hosts file or DNS)

Use -ipaddr to send commands to a single device or -rf to send commands to list of devices specfied in file.  (REQUIRED -rf or -ipaddr)

NOTE: Cannot use the -ipaddr and the -rf option at the same time!

-cf <filename>

File which contains a list of commands to send to routers.  One command per line.  Lines that begin with a "#" are considered comments and will not be sent to the router.

(REQUIRED -cf or -cmd)

NOTE: Cannot use the -cf and the -cmd option at the same time!

-cmd <command>

Command to send to router.  Useful when only needing to send a few commands to a single device or list of devices.  It saves you the time of having to create a text file with only a few commands in it.  If the command contains spaces then it must be enclosed in double quotes (only when running script from cli, not GUI. This option can be used up to 7 times when used with the GUI.  The command line version of this script can repeat this option an unlimited number of  times.  However, for more than 5 to 7 commands, it is recommended to put the commands in a text file and use the -cf option. (REQUIRED -cf or -cmd)

NOTE: Cannot use the -cf and the -cmd option at the same time!

Example:

-cmd "show tech"

-testmode

Test Mode. Build and display the commands that would have been sent to the devices but DO NOT actually connect to the devices and send the commands.  Useful for confirming command looping and variable substitutions are correct or for just double checking the commands that will be sent .  List of commands are

also written to the file $SCRIPT_HOME/<script_name>_sample_cmds.txt".

(OPTIONAL)

-wm

Saves configuration file to NVRAM after sending the commands.  This would only make sense if any of the commands were configuration commands.  This option performs a "write memory" on the router.  (OPTIONAL)

-ual (1 or 2)

User Access Level.  Tells the script what access-level (1st or 2nd) to log into the router before sending the commands.  By default the script will only go into 1st level access.  (OPTIONAL)

-dir <directory>

If specified, tells script to save output for each device into a separate file.  Files will be saved to the directory specified.  If the directory does not exist, the script will create it.  By default output for all devices is only saved to the detailed trace file.  The directory entered can be either an absolute directory or a relative directory.  If running the script from the GUI, a relative directory is relative to the "SCRIPT_HOME" variable. (From the GUI see Options->Settings). (OPTIONAL)

-autodir <date | time>

Automatically create new unique directory to save output for each device into a separate file.  The choices are date or time. 

The date option will create a new directory consisting  of just the date

e.g. 08012010 for Aug 1st 2010. 

The time option will append the time to the date:

e.g. 08012010_12h36m15s

If used with the -dir option, the new unique directory will be created under the -dir directory.  If the -dir option is not used, then the new unique directory will be created under the SCRIPT_HOME directory.  Note, if the date option is used and that directory name happens to all ready exist, then files in that directory will be overwritten. There are no safety prompts for the user when using this option.

-urfn

Use Route File Name.  When saving the output data to a separate file for each device, the filename used will be the name/IP Address stated in the -rf file.  The default filename is the router hostname configured on the router.  This option only applies when used with the -dir option. (OPTIONAL)

-safe

Safe Mode.  If an error occurs while sending a configuration command to a router in the list, all subsequent commands to that router will not be sent.  The script will continue on to the next router on the list and continue sending commands.  (OPTIONAL)

-ssafe

SuperSafe Mode.  Abort Script if there is an error while sending any of the configuration commands to any of the routers. (OPTIONAL)

-nokey

Don't prompt user for encryption key when using encrypted password file.  (OPTIONAL)

-ssh

Use Secure Shell when accessing routers.  Do NOT use with -pw option. (OPTIONAL)

-pw <filename>

Login/Password File.  (OPTIONAL)

-log <filename>

Save detailed trace file to a name other than the default file name.  (OPTIONAL)

-ulog

Unique Log file.  Save detailed trace log file to a Unique filename automatically created by script. Filename will be in format of scriptname_timestamp.log. (OPTIONAL)

Command

Description

clear counters

clear counter

The Cisco IOS clear counters command requires confirmation after entering the command in the CLI.  The script will automatically send the confirmation to clear the counters.

clear logging

clear log

The Cisco IOS clear logging (or clear log) command requires confirmation after entering the command in the CLI.  The script will automatically send the confirmation to clear the log.

clear line <line number>

The Cisco IOS clear line <line number> command requires confirmation after entering the command in the CLI.  The script will automatically send the confirmation to clear the line.

clear ip traffic

The Cisco IOS clear ip traffic command requires confirmation after entering the command in the CLI.  The script will automatically send the confirmation to clear the ip traffic counters.

reload

reload /noverify

The Cisco IOS reload command requires confirmation after entering the command in the CLI.  The script will automatically send the confirmation to reload the router.  Note, after entering the reload command, the router could respond with a message stating "the configuration has change, do you wish to save the configuration file before rebooting?" If this happens, the router will NOT reload the router, it will log an error message and exit from the router.

The reload /noverify option is supported and needed in the case when the "file verify auto" command is present in the IOS configuration.  When the file verify auto command is configured, the router verifies the integrity of the IOS file before reloading the router.  If the "file verify auto" option is present and the the /noverify option is not used, the Automater script will fail when trying to reload the router.

Note, do not use the reload command in the input file and the -wm option on the command line together. If you wish to perform a write mem before issuing a reload, then add the "wr mem" to the input command file before the reload command.  (This is because the -wm is performed after all of the commands in the input file are issued but the reload command will terminate the telnet session and the write mem can no longer be performed)

write mem

wr mem

If the script sees this string as one of the commands to send, internally it will run a separate procedure that is looking for the string [OK].  If it doesn't see this, it will log an error.  Note, you could also just use the -wm command line option if you want to save the configuration after all of the commands are sent.

configure replace

config replace

The Cisco IOS configure replace command requires confirmation after entering the command in the CLI.  The script will automatically send the confirmation.  In addition, it will also look for the string Rollback Done.  If if doesn't see this, it will log an error.

SLEEP <seconds>

The SLEEP command is not a command that will be sent to the router.  If desired, this is a method to introduce a delay between commands.  Seconds can be a whole integer (e.g. 2) or a real number (e.g. 1.5).  The SLEEP command must be entered in all CAPITAL letters otherwise it will be interpreted as a command to send to the router.  It must also start at the beginning of the line (no leading spaces or tabs).  Note, this is not typically needed but may be useful if you would like to watch the script as it is running to visually inspect the output of a particular command. CASE SENSITIVE

RETURN

Using the keyword RETURN is equivalent to sending just a carriage return or Enter key.  Not commonly used. CASE SENSITIVE

LOOPSTART <num>

or

LOOPEND

Allows the capability to send the same command(s) over and over, a specified number of times.  The command(s) that will repeated are the commands between the LOOPSTART and LOOPEND commands.  See Command Looping for more information. CASE SENSITIVE

COUNTERVAR <variable> <start_num> <increment by>

Define a counter variable. Provides a method to define a variable in the command file; it must be used with the LOOPING feature.  The variable must be a single alphabetical character.  "start_num" is the number that the counter will start at.  It will increment by the <increment by> number each time through the LOOP.  See Counter Variables for more information. CASE SENSITIVE