CDIST-TYPE__KEY_VALUE(7)

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

💖 cdist-type__key_value — the manual, but make it slay 💖

okay bestie, gather round, because this is the cdist-type__key_value page from the cdist manual and it's literally about ✨changing property values in files✨. That's the whole vibe. She's a cdist type, she edits values in a key-value based config file, and she does it flawlessly. No cap. 🎀

🌸 NAME 🌸

cdist-type__key_value — change property values in files, fr fr 💅

🦋 DESCRIPTION 🦋

This cdist type lets you change values in a key value based config file. That's it. That's the job. And she eats every single time. 👑

🎀 REQUIRED PARAMETERS 🎀

Like, you genuinely have to give her these. Non-negotiable. 💅

  • file — the file to operate on. The one we're editing. Yes, that one.
  • delimiter — the delimiter that separates the key from the value.

✨ OPTIONAL PARAMETERS ✨

These are the little extras, the accessories to the outfit 🫶

  • state — present or absent, and it defaults to present. If it's present, she sets the key to the value. If it's absent, she removes the key from the file. Gone. Not invited. 💀
  • key — the key to change. Defaults to object_id. (iykyk)
  • value — the value for the key. Optional if state=absent, but required otherwise. You can't have a value-less value situation, bestie.
  • comment — if you supply this, the value gets inserted before the line with the key, but only if the key or value must be changed. And listen — you need to make sure yourself that the line is prefixed with the correct comment sign. Like # or ; or wathever .. She is not your comment-sign babysitter. 🙈
  • onchange — the code to run if the key or value changes (i.e. is inserted, removed or replaced). Run it, queen. 🔥

🌈 BOOLEAN PARAMETERS 🌈

  • exact_delimiter — if you supply this, additional whitespaces between key, delimiter and value get treated as a wrong value. Strict mode activated, no extra spaces allowed, periodt. ✋

💜 MESSAGES 💜

She talks to you, obviously. Here's what she says and what it means:

  • remove — Removed existing key and value
  • insert — Added key and value
  • change — Changed value of existing key
  • create — A new line was inserted in a new file

🌟 EXAMPLES 🌟

okay here's where it gets cute, look at her go:

# Set the maximum system user id
__key_value SYS_UID_MAX --file /etc/login.defs --value 666 --delimiter ' '

# Same with fancy id
__key_value my-fancy-id --file /etc/login.defs --key SYS_UID_MAX --value 666 \
   --delimiter ' '

# Enable packet forwarding
__key_value net.ipv4.ip_forward --file /etc/sysctl.conf --value 1 \
   --delimiter ' = ' --comment '# my linux kernel should act as a router'

# Remove existing key/value
__key_value LEGACY_KEY --file /etc/somefile --state absent --delimiter '='

not me being obsessed with that comment line, "my linux kernel should act as a router" is main character energy fr 🌸

🧚 MORE INFORMATION 🧚

This type tries to handle as many values as possible, so it does not use regexes. Which means: you need to exactly specify the key and the delimiter. No fuzzy guessing, no vibes-based matching. And good news — the delimiter can be of any length. Slay. ✨

👑 AUTHORS 👑

Steven Armstrong <steven-cdist--@--armstrong.cc>

📜 COPYING 📜

Copyright (C) 2011 Steven Armstrong. 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

and that's the whole page, bestie 🫶 this was cdist 7.0.0, dated Jul 31, 2022, and honestly? iconic. go forth and edit your key values. mwah. 💅🎀🦋

📦 where this page comes from