Configuration and Command Scripts

Iotellect Network Manager can perform automatic reconfiguration of network devices by executing the so-called configuration scripts. Those scripts solve typical configuration change tasks, such as:

  • Changing device's ACL
  • Registering a new VLAN
  • Shutting down or rebooting a device
  • Modifying ARP table
  • Enabling IP SLA or NetFlow

Configuration scripts are normally executed by the server through an SSH or Telnet session. Scripts are not static, they can refer to any server-side or device-side data to ensure that each device receives its own customized set of commands.

The scripting engine supports two different syntax variants for writing simple line-by-line scripts and implementing custom logic based on device replies.

All configuration scripts can be applied to multiple devices in a bulk mode at once. The execution can be started on-demand, scheduled or initiated by an alert.

Script Types

There are two types of configuration and command scripts:

  • Expect scripts. Those scripts send some data to the device and expect a certain output, hence the name. See expect scripts for more information.
  • Parameterized scripts. Those scripts prompt operators to specify some input and dynamically construct command(s) that's sent to the device. No conditional device output processing is available. See parameterization engine for more information on how to configure input format and device commands.

Script Management

Configuration and commands scripts are managed via Configuration Scripts table available in the global configuration of Network Host device driver.

Script Execution

To execute a configuration or command script for a certain device, use Run Configuration Script action available in Configuration Management group.

Similarly to any other Iotellect actions, Run Configuration Script action supports some useful options:

  • Headless execution upon alert or schedule
  • Batch execution for many devices at once

Script Parameters

Before starting a script, Iotellect Server scans script table and finds all field references, e.g. references of {field} form. A Script Parameters dialog that pops up before script execution prompts operators to specify values for those references. For example, if a script includes {MAC} and {IP} references, the system will require specifying MAC and IP addresses that will be used during execution.

If parameters (fields) with matching names exist in the device's Backup Parameters table, those parameters are pre-filled from this table, still allowing an operator to adjust their values on-the-fly before the script execution starts.

Action Name        runConfigurationScript

Records:                1

Record Format:

Field Name

Field Type

Notes

ccmScriptName

String

Script name.

ccmScriptParameters

DataTable

Script parameters Data Table. See above for details.

controlProtocol

String

Control protocol: 'Telnet' or 'SSH'. Default: 'Telnet'.

telnetPort

Integer

Telnet port. Default: 23.

SSHPort

Integer

SSH port. Default: 22.

connectionTimeout

Integer

Connection timeout, ms. Default: 30000.

readTimeout

Integer

Read timeout, ms. Default: 5000.

eolDelimiter

String

End-of-Line Delimiter: 'rn' or 'n'. Default: 'rn'.

Use 'n' delimiter when SSH control protocol selected.

sshUsername

String

Username to use for SSH authentication.

sshPassword

String

Password to use for SSH authentication.

Was this page helpful?