<linkrel="next"title="prometheus.prometheus.blackbox_exporter role – Deploy and manage Prometheus blackbox exporter"href="blackbox_exporter_role.html"/>
<linkrel="prev"title="Prometheus.Prometheus"href="index.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="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"><aclass="reference internal"href="node_exporter_role.html">prometheus.prometheus.node_exporter role – Prometheus Node Exporter</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="prometheus_role.html">prometheus.prometheus.prometheus role – Installs and configures prometheus</a></li>
<h1>prometheus.prometheus.alertmanager role – Prometheus Alertmanager service<aclass="headerlink"href="#prometheus-prometheus-alertmanager-role-prometheus-alertmanager-service"title="Link 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.alertmanager</span></code>.</p>
</div>
<navclass="contents local"id="contents">
<ulclass="simple">
<li><p><aclass="reference internal"href="#entry-point-main-prometheus-alertmanager-service"id="id1">Entry point <codeclass="docutils literal notranslate"><spanclass="pre">main</span></code>– Prometheus Alertmanager service</a></p>
<h2><aclass="toc-backref"href="#id1"role="doc-backlink">Entry point <codeclass="docutils literal notranslate"><spanclass="pre">main</span></code>– Prometheus Alertmanager service</a><aclass="headerlink"href="#entry-point-main-prometheus-alertmanager-service"title="Link to this heading"></a></h2>
<li><p>Deploy and manage Prometheus <aclass="reference external"href="https://github.com/prometheus/alertmanager">alertmanager</a> service using ansible.</p></li>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_amtool_config_alertmanager_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 alertmanager</p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_amtool_config_file"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>Template for amtool config</p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_amtool_config_output"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>Extended output, use <codeclass="docutils literal notranslate"><spanclass="pre">""</span></code> for simple output.</p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_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>Allows to use local packages instead of ones distributed on github.</p>
<p>As parameter it takes a directory where <codeclass="docutils literal notranslate"><spanclass="pre">alertmanager</span></code> AND <codeclass="docutils literal notranslate"><spanclass="pre">amtool</span></code> binaries are stored on host on which ansible is ran.</p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_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 alertmanager binaries .tar.gz file</p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_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 alertmanager checksums file</p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_cluster"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>HA cluster network configuration. Disabled by default.</p>
<p>More information in <aclass="reference external"href="https://github.com/prometheus/alertmanager#high-availability">alertmanager readme</a></p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_config_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>Path to directory with alertmanager configuration</p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_config_file"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>Variable used to provide custom alertmanager configuration file in form of ansible template</p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_config_flags_extra"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>Additional configuration flags passed to prometheus binary at startup</p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_db_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>Path to directory with alertmanager database</p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_hipchat_api_url"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_hipchat_auth_token"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_http_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>Http config for using custom webhooks</p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_inhibit_rules"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 inhibition rules. Same as in <aclass="reference external"href="https://prometheus.io/docs/alerting/configuration/#inhibit_rule">official docs</a></p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_opsgenie_api_key"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_opsgenie_api_url"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_pagerduty_url"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_receivers"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>A list of notification receivers. Configuration same as in <aclass="reference external"href="https://prometheus.io/docs/alerting/configuration/#receiver">official docs</a></p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_resolve_timeout"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>Time after which an alert is declared resolved</p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_route"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>Alert routing. More in <aclass="reference external"href="https://prometheus.io/docs/alerting/configuration/#route">official docs</a></p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_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>Alertmanager installation tasks gets skipped when set to true.</p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_slack_api_url"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_smtp"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">dictionary</span></p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_template_files"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 folders where ansible will look for template files which will be copied to <codeclass="docutils literal notranslate"><spanclass="pre">"{{</span><spanclass="pre">alertmanager_config_dir</span><spanclass="pre">}}/templates/"</span></code>.</p>
<p>Files must have <codeclass="docutils literal notranslate"><spanclass="pre">*.tmpl</span></code> extension</p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_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>Alertmanager package version. Also accepts `latest` as parameter.</p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_victorops_api_key"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_victorops_api_url"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_web_external_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>External address on which alertmanager is available. Useful when behind reverse proxy. Ex. example.org/alertmanager</p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_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 alertmanager will be listening</p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_wechat_corp_id"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_wechat_secret"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#parameter-main--alertmanager_wechat_url"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>