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 |
Example |
DateTime |
The current system date and time in the format yyMMdd-HHmmss. |
130626-143218 |
Device.IPv4Address |
The device's IPv4 address. |
123.456.78.9 |
Device.IPv6Address |
The device's IPv6 address. |
ff06:1:1:1:1:3:2:c3 |
Device.IpAddress |
The device's network IP address. |
123.456.78.9 |
Device.SystemName |
The device's hostname. |
DEV-2821.ipswitch.com |
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. |
FileCaptureKey=running-config |
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. |
FileTransferMethod = SCP Client |
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. |
|