212 lines
13 KiB
HTML
212 lines
13 KiB
HTML
|
<!DOCTYPE html>
|
||
|
|
<html class="writer-html5" lang="en" >
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
|
||
|
|
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
|
|
<title>22. Scan — cdist 6.9.8-60-g77d9a757 documentation</title>
|
||
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||
|
|
|
||
|
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||
|
|
<script src="_static/doctools.js"></script>
|
||
|
|
<script src="_static/sphinx_highlight.js"></script>
|
||
|
|
<script 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="23. cdist integration / using cdist as library" href="cdist-integration.html" />
|
||
|
|
<link rel="prev" title="21. 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">
|
||
|
|
6.9.8-60-g77d9a757
|
||
|
|
</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" aria-label="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="Navigation menu">
|
||
|
|
<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-preos.html">21. PreOS</a></li>
|
||
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">22. Scan</a><ul>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="#description">22.1. Description</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="#usage-examples">22.2. Usage (Examples)</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="#modes">22.3. Modes</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="#name-mapper-script">22.4. Name Mapper Script</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l1"><a class="reference internal" href="cdist-integration.html">23. cdist integration / using cdist as library</a></li>
|
||
|
|
<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>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
|
|
<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="Page navigation">
|
||
|
|
<ul class="wy-breadcrumbs">
|
||
|
|
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
|
|
<li class="breadcrumb-item active"><span class="section-number">22. </span>Scan</li>
|
||
|
|
<li class="wy-breadcrumbs-aside">
|
||
|
|
<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">
|
||
|
|
|
||
|
|
<section id="scan">
|
||
|
|
<h1><span class="section-number">22. </span>Scan<a class="headerlink" href="#scan" title="Permalink to this heading">¶</a></h1>
|
||
|
|
<section id="description">
|
||
|
|
<h2><span class="section-number">22.1. </span>Description<a class="headerlink" href="#description" title="Permalink to this heading">¶</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>
|
||
|
|
</section>
|
||
|
|
<section id="usage-examples">
|
||
|
|
<h2><span class="section-number">22.2. </span>Usage (Examples)<a class="headerlink" href="#usage-examples" title="Permalink to this heading">¶</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>$<span class="w"> </span>cdist<span class="w"> </span>scan<span class="w"> </span>--beta<span class="w"> </span>--interface<span class="w"> </span>eth0<span class="w"> </span><span class="se">\</span>
|
||
|
|
<span class="w"> </span>--mode<span class="w"> </span>scan<span class="w"> </span>--name-mapper<span class="w"> </span>path/to/script<span class="w"> </span><span class="se">\</span>
|
||
|
|
<span class="w"> </span>--mode<span class="w"> </span>trigger<span class="w"> </span>--mode<span class="w"> </span>config
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>List known hosts and exit.</p>
|
||
|
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>cdist<span class="w"> </span>scan<span class="w"> </span>--beta<span class="w"> </span>--list<span class="w"> </span>--name-mapper<span class="w"> </span>path/to/script
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>Please refer to <cite>cdist(1)</cite> for a detailed list of parameters.</p>
|
||
|
|
</section>
|
||
|
|
<section id="modes">
|
||
|
|
<h2><span class="section-number">22.3. </span>Modes<a class="headerlink" href="#modes" title="Permalink to this heading">¶</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>
|
||
|
|
</section>
|
||
|
|
<section id="name-mapper-script">
|
||
|
|
<h2><span class="section-number">22.4. </span>Name Mapper Script<a class="headerlink" href="#name-mapper-script" title="Permalink to this heading">¶</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>
|
||
|
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/bin/sh</span>
|
||
|
|
|
||
|
|
<span class="k">case</span><span class="w"> </span><span class="s2">"</span><span class="nv">$1</span><span class="s2">"</span><span class="w"> </span><span class="k">in</span>
|
||
|
|
<span class="w"> </span><span class="s2">"fe80::20d:b9ff:fe57:3524"</span><span class="o">)</span>
|
||
|
|
<span class="w"> </span><span class="nb">printf</span><span class="w"> </span><span class="s2">"my-host-01"</span>
|
||
|
|
<span class="w"> </span><span class="p">;;</span>
|
||
|
|
<span class="w"> </span><span class="s2">"fe80::7603:bdff:fe05:89bb"</span><span class="o">)</span>
|
||
|
|
<span class="w"> </span><span class="nb">printf</span><span class="w"> </span><span class="s2">"my-host-02"</span>
|
||
|
|
<span class="w"> </span><span class="p">;;</span>
|
||
|
|
<span class="k">esac</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
<p>Resolving name from <cite>PTR</cite> DNS record:</p>
|
||
|
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="ch">#!/bin/sh</span>
|
||
|
|
|
||
|
|
<span class="k">for</span><span class="w"> </span>cmd<span class="w"> </span><span class="k">in</span><span class="w"> </span>dig<span class="w"> </span>sed<span class="p">;</span><span class="w"> </span><span class="k">do</span>
|
||
|
|
<span class="w"> </span><span class="k">if</span><span class="w"> </span>!<span class="w"> </span><span class="nb">command</span><span class="w"> </span>-v<span class="w"> </span><span class="nv">$cmd</span><span class="w"> </span>><span class="w"> </span>/dev/null<span class="p">;</span><span class="w"> </span><span class="k">then</span>
|
||
|
|
<span class="w"> </span><span class="nb">exit</span><span class="w"> </span><span class="m">1</span>
|
||
|
|
<span class="w"> </span><span class="k">fi</span>
|
||
|
|
<span class="k">done</span>
|
||
|
|
|
||
|
|
dig<span class="w"> </span>+short<span class="w"> </span>-x<span class="w"> </span><span class="s2">"</span><span class="nv">$1</span><span class="s2">"</span><span class="w"> </span><span class="p">|</span><span class="w"> </span>sed<span class="w"> </span>-e<span class="w"> </span><span class="s1">'s/.$//'</span>
|
||
|
|
</pre></div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
|
|
<a href="cdist-preos.html" class="btn btn-neutral float-left" title="21. PreOS" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
|
|
<a href="cdist-integration.html" class="btn btn-neutral float-right" title="23. cdist integration / using cdist as library" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<hr/>
|
||
|
|
|
||
|
|
<div role="contentinfo">
|
||
|
|
<p>© Copyright ungleich GmbH 2021.</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
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>.
|
||
|
|
|
||
|
|
|
||
|
|
</footer>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
</div>
|
||
|
|
<script>
|
||
|
|
jQuery(function () {
|
||
|
|
SphinxRtdTheme.Navigation.enable(true);
|
||
|
|
});
|
||
|
|
</script>
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|