| 1 |
|
| 2 |
|
| 3 |
<!DOCTYPE html> |
| 4 |
<html class="writer-html5" lang="en" data-content_root="../"> |
| 5 |
<head> |
| 6 |
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| 7 |
<meta content="2.24.0" name="antsibull-docs" /> |
| 8 |
|
| 9 |
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| 10 |
<title>Index of all Collection Environment Variables — Ansible collections documentation</title> |
| 11 |
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=41de9001" /> |
| 12 |
<link rel="stylesheet" type="text/css" href="../_static/css/ansible.css?v=b54c304f" /> |
| 13 |
<link rel="stylesheet" type="text/css" href="../_static/antsibull-minimal.css" /> |
| 14 |
<link rel="stylesheet" type="text/css" href="../_static/css/rtd-ethical-ads.css?v=289b023e" /> |
| 15 |
|
| 16 |
|
| 17 |
<link rel="shortcut icon" href="../_static/images/Ansible-Mark-RGB_Black.png"/> |
| 18 |
<script src="../_static/jquery.js?v=5d32c60e"></script> |
| 19 |
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
| 20 |
<script src="../_static/documentation_options.js?v=7f41d439"></script> |
| 21 |
<script src="../_static/doctools.js?v=fd6eb6e6"></script> |
| 22 |
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script> |
| 23 |
<script src="../_static/js/theme.js"></script> |
| 24 |
<link rel="search" title="Search" href="../search.html" /> |
| 25 |
<link rel="prev" title="Index of all Modules" href="index_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme --> |
| 26 |
|
| 27 |
|
| 28 |
|
| 29 |
|
| 30 |
</head> |
| 31 |
|
| 32 |
<body class="wy-body-for-nav"><!-- extra body elements for Ansible beyond RTD Sphinx Theme --> |
| 33 |
|
| 34 |
<div class="DocSite-globalNav ansibleNav"> |
| 35 |
<ul> |
| 36 |
<li><a href="https://www.ansible.com/blog" target="_blank">Blog</a></li> |
| 37 |
<li><a href="https://forum.ansible.com/" target="_blank">Ansible community forum</a></li> |
| 38 |
<li><a href="https://docs.ansible.com/" target="_blank">Documentation</a></li> |
| 39 |
</ul> |
| 40 |
</div> |
| 41 |
|
| 42 |
<a class="DocSite-nav" href="/" style="padding-bottom: 30px;"> |
| 43 |
|
| 44 |
<img class="DocSiteNav-logo" |
| 45 |
src="../_static/images/Ansible-Mark-RGB_White.png" |
| 46 |
alt="Ansible Logo"> |
| 47 |
<div class="DocSiteNav-title">Ansible Collections Documentation</div> |
| 48 |
</a> |
| 49 |
<div class="wy-grid-for-nav"> |
| 50 |
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| 51 |
<div class="wy-side-scroll"> |
| 52 |
<div class="wy-side-nav-search" > |
| 53 |
|
| 54 |
|
| 55 |
|
| 56 |
<a href="../index.html" class="icon icon-home"> |
| 57 |
Ansible collections |
| 58 |
</a><!--- Based on https://github.com/rtfd/sphinx_rtd_theme/pull/438/files --> |
| 59 |
|
| 60 |
<div class="version"> |
| 61 |
|
| 62 |
|
| 63 |
|
| 64 |
</div> |
| 65 |
<div role="search"> |
| 66 |
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> |
| 67 |
<label class="sr-only" for="q">Search docs:</label> |
| 68 |
<input type="text" class="st-default-search-input" id="q" name="q" placeholder="Search docs" /> |
| 69 |
<input type="hidden" name="check_keywords" value="yes" /> |
| 70 |
<input type="hidden" name="area" value="default" /> |
| 71 |
</form> |
| 72 |
</div> |
| 73 |
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> |
| 74 |
|
| 75 |
<p class="caption" role="heading"><span class="caption-text">Collections:</span></p> |
| 76 |
<ul> |
| 77 |
<li class="toctree-l1"><a class="reference internal" href="index.html">Collection Index</a></li> |
| 78 |
</ul> |
| 79 |
<p class="caption" role="heading"><span class="caption-text">Plugin indexes:</span></p> |
| 80 |
<ul> |
| 81 |
<li class="toctree-l1"><a class="reference internal" href="index_become.html">Index of all Become Plugins</a></li> |
| 82 |
<li class="toctree-l1"><a class="reference internal" href="index_connection.html">Index of all Connection Plugins</a></li> |
| 83 |
<li class="toctree-l1"><a class="reference internal" href="index_inventory.html">Index of all Inventory Plugins</a></li> |
| 84 |
<li class="toctree-l1"><a class="reference internal" href="index_module.html">Index of all Modules</a></li> |
| 85 |
</ul> |
| 86 |
<p class="caption" role="heading"><span class="caption-text">Reference indexes:</span></p> |
| 87 |
<ul class="current"> |
| 88 |
<li class="toctree-l1 current"><a class="current reference internal" href="#">Index of all Collection Environment Variables</a></li> |
| 89 |
</ul> |
| 90 |
<!-- extra nav elements for Ansible beyond RTD Sphinx Theme --> |
| 91 |
|
| 92 |
</div> |
| 93 |
</div> |
| 94 |
</nav> |
| 95 |
|
| 96 |
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > |
| 97 |
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| 98 |
<a href="../index.html">Ansible collections</a> |
| 99 |
</nav> |
| 100 |
|
| 101 |
<div class="wy-nav-content"> |
| 102 |
<div class="rst-content"> |
| 103 |
<div role="navigation" aria-label="Page navigation"> |
| 104 |
<ul class="wy-breadcrumbs"> |
| 105 |
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li> |
| 106 |
<li class="breadcrumb-item active">Index of all Collection Environment Variables</li> |
| 107 |
<li class="wy-breadcrumbs-aside"> |
| 108 |
</li> |
| 109 |
</ul> |
| 110 |
<hr/> |
| 111 |
</div> |
| 112 |
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| 113 |
|
| 114 |
|
| 115 |
<div itemprop="articleBody"> |
| 116 |
|
| 117 |
<section id="index-of-all-collection-environment-variables"> |
| 118 |
<span id="list-of-collection-env-vars"></span><h1>Index of all Collection Environment Variables<a class="headerlink" href="#index-of-all-collection-environment-variables" title="Link to this heading"></a></h1> |
| 119 |
<p>The following index documents all environment variables declared by plugins in collections. |
| 120 |
Environment variables used by the ansible-core configuration are documented in <a class="reference external" href="https://docs.ansible.com/projects/ansible/devel/reference_appendices/config.html#ansible-configuration-settings" title="(in Ansible devel)"><span>Ansible Configuration Settings</span></a>.</p> |
| 121 |
<dl class="std envvar"> |
| 122 |
<dt class="sig sig-object std" id="envvar-ANSIBLE_BECOME_PASS"> |
| 123 |
<span class="sig-name descname"><span class="pre">ANSIBLE_BECOME_PASS</span></span><a class="headerlink" href="#envvar-ANSIBLE_BECOME_PASS" title="Link to this definition"></a></dt> |
| 124 |
<dd><p>Password to pass to sudo</p> |
| 125 |
<p><em>Used by:</em> |
| 126 |
<a class="reference internal" href="containers/podman/podman_unshare_become.html#ansible-collections-containers-podman-podman-unshare-become"><span class="std std-ref">containers.podman.podman_unshare become plugin</span></a></p> |
| 127 |
</dd></dl> |
| 128 |
|
| 129 |
<dl class="std envvar"> |
| 130 |
<dt class="sig sig-object std" id="envvar-ANSIBLE_BUILDAH_EXECUTABLE"> |
| 131 |
<span class="sig-name descname"><span class="pre">ANSIBLE_BUILDAH_EXECUTABLE</span></span><a class="headerlink" href="#envvar-ANSIBLE_BUILDAH_EXECUTABLE" title="Link to this definition"></a></dt> |
| 132 |
<dd><p>See the documentations for the options where this environment variable is used.</p> |
| 133 |
<p><em>Used by:</em> |
| 134 |
<a class="reference internal" href="containers/podman/buildah_connection.html#ansible-collections-containers-podman-buildah-connection"><span class="std std-ref">containers.podman.buildah connection plugin</span></a>, |
| 135 |
<a class="reference internal" href="containers/podman/buildah_containers_inventory.html#ansible-collections-containers-podman-buildah-containers-inventory"><span class="std std-ref">containers.podman.buildah_containers inventory plugin</span></a></p> |
| 136 |
</dd></dl> |
| 137 |
|
| 138 |
<dl class="std envvar"> |
| 139 |
<dt class="sig sig-object std" id="envvar-ANSIBLE_BUILDAH_EXTRA_ARGS"> |
| 140 |
<span class="sig-name descname"><span class="pre">ANSIBLE_BUILDAH_EXTRA_ARGS</span></span><a class="headerlink" href="#envvar-ANSIBLE_BUILDAH_EXTRA_ARGS" title="Link to this definition"></a></dt> |
| 141 |
<dd><p>Extra arguments to pass to the buildah command line.</p> |
| 142 |
<p><em>Used by:</em> |
| 143 |
<a class="reference internal" href="containers/podman/buildah_connection.html#ansible-collections-containers-podman-buildah-connection"><span class="std std-ref">containers.podman.buildah connection plugin</span></a></p> |
| 144 |
</dd></dl> |
| 145 |
|
| 146 |
<dl class="std envvar"> |
| 147 |
<dt class="sig sig-object std" id="envvar-ANSIBLE_BUILDAH_HOST"> |
| 148 |
<span class="sig-name descname"><span class="pre">ANSIBLE_BUILDAH_HOST</span></span><a class="headerlink" href="#envvar-ANSIBLE_BUILDAH_HOST" title="Link to this definition"></a></dt> |
| 149 |
<dd><p>The ID or name of the buildah working container you want to access.</p> |
| 150 |
<p><em>Used by:</em> |
| 151 |
<a class="reference internal" href="containers/podman/buildah_connection.html#ansible-collections-containers-podman-buildah-connection"><span class="std std-ref">containers.podman.buildah connection plugin</span></a></p> |
| 152 |
</dd></dl> |
| 153 |
|
| 154 |
<dl class="std envvar"> |
| 155 |
<dt class="sig sig-object std" id="envvar-ANSIBLE_BUILDAH_MOUNT_DETECTION"> |
| 156 |
<span class="sig-name descname"><span class="pre">ANSIBLE_BUILDAH_MOUNT_DETECTION</span></span><a class="headerlink" href="#envvar-ANSIBLE_BUILDAH_MOUNT_DETECTION" title="Link to this definition"></a></dt> |
| 157 |
<dd><p>Enable automatic detection and use of container mount points for file operations.</p> |
| 158 |
<p><em>Used by:</em> |
| 159 |
<a class="reference internal" href="containers/podman/buildah_connection.html#ansible-collections-containers-podman-buildah-connection"><span class="std std-ref">containers.podman.buildah connection plugin</span></a></p> |
| 160 |
</dd></dl> |
| 161 |
|
| 162 |
<dl class="std envvar"> |
| 163 |
<dt class="sig sig-object std" id="envvar-ANSIBLE_BUILDAH_TIMEOUT"> |
| 164 |
<span class="sig-name descname"><span class="pre">ANSIBLE_BUILDAH_TIMEOUT</span></span><a class="headerlink" href="#envvar-ANSIBLE_BUILDAH_TIMEOUT" title="Link to this definition"></a></dt> |
| 165 |
<dd><p>Timeout in seconds for container operations. 0 means no timeout.</p> |
| 166 |
<p><em>Used by:</em> |
| 167 |
<a class="reference internal" href="containers/podman/buildah_connection.html#ansible-collections-containers-podman-buildah-connection"><span class="std std-ref">containers.podman.buildah connection plugin</span></a></p> |
| 168 |
</dd></dl> |
| 169 |
|
| 170 |
<dl class="std envvar"> |
| 171 |
<dt class="sig sig-object std" id="envvar-ANSIBLE_BUILDAH_WORKING_DIRECTORY"> |
| 172 |
<span class="sig-name descname"><span class="pre">ANSIBLE_BUILDAH_WORKING_DIRECTORY</span></span><a class="headerlink" href="#envvar-ANSIBLE_BUILDAH_WORKING_DIRECTORY" title="Link to this definition"></a></dt> |
| 173 |
<dd><p>Set working directory for commands executed in the container.</p> |
| 174 |
<p><em>Used by:</em> |
| 175 |
<a class="reference internal" href="containers/podman/buildah_connection.html#ansible-collections-containers-podman-buildah-connection"><span class="std std-ref">containers.podman.buildah connection plugin</span></a></p> |
| 176 |
</dd></dl> |
| 177 |
|
| 178 |
<dl class="std envvar"> |
| 179 |
<dt class="sig sig-object std" id="envvar-ANSIBLE_PODMAN_EXECUTABLE"> |
| 180 |
<span class="sig-name descname"><span class="pre">ANSIBLE_PODMAN_EXECUTABLE</span></span><a class="headerlink" href="#envvar-ANSIBLE_PODMAN_EXECUTABLE" title="Link to this definition"></a></dt> |
| 181 |
<dd><p>See the documentations for the options where this environment variable is used.</p> |
| 182 |
<p><em>Used by:</em> |
| 183 |
<a class="reference internal" href="containers/podman/podman_connection.html#ansible-collections-containers-podman-podman-connection"><span class="std std-ref">containers.podman.podman connection plugin</span></a>, |
| 184 |
<a class="reference internal" href="containers/podman/podman_containers_inventory.html#ansible-collections-containers-podman-podman-containers-inventory"><span class="std std-ref">containers.podman.podman_containers inventory plugin</span></a></p> |
| 185 |
</dd></dl> |
| 186 |
|
| 187 |
<dl class="std envvar"> |
| 188 |
<dt class="sig sig-object std" id="envvar-ANSIBLE_PODMAN_EXTRA_ARGS"> |
| 189 |
<span class="sig-name descname"><span class="pre">ANSIBLE_PODMAN_EXTRA_ARGS</span></span><a class="headerlink" href="#envvar-ANSIBLE_PODMAN_EXTRA_ARGS" title="Link to this definition"></a></dt> |
| 190 |
<dd><p>Extra arguments to pass to the podman command line.</p> |
| 191 |
<p><em>Used by:</em> |
| 192 |
<a class="reference internal" href="containers/podman/podman_connection.html#ansible-collections-containers-podman-podman-connection"><span class="std std-ref">containers.podman.podman connection plugin</span></a></p> |
| 193 |
</dd></dl> |
| 194 |
|
| 195 |
<dl class="std envvar"> |
| 196 |
<dt class="sig sig-object std" id="envvar-ANSIBLE_PODMAN_HOST"> |
| 197 |
<span class="sig-name descname"><span class="pre">ANSIBLE_PODMAN_HOST</span></span><a class="headerlink" href="#envvar-ANSIBLE_PODMAN_HOST" title="Link to this definition"></a></dt> |
| 198 |
<dd><p>The ID or name of the container you want to access.</p> |
| 199 |
<p><em>Used by:</em> |
| 200 |
<a class="reference internal" href="containers/podman/podman_connection.html#ansible-collections-containers-podman-podman-connection"><span class="std std-ref">containers.podman.podman connection plugin</span></a></p> |
| 201 |
</dd></dl> |
| 202 |
|
| 203 |
<dl class="std envvar"> |
| 204 |
<dt class="sig sig-object std" id="envvar-ANSIBLE_PODMAN_MOUNT_DETECTION"> |
| 205 |
<span class="sig-name descname"><span class="pre">ANSIBLE_PODMAN_MOUNT_DETECTION</span></span><a class="headerlink" href="#envvar-ANSIBLE_PODMAN_MOUNT_DETECTION" title="Link to this definition"></a></dt> |
| 206 |
<dd><p>Enable automatic detection and use of container mount points for file operations.</p> |
| 207 |
<p><em>Used by:</em> |
| 208 |
<a class="reference internal" href="containers/podman/podman_connection.html#ansible-collections-containers-podman-podman-connection"><span class="std std-ref">containers.podman.podman connection plugin</span></a></p> |
| 209 |
</dd></dl> |
| 210 |
|
| 211 |
<dl class="std envvar"> |
| 212 |
<dt class="sig sig-object std" id="envvar-ANSIBLE_PODMAN_TIMEOUT"> |
| 213 |
<span class="sig-name descname"><span class="pre">ANSIBLE_PODMAN_TIMEOUT</span></span><a class="headerlink" href="#envvar-ANSIBLE_PODMAN_TIMEOUT" title="Link to this definition"></a></dt> |
| 214 |
<dd><p>Timeout in seconds for container operations. 0 means no timeout.</p> |
| 215 |
<p><em>Used by:</em> |
| 216 |
<a class="reference internal" href="containers/podman/podman_connection.html#ansible-collections-containers-podman-podman-connection"><span class="std std-ref">containers.podman.podman connection plugin</span></a></p> |
| 217 |
</dd></dl> |
| 218 |
|
| 219 |
<dl class="std envvar"> |
| 220 |
<dt class="sig sig-object std" id="envvar-ANSIBLE_SUDO_EXE"> |
| 221 |
<span class="sig-name descname"><span class="pre">ANSIBLE_SUDO_EXE</span></span><a class="headerlink" href="#envvar-ANSIBLE_SUDO_EXE" title="Link to this definition"></a></dt> |
| 222 |
<dd><p>Sudo executable</p> |
| 223 |
<p><em>Used by:</em> |
| 224 |
<a class="reference internal" href="containers/podman/podman_unshare_become.html#ansible-collections-containers-podman-podman-unshare-become"><span class="std std-ref">containers.podman.podman_unshare become plugin</span></a></p> |
| 225 |
</dd></dl> |
| 226 |
|
| 227 |
<dl class="std envvar"> |
| 228 |
<dt class="sig sig-object std" id="envvar-ANSIBLE_SUDO_PASS"> |
| 229 |
<span class="sig-name descname"><span class="pre">ANSIBLE_SUDO_PASS</span></span><a class="headerlink" href="#envvar-ANSIBLE_SUDO_PASS" title="Link to this definition"></a></dt> |
| 230 |
<dd><p>Password to pass to sudo</p> |
| 231 |
<p><em>Used by:</em> |
| 232 |
<a class="reference internal" href="containers/podman/podman_unshare_become.html#ansible-collections-containers-podman-podman-unshare-become"><span class="std std-ref">containers.podman.podman_unshare become plugin</span></a></p> |
| 233 |
</dd></dl> |
| 234 |
|
| 235 |
<dl class="std envvar"> |
| 236 |
<dt class="sig sig-object std" id="envvar-ANSIBLE_SUDO_USER"> |
| 237 |
<span class="sig-name descname"><span class="pre">ANSIBLE_SUDO_USER</span></span><a class="headerlink" href="#envvar-ANSIBLE_SUDO_USER" title="Link to this definition"></a></dt> |
| 238 |
<dd><p>User you ‘become’ to execute the task (‘root’ is not a valid value here).</p> |
| 239 |
<p><em>Used by:</em> |
| 240 |
<a class="reference internal" href="containers/podman/podman_unshare_become.html#ansible-collections-containers-podman-podman-unshare-become"><span class="std std-ref">containers.podman.podman_unshare become plugin</span></a></p> |
| 241 |
</dd></dl> |
| 242 |
|
| 243 |
</section> |
| 244 |
|
| 245 |
|
| 246 |
</div> |
| 247 |
</div> |
| 248 |
|
| 249 |
|
| 250 |
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| 251 |
<a href="index_module.html" class="btn btn-neutral float-left" title="Index of all Modules" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| 252 |
</div> |
| 253 |
|
| 254 |
<hr/> |
| 255 |
|
| 256 |
<div role="contentinfo"> |
| 257 |
<p>© Copyright Ansible contributors.</p> |
| 258 |
</div> |
| 259 |
|
| 260 |
|
| 261 |
|
| 262 |
|
| 263 |
</footer> |
| 264 |
</div> |
| 265 |
</div> |
| 266 |
</section> |
| 267 |
</div> |
| 268 |
<script> |
| 269 |
jQuery(function () { |
| 270 |
SphinxRtdTheme.Navigation.enable(true); |
| 271 |
}); |
| 272 |
</script><!-- extra footer elements for Ansible beyond RTD Sphinx Theme --> |
| 273 |
|
| 274 |
</body> |
| 275 |
</html> |