Otter Documentation

files - Delete Files

  • Last Modified: 2020-03-05

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.

Delete Files

Deletes files on a server.

Operation type:

Executing - this operation will perform a specified action or actions on a remote server.

Script usage:

Delete-Files(
	Include: <@(text)>,
	[Exclude: <@(text)>],
	[Directory: <text>],
	[Verbose: <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
Include (default)
@(text)
Include
See KB#1119 to learn more about masking syntax. This argument is required.
Exclude
@(text)
Exclude
See KB#1119 to learn more about masking syntax.
Directory
text
Directory
Verbose
true/false
Verbose

Note: This operation will delete files one-by-one. To clear large directories, a PowerShell script may be more performant.

Example:

# delete all .config files in the working directory except web.config
Delete-Files(
    Include: *.config,
    Exlude: web.config
);

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 7ca022a8 on master