> For the complete documentation index, see [llms.txt](https://docs.frends.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.frends.com/tasks/tasks/smb/renamefile.md). # RenameFile Task version: 2.2.0 Required Frends version: 5.7+ Required .NET version: 8.0 Compatible Agents: Crossplatform Source code: ## Task Parameters {% tabs %} {% tab title="Input" %} | Name | Description | | ---------------------- | -------------------------------------------------------------------------------------------------------------------- | | Path : `String` |

Path to the file to be renamed.


Default: -
Example: folder\oldfile.txt

| | NewFileName : `String` |

The new filename including extension.


Default: -
Example: newfile.txt

| | {% endtab %} | | {% tab title="Connection" %} | Name | Description | | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Server : `String` |

SMB server address or hostname.


Default: -
Example: 127.0.0.1

| | Share : `String` |

SMB share name to connect to.


Default: -
Example: testshare

| | Username : `String` |

Username for SMB authentication.

This needs to be of format domain\username


Default: -
Example: WORKGROUP\Administrator

| | 🗝Password : `String` |

Password for the SMB credentials.


Default: -
Example: Password123

| | OperatingSystem : `Os` |

Defines the operating system of the SMB server.

Options used to determine correct path separator to use.

Possible values:

Options used to determine correct path separator to use.

Options used to determine correct path separator to use.


Default: 2
Example: Linux

| | {% endtab %} | | {% tab title="Options" %} | Name | Description | | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | RenameBehaviour : `RenameBehaviour` |

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

Possible values:


Default: 2
Example: RenameBehaviour.Throw

| | ThrowErrorOnFailure : `Boolean` |

Whether to throw an error on failure.


Default: True
Example: false

| | ErrorMessageOnFailure : `String` |

Overrides the error message on failure.


Default: -
Example: Custom error message

| | {% endtab %} | | | {% endtabs %} | | ## Task Result | Name | Description | | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | Success : `Boolean` |

Indicates if the task completed successfully.
Example: true

| | NewFilePath : `PathString` |

Full path of the file after the rename operation.
Example: Folder/SubFolder/document.txt

| | Error : `Error` |

Error that occurred during task execution.
Example: object { string Message, Exception AdditionalInfo }

| ## Task Changelog Changelog for Task Frends.Smb.RenameFile. ### \[2.2.0] - 2026-06-26 #### Changed * Username parsing: now accepts a username without a domain instead of throwing an error. ### \[2.1.0] - 2026-04-23 #### Fixed * Input parameters treated as normal string instead of PathString type. ### \[2.0.0] - 2026-04-08 #### Added * New connection parameters that defined what servers Operating System. * \[Breaking Change] Introduce PathString type that will represent paths with OS specific separators. ### \[1.0.0] - 2025-11-07 #### Added * Initial implementation --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.frends.com/tasks/tasks/smb/renamefile.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.