FTP commands
- Last Updated: May 12, 2023
- 1 minute read
- WhatsUp Gold
- Version 2026
- Version 2025
- Version 2024
- Version 2023.1
@scp-client-transfer - should be used when an SCP client is to be used for a file transfer.
@sftp-client transfer - should be used when an SFTP client is to be used for a file transfer.
The commands take the following form:
<FTP-Command> <FromFile> <DeviceUserName>@<DeviceIpAdress>:<ToFile>
Note that <ToFile> is stored on the device on which the script is run against.
Some variables make these commands easier to use. Consider the following script:
FileTransferMethod = SCP_CLIENT
@scp-client-transfer $(TransferFileDirectory)\myFile $(Settings.UserName)@$(Device.IpAddress):/var/tmp/myFile
By setting the FileTransferMethod variable to SCP_CLIENT, the TransferFileDirectory is set to the scp client directory. Settings.UserName contains the credential username for the device the script is run against, Device.IpAddress contains the IP address of the device on which the script is run against.
Configuration Management uses default scp and sftp clients. The clients and their settings can be changed from the console under Tools > File Transfer Settings.