Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Rename File or Directory activity

The Rename File or Directory activity renames a file or directory to a new name on an SFTP server.

Input variables

VariableDescription
sourceHostName or IP address of the server containing the file or directory you want to rename.
sourcePortPort number to use to communicate with the target server. The default port number is 22.
sourceFilePathFull path to the file or directory to rename.
targetFilePathFull path to the renamed file or directory.
sourceCredentialTagSpecific Credential aliases for Orchestration activities this activity must use to run SSH commands on the host.

Output variables

VariableDescription
errorMessagesThe executionResult.errorMessages from the Activity designer parsing sources. If this variable is not null, the operation has failed.
resultA message saying that the operation has been successful. For example, you might see: Rename /tmp/sftp_test/subdir1 to /tmp/sftp_test/subdir2 complete.

Conditions

ConditionDescription
SuccessThe activity succeeded in renaming the file or directory.
FailureThe activity failed to rename the file or directory.

Parent Topic:SFTP File Transfer activity pack