---
title: "Rename-File"
---
Renames a file on a server.
Rename-File(
From: <text>,
To: <text>,
[Overwrite: <true/false>]
);
This operation may be prefixed with Files::, although this is a built-in namespace and isn't really necessary.
| Name | Format | Script Usage | Usage Notes |
|---|---|---|---|
| ☆ Source file | text | From | This argument is required. |
| ☆ Target file | text | To | This argument is required. |
| Overwrite | true/false | Overwrite |
Note: To rename multiple files at once, running a PowerShell script is recommended.
# renames logs.txt to include the environment name in context
Rename-File (
From: logs.txt,
To: logs.$EnvironmentName.txt,
Overwrite: true
);