2023-03-14 19:40:11 +00:00
<!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 name = "viewport" content = "width=device-width, initial-scale=1.0" / >
< title > prometheus.prometheus.blackbox_exporter role – — 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]-->
2023-08-22 06:11:14 +00:00
< 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 >
2023-03-14 19:40:11 +00:00
< script src = "_static/js/theme.js" > < / script >
< link rel = "search" title = "Search" href = "search.html" / >
2023-08-16 12:28:38 +00:00
< link rel = "next" title = "prometheus.prometheus.chrony_exporter role – href = "chrony_exporter_role.html" / >
2023-03-14 19:40:11 +00:00
< link rel = "prev" title = "prometheus.prometheus.alertmanager role – href = "alertmanager_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 – < / a > < / li >
< li class = "toctree-l1 current" > < a class = "current reference internal" href = "#" > prometheus.prometheus.blackbox_exporter role – < / a > < ul >
< li class = "toctree-l2" > < a class = "reference internal" href = "#entry-point-main-deploy-and-manage-prometheus-blackbox-exporter" > Entry point < code class = "docutils literal notranslate" > < span class = "pre" > main< / span > < / code > – < / 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 >
2023-08-16 12:28:38 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "chrony_exporter_role.html" > prometheus.prometheus.chrony_exporter role – < / a > < / li >
2023-03-14 19:40:11 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "mysqld_exporter_role.html" > prometheus.prometheus.mysqld_exporter role – < / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "node_exporter_role.html" > prometheus.prometheus.node_exporter role – < / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "prometheus_role.html" > prometheus.prometheus.prometheus role – < / a > < / li >
2023-08-16 15:01:29 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "pushgateway_role.html" > prometheus.prometheus.pushgateway role – < / a > < / li >
2023-08-16 15:06:49 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "smokeping_prober_role.html" > prometheus.prometheus.smokeping_prober role – < / a > < / li >
2023-03-14 19:40:11 +00:00
< li class = "toctree-l1" > < a class = "reference internal" href = "snmp_exporter_role.html" > prometheus.prometheus.snmp_exporter role – < / a > < / li >
< li class = "toctree-l1" > < a class = "reference internal" href = "systemd_exporter_role.html" > prometheus.prometheus.systemd_exporter role – < / 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.blackbox_exporter role – < / 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-blackbox-exporter-role" > < / span > < section id = "prometheus-prometheus-blackbox-exporter-role-deploy-and-manage-prometheus-blackbox-exporter" >
2023-08-22 06:11:14 +00:00
< h1 > prometheus.prometheus.blackbox_exporter role – < a class = "headerlink" href = "#prometheus-prometheus-blackbox-exporter-role-deploy-and-manage-prometheus-blackbox-exporter" title = "Link to this heading" > < / a > < / h1 >
2023-03-14 19:40:11 +00:00
< div class = "admonition note" >
< p class = "admonition-title" > Note< / p >
2023-07-29 15:55:20 +00:00
< p > This role is part of the < a class = "reference external" href = "https://galaxy.ansible.com/prometheus/prometheus" > prometheus.prometheus collection< / a > (version 0.6.0).< / p >
2023-03-14 19:40:11 +00:00
< 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.blackbox_exporter< / span > < / code > .< / p >
< / div >
< nav class = "contents local" id = "contents" >
< ul class = "simple" >
< li > < p > < a class = "reference internal" href = "#entry-point-main-deploy-and-manage-prometheus-blackbox-exporter" id = "id1" > Entry point < code class = "docutils literal notranslate" > < span class = "pre" > main< / span > < / code > – < / 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-deploy-and-manage-prometheus-blackbox-exporter" >
2023-08-22 06:11:14 +00:00
< h2 > < a class = "toc-backref" href = "#id1" role = "doc-backlink" > Entry point < code class = "docutils literal notranslate" > < span class = "pre" > main< / span > < / code > – < / a > < a class = "headerlink" href = "#entry-point-main-deploy-and-manage-prometheus-blackbox-exporter" title = "Link to this heading" > < / a > < / h2 >
2023-03-14 19:40:11 +00:00
< section id = "synopsis" >
2023-08-22 06:11:14 +00:00
< h3 > < a class = "toc-backref" href = "#id2" role = "doc-backlink" > Synopsis< / a > < a class = "headerlink" href = "#synopsis" title = "Link to this heading" > < / a > < / h3 >
2023-03-14 19:40:11 +00:00
< ul class = "simple" >
< li > < p > Deploy and manage Prometheus blackbox exporter which allows blackbox probing of endpoints over HTTP, HTTPS, DNS, TCP and ICMP.< / p > < / li >
< / ul >
< / section >
< section id = "parameters" >
2023-08-22 06:11:14 +00:00
< h3 > < a class = "toc-backref" href = "#id3" role = "doc-backlink" > Parameters< / a > < a class = "headerlink" href = "#parameters" title = "Link to this heading" > < / a > < / h3 >
2023-03-14 19:40:11 +00:00
< table class = "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--blackbox_exporter_binary_url" > < / div > < p class = "ansible-option-title" id = "ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-binary-url" > < strong > blackbox_exporter_binary_url< / strong > < / p >
< a class = "ansibleOptionLink" href = "#parameter-main--blackbox_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 blackbox_exporter binaries .tar.gz file< / p >
< p class = "ansible-option-line" > < span class = "ansible-option-default-bold" > Default:< / span > < code class = "ansible-option-default docutils literal notranslate" > < span class = "pre" > " https://github.com/{{< / span > < span class = "pre" > _blackbox_exporter_repo< / span > < span class = "pre" > }}/releases/download/v{{< / span > < span class = "pre" > blackbox_exporter_version< / span > < span class = "pre" > }}/blackbox_exporter-{{< / span > < span class = "pre" > blackbox_exporter_version< / span > < span class = "pre" > }}.linux-{{< / span > < span class = "pre" > go_arch_map[ansible_architecture]< / span > < span class = "pre" > |< / span > < span class = "pre" > default(ansible_architecture)< / span > < span class = "pre" > }}.tar.gz" < / span > < / code > < / p >
< / div > < / td >
< / tr >
< tr class = "row-odd" > < td > < div class = "ansible-option-cell" >
< div class = "ansibleOptionAnchor" id = "parameter-main--blackbox_exporter_cli_flags" > < / div > < p class = "ansible-option-title" id = "ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-cli-flags" > < strong > blackbox_exporter_cli_flags< / strong > < / p >
< a class = "ansibleOptionLink" href = "#parameter-main--blackbox_exporter_cli_flags" 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 > Additional configuration flags passed to blackbox exporter binary at startup< / p >
< / div > < / td >
< / tr >
< tr class = "row-even" > < td > < div class = "ansible-option-cell" >
2023-07-29 15:55:20 +00:00
< div class = "ansibleOptionAnchor" id = "parameter-main--blackbox_exporter_config_dir" > < / div > < p class = "ansible-option-title" id = "ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-config-dir" > < strong > blackbox_exporter_config_dir< / strong > < / p >
< a class = "ansibleOptionLink" href = "#parameter-main--blackbox_exporter_config_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 > Directory where the blackbox exporter configuration file is placed< / p >
< p class = "ansible-option-line" > < span class = "ansible-option-default-bold" > Default:< / span > < code class = "ansible-option-default docutils literal notranslate" > < span class = "pre" > " /etc" < / span > < / code > < / p >
< / div > < / td >
< / tr >
< tr class = "row-odd" > < td > < div class = "ansible-option-cell" >
2023-03-14 19:40:11 +00:00
< div class = "ansibleOptionAnchor" id = "parameter-main--blackbox_exporter_configuration_modules" > < / div > < p class = "ansible-option-title" id = "ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-configuration-modules" > < strong > blackbox_exporter_configuration_modules< / strong > < / p >
< a class = "ansibleOptionLink" href = "#parameter-main--blackbox_exporter_configuration_modules" 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 > Endpoints configuration< / p >
< p class = "ansible-option-line" > < span class = "ansible-option-default-bold" > Default:< / span > < code class = "ansible-option-default docutils literal notranslate" > < span class = "pre" > {" http_2xx" :< / span > < span class = "pre" > {" http" :< / span > < span class = "pre" > {" method" :< / span > < span class = "pre" > " GET" ,< / span > < span class = "pre" > " valid_status_codes" :< / span > < span class = "pre" > []},< / span > < span class = "pre" > " prober" :< / span > < span class = "pre" > " http" ,< / span > < span class = "pre" > " timeout" :< / span > < span class = "pre" > " 5s" }}< / span > < / code > < / p >
< / div > < / td >
< / tr >
2023-07-29 15:55:20 +00:00
< tr class = "row-even" > < td > < div class = "ansible-option-cell" >
2023-08-16 15:50:39 +00:00
< div class = "ansibleOptionAnchor" id = "parameter-main--blackbox_exporter_group" > < / div > < p class = "ansible-option-title" id = "ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-group" > < strong > blackbox_exporter_group< / strong > < / p >
< a class = "ansibleOptionLink" href = "#parameter-main--blackbox_exporter_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 > The group the exporter runs as< / p >
< p class = "ansible-option-line" > < span class = "ansible-option-default-bold" > Default:< / span > < code class = "ansible-option-default docutils literal notranslate" > < span class = "pre" > " blackbox-exp" < / span > < / code > < / p >
< / div > < / td >
< / tr >
< tr class = "row-odd" > < td > < div class = "ansible-option-cell" >
2023-03-26 09:53:46 +00:00
< div class = "ansibleOptionAnchor" id = "parameter-main--blackbox_exporter_skip_install" > < / div > < p class = "ansible-option-title" id = "ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-skip-install" > < strong > blackbox_exporter_skip_install< / strong > < / p >
< a class = "ansibleOptionLink" href = "#parameter-main--blackbox_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 > Blackbox exporter installation tasks gets skipped when set to true.< / p >
< p class = "ansible-option-line" > < span class = "ansible-option-choices" > Choices:< / span > < / p >
< ul class = "simple" >
< li > < p > < code class = "ansible-option-default-bold docutils literal notranslate" > < span class = "pre" > false< / span > < / 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 >
2023-08-16 15:50:39 +00:00
< tr class = "row-even" > < td > < div class = "ansible-option-cell" >
< div class = "ansibleOptionAnchor" id = "parameter-main--blackbox_exporter_user" > < / div > < p class = "ansible-option-title" id = "ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-user" > < strong > blackbox_exporter_user< / strong > < / p >
< a class = "ansibleOptionLink" href = "#parameter-main--blackbox_exporter_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 > The user the exporter runs as< / p >
< p class = "ansible-option-line" > < span class = "ansible-option-default-bold" > Default:< / span > < code class = "ansible-option-default docutils literal notranslate" > < span class = "pre" > " blackbox-exp" < / span > < / code > < / p >
< / div > < / td >
< / tr >
2023-07-29 15:55:20 +00:00
< tr class = "row-odd" > < td > < div class = "ansible-option-cell" >
2023-03-14 19:40:11 +00:00
< div class = "ansibleOptionAnchor" id = "parameter-main--blackbox_exporter_version" > < / div > < p class = "ansible-option-title" id = "ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-version" > < strong > blackbox_exporter_version< / strong > < / p >
< a class = "ansibleOptionLink" href = "#parameter-main--blackbox_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 > Blackbox exporter package version< / p >
2023-06-01 14:45:25 +00:00
< p class = "ansible-option-line" > < span class = "ansible-option-default-bold" > Default:< / span > < code class = "ansible-option-default docutils literal notranslate" > < span class = "pre" > " 0.24.0" < / span > < / code > < / p >
2023-03-14 19:40:11 +00:00
< / div > < / td >
< / tr >
2023-07-29 15:55:20 +00:00
< tr class = "row-even" > < td > < div class = "ansible-option-cell" >
2023-03-14 19:40:11 +00:00
< div class = "ansibleOptionAnchor" id = "parameter-main--blackbox_exporter_web_listen_address" > < / div > < p class = "ansible-option-title" id = "ansible-collections-prometheus-prometheus-blackbox-exporter-role-parameter-main-blackbox-exporter-web-listen-address" > < strong > blackbox_exporter_web_listen_address< / strong > < / p >
< a class = "ansibleOptionLink" href = "#parameter-main--blackbox_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 blackbox exporter will be listening< / p >
< p class = "ansible-option-line" > < span class = "ansible-option-default-bold" > Default:< / span > < code class = "ansible-option-default docutils literal notranslate" > < span class = "pre" > " 0.0.0.0:9115" < / span > < / code > < / p >
< / div > < / td >
< / tr >
< / tbody >
< / table >
< / section >
< section id = "authors" >
2023-08-22 06:11:14 +00:00
< h3 > < a class = "toc-backref" href = "#id4" role = "doc-backlink" > Authors< / a > < a class = "headerlink" href = "#authors" title = "Link to this heading" > < / a > < / h3 >
2023-03-14 19:40:11 +00:00
< ul class = "simple" >
< li > < p > Prometheus Community< / p > < / li >
< / ul >
< section id = "collection-links" >
2023-08-22 06:11:14 +00:00
< h4 > Collection links< a class = "headerlink" href = "#collection-links" title = "Link to this heading" > < / a > < / h4 >
2023-03-14 19:40:11 +00:00
< p class = "ansible-links" >
< a href = "https://github.com/prometheus-community/ansible/issues" aria-role = "button" target = "_blank" rel = "noopener external" > Issue Tracker< / a >
< a href = "https://prometheus.io" aria-role = "button" target = "_blank" rel = "noopener external" > Homepage< / a >
< a href = "https://github.com/prometheus-community/ansible" aria-role = "button" target = "_blank" rel = "noopener external" > Repository (Sources)< / a >
< / p > < / section >
< / section >
< / section >
< / section >
< / div >
< / div >
< footer > < div class = "rst-footer-buttons" role = "navigation" aria-label = "Footer" >
< a href = "alertmanager_role.html" class = "btn btn-neutral float-left" title = "prometheus.prometheus.alertmanager role – accesskey = "p" rel = "prev" > < span class = "fa fa-arrow-circle-left" aria-hidden = "true" > < / span > Previous< / a >
2023-08-16 12:28:38 +00:00
< a href = "chrony_exporter_role.html" class = "btn btn-neutral float-right" title = "prometheus.prometheus.chrony_exporter role – accesskey = "n" rel = "next" > Next < span class = "fa fa-arrow-circle-right" aria-hidden = "true" > < / span > < / a >
2023-03-14 19:40:11 +00:00
< / 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 >
