<linkrel="next"title="prometheus.prometheus.prometheus role – Installs and configures prometheus"href="prometheus_role.html"/>
<linkrel="prev"title="prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter"href="mysqld_exporter_role.html"/><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
</head>
<bodyclass="wy-body-for-nav"><!-- extra body elements for Ansible beyond RTD Sphinx Theme -->
<liclass="toctree-l1"><aclass="reference internal"href="alertmanager_role.html">prometheus.prometheus.alertmanager role – Prometheus Alertmanager service</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter</a></li>
<liclass="toctree-l1 current"><aclass="current reference internal"href="#">prometheus.prometheus.node_exporter role – Prometheus Node Exporter</a><ul>
<liclass="toctree-l2"><aclass="reference internal"href="#entry-point-main-prometheus-node-exporter">Entry point <codeclass="docutils literal notranslate"><spanclass="pre">main</span></code>– Prometheus Node Exporter</a><ul>
<liclass="toctree-l1"><aclass="reference internal"href="prometheus_role.html">prometheus.prometheus.prometheus role – Installs and configures prometheus</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role – Prometheus SNMP exporter</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="systemd_exporter_role.html">prometheus.prometheus.systemd_exporter role – Prometheus Systemd Exporter</a></li>
</ul>
<!-- extra nav elements for Ansible beyond RTD Sphinx Theme -->
<h1>prometheus.prometheus.node_exporter role – Prometheus Node Exporter<aclass="headerlink"href="#prometheus-prometheus-node-exporter-role-prometheus-node-exporter"title="Permalink to this heading"></a></h1>
<p>This role is part of the <aclass="reference external"href="https://galaxy.ansible.com/prometheus/prometheus">prometheus.prometheus collection</a> (version 0.6.0).</p>
<p>To install it use: <codeclass="code docutils literal notranslate"><spanclass="pre">ansible-galaxy</span><spanclass="pre">collection</span><spanclass="pre">install</span><spanclass="pre">prometheus.prometheus</span></code>.</p>
<p>To use it in a playbook, specify: <codeclass="code docutils literal notranslate"><spanclass="pre">prometheus.prometheus.node_exporter</span></code>.</p>
</div>
<navclass="contents local"id="contents">
<ulclass="simple">
<li><p><aclass="reference internal"href="#entry-point-main-prometheus-node-exporter"id="id1">Entry point <codeclass="docutils literal notranslate"><spanclass="pre">main</span></code>– Prometheus Node Exporter</a></p>
<h2><aclass="toc-backref"href="#id1"role="doc-backlink">Entry point <codeclass="docutils literal notranslate"><spanclass="pre">main</span></code>– Prometheus Node Exporter</a><aclass="headerlink"href="#entry-point-main-prometheus-node-exporter"title="Permalink to this heading"></a></h2>
<sectionid="synopsis">
<h3><aclass="toc-backref"href="#id2"role="doc-backlink">Synopsis</a><aclass="headerlink"href="#synopsis"title="Permalink to this heading"></a></h3>
<ulclass="simple">
<li><p>Deploy prometheus <aclass="reference external"href="https://github.com/prometheus/node_exporter">node exporter</a> using ansible</p></li>
</ul>
</section>
<sectionid="parameters">
<h3><aclass="toc-backref"href="#id3"role="doc-backlink">Parameters</a><aclass="headerlink"href="#parameters"title="Permalink to this heading"></a></h3>
<aclass="ansibleOptionLink"href="#parameter-main--node_exporter_basic_auth_users"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">dictionary</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.</p>
<aclass="ansibleOptionLink"href="#parameter-main--node_exporter_binary_install_dir"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#parameter-main--node_exporter_binary_local_dir"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>Enables the use of local packages instead of those distributed on github.</p>
<p>The parameter may be set to a directory where the <codeclass="docutils literal notranslate"><spanclass="pre">node_exporter</span></code> binary is stored on the host where ansible is run.</p>
<p>This overrides the <em>node_exporter_version</em> parameter</p>
<aclass="ansibleOptionLink"href="#parameter-main--node_exporter_binary_url"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>URL of the node exporter binaries .tar.gz file</p>
<aclass="ansibleOptionLink"href="#parameter-main--node_exporter_checksums_url"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>URL of the node exporter checksums file</p>
<aclass="ansibleOptionLink"href="#parameter-main--node_exporter_disabled_collectors"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">list</span> / <spanclass="ansible-option-elements">elements=string</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>List of disabled collectors.</p>
<aclass="ansibleOptionLink"href="#parameter-main--node_exporter_enabled_collectors"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">list</span> / <spanclass="ansible-option-elements">elements=string</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>List of dicts defining additionally enabled collectors and their configuration.</p>
<p>It adds collectors to <aclass="reference external"href="https://github.com/prometheus/node_exporter#enabled-by-default">those enabled by default</a>.</p>
<aclass="ansibleOptionLink"href="#parameter-main--node_exporter_http_server_config"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">dictionary</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>Config for HTTP/2 support.</p>
<p>Keys and values are the same as in <aclass="reference external"href="https://github.com/prometheus/node_exporter/blob/master/https/README.md#sample-config">node_exporter docs</a>.</p>
<aclass="ansibleOptionLink"href="#parameter-main--node_exporter_skip_install"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">boolean</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>Node exporter installation tasks gets skipped when set to true.</p>
<aclass="ansibleOptionLink"href="#parameter-main--node_exporter_system_group"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#parameter-main--node_exporter_system_user"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#parameter-main--node_exporter_textfile_dir"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>Directory used by the <aclass="reference external"href="https://github.com/prometheus/node_exporter#textfile-collector">Textfile Collector</a>.</p>
<p>To get permissions to write metrics in this directory, users must be in <codeclass="docutils literal notranslate"><spanclass="pre">node-exp</span></code> system group.</p>
<p><strong>Note:</strong> More information in TROUBLESHOOTING.md guide.</p>
<aclass="ansibleOptionLink"href="#parameter-main--node_exporter_tls_server_config"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">dictionary</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>Configuration for TLS authentication.</p>
<p>Keys and values are the same as in <aclass="reference external"href="https://github.com/prometheus/node_exporter/blob/master/https/README.md#sample-config">node_exporter docs</a>.</p>
<aclass="ansibleOptionLink"href="#parameter-main--node_exporter_version"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>Node exporter package version. Also accepts latest as parameter.</p>
<aclass="ansibleOptionLink"href="#parameter-main--node_exporter_web_listen_address"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>Address on which node exporter will listen</p>
<aclass="ansibleOptionLink"href="#parameter-main--node_exporter_web_telemetry_path"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>Path under which to expose metrics</p>