WhatsConfigured users can write custom scripts that log in to devices through Telnet or SSH and run CLI commands on their devices. Scripts can be used to configure devices or to capture information about them in the WhatsConfigured database. For example, the following script uses Cisco IOS commands to capture a Cisco device's running configuration in the WhatsUp Gold database under the "running-config" key.
#
# Cisco IOS Backup Running Configuration
#
# login to the device
@login
#enter privileged mode
@enable
# display the running configuration of the device and capture it in the WUG database [running-config] show run
# logout from the device
[-] exit
The WhatsConfigured custom script language is relatively simple and consists primarily of command-line interface (CLI) commands. The language is not meant to be a full-featured scripting language, such as JavaScript or VBScript, but rather is kept simple so that is accessible to all levels of WhatsConfigured users, including those with minimal programming skills. In order to meet the standards of this target audience, the language contains no constructs for looping, branching, or creating subroutines; it only supports simple sequences of commands.
The custom script language has three possible elements:
Each of these elements is explained in detail in the following sections.