2021-07-10 18:59:18 +00:00
<!DOCTYPE html>
2021-08-24 18:42:27 +00:00
< html class = "writer-html5" lang = "en" >
2021-07-10 18:59:18 +00:00
< head >
2021-08-24 18:42:27 +00:00
< meta charset = "utf-8" / >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" / >
2021-07-10 18:59:18 +00:00
2021-08-24 18:42:27 +00:00
< title > 23. Scan — cdist 6.9.8 documentation< / title >
2021-07-10 18:59:18 +00:00
2021-08-24 18:42:27 +00:00
< link rel = "stylesheet" href = "_static/css/theme.css" type = "text/css" / >
< link rel = "stylesheet" href = "_static/pygments.css" type = "text/css" / >
2021-07-10 18:59:18 +00:00
2021-08-24 18:42:27 +00:00
2021-07-10 18:59:18 +00:00
2021-08-24 18:42:27 +00:00
<!-- [if lt IE 9]>
< script src = "_static/js/html5shiv.min.js" > < / script >
<![endif]-->
2021-07-10 18:59:18 +00:00
< script type = "text/javascript" id = "documentation_options" data-url_root = "./" src = "_static/documentation_options.js" > < / script >
< script src = "_static/jquery.js" > < / script >
< script src = "_static/underscore.js" > < / script >
< script src = "_static/doctools.js" > < / script >
< script type = "text/javascript" src = "_static/js/theme.js" > < / script >
< link rel = "index" title = "Index" href = "genindex.html" / >
< link rel = "search" title = "Search" href = "search.html" / >
< link rel = "next" title = "24. cdist integration / using cdist as library" href = "cdist-integration.html" / >
< link rel = "prev" title = "22. PreOS" href = "cdist-preos.html" / >
< / 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
< img src = "_static/cdist-logo.jpeg" class = "logo" alt = "Logo" / >
< / a >
< div class = "version" >
2021-08-24 18:42:27 +00:00
6.9.8
2021-07-10 18:59:18 +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 >
2021-08-24 18:42:27 +00:00
2021-07-10 18:59:18 +00:00
< 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-why.html" > 1. Why should I use cdist?< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-features.html" > 2. Features< / 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-upgrade.html" > 5. How to upgrade 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-quickstart.html" > 7. Quickstart< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-real-world.html" > 8. Dive into real world cdist< / 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 = "man1/cdist-dump.html" > 10. cdist-dump(1)< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "man1/cdist-new-type.html" > 11. cdist-new-type(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. Scan< / 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 = "#usage-examples" > 23.2. Usage (Examples)< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#modes" > 23.3. Modes< / a > < / li >
< li class = "toctree-l2" > < a class = "reference internal" href = "#name-mapper-script" > 23.4. Name Mapper Script< / a > < / li >
< / ul >
< / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-integration.html" > 24. cdist integration / using cdist as library< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-reference.html" > 25. Reference< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-best-practice.html" > 26. Best practice< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-stages.html" > 27. Execution stages< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-cache.html" > 28. Local cache overview< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-saving-output-streams.html" > 29. Saving output streams< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-remote-exec-copy.html" > 30. Remote exec and copy commands< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-hacker.html" > 31. Hacking< / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "cdist-troubleshooting.html" > 32. Troubleshooting< / a > < / li >
< / ul >
< / div >
2021-08-24 18:42:27 +00:00
2021-07-10 18:59:18 +00:00
< / 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" >
2021-08-24 18:42:27 +00:00
2021-07-10 18:59:18 +00:00
< div role = "navigation" aria-label = "breadcrumbs navigation" >
< ul class = "wy-breadcrumbs" >
2021-08-24 18:42:27 +00:00
< li > < a href = "index.html" class = "icon icon-home" > < / a > » < / li >
2021-07-10 18:59:18 +00:00
< li > < span class = "section-number" > 23. < / span > Scan< / li >
< li class = "wy-breadcrumbs-aside" >
2021-08-24 18:42:27 +00:00
2021-07-10 18:59:18 +00:00
< a href = "_sources/cdist-scan.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" >
2021-08-24 18:42:27 +00:00
< div class = "section" id = "scan" >
2021-07-10 18:59:18 +00:00
< h1 > < span class = "section-number" > 23. < / span > Scan< a class = "headerlink" href = "#scan" title = "Permalink to this headline" > ¶< / a > < / h1 >
2021-08-24 18:42:27 +00:00
< div class = "section" id = "description" >
2021-07-10 18:59:18 +00:00
< h2 > < span class = "section-number" > 23.1. < / span > Description< a class = "headerlink" href = "#description" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Runs cdist as a daemon that discover/watch on hosts and reconfigure them
periodically. It is especially useful in netboot-based environment where hosts
boot unconfigured, and to ensure your infrastructure stays in sync with your
configuration.< / p >
< p > This feature is still consider to be in < strong > beta< / strong > stage, and only operate on
IPv6 (including link-local).< / p >
2021-08-24 18:42:27 +00:00
< / div >
< div class = "section" id = "usage-examples" >
2021-07-10 18:59:18 +00:00
< h2 > < span class = "section-number" > 23.2. < / span > Usage (Examples)< a class = "headerlink" href = "#usage-examples" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > Discover hosts on local network and configure those whose name is resolved by
the name mapper script.< / p >
< div class = "highlight-sh notranslate" > < div class = "highlight" > < pre > < span > < / span > $ cdist scan --beta --interface eth0 < span class = "se" > \< / span >
--mode scan --name-mapper path/to/script < span class = "se" > \< / span >
--mode trigger --mode config
< / pre > < / div >
< / div >
< p > List known hosts and exit.< / p >
< div class = "highlight-sh notranslate" > < div class = "highlight" > < pre > < span > < / span > $ cdist scan --beta --list --name-mapper path/to/script
< / pre > < / div >
< / div >
< p > Please refer to < cite > cdist(1)< / cite > for a detailed list of parameters.< / p >
2021-08-24 18:42:27 +00:00
< / div >
< div class = "section" id = "modes" >
2021-07-10 18:59:18 +00:00
< h2 > < span class = "section-number" > 23.3. < / span > Modes< a class = "headerlink" href = "#modes" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > The scanner has 3 modes that can be independently toggled. If the < cite > --mode< / cite >
parameter is not specified, only < cite > tigger< / cite > and < cite > scan< / cite > are enabled (= hosts are
not configured).< / p >
< dl class = "simple" >
< dt > trigger< / dt > < dd > < p > Send ICMPv6 requests to specific hosts or broadcast over IPv6 link-local to
trigger detection by the < cite > scan< / cite > module.< / p >
< / dd >
< dt > scan< / dt > < dd > < p > Watch for incoming ICMPv6 replies and optionally configure detected hosts.< / p >
< / dd >
< dt > config< / dt > < dd > < p > Enable configuration of hosts detected by < cite > scan< / cite > .< / p >
< / dd >
< / dl >
2021-08-24 18:42:27 +00:00
< / div >
< div class = "section" id = "name-mapper-script" >
2021-07-10 18:59:18 +00:00
< h2 > < span class = "section-number" > 23.4. < / span > Name Mapper Script< a class = "headerlink" href = "#name-mapper-script" title = "Permalink to this headline" > ¶< / a > < / h2 >
< p > The name mapper script takes an IPv6 address as first argument and writes the
resolved name to stdout - if any. The script must be executable.< / p >
< p > Simplest script:< / p >
2021-08-24 18:42:27 +00:00
< div class = "highlight-sh notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "ch" > #!/bin/sh< / span >
< span class = "k" > case< / span > < span class = "s2" > " < / span > < span class = "nv" > $1< / span > < span class = "s2" > " < / span > in
< span class = "s2" > " fe80::20d:b9ff:fe57:3524" < / span > < span class = "o" > )< / span >
< span class = "nb" > printf< / span > < span class = "s2" > " my-host-01" < / span >
< span class = "p" > ;;< / span >
< span class = "s2" > " fe80::7603:bdff:fe05:89bb" < / span > < span class = "o" > )< / span >
< span class = "nb" > printf< / span > < span class = "s2" > " my-host-02" < / span >
< span class = "p" > ;;< / span >
< span class = "k" > esac< / span >
< / pre > < / div >
< / div >
2021-07-10 18:59:18 +00:00
< p > Resolving name from < cite > PTR< / cite > DNS record:< / p >
2021-08-24 18:42:27 +00:00
< div class = "highlight-sh notranslate" > < div class = "highlight" > < pre > < span > < / span > < span class = "ch" > #!/bin/sh< / span >
< span class = "k" > for< / span > cmd in dig sed< span class = "p" > ;< / span > < span class = "k" > do< / span >
< span class = "k" > if< / span > ! < span class = "nb" > command< / span > -v < span class = "nv" > $cmd< / span > > /dev/null< span class = "p" > ;< / span > < span class = "k" > then< / span >
< span class = "nb" > exit< / span > < span class = "m" > 1< / span >
< span class = "k" > fi< / span >
< span class = "k" > done< / span >
dig +short -x < span class = "s2" > " < / span > < span class = "nv" > $1< / span > < span class = "s2" > " < / span > < span class = "p" > |< / span > sed -e < span class = "s1" > ' s/.$//' < / span >
< / pre > < / div >
< / div >
< / div >
< / div >
2021-07-10 18:59:18 +00:00
< / div >
< / div >
< footer >
< div class = "rst-footer-buttons" role = "navigation" aria-label = "footer navigation" >
2021-08-24 18:42:27 +00:00
< a href = "cdist-integration.html" class = "btn btn-neutral float-right" title = "24. cdist integration / using cdist as library" accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" aria-hidden = "true" > < / span > < / a >
< a href = "cdist-preos.html" class = "btn btn-neutral float-left" title = "22. PreOS" accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" aria-hidden = "true" > < / span > Previous< / a >
2021-07-10 18:59:18 +00:00
< / div >
< hr / >
< div role = "contentinfo" >
< p >
2021-08-24 18:42:27 +00:00
© Copyright ungleich GmbH 2021.
2021-07-10 18:59:18 +00:00
< / p >
< / div >
2021-08-24 18:42:27 +00:00
Built with < a href = "https://www.sphinx-doc.org/" > Sphinx< / a > using a
< a href = "https://github.com/readthedocs/sphinx_rtd_theme" > theme< / a >
provided by < a href = "https://readthedocs.org" > Read the Docs< / a > .
2021-07-10 18:59:18 +00:00
< / footer >
< / div >
< / div >
< / section >
< / div >
< script type = "text/javascript" >
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
< / script >
< / body >
< / html >
