2016-11-27 15:32:05 +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-12-03 09:18:03 +00:00
< title > 14. Explorer — cdist 4.4.0-182-g70369bf documentation< / title >
2016-11-27 15:32:05 +00:00
< 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" / >
2016-12-03 09:18:03 +00:00
< link rel = "top" title = "cdist 4.4.0-182-g70369bf documentation" href = "index.html" / >
2016-11-27 15:32:05 +00:00
< link rel = "next" title = "15. Messaging" href = "cdist-messaging.html" / >
2016-12-02 19:52:13 +00:00
< link rel = "prev" title = "13.120. cdist-type__zypper_service(7)" href = "man7/cdist-type__zypper_service.html" / >
2016-11-27 15:32:05 +00:00
< 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-12-03 09:18:03 +00:00
4.4.0-182-g70369bf
2016-11-27 15:32:05 +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 = "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-manifest.html" > 11. Manifest< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type.html" > 12. cdist type< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-types.html" > 13. cdist types< / a > < / li >
< li class = "toctree-l1 current" > < a class = "current reference internal" href = "#" > 14. Explorer< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "#description" > 14.1. Description< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#examples" > 14.2. Examples< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-messaging.html" > 15. Messaging< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-parallelization.html" > 16. Parallelization< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-inventory.html" > 17. Inventory< / a > < / li >
2016-11-27 17:43:52 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-trigger.html" > 18. Trigger< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-preos.html" > 19. PreOS< / 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-remote-exec-copy.html" > 23. Remote exec and copy commands< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-hacker.html" > 24. Hacking< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-troubleshooting.html" > 25. Troubleshooting< / a > < / li >
2016-11-27 15:32:05 +00:00
< / 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 > 14. Explorer< / li >
< li class = "wy-breadcrumbs-aside" >
< a href = "_sources/cdist-explorer.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 = "explorer" >
< h1 > 14. Explorer< a class = "headerlink" href = "#explorer" title = "Permalink to this headline" > ¶< / a > < / h1 >
< div class = "section" id = "description" >
< h2 > 14.1. Description< a class = "headerlink" href = "#description" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Explorer are small shell scripts, which will be executed on the target
host. The aim of the explorer is to give hints to types on how to act on the
target system. An explorer outputs the result to stdout, which is usually
a one liner, but may be empty or multi line especially in the case of
type explorers.< / p >
< p > There are general explorers, which are run in an early stage, and
type explorers. Both work almost exactly the same way, with the difference
that the values of the general explorers are stored in a general location and
the type specific below the object.< / p >
< p > Explorers can reuse other explorers on the target system by calling< / p >
< div class = "highlight-default" > < div class = "highlight" > < pre > < span > < / span > $__explorer/< explorer_name> (general and type explorer)
< / pre > < / div >
< / div >
< p > or< / p >
< div class = "highlight-default" > < div class = "highlight" > < pre > < span > < / span > $__type_explorer/< explorer name> (type explorer).
< / pre > < / div >
< / div >
< p > In case of significant errors, the explorer may exit non-zero and return an
error message on stderr, which will cause cdist to abort.< / p >
< p > You can also use stderr for debugging purposes while developing a new
explorer.< / p >
< / div >
< div class = "section" id = "examples" >
< h2 > 14.2. Examples< a class = "headerlink" href = "#examples" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > A very simple explorer may look like this:< / p >
< div class = "highlight-default" > < div class = "highlight" > < pre > < span > < / span > < span class = "n" > hostname< / span >
< / pre > < / div >
< / div >
< p > Which is in practise the < strong > hostname< / strong > explorer.< / p >
< p > A type explorer, which could check for the status of a package may look like this:< / p >
< div class = "highlight-sh" > < div class = "highlight" > < pre > < span > < / span > < span class = "k" > if< / span > < span class = "o" > [< / span > -f < span class = "s2" > " < / span > < span class = "nv" > $__object< / span > < span class = "s2" > /parameter/name" < / span > < span class = "o" > ]< / span > < span class = "p" > ;< / span > < span class = "k" > then< / span >
< span class = "nv" > name< / span > < span class = "o" > =< / span > < span class = "s2" > " < / span > < span class = "k" > $(< / span > cat < span class = "s2" > " < / span > < span class = "nv" > $__object< / span > < span class = "s2" > /parameter/name" < / span > < span class = "k" > )< / span > < span class = "s2" > " < / span >
< span class = "k" > else< / span >
< span class = "nv" > name< / span > < span class = "o" > =< / span > < span class = "s2" > " < / span > < span class = "nv" > $__object_id< / span > < span class = "s2" > " < / span >
< span class = "k" > fi< / span >
< span class = "c1" > # Expect dpkg failing, if package is not known / installed< / span >
dpkg -s < span class = "s2" > " < / span > < span class = "nv" > $name< / span > < span class = "s2" > " < / span > 2> /dev/null < span class = "o" > ||< / span > < span class = "nb" > exit< / span > 0
< / pre > < / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
< a href = "cdist-messaging.html" class = "btn btn-neutral float-right" title = "15. Messaging" accesskey = "n" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
2016-12-02 19:52:13 +00:00
< a href = "man7/cdist-type__zypper_service.html" class = "btn btn-neutral" title = "13.120. cdist-type__zypper_service(7)" accesskey = "p" > < span class = "fa fa-arrow-circle-left" > < / span > Previous< / a >
2016-11-27 15:32:05 +00:00
< / 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-12-03 09:18:03 +00:00
VERSION:'4.4.0-182-g70369bf',
2016-11-27 15:32:05 +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 >
