CDIST-TYPE__DIRECTORY(7)

📦
version 7.0.0 · 8 versions
, in fedora 43, fedora 44

✨ NAME ✨

cdist-type__directory(7) — manage a directory 💅

This is the cdist type that handles directories on the target, bestie. It can create them or remove them.

🌸 DESCRIPTION 🌸

This cdist type allows you to create or remove directories on the target. That's the whole vibe. ✨

🎀 REQUIRED PARAMETERS 🎀

None. Not a single one, bestie — you're free to go off with the optional stuff. 💖

💖 OPTIONAL PARAMETERS 💖

  • state — can be 'present', 'absent', 'exists' or 'pre-exists', and it defaults to 'present', where:
    • present — the directory exists and the given attributes are set. ✨
    • absent — the directory does not exist. 💀
    • exists — the directory exists, but its attributes are not altered if it already existed. 🙈
    • pre-exists — check that the directory exists and is indeed a directory, but do not create or modify it. 👑
  • group — Group to chgrp to. 🫶
  • mode — Unix permissions, suitable for chmod. 💅
  • owner — User to chown to. 👑

🔥 BOOLEAN PARAMETERS 🔥

  • parents — Whether to create parents as well (mkdir -p behaviour). Warning: all intermediate directory permissions default to whatever mkdir -p does. Usually this means root:root, 0700. 😭
  • recursive — If supplied the chgrp and chown call will run recursively. This does not influence the behaviour of chmod. 💅

🦋 MESSAGES 🦋

  • chgrp <group> — Changed group membership 💖
  • chown <owner> — Changed owner 👑
  • chmod <mode> — Changed mode ✨
  • create — Empty directory was created 🎀
  • remove — Directory exists, but state is absent, directory will be removed by generated code. 💀
  • remove non directory — Something other than a directory with the same name exists and was removed prior to create. 😭

🌈 EXAMPLES 🌈

Okay bestie, here are the examples, copied exactly so you can steal them:

# A silly example
__directory /tmp/foobar

# Remove a directory
__directory /tmp/foobar --state absent

# Ensure /etc exists correctly
__directory /etc --owner root --group root --mode 0755

# Create nfs service directory, including parents
__directory /home/services/nfs --parents

# Change permissions recursively
__directory /home/services --recursive --owner root --group root

# Setup a temp directory
__directory /local --mode 1777

# Take it all
__directory /home/services/kvm --recursive --parents \
    --owner root --group root --mode 0755 --state present

💜 AUTHORS 💜

Nico Schottelius <nico-cdist--@--schottelius.org> 🌸

📜 COPYING 📜

Copyright (C) 2011 Nico Schottelius. You can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. 💖

ungleich GmbH 2021 ✨

Catch you later, bestie — this was cdist-type__directory(7), from cdist version 7.0.0, dated Jul 31, 2022. Stay slay, stay organized, and may your directories always be exactly where you left them. 💖✨👑

📦 where this page comes from