507 lines
32 KiB
HTML
507 lines
32 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>14.74. cdist-type__key_value(7) — cdist 4.8.4 documentation</title>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="index" title="Index"
|
|
href="../genindex.html"/>
|
|
<link rel="search" title="Search" href="../search.html"/>
|
|
<link rel="top" title="cdist 4.8.4 documentation" href="../index.html"/>
|
|
<link rel="up" title="14. cdist types" href="../cdist-types.html"/>
|
|
<link rel="next" title="14.75. cdist-type__keyboard(7)" href="cdist-type__keyboard.html"/>
|
|
<link rel="prev" title="14.73. cdist-type__jail_freebsd9(7)" href="cdist-type__jail_freebsd9.html"/>
|
|
|
|
|
|
<script src="../_static/js/modernizr.min.js"></script>
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
|
|
|
|
|
|
<a href="../index.html" class="icon icon-home"> cdist
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<div class="version">
|
|
4.8.4
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-intro.html">1. cdist - usable configuration management</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-why.html">2. Why should I use cdist?</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-os.html">3. Supported Operating Systems</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-install.html">4. How to install cdist</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-update.html">5. How to update cdist</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-support.html">6. Support</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-features.html">7. Features</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-quickstart.html">8. Quickstart</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../man1/cdist.html">9. cdist(1)</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-bootstrap.html">10. Bootstrap</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-configuration.html">11. Configuration</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-manifest.html">12. Manifest</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-type.html">13. cdist type</a></li>
|
|
<li class="toctree-l1 current"><a class="reference internal" href="../cdist-types.html">14. cdist types</a><ul class="current">
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_default_release.html">14.1. cdist-type__apt_default_release(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_key.html">14.2. cdist-type__apt_key(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_key_uri.html">14.3. cdist-type__apt_key_uri(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_mark.html">14.4. cdist-type__apt_mark(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_norecommends.html">14.5. cdist-type__apt_norecommends(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_ppa.html">14.6. cdist-type__apt_ppa(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_source.html">14.7. cdist-type__apt_source(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__apt_update_index.html">14.8. cdist-type__apt_update_index(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__block.html">14.9. cdist-type__block(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__ccollect_source.html">14.10. cdist-type__ccollect_source(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__cdist.html">14.11. cdist-type__cdist(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__cdistmarker.html">14.12. cdist-type__cdistmarker(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__chroot_mount.html">14.13. cdist-type__chroot_mount(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__chroot_umount.html">14.14. cdist-type__chroot_umount(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__config_file.html">14.15. cdist-type__config_file(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul.html">14.16. cdist-type__consul(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_agent.html">14.17. cdist-type__consul_agent(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_check.html">14.18. cdist-type__consul_check(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_reload.html">14.19. cdist-type__consul_reload(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_service.html">14.20. cdist-type__consul_service(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_template.html">14.21. cdist-type__consul_template(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_template_template.html">14.22. cdist-type__consul_template_template(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_watch_checks.html">14.23. cdist-type__consul_watch_checks(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_watch_event.html">14.24. cdist-type__consul_watch_event(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_watch_key.html">14.25. cdist-type__consul_watch_key(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_watch_keyprefix.html">14.26. cdist-type__consul_watch_keyprefix(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_watch_nodes.html">14.27. cdist-type__consul_watch_nodes(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_watch_service.html">14.28. cdist-type__consul_watch_service(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__consul_watch_services.html">14.29. cdist-type__consul_watch_services(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__cron.html">14.30. cdist-type__cron(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__daemontools.html">14.31. cdist-type__daemontools(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__daemontools_service.html">14.32. cdist-type__daemontools_service(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__debconf_set_selections.html">14.33. cdist-type__debconf_set_selections(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__directory.html">14.34. cdist-type__directory(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__docker.html">14.35. cdist-type__docker(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__docker_compose.html">14.36. cdist-type__docker_compose(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__docker_stack.html">14.37. cdist-type__docker_stack(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__docker_swarm.html">14.38. cdist-type__docker_swarm(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__dog_vdi.html">14.39. cdist-type__dog_vdi(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__dot_file.html">14.40. cdist-type__dot_file(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__file.html">14.41. cdist-type__file(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__filesystem.html">14.42. cdist-type__filesystem(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__firewalld_rule.html">14.43. cdist-type__firewalld_rule(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__firewalld_start.html">14.44. cdist-type__firewalld_start(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__git.html">14.45. cdist-type__git(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__go_get.html">14.46. cdist-type__go_get(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__golang_from_vendor.html">14.47. cdist-type__golang_from_vendor(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__grafana_dashboard.html">14.48. cdist-type__grafana_dashboard(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__group.html">14.49. cdist-type__group(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__hostname.html">14.50. cdist-type__hostname(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__hosts.html">14.51. cdist-type__hosts(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_bootloader_grub.html">14.52. cdist-type__install_bootloader_grub(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_chroot_mount.html">14.53. cdist-type__install_chroot_mount(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_chroot_umount.html">14.54. cdist-type__install_chroot_umount(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_config.html">14.55. cdist-type__install_config(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_directory.html">14.56. cdist-type__directory(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_file.html">14.57. cdist-type__install_file(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_fstab.html">14.58. cdist-type__install_fstab(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_generate_fstab.html">14.59. cdist-type__install_generate_fstab(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_mkfs.html">14.60. cdist-type__install_mkfs(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_mount.html">14.61. cdist-type__install_mount(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_partition_msdos.html">14.62. cdist-type__install_partition_msdos(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_partition_msdos_apply.html">14.63. cdist-type__install_partition_msdos_apply(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_reboot.html">14.64. cdist-type__install_reboot(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_reset_disk.html">14.65. cdist-type__install_reset_disk(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_stage.html">14.66. cdist-type__install_stage(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__install_umount.html">14.67. cdist-type__install_umount(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__iptables_apply.html">14.68. cdist-type__iptables_apply(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__iptables_rule.html">14.69. cdist-type__iptables_rule(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__issue.html">14.70. cdist-type__issue(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__jail.html">14.71. cdist-type__jail(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__jail_freebsd10.html">14.72. cdist-type__jail_freebsd10(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__jail_freebsd9.html">14.73. cdist-type__jail_freebsd9(7)</a></li>
|
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">14.74. cdist-type__key_value(7)</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#name">14.74.1. NAME</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#description">14.74.2. DESCRIPTION</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#required-parameters">14.74.3. REQUIRED PARAMETERS</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#optional-parameters">14.74.4. OPTIONAL PARAMETERS</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#boolean-parameters">14.74.5. BOOLEAN PARAMETERS</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#messages">14.74.6. MESSAGES</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#examples">14.74.7. EXAMPLES</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#more-information">14.74.8. MORE INFORMATION</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#authors">14.74.9. AUTHORS</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#copying">14.74.10. COPYING</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__keyboard.html">14.75. cdist-type__keyboard(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__letsencrypt_cert.html">14.76. cdist-type__letsencrypt_cert(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__line.html">14.77. cdist-type__line(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__link.html">14.78. cdist-type__link(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__locale.html">14.79. cdist-type__locale(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__locale_system.html">14.80. cdist-type__locale_system(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__motd.html">14.81. cdist-type__motd(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__mount.html">14.82. cdist-type__mount(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__mysql_database.html">14.83. cdist-type__mysql_database(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package.html">14.84. cdist-type__package(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_apt.html">14.85. cdist-type__package_apt(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_dpkg.html">14.86. cdist-type__package_dpkg(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_emerge.html">14.87. cdist-type__package_emerge(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_emerge_dependencies.html">14.88. cdist-type__package_emerge_dependencies(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_luarocks.html">14.89. cdist-type__package_luarocks(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_opkg.html">14.90. cdist-type__package_opkg(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_pacman.html">14.91. cdist-type__package_pacman(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_pip.html">14.92. cdist-type__package_pip(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_pkg_freebsd.html">14.93. cdist-type__package_pkg_freebsd(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_pkg_openbsd.html">14.94. cdist-type__package_pkg(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_pkgng_freebsd.html">14.95. cdist-type__package_pkgng_freebsd(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_rubygem.html">14.96. cdist-type__package_rubygem(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_update_index.html">14.97. cdist-type__package_update_index(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_upgrade_all.html">14.98. cdist-type__package_upgrade_all(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_yum.html">14.99. cdist-type__package_yum(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__package_zypper.html">14.100. cdist-type__package_zypper(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__pacman_conf.html">14.101. cdist-type__pacman_conf(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__pacman_conf_integrate.html">14.102. cdist-type__pacman_conf_integrate(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__pf_apply.html">14.103. cdist-type__pf_apply(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__pf_ruleset.html">14.104. cdist-type__pf_ruleset(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postfix.html">14.105. cdist-type__postfix(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postfix_master.html">14.106. cdist-type__postfix_master(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postfix_postconf.html">14.107. cdist-type__postfix_postconf(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postfix_postmap.html">14.108. cdist-type__postfix_postmap(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postfix_reload.html">14.109. cdist-type__postfix_reload(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postgres_database.html">14.110. cdist-type__postgres_database(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postgres_extension.html">14.111. cdist-type__postgres_extension(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__postgres_role.html">14.112. cdist-type__postgres_role(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__process.html">14.113. cdist-type__process(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__prometheus_alertmanager.html">14.114. cdist-type__prometheus_alertmanager(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__prometheus_exporter.html">14.115. cdist-type__prometheus_exporter(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__prometheus_server.html">14.116. cdist-type__prometheus_server(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__pyvenv.html">14.117. cdist-type__pyvenv(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__qemu_img.html">14.118. cdist-type__qemu_img(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__rbenv.html">14.119. cdist-type__rbenv(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__rsync.html">14.120. cdist-type__rsync(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__rvm.html">14.121. cdist-type__rvm(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__rvm_gem.html">14.122. cdist-type__rvm_gemset(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__rvm_gemset.html">14.123. cdist-type__rvm_gemset(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__rvm_ruby.html">14.124. cdist-type__rvm_ruby(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__ssh_authorized_key.html">14.125. cdist-type__ssh_authorized_key(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__ssh_authorized_keys.html">14.126. cdist-type__ssh_authorized_keys(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__ssh_dot_ssh.html">14.127. cdist-type__ssh_dot_ssh(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__staged_file.html">14.128. cdist-type__staged_file(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__start_on_boot.html">14.129. cdist-type__start_on_boot(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__sysctl.html">14.130. cdist-type__sysctl(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__systemd_unit.html">14.131. cdist-type__systemd_unit(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__timezone.html">14.132. cdist-type__timezone(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__update_alternatives.html">14.133. cdist-type__update_alternatives(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__user.html">14.134. cdist-type__user(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__user_groups.html">14.135. cdist-type__user_groups(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__yum_repo.html">14.136. cdist-type__yum_repo(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__zypper_repo.html">14.137. cdist-type__zypper_repo(7)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="cdist-type__zypper_service.html">14.138. cdist-type__zypper_service(7)</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-explorer.html">15. Explorer</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-messaging.html">16. Messaging</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-parallelization.html">17. Parallelization</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-inventory.html">18. Inventory</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-integration.html">19. cdist integration / using cdist as library</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-reference.html">20. Reference</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-best-practice.html">21. Best practice</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-stages.html">22. Execution stages</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-cache.html">23. Local cache overview</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-saving-output-streams.html">24. Saving output streams</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-remote-exec-copy.html">25. Remote exec and copy commands</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-hacker.html">26. Hacking</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../cdist-troubleshooting.html">27. Troubleshooting</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="../index.html">cdist</a>
|
|
|
|
</nav>
|
|
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
|
|
<ul class="wy-breadcrumbs">
|
|
|
|
<li><a href="../index.html">Docs</a> »</li>
|
|
|
|
<li><a href="../cdist-types.html">14. cdist types</a> »</li>
|
|
|
|
<li>14.74. cdist-type__key_value(7)</li>
|
|
|
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="../_sources/man7/cdist-type__key_value.rst.txt" rel="nofollow"> View page source</a>
|
|
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<div class="section" id="cdist-type-key-value-7">
|
|
<h1>14.74. cdist-type__key_value(7)<a class="headerlink" href="#cdist-type-key-value-7" title="Permalink to this headline">¶</a></h1>
|
|
<div class="section" id="name">
|
|
<h2>14.74.1. NAME<a class="headerlink" href="#name" title="Permalink to this headline">¶</a></h2>
|
|
<p>cdist-type__key_value - Change property values in files</p>
|
|
</div>
|
|
<div class="section" id="description">
|
|
<h2>14.74.2. DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
|
|
<p>This cdist type allows you to change values in a key value based config
|
|
file.</p>
|
|
</div>
|
|
<div class="section" id="required-parameters">
|
|
<h2>14.74.3. REQUIRED PARAMETERS<a class="headerlink" href="#required-parameters" title="Permalink to this headline">¶</a></h2>
|
|
<dl class="docutils">
|
|
<dt>file</dt>
|
|
<dd>The file to operate on.</dd>
|
|
<dt>delimiter</dt>
|
|
<dd>The delimiter which separates the key from the value.</dd>
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="optional-parameters">
|
|
<h2>14.74.4. OPTIONAL PARAMETERS<a class="headerlink" href="#optional-parameters" title="Permalink to this headline">¶</a></h2>
|
|
<dl class="docutils">
|
|
<dt>state</dt>
|
|
<dd>present or absent, defaults to present. If present, sets the key to value,
|
|
if absent, removes the key from the file.</dd>
|
|
<dt>key</dt>
|
|
<dd>The key to change. Defaults to object_id.</dd>
|
|
<dt>value</dt>
|
|
<dd>The value for the key. Optional if state=absent, required otherwise.</dd>
|
|
<dt>comment</dt>
|
|
<dd>If supplied, the value will be inserted before the line with the key,
|
|
but only if the key or value must be changed.
|
|
You need to ensure yourself that the line is prefixed with the correct
|
|
comment sign. (for example # or ; or wathever ..)</dd>
|
|
<dt>onchange</dt>
|
|
<dd>The code to run if the key or value changes (i.e. is inserted, removed or replaced).</dd>
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="boolean-parameters">
|
|
<h2>14.74.5. BOOLEAN PARAMETERS<a class="headerlink" href="#boolean-parameters" title="Permalink to this headline">¶</a></h2>
|
|
<dl class="docutils">
|
|
<dt>exact_delimiter</dt>
|
|
<dd>If supplied, treat additional whitespaces between key, delimiter and value
|
|
as wrong value.</dd>
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="messages">
|
|
<h2>14.74.6. MESSAGES<a class="headerlink" href="#messages" title="Permalink to this headline">¶</a></h2>
|
|
<dl class="docutils">
|
|
<dt>remove</dt>
|
|
<dd>Removed existing key and value</dd>
|
|
<dt>insert</dt>
|
|
<dd>Added key and value</dd>
|
|
<dt>change</dt>
|
|
<dd>Changed value of existing key</dd>
|
|
<dt>create</dt>
|
|
<dd>A new line was inserted in a new file</dd>
|
|
</dl>
|
|
</div>
|
|
<div class="section" id="examples">
|
|
<h2>14.74.7. EXAMPLES<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
|
|
<div class="highlight-sh"><div class="highlight"><pre><span></span><span class="c1"># Set the maximum system user id</span>
|
|
__key_value SYS_UID_MAX --file /etc/login.defs --value <span class="m">666</span> --delimiter <span class="s1">' '</span>
|
|
|
|
<span class="c1"># Same with fancy id</span>
|
|
__key_value my-fancy-id --file /etc/login.defs --key SYS_UID_MAX --value <span class="m">666</span> <span class="se">\</span>
|
|
--delimiter <span class="s1">' '</span>
|
|
|
|
<span class="c1"># Enable packet forwarding</span>
|
|
__key_value net.ipv4.ip_forward --file /etc/sysctl.conf --value <span class="m">1</span> <span class="se">\</span>
|
|
--delimiter <span class="s1">' = '</span> --comment <span class="s1">'# my linux kernel should act as a router'</span>
|
|
|
|
<span class="c1"># Remove existing key/value</span>
|
|
__key_value LEGACY_KEY --file /etc/somefile --state absent --delimiter <span class="s1">'='</span>
|
|
</pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="more-information">
|
|
<h2>14.74.8. MORE INFORMATION<a class="headerlink" href="#more-information" title="Permalink to this headline">¶</a></h2>
|
|
<p>This type try to handle as many values as possible, so it doesn't use regexes.
|
|
So you need to exactly specify the key and delimiter. Delimiter can be of any length.</p>
|
|
</div>
|
|
<div class="section" id="authors">
|
|
<h2>14.74.9. AUTHORS<a class="headerlink" href="#authors" title="Permalink to this headline">¶</a></h2>
|
|
<p>Steven Armstrong <<a class="reference external" href="mailto:steven-cdist--%40--armstrong.cc">steven-cdist--<span>@</span>--armstrong<span>.</span>cc</a>></p>
|
|
</div>
|
|
<div class="section" id="copying">
|
|
<h2>14.74.10. COPYING<a class="headerlink" href="#copying" title="Permalink to this headline">¶</a></h2>
|
|
<p>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.</p>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
<div class="articleComments">
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="cdist-type__keyboard.html" class="btn btn-neutral float-right" title="14.75. cdist-type__keyboard(7)" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
|
|
|
|
|
|
<a href="cdist-type__jail_freebsd9.html" class="btn btn-neutral" title="14.73. cdist-type__jail_freebsd9(7)" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
© Copyright .
|
|
|
|
</p>
|
|
</div>
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT:'../',
|
|
VERSION:'4.8.4',
|
|
COLLAPSE_INDEX:false,
|
|
FILE_SUFFIX:'.html',
|
|
HAS_SOURCE: true,
|
|
SOURCELINK_SUFFIX: '.txt'
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="../_static/jquery.js"></script>
|
|
<script type="text/javascript" src="../_static/underscore.js"></script>
|
|
<script type="text/javascript" src="../_static/doctools.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" src="../_static/js/theme.js"></script>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
jQuery(function () {
|
|
SphinxRtdTheme.StickyNav.enable();
|
|
});
|
|
</script>
|
|
|
|
|
|
</body>
|
|
</html> |