Rename File
- 14 May 2021
- 1 Minute to read
- Print
- DarkLight
- PDF
Rename File
- Updated on 14 May 2021
- 1 Minute to read
- Print
- DarkLight
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
This is generated from the built in components of BuildMaster 7.0.0, and may be different than what you have installed (especially if you have extensions); go to [User Icon] -> Documentation within your BuildMaster instance to see exactly what operations are available.
Rename File
Renames a file on a server.
Script usage:
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.
Arguments:
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.
Example:
# renames logs.txt to include the environment name in context Rename-File ( From: logs.txt, To: logs.$EnvironmentName.txt, Overwrite: true );
Was this article helpful?