Skip to content

Directory

The builtin.directory resource allows you to manage a directory, either creating or deleting it, and setting permissions.

Resource parameters

NameDescriptionRequiredDefault
pathPath to the directory you want to managetrue
ownerSet owner of the directoryfalseroot
groupSet group of the directoryfalseroot
modeSet permissions of the directoryfalse0644
force_deleteForce the deletion of the directory, even if it's not emptyfalsefalse

Examples

Create a directory at path /tmp/my_directory

yaml
- title: "Create directory /tmp/my_directory"
  type: "builtin.directory"
  present: true
  data:
    path: "/tmp/my_directory"

Force deletion of a directory at path /tmp/my_directory_to_delete

yaml
- title: "Force delete directory `/tmp/my_directory_to_delete`"
  type: "builtin.directory"
  present: false
  data:
    path: "/tmp/my_directory_to_delete"
    force_delete: true