2016-05-27 05:29:45 +00:00
<!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" >
2016-05-27 05:59:19 +00:00
< title > 9. cdist-reference(7) — cdist 4.1.0 documentation< / title >
2016-05-27 05:29:45 +00:00
< link rel = "stylesheet" href = "../_static/css/theme.css" type = "text/css" / >
2016-05-27 05:59:19 +00:00
< link rel = "top" title = "cdist 4.1.0 documentation" href = "../index.html" / >
2016-05-27 05:29:45 +00:00
< link rel = "next" title = "10. cdist-remote-exec-copy(7)" href = "cdist-remote-exec-copy.html" / >
< link rel = "prev" title = "8. cdist-quickstart(7)" href = "cdist-quickstart.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" >
2016-05-27 05:59:19 +00:00
4.1.0
2016-05-27 05:29:45 +00:00
< / 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 = "../man1/cdist.html" > 1. cdist(1)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-best-practice.html" > 2. cdist-best-practice(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-bootstrap.html" > 3. cdist-bootstrap(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-explorer.html" > 4. cdist-explorer(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-hacker.html" > 5. cdist-hacker(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-manifest.html" > 6. cdist-manifest(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-messaging.html" > 7. cdist-messaging(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-quickstart.html" > 8. cdist-quickstart(7)< / a > < / li >
< li class = "toctree-l1 current" > < a class = "current reference internal" href = "#" > 9. cdist-reference(7)< / a > < ul class = "simple" >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-remote-exec-copy.html" > 10. cdist-remote-exec-copy(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-stages.html" > 11. cdist-stages(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-troubleshooting.html" > 12. cdist-troubleshooting(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-tutorial.html" > 13. cdist-tutorial(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type.html" > 14. cdist-type(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__apt_key.html" > 15. cdist-type__apt_key(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__apt_key_uri.html" > 16. cdist-type__apt_key_uri(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__apt_norecommends.html" > 17. cdist-type__apt_norecommends(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__apt_ppa.html" > 18. cdist-type__apt_ppa(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__apt_source.html" > 19. cdist-type__apt_source(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__apt_update_index.html" > 20. cdist-type__apt_update_index(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__block.html" > 21. cdist-type__block(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__ccollect_source.html" > 22. cdist-type__ccollect_source(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__cdist.html" > 23. cdist-type__cdist(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__cdistmarker.html" > 24. cdist-type__cdistmarker(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__config_file.html" > 25. cdist-type__config_file(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__consul.html" > 26. cdist-type__consul(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__consul_agent.html" > 27. cdist-type__consul_agent(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__consul_check.html" > 28. cdist-type__consul_check(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__consul_reload.html" > 29. cdist-type__consul_reload(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__consul_service.html" > 30. cdist-type__consul_service(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__consul_template.html" > 31. cdist-type__consul_template(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__consul_template_template.html" > 32. cdist-type__consul_template_template(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__consul_watch_checks.html" > 33. cdist-type__consul_watch_checks(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__consul_watch_event.html" > 34. cdist-type__consul_watch_event(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__consul_watch_key.html" > 35. cdist-type__consul_watch_key(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__consul_watch_keyprefix.html" > 36. cdist-type__consul_watch_keyprefix(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__consul_watch_nodes.html" > 37. cdist-type__consul_watch_nodes(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__consul_watch_service.html" > 38. cdist-type__consul_watch_service(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__consul_watch_services.html" > 39. cdist-type__consul_watch_services(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__cron.html" > 40. cdist-type__cron(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__debconf_set_selections.html" > 41. cdist-type__debconf_set_selections(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__directory.html" > 42. cdist-type__directory(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__dog_vdi.html" > 43. cdist-type__dog_vdi(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__file.html" > 44. cdist-type__file(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__firewalld_rule.html" > 45. cdist-type__firewalld_rule(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__git.html" > 46. cdist-type__git(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__group.html" > 47. cdist-type__group(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__hostname.html" > 48. cdist-type__hostname(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__iptables_apply.html" > 49. cdist-type__iptables_apply(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__iptables_rule.html" > 50. cdist-type__iptables_rule(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__issue.html" > 51. cdist-type__issue(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__jail.html" > 52. cdist-type__jail(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__key_value.html" > 53. cdist-type__key_value(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__line.html" > 54. cdist-type__line(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__link.html" > 55. cdist-type__link(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__locale.html" > 56. cdist-type__locale(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__motd.html" > 57. cdist-type__motd(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__mount.html" > 58. cdist-type__mount(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__mysql_database.html" > 59. cdist-type__mysql_database(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__package.html" > 60. cdist-type__package(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__package_apt.html" > 61. cdist-type__package_apt(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__package_emerge.html" > 62. cdist-type__package_emerge(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__package_emerge_dependencies.html" > 63. cdist-type__package_emerge_dependencies(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__package_luarocks.html" > 64. cdist-type__package_luarocks(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__package_opkg.html" > 65. cdist-type__package_opkg(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__package_pacman.html" > 66. cdist-type__package_pacman(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__package_pip.html" > 67. cdist-type__package_pip(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__package_pkg_freebsd.html" > 68. cdist-type__package_pkg_freebsd(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__package_pkg_openbsd.html" > 69. cdist-type__package_pkg(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__package_pkgng_freebsd.html" > 70. cdist-type__package_pkgng_freebsd(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__package_rubygem.html" > 71. cdist-type__package_rubygem(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__package_update_index.html" > 72. cdist-type__package_update_index(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__package_upgrade_all.html" > 73. cdist-type__package_upgrade_all(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__package_yum.html" > 74. cdist-type__package_yum(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__package_zypper.html" > 75. cdist-type__package_zypper(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__pacman_conf.html" > 76. cdist-type__pacman_conf(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__pacman_conf_integrate.html" > 77. cdist-type__pacman_conf_integrate(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__pf_apply.html" > 78. cdist-type__pf_apply(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__pf_ruleset.html" > 79. cdist-type__pf_ruleset(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__postfix.html" > 80. cdist-type__postfix(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__postfix_master.html" > 81. cdist-type__postfix_master(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__postfix_postconf.html" > 82. cdist-type__postfix_postconf(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__postfix_postmap.html" > 83. cdist-type__postfix_postmap(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__postfix_reload.html" > 84. cdist-type__postfix_reload(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__postgres_database.html" > 85. cdist-type__postgres_database(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__postgres_role.html" > 86. cdist-type__postgres_role(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__process.html" > 87. cdist-type__process(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__pyvenv.html" > 88. cdist-type__pyvenv(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__qemu_img.html" > 89. cdist-type__qemu_img(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__rbenv.html" > 90. cdist-type__rbenv(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__rsync.html" > 91. cdist-type__rsync(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__rvm.html" > 92. cdist-type__rvm(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__rvm_gem.html" > 93. cdist-type__rvm_gemset(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__rvm_gemset.html" > 94. cdist-type__rvm_gemset(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__rvm_ruby.html" > 95. cdist-type__rvm_ruby(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__ssh_authorized_key.html" > 96. cdist-type__ssh_authorized_key(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__ssh_authorized_keys.html" > 97. cdist-type__ssh_authorized_keys(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__ssh_dot_ssh.html" > 98. cdist-type__ssh_dot_ssh(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__staged_file.html" > 99. cdist-type__staged_file(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__start_on_boot.html" > 100. cdist-type__start_on_boot(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__timezone.html" > 101. cdist-type__timezone(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__update_alternatives.html" > 102. cdist-type__update_alternatives(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__user.html" > 103. cdist-type__user(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__user_groups.html" > 104. cdist-type__user_groups(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__yum_repo.html" > 105. cdist-type__yum_repo(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__zypper_repo.html" > 106. cdist-type__zypper_repo(7)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type__zypper_service.html" > 107. cdist-type__zypper_service(7)< / 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 > 9. cdist-reference(7)< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "../_sources/man7/cdist-reference.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-reference-7" >
< h1 > 9. cdist-reference(7)< a class = "headerlink" href = "#cdist-reference-7" title = "Permalink to this headline" > ¶< / a > < / h1 >
< p > Variable, path and type reference for cdist< / p >
< p > Nico Schottelius < < a class = "reference external" href = "mailto:nico-cdist--%40--schottelius.org" > nico-cdist--< span > @ < / span > --schottelius< span > . < / span > org< / a > > < / p >
< div class = "section" id = "explorers" >
< h2 > 9.1. EXPLORERS< a class = "headerlink" href = "#explorers" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > The following global explorers are available:< / p >
< ul class = "simple" >
< li > cpu_cores< / li >
< li > cpu_sockets< / li >
< li > hostname< / li >
< li > init< / li >
< li > interfaces< / li >
< li > lsb_codename< / li >
< li > lsb_description< / li >
< li > lsb_id< / li >
< li > lsb_release< / li >
< li > machine< / li >
< li > machine_type< / li >
< li > memory< / li >
< li > os< / li >
< li > os_version< / li >
< li > runlevel< / li >
< / ul >
< / div >
< div class = "section" id = "paths" >
< h2 > 9.2. PATHS< a class = "headerlink" href = "#paths" title = "Permalink to this headline" > ¶< / a > < / h2 >
< dl class = "docutils" >
< dt > $HOME/.cdist< / dt >
< dd > The standard cdist configuration directory relative to your home directory
This is usually the place you want to store your site specific configuration< / dd >
< dt > cdist/conf/< / dt >
< dd > The distribution configuration directory
This contains types and explorers to be used< / dd >
< dt > confdir< / dt >
< dd > Cdist will use all available configuration directories and create
a temporary confdir containing links to the real configuration directories.
This way it is possible to merge configuration directories.
By default it consists of everything in $HOME/.cdist and cdist/conf/.
For more details see cdist(1)< / dd >
< dt > confdir/manifest/init< / dt >
< dd > This is the central entry point.
It is an executable (+x bit set) shell script that can use
values from the explorers to decide which configuration to create
for the specified target host.
Its intent is to used to define mapping from configurations to hosts.< / dd >
< dt > confdir/manifest/*< / dt >
< dd > All other files in this directory are not directly used by cdist, but you
can separate configuration mappings, if you have a lot of code in the
conf/manifest/init file. This may also be helpful to have different admins
maintain different groups of hosts.< / dd >
< dt > confdir/explorer/< name> < / dt >
< dd > Contains explorers to be run on the target hosts, see cdist-explorer(7).< / dd >
< dt > confdir/type/< / dt >
< dd > Contains all available types, which are used to provide
some kind of functionality. See cdist-type(7).< / dd >
< dt > confdir/type/< name> /< / dt >
< dd > Home of the type < name> .
This directory is referenced by the variable __type (see below).< / dd >
< dt > confdir/type/< name> /man.rst< / dt >
< dd > Manpage in reStructuredText format (required for inclusion into upstream)< / dd >
< dt > confdir/type/< name> /manifest< / dt >
< dd > Used to generate additional objects from a type.< / dd >
< dt > confdir/type/< name> /gencode-local< / dt >
< dd > Used to generate code to be executed on the source host< / dd >
< dt > confdir/type/< name> /gencode-remote< / dt >
< dd > Used to generate code to be executed on the target host< / dd >
< dt > confdir/type/< name> /parameter/required< / dt >
< dd > Parameters required by type, n separated list.< / dd >
< dt > confdir/type/< name> /parameter/optional< / dt >
< dd > Parameters optionally accepted by type, n separated list.< / dd >
< dt > confdir/type/< name> /parameter/default/*< / dt >
< dd > Default values for optional parameters.
Assuming an optional parameter name of ‘ foo’ , it’ s default value would
be read from the file confdir/type/< name> /parameter/default/foo.< / dd >
< dt > confdir/type/< name> /parameter/boolean< / dt >
< dd > Boolean parameters accepted by type, n separated list.< / dd >
< dt > confdir/type/< name> /explorer< / dt >
< dd > Location of the type specific explorers.
This directory is referenced by the variable __type_explorer (see below).
See cdist-explorer(7).< / dd >
< dt > confdir/type/< name> /files< / dt >
< dd > This directory is reserved for user data and will not be used
by cdist at any time. It can be used for storing supplementary
files (like scripts to act as a template or configuration files).< / dd >
< dt > out/< / dt >
< dd > This directory contains output of cdist and is usually located
in a temporary directory and thus will be removed after the run.
This directory is referenced by the variable __global (see below).< / dd >
< dt > out/explorer< / dt >
< dd > Output of general explorers.< / dd >
< dt > out/object< / dt >
< dd > Objects created for the host.< / dd >
< dt > out/object/< object> < / dt >
< dd > Contains all object specific information.
This directory is referenced by the variable __object (see below).< / dd >
< dt > out/object/< object> /explorers< / dt >
< dd > Output of type specific explorers, per object.< / dd >
< / dl >
< / div >
< div class = "section" id = "types" >
< h2 > 9.3. TYPES< a class = "headerlink" href = "#types" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > The following types are available:< / p >
< ul class = "simple" >
< li > __apt_key (< a class = "reference external" href = "cdist-type__apt_key.html" > cdist-type__apt_key(7)< / a > )< / li >
< li > __apt_key_uri (< a class = "reference external" href = "cdist-type__apt_key_uri.html" > cdist-type__apt_key_uri(7)< / a > )< / li >
< li > __apt_norecommends (< a class = "reference external" href = "cdist-type__apt_norecommends.html" > cdist-type__apt_norecommends(7)< / a > )< / li >
< li > __apt_ppa (< a class = "reference external" href = "cdist-type__apt_ppa.html" > cdist-type__apt_ppa(7)< / a > )< / li >
< li > __apt_source (< a class = "reference external" href = "cdist-type__apt_source.html" > cdist-type__apt_source(7)< / a > )< / li >
< li > __apt_update_index (< a class = "reference external" href = "cdist-type__apt_update_index.html" > cdist-type__apt_update_index(7)< / a > )< / li >
< li > __block (< a class = "reference external" href = "cdist-type__block.html" > cdist-type__block(7)< / a > )< / li >
< li > __ccollect_source (< a class = "reference external" href = "cdist-type__ccollect_source.html" > cdist-type__ccollect_source(7)< / a > )< / li >
< li > __cdist (< a class = "reference external" href = "cdist-type__cdist.html" > cdist-type__cdist(7)< / a > )< / li >
< li > __cdistmarker (< a class = "reference external" href = "cdist-type__cdistmarker.html" > cdist-type__cdistmarker(7)< / a > )< / li >
< li > __config_file (< a class = "reference external" href = "cdist-type__config_file.html" > cdist-type__config_file(7)< / a > )< / li >
< li > __consul (< a class = "reference external" href = "cdist-type__consul.html" > cdist-type__consul(7)< / a > )< / li >
< li > __consul_agent (< a class = "reference external" href = "cdist-type__consul_agent.html" > cdist-type__consul_agent(7)< / a > )< / li >
< li > __consul_check (< a class = "reference external" href = "cdist-type__consul_check.html" > cdist-type__consul_check(7)< / a > )< / li >
< li > __consul_reload (< a class = "reference external" href = "cdist-type__consul_reload.html" > cdist-type__consul_reload(7)< / a > )< / li >
< li > __consul_service (< a class = "reference external" href = "cdist-type__consul_service.html" > cdist-type__consul_service(7)< / a > )< / li >
< li > __consul_template (< a class = "reference external" href = "cdist-type__consul_template.html" > cdist-type__consul_template(7)< / a > )< / li >
< li > __consul_template_template (< a class = "reference external" href = "cdist-type__consul_template_template.html" > cdist-type__consul_template_template(7)< / a > )< / li >
< li > __consul_watch_checks (< a class = "reference external" href = "cdist-type__consul_watch_checks.html" > cdist-type__consul_watch_checks(7)< / a > )< / li >
< li > __consul_watch_event (< a class = "reference external" href = "cdist-type__consul_watch_event.html" > cdist-type__consul_watch_event(7)< / a > )< / li >
< li > __consul_watch_key (< a class = "reference external" href = "cdist-type__consul_watch_key.html" > cdist-type__consul_watch_key(7)< / a > )< / li >
< li > __consul_watch_keyprefix (< a class = "reference external" href = "cdist-type__consul_watch_keyprefix.html" > cdist-type__consul_watch_keyprefix(7)< / a > )< / li >
< li > __consul_watch_nodes (< a class = "reference external" href = "cdist-type__consul_watch_nodes.html" > cdist-type__consul_watch_nodes(7)< / a > )< / li >
< li > __consul_watch_service (< a class = "reference external" href = "cdist-type__consul_watch_service.html" > cdist-type__consul_watch_service(7)< / a > )< / li >
< li > __consul_watch_services (< a class = "reference external" href = "cdist-type__consul_watch_services.html" > cdist-type__consul_watch_services(7)< / a > )< / li >
< li > __cron (< a class = "reference external" href = "cdist-type__cron.html" > cdist-type__cron(7)< / a > )< / li >
< li > __debconf_set_selections (< a class = "reference external" href = "cdist-type__debconf_set_selections.html" > cdist-type__debconf_set_selections(7)< / a > )< / li >
< li > __directory (< a class = "reference external" href = "cdist-type__directory.html" > cdist-type__directory(7)< / a > )< / li >
< li > __dog_vdi (< a class = "reference external" href = "cdist-type__dog_vdi.html" > cdist-type__dog_vdi(7)< / a > )< / li >
< li > __file (< a class = "reference external" href = "cdist-type__file.html" > cdist-type__file(7)< / a > )< / li >
< li > __firewalld_rule (< a class = "reference external" href = "cdist-type__firewalld_rule.html" > cdist-type__firewalld_rule(7)< / a > )< / li >
< li > __git (< a class = "reference external" href = "cdist-type__git.html" > cdist-type__git(7)< / a > )< / li >
< li > __group (< a class = "reference external" href = "cdist-type__group.html" > cdist-type__group(7)< / a > )< / li >
< li > __hostname (< a class = "reference external" href = "cdist-type__hostname.html" > cdist-type__hostname(7)< / a > )< / li >
< li > __iptables_apply (< a class = "reference external" href = "cdist-type__iptables_apply.html" > cdist-type__iptables_apply(7)< / a > )< / li >
< li > __iptables_rule (< a class = "reference external" href = "cdist-type__iptables_rule.html" > cdist-type__iptables_rule(7)< / a > )< / li >
< li > __issue (< a class = "reference external" href = "cdist-type__issue.html" > cdist-type__issue(7)< / a > )< / li >
< li > __jail (< a class = "reference external" href = "cdist-type__jail.html" > cdist-type__jail(7)< / a > )< / li >
< li > __key_value (< a class = "reference external" href = "cdist-type__key_value.html" > cdist-type__key_value(7)< / a > )< / li >
< li > __line (< a class = "reference external" href = "cdist-type__line.html" > cdist-type__line(7)< / a > )< / li >
< li > __link (< a class = "reference external" href = "cdist-type__link.html" > cdist-type__link(7)< / a > )< / li >
< li > __locale (< a class = "reference external" href = "cdist-type__locale.html" > cdist-type__locale(7)< / a > )< / li >
< li > __motd (< a class = "reference external" href = "cdist-type__motd.html" > cdist-type__motd(7)< / a > )< / li >
< li > __mount (< a class = "reference external" href = "cdist-type__mount.html" > cdist-type__mount(7)< / a > )< / li >
< li > __mysql_database (< a class = "reference external" href = "cdist-type__mysql_database.html" > cdist-type__mysql_database(7)< / a > )< / li >
< li > __package (< a class = "reference external" href = "cdist-type__package.html" > cdist-type__package(7)< / a > )< / li >
< li > __package_apt (< a class = "reference external" href = "cdist-type__package_apt.html" > cdist-type__package_apt(7)< / a > )< / li >
< li > __package_emerge (< a class = "reference external" href = "cdist-type__package_emerge.html" > cdist-type__package_emerge(7)< / a > )< / li >
< li > __package_emerge_dependencies (< a class = "reference external" href = "cdist-type__package_emerge_dependencies.html" > cdist-type__package_emerge_dependencies(7)< / a > )< / li >
< li > __package_luarocks (< a class = "reference external" href = "cdist-type__package_luarocks.html" > cdist-type__package_luarocks(7)< / a > )< / li >
< li > __package_opkg (< a class = "reference external" href = "cdist-type__package_opkg.html" > cdist-type__package_opkg(7)< / a > )< / li >
< li > __package_pacman (< a class = "reference external" href = "cdist-type__package_pacman.html" > cdist-type__package_pacman(7)< / a > )< / li >
< li > __package_pip (< a class = "reference external" href = "cdist-type__package_pip.html" > cdist-type__package_pip(7)< / a > )< / li >
< li > __package_pkg_freebsd (< a class = "reference external" href = "cdist-type__package_pkg_freebsd.html" > cdist-type__package_pkg_freebsd(7)< / a > )< / li >
< li > __package_pkg_openbsd (< a class = "reference external" href = "cdist-type__package_pkg_openbsd.html" > cdist-type__package_pkg_openbsd(7)< / a > )< / li >
< li > __package_pkgng_freebsd (< a class = "reference external" href = "cdist-type__package_pkgng_freebsd.html" > cdist-type__package_pkgng_freebsd(7)< / a > )< / li >
< li > __package_rubygem (< a class = "reference external" href = "cdist-type__package_rubygem.html" > cdist-type__package_rubygem(7)< / a > )< / li >
< li > __package_update_index (< a class = "reference external" href = "cdist-type__package_update_index.html" > cdist-type__package_update_index(7)< / a > )< / li >
< li > __package_upgrade_all (< a class = "reference external" href = "cdist-type__package_upgrade_all.html" > cdist-type__package_upgrade_all(7)< / a > )< / li >
< li > __package_yum (< a class = "reference external" href = "cdist-type__package_yum.html" > cdist-type__package_yum(7)< / a > )< / li >
< li > __package_zypper (< a class = "reference external" href = "cdist-type__package_zypper.html" > cdist-type__package_zypper(7)< / a > )< / li >
< li > __pacman_conf (< a class = "reference external" href = "cdist-type__pacman_conf.html" > cdist-type__pacman_conf(7)< / a > )< / li >
< li > __pacman_conf_integrate (< a class = "reference external" href = "cdist-type__pacman_conf_integrate.html" > cdist-type__pacman_conf_integrate(7)< / a > )< / li >
< li > __pf_apply (< a class = "reference external" href = "cdist-type__pf_apply.html" > cdist-type__pf_apply(7)< / a > )< / li >
< li > __pf_ruleset (< a class = "reference external" href = "cdist-type__pf_ruleset.html" > cdist-type__pf_ruleset(7)< / a > )< / li >
< li > __postfix (< a class = "reference external" href = "cdist-type__postfix.html" > cdist-type__postfix(7)< / a > )< / li >
< li > __postfix_master (< a class = "reference external" href = "cdist-type__postfix_master.html" > cdist-type__postfix_master(7)< / a > )< / li >
< li > __postfix_postconf (< a class = "reference external" href = "cdist-type__postfix_postconf.html" > cdist-type__postfix_postconf(7)< / a > )< / li >
< li > __postfix_postmap (< a class = "reference external" href = "cdist-type__postfix_postmap.html" > cdist-type__postfix_postmap(7)< / a > )< / li >
< li > __postfix_reload (< a class = "reference external" href = "cdist-type__postfix_reload.html" > cdist-type__postfix_reload(7)< / a > )< / li >
< li > __postgres_database (< a class = "reference external" href = "cdist-type__postgres_database.html" > cdist-type__postgres_database(7)< / a > )< / li >
< li > __postgres_role (< a class = "reference external" href = "cdist-type__postgres_role.html" > cdist-type__postgres_role(7)< / a > )< / li >
< li > __process (< a class = "reference external" href = "cdist-type__process.html" > cdist-type__process(7)< / a > )< / li >
< li > __pyvenv (< a class = "reference external" href = "cdist-type__pyvenv.html" > cdist-type__pyvenv(7)< / a > )< / li >
< li > __qemu_img (< a class = "reference external" href = "cdist-type__qemu_img.html" > cdist-type__qemu_img(7)< / a > )< / li >
< li > __rbenv (< a class = "reference external" href = "cdist-type__rbenv.html" > cdist-type__rbenv(7)< / a > )< / li >
< li > __rsync (< a class = "reference external" href = "cdist-type__rsync.html" > cdist-type__rsync(7)< / a > )< / li >
< li > __rvm (< a class = "reference external" href = "cdist-type__rvm.html" > cdist-type__rvm(7)< / a > )< / li >
< li > __rvm_gem (< a class = "reference external" href = "cdist-type__rvm_gem.html" > cdist-type__rvm_gem(7)< / a > )< / li >
< li > __rvm_gemset (< a class = "reference external" href = "cdist-type__rvm_gemset.html" > cdist-type__rvm_gemset(7)< / a > )< / li >
< li > __rvm_ruby (< a class = "reference external" href = "cdist-type__rvm_ruby.html" > cdist-type__rvm_ruby(7)< / a > )< / li >
< li > __ssh_authorized_key (< a class = "reference external" href = "cdist-type__ssh_authorized_key.html" > cdist-type__ssh_authorized_key(7)< / a > )< / li >
< li > __ssh_authorized_keys (< a class = "reference external" href = "cdist-type__ssh_authorized_keys.html" > cdist-type__ssh_authorized_keys(7)< / a > )< / li >
< li > __ssh_dot_ssh (< a class = "reference external" href = "cdist-type__ssh_dot_ssh.html" > cdist-type__ssh_dot_ssh(7)< / a > )< / li >
< li > __staged_file (< a class = "reference external" href = "cdist-type__staged_file.html" > cdist-type__staged_file(7)< / a > )< / li >
< li > __start_on_boot (< a class = "reference external" href = "cdist-type__start_on_boot.html" > cdist-type__start_on_boot(7)< / a > )< / li >
< li > __timezone (< a class = "reference external" href = "cdist-type__timezone.html" > cdist-type__timezone(7)< / a > )< / li >
< li > __update_alternatives (< a class = "reference external" href = "cdist-type__update_alternatives.html" > cdist-type__update_alternatives(7)< / a > )< / li >
< li > __user (< a class = "reference external" href = "cdist-type__user.html" > cdist-type__user(7)< / a > )< / li >
< li > __user_groups (< a class = "reference external" href = "cdist-type__user_groups.html" > cdist-type__user_groups(7)< / a > )< / li >
< li > __yum_repo (< a class = "reference external" href = "cdist-type__yum_repo.html" > cdist-type__yum_repo(7)< / a > )< / li >
< li > __zypper_repo (< a class = "reference external" href = "cdist-type__zypper_repo.html" > cdist-type__zypper_repo(7)< / a > )< / li >
< li > __zypper_service (< a class = "reference external" href = "cdist-type__zypper_service.html" > cdist-type__zypper_service(7)< / a > )< / li >
< / ul >
< / div >
< div class = "section" id = "objects" >
< h2 > 9.4. OBJECTS< a class = "headerlink" href = "#objects" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > For object to object communication and tests, the following paths are
usable within a object directory:< / p >
< dl class = "docutils" >
< dt > files< / dt >
< dd > This directory is reserved for user data and will not be used
by cdist at any time. It can be used freely by the type
(for instance to store template results).< / dd >
< dt > changed< / dt >
< dd > This empty file exists in an object directory, if the object has
code to be executed (either remote or local)< / dd >
< dt > stdin< / dt >
< dd > This file exists and contains data, if data was provided on stdin
when the type was called.< / dd >
< / dl >
< / div >
< div class = "section" id = "environment-variables-for-reading" >
< h2 > 9.5. ENVIRONMENT VARIABLES (FOR READING)< a class = "headerlink" href = "#environment-variables-for-reading" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > The following environment variables are exported by cdist:< / p >
< dl class = "docutils" >
< dt > __explorer< / dt >
< dd > Directory that contains all global explorers.
Available for: initial manifest, explorer, type explorer, shell< / dd >
< dt > __manifest< / dt >
< dd > Directory that contains the initial manifest.
Available for: initial manifest, type manifest, shell< / dd >
< dt > __global< / dt >
< dd > Directory that contains generic output like explorer.
Available for: initial manifest, type manifest, type gencode, shell< / dd >
< dt > __messages_in< / dt >
< dd > File to read messages from.
Available for: initial manifest, type manifest, type gencode< / dd >
< dt > __messages_out< / dt >
< dd > File to write messages.
Available for: initial manifest, type manifest, type gencode< / dd >
< dt > __object< / dt >
< dd > Directory that contains the current object.
Available for: type manifest, type explorer, type gencode and code scripts< / dd >
< dt > __object_id< / dt >
< dd > The type unique object id.
Available for: type manifest, type explorer, type gencode and code scripts
Note: The leading and the trailing “ /” will always be stripped (caused by
the filesystem database and ensured by the core).
Note: Double slashes (“ //” ) will not be fixed and result in an error.< / dd >
< dt > __object_name< / dt >
< dd > The full qualified name of the current object.
Available for: type manifest, type explorer, type gencode< / dd >
< dt > __target_host< / dt >
< dd > The host we are deploying to.
Available for: explorer, initial manifest, type explorer, type manifest, type gencode, shell< / dd >
< dt > __type< / dt >
< dd > Path to the current type.
Available for: type manifest, type gencode< / dd >
< dt > __type_explorer< / dt >
< dd > Directory that contains the type explorers.
Available for: type explorer< / dd >
< / dl >
< / div >
< div class = "section" id = "environment-variables-for-writing" >
< h2 > 9.6. ENVIRONMENT VARIABLES (FOR WRITING)< a class = "headerlink" href = "#environment-variables-for-writing" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > The following environment variables influence the behaviour of cdist:< / p >
< dl class = "docutils" >
< dt > require< / dt >
< dd > Setup dependencies between objects (see cdist-manifest(7))< / dd >
< dt > CDIST_LOCAL_SHELL< / dt >
< dd > Use this shell locally instead of /bin/sh to execute scripts< / dd >
< dt > CDIST_REMOTE_SHELL< / dt >
< dd > Use this shell remotely instead of /bin/sh to execute scripts< / dd >
< dt > CDIST_OVERRIDE< / dt >
< dd > Allow overwriting type parameters (see cdist-manifest(7))< / dd >
< dt > CDIST_ORDER_DEPENDENCY< / dt >
< dd > Create dependencies based on the execution order (see cdist-manifest(7))< / dd >
< dt > CDIST_REMOTE_EXEC< / dt >
< dd > Use this command for remote execution (should behave like ssh)< / dd >
< dt > CDIST_REMOTE_COPY< / dt >
< dd > Use this command for remote copy (should behave like scp)< / dd >
< / dl >
< / div >
< div class = "section" id = "see-also" >
< h2 > 9.7. SEE ALSO< a class = "headerlink" href = "#see-also" title = "Permalink to this headline" > ¶< / a > < / h2 >
< ul class = "simple" >
< li > < a class = "reference external" href = "../man1/cdist.html" > cdist(1)< / a > < / li >
< / ul >
< / div >
< div class = "section" id = "copying" >
< h2 > 9.8. COPYING< a class = "headerlink" href = "#copying" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Copyright (C) 2011-2014 Nico Schottelius. Free use of this software is
granted under the terms of the GNU General Public License version 3 (GPLv3).< / p >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
< a href = "cdist-remote-exec-copy.html" class = "btn btn-neutral float-right" title = "10. cdist-remote-exec-copy(7)" accesskey = "n" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
< a href = "cdist-quickstart.html" class = "btn btn-neutral" title = "8. cdist-quickstart(7)" accesskey = "p" > < 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:'../',
2016-05-27 05:59:19 +00:00
VERSION:'4.1.0',
2016-05-27 05:29:45 +00:00
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
< / 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 >
