Upon successful installation, or upgrade to the latest version of WhatsUp Gold, an SFTP/SCP server is automatically installed on the local WhatsUp Gold machine intended for use with Configuration Management. SFTP & SCP File Transfer settings will be configured out of the box including timeout, username, password, and root directory. WhatsUp Gold will determine the IP address automatically when a task script (backup or restore) is run and it is expected that this field will remain blank. However, if you receive any errors related to IP Address or would like to change the IP, you can populate this field manually. Please note, during upgrades, if SFTP or SCP settings are already configured by users, WhatsUp Gold will NOT override existing settings.

Select Configuration Management > File Transfer Settings from the SETTINGS menu to launch the File Transfer Settings dialog where you can modify these settings:

TFTP Settings

  • IP Address. The IP Address of the Trivial File Transfer Protocol server.
  • Port. The port number used by WhatsUp Gold for communication with the TFTP server.
  • Root Directory. The location where files received by the TFTP server are saved and where any files sent by the server are copied prior to sending.
  • TFTP transfer completion timeout (seconds). The amount of time that must elapse before a file transfer fails due to not receiving data.
  • TFTP transfer command timeout (seconds). The amount of time that must elapse before an individual command fails due to an unsuccessful attempt to executing a command.
  • Cleanup all TFTP transfer files created by Configuration Management. Enable this option to delete related files after the backup file(s) have been written to the database.
  • Use TFTP for configuration backup. Enable this option to ensure configuration files are validated using the TFTP server.
  • Use alternate TFTP server. Enable this option to specify the IP Address, Port, and Root Directory for a second TFTP server.

SFTP Settings

  • SFTP transfer completion timeout (seconds). The amount of time that must elapse before a file transfer fails due to not receiving data.
  • Cleanup all SFTP transfer files created by Configuration Management. Enable this option to delete related files after the backup file(s) have been written to the database.
  • Username. The user name associated with the account accessing the SFTP server.
  • IP Address. The IP Address of the Secure File Transfer Protocol server.
  • Password/Verify Password. The password associated with the account accessing the SFTP server.
  • Port. The port number used by WhatsUp Gold for communication with the SFTP server.
  • SFTP transfer command timeout (seconds). The amount of time that must elapse before an individual command fails due to an unsuccessful attempt to executing a command.
  • Root Directory. The location where files received by the SFTP server are saved and where any files sent by the server are copied prior to sending.
  • Directory. The location where the SFTP server is installed.
  • Application. The location of the executable used to access the SFTP server.
  • Application Arguments. the information passed to the server required for access (e.g., protocol, password).

SCP Settings

  • SCP transfer completion timeout (seconds). The amount of time that must elapse before a file transfer fails due to not receiving data.
  • Cleanup all SCP transfer files created by Configuration Management. Enable this option to delete related files after the backup file(s) have been written to the database.
  • Username. The user name associated with the account accessing the SCP server.
  • IP Address. The IP Address of the SCP server.
  • Password/Verify Password. The password associated with the account accessing the SCP server.
  • Port. The port number used by WhatsUp Gold for communication with the SCP server.
  • SCP transfer command timeout (seconds). The amount of time that must elapse before an individual command fails due to an unsuccessful attempt to executing a command.
  • Root Directory. The location where files received by the SCP server are saved and where any files sent by the server are copied prior to sending.
  • Directory. The location where the SCP server is installed.
  • Application. The location of the executable used to access the SCP server.
  • Application Arguments. the information passed to the server required for access (e.g., protocol, password).

Additional Information

The installer will attempt to use port 22 for SSH connection, by default, however, if another application on the same server is already using this port, WhatsUp Gold installation will successfully complete, but the SFTP Server service will not start, and the port must then be configured manually.

After installation or upgrade, you can see the new directories in the root of C:\ for the SFTP server. SFTP Server settings can also be modified using the SFTP Server application installed with WhatsUp Gold. On the WhatsUp Gold machine, navigate to C:\SFTPServer, then double-click SFTPServer.exe to launch the application. From here, you have access to several settings, including the ability to change the port and the root directory. You can also add new users or modify existing ones. Please see the SFTP Server help documentation for more information.

Important: Any changes made here must also be reflected in the File Transfer Settings dialog in WhatsUp Gold described previously.