Templates allow network admins to automatically push device configurations to devices of the same type by replacing device-specific (IP address, hostname) information with variables, saving them time and reducing the possibility of error from one manual device configuration to another.
Note: The values of these variables are read-only and cannot be modified by scripts, though scripts are free to reference their values.
Name |
Description |
DateTime |
The current system date and time in the format yyMMdd-HHmmss. |
Device.IPv4Address |
The device's IPv4 address. |
Device.IPv6Address |
The device's IPv6 address. |
Device.IpAddress |
The device's network IP address. |
Device.SystemName |
The device's hostname. |
FileCaptureKey |
The presence of this variable in a script indicates that the device configuration specified with the variable should be captured from the file system as part of the transfer task. |
FileTransferMethod |
Determines the file transfer method to be used for the config file upload. Can be: SCP_SERVER, SCP_Client, SFTP_SERVER, SFTP_CLIENT, TFTP_SERVER. |
ReadTimeout |
Specifies how long WhatsConfigured should wait to read expected output after a command is issued. |
ScpClientDirectory |
The SCP client directory. |
ScpServerAddress |
The IP address of the SCP server. |
ScpServerPassword |
The password of the SCP server. |
ScpServerPort |
The port of the SCP server. |
ScpServerUserName |
The username required to connect to the SCP server. |
SftpClientDirectory |
The SFTP client directory. |
SftpServerAddress |
The IP address of the SFTP server. |
SftpServerPassword |
The password of the SFTP server. |
SftpServerPort |
The port of the SFTP server. |
SftpServerUserName |
The username required to connect to the SFTP server. |