Otter Documentation

files - Ensure Directory

  • 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.

Ensure Directory

Ensures the existence of a directory on a server.

Operation type:

Ensuring - this operation will ensure a specified configuration exists on a remote server after comparing its current state to the desired state.

Script usage:

Ensure-Directory(
	Name: <text>,
	[Exists: <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
🔑 Name
text
Name
This argument is the unique key for this operation, which means it must uniquely identify the target of the operation. This argument is required.
Exists
true/false
Exists

Example:

# ensures the Logs directory for the website exists and that it's writable
Ensure-Directory(
    Name: E:\Website\Logs,
    ReadOnly: false
);

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 979eb9fd on master