# RenameFile Required Frends version: 5.5+ Required .NET version: 6.0 Compatible Agents: Crossplatform Source code: {% tabs %} {% tab title="Parameter: Input" %} | Name | Description | | ----------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Path : `String` |

Full path of the target file to be renamed.


Default: -
Example: /root/folder/example.txt

| | NewFileName : `String` |

New name for the file.


Default: -
Example: newName.txt

| | RenameBehaviour : `RenameBehaviour` |

How the file rename should work if a file with the new name already exists.

If Rename is selected, will append a number to the new file name e.g. renamed(2).txt

Possible values:

How the file rename should work if a file with the new name already exists.

If Rename is selected, will append a number to the new file name e.g. renamed(2).txt

How the file rename should work if a file with the new name already exists.

If Rename is selected, will append a number to the new file name e.g. renamed(2).txt

How the file rename should work if a file with the new name already exists.

If Rename is selected, will append a number to the new file name e.g. renamed(2).txt


Default: -
Example: -

| | {% endtab %} | | {% tab title="Parameter: Connection" %} | Name | Description | | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ConnectionTimeout : `Int32` |

The lenght of time, in seconds, until the connection times out.

You can use value -1 to indicate that the connection does not time out.

Default value is 60 seconds.


Default: 60
Example: 60

| | Address : `String` |

SFTP host address


Default: -
Example: localhost

| | Port : `Int32` |

Port number to use in the connection to the server.


Default: 22
Example: 22

| | Authentication : `AuthenticationType` |

Selection for authentication type

Possible values:

Selection for authentication type

Selection for authentication type

Selection for authentication type

Selection for authentication type

Selection for authentication type


Default: -
Example: AuthenticationType.UsernamePassword

| | Username : `String` |

Username to use for authentication to the server. Note that the file endpoint only supports

username for remote shares and the username must be in the format DOMAIN\Username.


Default: -
Example: foo

| | 🗝Password : `String` |

Password to use in the authentication to the server.


Default: -
Example: pass

| | PrivateKeyFile : `String` |

Full path to private key file. Supported private key formats: OpenSSH and ssh.com.

PuTTY keys can be converted with puttygen.exe application.

1. Load your key file into puttygen.exe

2. Conversion > Export OpenSSH key (not the "force new file format" option)


Default: -
Example: C:\path\to\private\key

| | 🗝PrivateKeyString : `String` |

Private key as a string, supported private key formats: OpenSSH and ssh.com.

PuTTY keys can be converted with puttygen.exe application.

1. Load your key file into puttygen.exe

2. Conversion > Export OpenSSH key (not the "force new file format" option)


Default: -
Example: -----BEGIN RSA PRIVATE KEY----- Fqxq2jbSKyb0a+oW96Tjoif3Kcb5zZ0FiQyiHgQozLXrecjdUwjWuedkDoZMxwG5 bxpOnxZ/88tDzYCtCPcYCPRF8BNueUsZO8/tztTra+4NgVd/omXHG5bqb7iMB4dc ... OX7Q/wO4lqOlFhLtRnSL0cfuhRmt59pM75Zd+euX5tv9jmCj+AQT/kiBoMhNrDGk N2gTujnH7HCr/afSBeL3xnYcEmeCQTxTPZofBjPC+TPd9g7MntSGBeU/Fstv0jbg -----END RSA PRIVATE KEY-----

| | 🗝PrivateKeyPassphrase : `String` |

Passphrase for the private key file.


Default: -
Example: passphrase

| | ServerFingerPrint : `String` |

Fingerprint of the SFTP server. When using "Username-Password"

authentication it is recommended to use server fingerprint in

order to be sure of the server you are connecting.


Default: -
Example: MD5: '41:76:EA:65:62:6E:D3:68:DC:41:9A:F2:F2:20:69:9D' SHA256: 'FBQn5eyoxpAl33Ly0gyScCGAqZeMVsfY7qss3KOM/hY='

| | HostKeyAlgorithm : `HostKeyAlgorithms` |

Host key algorithm to use when connecting to server.

Default value is Any which doesn't force the task to use

specific algorithm.

Possible values:

Host key algorithm to use when connecting to server.

Default value is Any which doesn't force the task to use

specific algorithm.

Host key algorithm to use when connecting to server.

Default value is Any which doesn't force the task to use

specific algorithm.

Host key algorithm to use when connecting to server.

Default value is Any which doesn't force the task to use

specific algorithm.

Host key algorithm to use when connecting to server.

Default value is Any which doesn't force the task to use

specific algorithm.

Host key algorithm to use when connecting to server.

Default value is Any which doesn't force the task to use

specific algorithm.

Host key algorithm to use when connecting to server.

Default value is Any which doesn't force the task to use

specific algorithm.


Default: 0
Example: HostKeyAlgorithms.RSA

| | UseKeyboardInteractiveAuthentication : `Boolean` |

Enable if the server uses keyboard-interactive authentication method.


Default: False
Example: false

| | PromptAndResponse : `PromptResponse[]` |

Responses for the server prompts when using Keyboard Interactive authentication method.


Default: -
Example: \[PromptResponse { Prompt = Verification code, Response = 123456789 } ]

| | BufferSize : `UInt32` |

Integer value of used buffer size as KB.

Default value is 32 KB.


Default: 32
Example: 32

| | {% endtab %} | | {% tab title="Result: Result" %} | Name | Description | | --------------- | ----------------------------------------------------------------------------------- | | Path : `String` |

Path for the renamed file.
Example: /test/folder/example.txt

| | {% endtab %} | | {% tab title="Changelog" %} ## Changelog ### \[3.0.0] - 2026-01-27 #### Changed **Breaking changes!** * Updated dependency SSH.NET to the newest version 2025.1.0. * Drop DSS support ### \[2.3.0] - 2026-01-13 #### Fixed * Operation timeout is now using the Connection.ConnectionTimeout parameter. ### \[2.2.0] - 2025-01-10 #### Fixed * Fixed issue with ConnectionInfoBuilder having static properties for connection and input parameters which lead to Task not being thread safe. ### \[2.1.0] - 2024-08-19 #### Updated * Updated Renci.SshNet library to version 2024.1.0. ### \[2.0.0] - 2024-01-03 #### Updated * \[Breaking] Updated dependency SSH.NET to the newest version 2023.0.0. #### Changed * Changed connection info builder to create the connection info as it's done in DownloadFiles. * \[Breaking] Changed PrivateKeyFilePassphrase parameter to PrivateKeyPassphrase and enabled it when PrivateKeyString was used. ### \[1.0.0] - 2023-05-23 #### Added * Initial implementation {% endtab %} {% endtabs %}