2019-01-25 15:18:27 +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" >
2019-04-11 13:04:55 +00:00
< title > 23. cdist integration / using cdist as library — cdist 4.10.10 documentation< / title >
2019-01-25 15:18:27 +00:00
< link rel = "stylesheet" href = "_static/css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
2019-04-11 13:04:55 +00:00
< link rel = "next" title = "24. Reference" href = "cdist-reference.html" / >
< link rel = "prev" title = "22. PreOS" href = "cdist-preos.html" / >
2019-01-25 15:18:27 +00:00
< script src = "_static/js/modernizr.min.js" > < / script >
< / head >
< body class = "wy-body-for-nav" >
< 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" >
2019-04-11 13:04:55 +00:00
4.10.10
2019-01-25 15:18:27 +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 = "cdist-real-world.html" > 9. Dive into real world cdist< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "man1/cdist.html" > 10. cdist(1)< / a > < / li >
2019-04-11 13:04:55 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "man1/cdist-dump.html" > 11. cdist-dump(1)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-bootstrap.html" > 12. Bootstrap< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-configuration.html" > 13. Configuration< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-manifest.html" > 14. Manifest< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-type.html" > 15. cdist type< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-types.html" > 16. cdist types< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-explorer.html" > 17. Explorer< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-messaging.html" > 18. Messaging< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-parallelization.html" > 19. Parallelization< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-inventory.html" > 20. Inventory< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-trigger.html" > 21. Trigger< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-preos.html" > 22. PreOS< / a > < / li >
< li class = "toctree-l1 current" > < a class = "current reference internal" href = "#" > 23. cdist integration / using cdist as library< / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "#description" > 23.1. Description< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#examples" > 23.2. Examples< / a > < / li >
2019-01-25 15:18:27 +00:00
< / ul >
< / li >
2019-04-11 13:04:55 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-reference.html" > 24. Reference< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-best-practice.html" > 25. Best practice< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-stages.html" > 26. Execution stages< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-cache.html" > 27. Local cache overview< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-saving-output-streams.html" > 28. Saving output streams< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-remote-exec-copy.html" > 29. Remote exec and copy commands< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-hacker.html" > 30. Hacking< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-troubleshooting.html" > 31. Troubleshooting< / a > < / li >
2019-01-25 15:18:27 +00:00
< / ul >
< / div >
< / div >
< / nav >
< section data-toggle = "wy-nav-shift" class = "wy-nav-content-wrap" >
< nav class = "wy-nav-top" 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 >
2019-04-11 13:04:55 +00:00
< li > 23. cdist integration / using cdist as library< / li >
2019-01-25 15:18:27 +00:00
< li class = "wy-breadcrumbs-aside" >
< a href = "_sources/cdist-integration.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-integration-using-cdist-as-library" >
2019-04-11 13:04:55 +00:00
< h1 > 23. cdist integration / using cdist as library< a class = "headerlink" href = "#cdist-integration-using-cdist-as-library" title = "Permalink to this headline" > ¶< / a > < / h1 >
2019-01-25 15:18:27 +00:00
< div class = "section" id = "description" >
2019-04-11 13:04:55 +00:00
< h2 > 23.1. Description< a class = "headerlink" href = "#description" title = "Permalink to this headline" > ¶< / a > < / h2 >
2019-01-25 15:18:27 +00:00
< p > cdist can be integrate with other applications by importing cdist and other
cdist modules and setting all by hand. There are also helper functions which
aim to ease this integration. Just import < strong > cdist.integration< / strong > and use its
functions:< / p >
< ul class = "simple" >
< li > < strong > cdist.integration.configure_hosts_simple< / strong > for configuration< / li >
< li > < strong > cdist.integration.install_hosts_simple< / strong > for installation.< / li >
< / ul >
< p > Functions require < cite > host< / cite > and < cite > manifest< / cite > parameters.
< cite > host< / cite > can be specified as a string representing host or as iterable
of hosts. < cite > manifest< / cite > is a path to initial manifest. For other cdist
options default values will be used. < cite > verbose< / cite > is a desired verbosity
level which defaults to VERBOSE_INFO. < cite > cdist_path< / cite > parameter specifies
path to cdist executable, if it is < cite > None< / cite > then functions will try to
find it first from local lib directory and then in PATH.< / p >
< p > In case of cdist error < strong > cdist.Error< / strong > exception is raised.< / p >
< p > < strong > WARNING< / strong > : cdist integration helper functions are not yet stable!< / p >
< / div >
< div class = "section" id = "examples" >
2019-04-11 13:04:55 +00:00
< h2 > 23.2. Examples< a class = "headerlink" href = "#examples" title = "Permalink to this headline" > ¶< / a > < / h2 >
2019-01-25 15:18:27 +00:00
< div class = "highlight-sh notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "c1" > # configure host from python interactive shell< / span >
> > > import cdist.integration
> > > cdist.integration.configure_hosts_simple< span class = "o" > (< / span > < span class = "s1" > ' 185.203.114.185' < / span > ,
... < span class = "s1" > ' ~/.cdist/manifest/init' < / span > < span class = "o" > )< / span >
< span class = "c1" > # configure host from python interactive shell, specifying verbosity level< / span >
> > > import cdist.integration
> > > cdist.integration.configure_hosts_simple< span class = "o" > (< / span >
... < span class = "s1" > ' 185.203.114.185' < / span > , < span class = "s1" > ' ~/.cdist/manifest/init' < / span > ,
... < span class = "nv" > verbose< / span > < span class = "o" > =< / span > cdist.argparse.VERBOSE_TRACE< span class = "o" > )< / span >
< span class = "c1" > # configure specified dns hosts from python interactive shell< / span >
> > > import cdist.integration
> > > < span class = "nv" > hosts< / span > < span class = "o" > =< / span > < span class = "o" > (< / span > < span class = "s1" > ' dns1.ungleich.ch' < / span > , < span class = "s1" > ' dns2.ungleich.ch' < / span > , < span class = "s1" > ' dns3.ungleich.ch' < / span > , < span class = "o" > )< / span >
> > > cdist.integration.configure_hosts_simple< span class = "o" > (< / span > hosts,
... < span class = "s1" > ' ~/.cdist/manifest/init' < / span > < span class = "o" > )< / span >
< / pre > < / div >
< / div >
< / div >
< / div >
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
2019-04-11 13:04:55 +00:00
< a href = "cdist-reference.html" class = "btn btn-neutral float-right" title = "24. Reference" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" > < / span > < / a >
2019-01-25 15:18:27 +00:00
2019-04-11 13:04:55 +00:00
< a href = "cdist-preos.html" class = "btn btn-neutral" title = "22. PreOS" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" > < / span > Previous< / a >
2019-01-25 15:18:27 +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/rtfd/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" id = "documentation_options" data-url_root = "./" src = "_static/documentation_options.js" > < / 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 async = "async" type = "text/javascript" src = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML" > < / script >
< script type = "text/javascript" src = "_static/js/theme.js" > < / script >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
< / body >
< / html >
