permissions_type_recursion

Ensure that a file or directory is present and has the right mode/owner/group.

⚙️ Compatible targets: Linux

Parameters

NameDocumentation
pathPath to edit.

This parameter is required.
modeMode of the path to edit.

This parameter is optional.
ownerOwner of the path to edit.

This parameter is optional.
groupGroup of the path to edit.

This parameter is optional.
typeType of the path to edit (all/files/directories).

This parameter is required.
recursionRecursion depth to enforce for this path (0, 1, 2, ..., inf).

This parameter is required.

Outcome conditions

You need to replace ${path} with its actual canonified value.

  • ✅ Ok: permissions_${path}_ok
    • ☑️ Already compliant: permissions_${path}_kept
    • 🟨 Repaired: permissions_${path}_repaired
  • ❌ Error: permissions_${path}_error

Example

method: permissions_type_recursion
params:
  path: VALUE
  mode: OPTIONAL_VALUE
  owner: OPTIONAL_VALUE
  group: OPTIONAL_VALUE
  recursion: VALUE
  type: VALUE

Documentation

The method ensure that all files|directories|files and directories have the correct owner, group owner and permissions.

The parameter type can be either: "all", "files" or "directories". The parameter recursion can be either: "0,1,2,3,.... inf" The level of recursion is the maximum depth of subfolder that will be managed by the method:

  • 0 being the current folder/file
  • 1 being the current folder/file and its subfolders
  • ..
  • inf being the file or the whole folder tree