Otter Documentation

files - Rename File

  • Last Modified: 2020-06-26

This is generated from the built-in components of Otter 2.2, and may be different than what you have installed (especially if you have extensions); go to [User Icon] > Documentation within your Otter instance to see exactly what operations are available.

Rename File

Renames a file on a server.

Operation type:

Executing - this operation will perform a specified action or actions on a remote 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
);

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.

Generated from commit 46e90aca on master