mirror of
https://github.com/prometheus-community/ansible
synced 2024-11-23 04:13:05 +00:00
395 lines
No EOL
32 KiB
HTML
395 lines
No EOL
32 KiB
HTML
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" >
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
|
||
<meta content="2.5.0" name="antsibull-docs" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>prometheus.prometheus.smartctl_exporter role – Prometheus Smartctl Exporter — Prometheus.Prometheus Collection documentation</title>
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/css/ansible.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/antsibull-minimal.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/css/rtd-ethical-ads.css" type="text/css" />
|
||
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
|
||
<!--[if lt IE 9]>
|
||
<script src="_static/js/html5shiv.min.js"></script>
|
||
<![endif]-->
|
||
|
||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||
<script src="_static/documentation_options.js?v=7f41d439"></script>
|
||
<script src="_static/doctools.js?v=888ff710"></script>
|
||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<script src="_static/js/theme.js"></script>
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="prometheus.prometheus.smokeping_prober role – Prometheus Smokeping Prober" href="smokeping_prober_role.html" />
|
||
<link rel="prev" title="prometheus.prometheus.pushgateway role – Prometheus Pushgateway" href="pushgateway_role.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
|
||
|
||
|
||
|
||
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav"><!-- extra body elements for Ansible beyond RTD Sphinx Theme -->
|
||
|
||
<div class="DocSite-globalNav ansibleNav">
|
||
<ul>
|
||
<li><a href="https://www.ansible.com/ansiblefest" target="_blank">AnsibleFest</a></li>
|
||
<li><a href="https://www.ansible.com/tower" target="_blank">Products</a></li>
|
||
<li><a href="https://www.ansible.com/community" target="_blank">Community</a></li>
|
||
<li><a href="https://www.ansible.com/webinars-training" target="_blank">Webinars & Training</a></li>
|
||
<li><a href="https://www.ansible.com/blog" target="_blank">Blog</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<a class="DocSite-nav" href="https://prometheus-community.github.io/ansible/branch/main/" style="padding-bottom: 30px;">
|
||
|
||
<img class="DocSiteNav-logo"
|
||
src="_static/images/Ansible-Mark-RGB_White.png"
|
||
alt="Ansible Logo">
|
||
<div class="DocSiteNav-title">Prometheus.Prometheus Collection Docs</div>
|
||
</a>
|
||
<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">
|
||
Prometheus.Prometheus Collection
|
||
</a><!--- Based on https://github.com/rtfd/sphinx_rtd_theme/pull/438/files -->
|
||
|
||
<div class="version">
|
||
|
||
|
||
|
||
</div>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<label class="sr-only" for="q">Search docs:</label>
|
||
<input type="text" class="st-default-search-input" id="q" 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="Navigation menu">
|
||
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="alertmanager_role.html">prometheus.prometheus.alertmanager role – Prometheus Alertmanager service</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="blackbox_exporter_role.html">prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="chrony_exporter_role.html">prometheus.prometheus.chrony_exporter role – Prometheus Chrony Exporter</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="mysqld_exporter_role.html">prometheus.prometheus.mysqld_exporter role – Prometheus MySQLd Exporter</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="node_exporter_role.html">prometheus.prometheus.node_exporter role – Prometheus Node Exporter</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="prometheus_role.html">prometheus.prometheus.prometheus role – Installs and configures prometheus</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="pushgateway_role.html">prometheus.prometheus.pushgateway role – Prometheus Pushgateway</a></li>
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">prometheus.prometheus.smartctl_exporter role – Prometheus Smartctl Exporter</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#entry-point-main-prometheus-smartctl-exporter">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Prometheus Smartctl Exporter</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#synopsis">Synopsis</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#parameters">Parameters</a></li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#authors">Authors</a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#collection-links">Collection links</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="smokeping_prober_role.html">prometheus.prometheus.smokeping_prober role – Prometheus Smokeping Prober</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="snmp_exporter_role.html">prometheus.prometheus.snmp_exporter role – Prometheus SNMP exporter</a></li>
|
||
<li class="toctree-l1"><a class="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 -->
|
||
|
||
</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">Prometheus.Prometheus Collection</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">prometheus.prometheus.smartctl_exporter role – Prometheus Smartctl Exporter</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
|
||
|
||
<div itemprop="articleBody">
|
||
|
||
<span class="target" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role"></span><section id="prometheus-prometheus-smartctl-exporter-role-prometheus-smartctl-exporter">
|
||
<h1>prometheus.prometheus.smartctl_exporter role – Prometheus Smartctl Exporter<a class="headerlink" href="#prometheus-prometheus-smartctl-exporter-role-prometheus-smartctl-exporter" title="Link to this heading"></a></h1>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Note</p>
|
||
<p>This role is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/prometheus/prometheus/">prometheus.prometheus collection</a> (version 0.8.0).</p>
|
||
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
||
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
||
<p>To install it use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">prometheus.prometheus</span></code>.</p>
|
||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">prometheus.prometheus.smartctl_exporter</span></code>.</p>
|
||
</div>
|
||
<nav class="contents local" id="contents">
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="#entry-point-main-prometheus-smartctl-exporter" id="id1">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Prometheus Smartctl Exporter</a></p>
|
||
<ul>
|
||
<li><p><a class="reference internal" href="#synopsis" id="id2">Synopsis</a></p></li>
|
||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||
<li><p><a class="reference internal" href="#authors" id="id4">Authors</a></p></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
<section id="entry-point-main-prometheus-smartctl-exporter">
|
||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Entry point <code class="docutils literal notranslate"><span class="pre">main</span></code> – Prometheus Smartctl Exporter</a><a class="headerlink" href="#entry-point-main-prometheus-smartctl-exporter" title="Link to this heading"></a></h2>
|
||
<section id="synopsis">
|
||
<h3><a class="toc-backref" href="#id2" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h3>
|
||
<ul class="simple">
|
||
<li><p>Deploy prometheus <a class="reference external" href="https://github.com/prometheus-community/smartctl_exporter">smartctl exporter</a> using ansible</p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="parameters">
|
||
<h3><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Link to this heading"></a></h3>
|
||
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
||
<thead>
|
||
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
||
<th class="head"><p>Comments</p></th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_basic_auth_users"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-basic-auth-users"><strong>smartctl_exporter_basic_auth_users</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_basic_auth_users" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell"><p>Dictionary of users and password for basic authentication. Passwords are automatically hashed with bcrypt.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_binary_install_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-binary-install-dir"><strong>smartctl_exporter_binary_install_dir</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_binary_install_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell"><p><em>Advanced</em></p>
|
||
<p>Directory to install smartctl_exporter binary</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"/usr/local/bin"</span></code></p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_binary_local_dir"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-binary-local-dir"><strong>smartctl_exporter_binary_local_dir</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_binary_local_dir" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||
</div></td>
|
||
<td><div class="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 <code class="docutils literal notranslate"><span class="pre">smartctl_exporter</span></code> binary is stored on the host where ansible is run.</p>
|
||
<p>This overrides the <em>smartctl_exporter_version</em> parameter</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_binary_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-binary-url"><strong>smartctl_exporter_binary_url</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_binary_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell"><p>URL of the Smartctl exporter binaries .tar.gz file</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"https://github.com/{{</span> <span class="pre">_smartctl_exporter_repo</span> <span class="pre">}}/releases/download/v{{</span> <span class="pre">smartctl_exporter_version</span> <span class="pre">}}/smartctl_exporter-{{</span> <span class="pre">smartctl_exporter_version</span> <span class="pre">}}.linux-{{</span> <span class="pre">go_arch</span> <span class="pre">}}.tar.gz"</span></code></p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_checksums_url"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-checksums-url"><strong>smartctl_exporter_checksums_url</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_checksums_url" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell"><p>URL of the Smartctl exporter checksums file</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"https://github.com/{{</span> <span class="pre">_smartctl_exporter_repo</span> <span class="pre">}}/releases/download/v{{</span> <span class="pre">smartctl_exporter_version</span> <span class="pre">}}/sha256sums.txt"</span></code></p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_http_server_config"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-http-server-config"><strong>smartctl_exporter_http_server_config</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_http_server_config" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell"><p>Config for HTTP/2 support.</p>
|
||
<p>Keys and values are the same as in <a class="reference external" href="https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md">smartctl_exporter docs</a>.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_log_format"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-log-format"><strong>smartctl_exporter_log_format</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_log_format" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell"><p>Output format of log messages. One of: [logfmt, json]</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"logfmt"</span></code></p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_log_level"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-log-level"><strong>smartctl_exporter_log_level</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_log_level" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell"><p>Only log messages with the given severity or above. One of: [debug, info, warn, error]</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"info"</span></code></p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_skip_install"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-skip-install"><strong>smartctl_exporter_skip_install</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_skip_install" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell"><p>Smartctl exporter installation tasks gets skipped when set to true.</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
||
<ul class="simple">
|
||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
||
</ul>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_smartctl_device_exclude"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-smartctl-device-exclude"><strong>smartctl_exporter_smartctl_device_exclude</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_smartctl_device_exclude" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell"><p>Regexp of devices to exclude from automatic scanning. (mutually exclusive to smartctl_exporter_smartctl_device_include)</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">""</span></code></p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_smartctl_device_include"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-smartctl-device-include"><strong>smartctl_exporter_smartctl_device_include</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_smartctl_device_include" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell"><p>Regexp of devices to include in automatic scanning. (mutually exclusive to smartctl_exporter_smartctl_device_exclude)</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">""</span></code></p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_smartctl_devices"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-smartctl-devices"><strong>smartctl_exporter_smartctl_devices</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_smartctl_devices" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell"><p>List of devices to be monitored by smartctl_exporter. Disables auto scan for available devices.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_smartctl_interval"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-smartctl-interval"><strong>smartctl_exporter_smartctl_interval</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_smartctl_interval" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell"><p>The interval between smartctl polls</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"60s"</span></code></p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_smartctl_path"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-smartctl-path"><strong>smartctl_exporter_smartctl_path</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_smartctl_path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell"><p><em>Advanced</em></p>
|
||
<p>The path to the smartctl binary</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"/usr/sbin/smartctl"</span></code></p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_smartctl_rescan"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-smartctl-rescan"><strong>smartctl_exporter_smartctl_rescan</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_smartctl_rescan" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell"><p>The interval between rescanning for new/disappeared devices.</p>
|
||
<p>If the interval is smaller than 1s norescanning takes place.</p>
|
||
<p>If any devices are configured with smartctl_exporter_smartctl_device also no rescanning takes place.</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"10m"</span></code></p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_system_group"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-system-group"><strong>smartctl_exporter_system_group</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_system_group" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell"><p><em>Advanced</em></p>
|
||
<p>System group for Smartctl exporter</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"smartctl-exp"</span></code></p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_system_user"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-system-user"><strong>smartctl_exporter_system_user</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_system_user" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell"><p><em>Advanced</em></p>
|
||
<p>Smartctl exporter user</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"smartctl-exp"</span></code></p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_tls_server_config"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-tls-server-config"><strong>smartctl_exporter_tls_server_config</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_tls_server_config" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell"><p>Configuration for TLS authentication.</p>
|
||
<p>Keys and values are the same as in <a class="reference external" href="https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md">smartctl_exporter docs</a>.</p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_version"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-version"><strong>smartctl_exporter_version</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell"><p>Smartctl exporter package version. Also accepts latest as parameter.</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"0.11.0"</span></code></p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_web_listen_address"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-web-listen-address"><strong>smartctl_exporter_web_listen_address</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_web_listen_address" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell"><p>Address on which smartctl exporter will listen</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"0.0.0.0:9633"</span></code></p>
|
||
</div></td>
|
||
</tr>
|
||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||
<div class="ansibleOptionAnchor" id="parameter-main--smartctl_exporter_web_telemetry_path"></div><p class="ansible-option-title" id="ansible-collections-prometheus-prometheus-smartctl-exporter-role-parameter-main-smartctl-exporter-web-telemetry-path"><strong>smartctl_exporter_web_telemetry_path</strong></p>
|
||
<a class="ansibleOptionLink" href="#parameter-main--smartctl_exporter_web_telemetry_path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||
</div></td>
|
||
<td><div class="ansible-option-cell"><p>Path under which to expose metrics</p>
|
||
<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"/metrics"</span></code></p>
|
||
</div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</section>
|
||
<section id="authors">
|
||
<h3><a class="toc-backref" href="#id4" role="doc-backlink">Authors</a><a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
|
||
<ul class="simple">
|
||
<li><p>Prometheus Community</p></li>
|
||
</ul>
|
||
<section id="collection-links">
|
||
<h4>Collection links<a class="headerlink" href="#collection-links" title="Link to this heading"></a></h4>
|
||
<ul class="ansible-links">
|
||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/prometheus-community/ansible/issues" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://prometheus.io" rel="noopener external" target="_blank">Homepage</a></span></li>
|
||
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/prometheus-community/ansible" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
||
</ul>
|
||
</section>
|
||
</section>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="pushgateway_role.html" class="btn btn-neutral float-left" title="prometheus.prometheus.pushgateway role – Prometheus Pushgateway" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
<a href="smokeping_prober_role.html" class="btn btn-neutral float-right" title="prometheus.prometheus.smokeping_prober role – Prometheus Smokeping Prober" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright Prometheus.Prometheus Contributors.</p>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script><!-- extra footer elements for Ansible beyond RTD Sphinx Theme -->
|
||
|
||
</body>
|
||
</html> |