Renames a file or directory on an SFTP server.


icon

Inputs/Outputs

  • cbool.png must be atomic —

    must be atomic specifies whether the rename action must be atomic. The default value is FALSE.

    Use this input to ensure that running processes do not temporarily see the destination file as missing. Atomic rename is an OpenSSH extension and may not be supported on all SFTP servers.

  • cNI__SFTP_lvlib_Sessionlvclass.png session in —

    session in specifies the session of the SFTP server connection.

  • cstr.png old remote path —

    old remote path specifies the path of the file or directory that you want to rename on the SFTP server.

  • cstr.png new remote path —

    new remote path specifies the new path with the updated name of the file or directory.

  • cerrcodeclst.png error in —

    error in describes error conditions that occur before this node runs. This input provides standard error in functionality.

  • ci32.png timeout (ms) —

    timeout (ms) specifies the time, in milliseconds, that the VI waits before timing out. A value of –1 indicates to wait indefinitely. The default value is 30000.

  • iNI__SFTP_lvlib_Sessionlvclass.png session out —

    session out returns a session that stores the configuration and state of an SFTP server connection. Use this session to refer to the SFTP server connection in subsequent VI calls.

  • ierrcodeclst.png error out —

    error out contains error information. This output provides standard error out functionality.