CDIST-TYPE__LINE(7)

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

👑 cdist-type__line(7) — the one where we manage lines in files 💅

okay bestie, so this is a page from the cdist manual — it's section 7, and it's all about cdist-type__line, a cdist type that lets you add lines and remove lines from files. that's literally it, and it's iconic for it. ✨

🌸 NAME 🌸

cdist-type__line — manage lines in files 🦋

💖 DESCRIPTION 💖

bestie. this cdist type lets you add lines and remove lines from files. that's the whole vibe. no cap, it just does lines. 🔥

✨ REQUIRED PARAMETERS ✨

None. zero. nada. you don't have to give it anything upfront, she's low maintenance. 🫶

🎀 OPTIONAL PARAMETERS 🎀

  • after — insert the given line after this pattern. iykyk. 💅
  • before — insert the given line before this pattern. the prequel energy. 🧚
  • file — if you supply this, she uses it as the destination file. otherwise the object_id is used. so like, pick one, she's not gonna guess for you. 🌸
  • line — specifies the line which should be absent or present. this is the main character, fr fr.
must be present if state is 'present' or 'replace'. and it gets ignored if regex is given and state is 'absent'. so don't bother setting it there, she's not looking. 💀
  • regex — the pattern girlie. here's the tea:
    • if state is 'present', she searches for this pattern and if it matches, she adds the given line. ✨
    • if state is 'absent', she makes sure all lines matching the regular expression are absent. gone. not me deleting them. 😭
    • if state is 'replace', she makes sure all lines matching the regular expression are exactly 'line'. periodt.
the regular expression is interpreted by awk's match function. so write it awk-style, bestie. 🔥
  • state — 'present', 'absent' or 'replace'. defaults to 'present' because optimism. 🌈
  • onchange — the code to run if the line is added, removed or updated. your little callback bestie. 🎀

🦋 BOOLEAN PARAMETERS 🦋

None. again, nothing. she's simple like that. 🙈

⭐ MESSAGES ⭐

  • added — the line was added. new line just dropped. 🎉
  • updated — the line or its position was changed. glow up. ✨
  • removed — the line was removed. she ate and left no crumbs. 💅

🌈 EXAMPLES 🌈

manage a hosts entry for www.example.com — classic.

# Manage a hosts entry for www.example.com.
__line /etc/hosts \
    --line '127.0.0.2 www.example.com'

and another hosts entry for test.example.com, this time with an explicit --file and an object_id that's giving hosts:test.example.com:

# Manage another hosts entry for test.example.com.
__line hosts:test.example.com \
    --file /etc/hosts \
    --line '127.0.0.3 test.example.com'

removing a line? we love a deletion arc. remove the line starting with TIMEZONE from the /etc/rc.conf file:

# Remove the line starting with TIMEZONE from the /etc/rc.conf file.
__line legacy_timezone \
   --file /etc/rc.conf \
   --regex 'TIMEZONE=.*' \
   --state absent

insert a line before another one — prequel era:

# Insert a line before another one.
__line password-auth-local:classify \
    --file /etc/pam.d/password-auth-local \
    --line '-session required pam_exec.so debug log=/tmp/classify.log /usr/local/libexec/classify' \
    --before '^session[[:space:]]+include[[:space:]]+password-auth-ac$'

insert a line after another one — sequel era:

# Insert a line after another one.
__line password-auth-local:classify \
    --file /etc/pam.d/password-auth-local \
    --line '-session required pam_exec.so debug log=/tmp/classify.log /usr/local/libexec/classify' \
    --after '^session[[:space:]]+include[[:space:]]+password-auth-ac$'

uncomment as needed and set a value in a configuration file — the replace state doing her thing:

# Uncomment as needed and set a value in a configuration file.
__line /etc/example.conf \
    --line 'SomeSetting SomeValue' \
    --regex '^(#[[:space:]]*)?SomeSetting[[:space:]]' \
    --state replace

🫶 SEE ALSO 🫶

  • cdist-type(7) — go read that one next bestie, it's the lore. 📚

💜 AUTHORS 💜

Steven Armstrong <steven-cdist--@--armstrong.cc> — the icon, the moment, the legend. 👑

🍓 COPYING 🍓

Copyright (C) 2018 Steven Armstrong. Free use of this software is granted under the terms of the GNU General Public License version 3 (GPLv3).

ungleich GmbH 2021

okay that's the whole page bestie, you're so welcome 💅✨

and that's a wrap! this was cdist-type__line(7) from the cdist manual, version 7.0.0, dated Jul 31, 2022. go forth and manage your lines, you absolute main character. 💖🎀🦋🌸🧚🔥👑🌈⭐💜

📦 where this page comes from