--- title: "Rename-File" ---
This is generated from the built in components of Otter 2023.0, and may be different than what you have installed (especially if you have extensions); go to [Gear Icon] -> Administration -> Operations within your Otter instance to see exactly what operations are available.

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:

NameFormatScript UsageUsage 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
);