ansible/ansible-podman-collections
1
0
Fork 0
mirror of https://github.com/containers/ansible-podman-collections.git synced 2026-02-03 23:01:48 +00:00
Code Activity
ansible-podman-collections/docs/collections/environment_variables.html
Sergey 55fbd1c66f
Release 1.18.1 version (#998) 
Signed-off-by: Sagi Shnaidman <sshnaidm@redhat.com>
2026-01-15 17:58:22 +02:00

275 lines
No EOL
16 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta content="2.24.0" name="antsibull-docs" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index of all Collection Environment Variables &mdash; Ansible collections documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=41de9001" />
<link rel="stylesheet" type="text/css" href="../_static/css/ansible.css?v=b54c304f" />
<link rel="stylesheet" type="text/css" href="../_static/antsibull-minimal.css" />
<link rel="stylesheet" type="text/css" href="../_static/css/rtd-ethical-ads.css?v=289b023e" />
<link rel="shortcut icon" href="../_static/images/Ansible-Mark-RGB_Black.png"/>
<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=fd6eb6e6"></script>
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../_static/js/theme.js"></script>
<link rel="search" title="Search" href="../search.html" />
<link rel="prev" title="Index of all Modules" href="index_module.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/blog" target="_blank">Blog</a></li>
<li><a href="https://forum.ansible.com/" target="_blank">Ansible community forum</a></li>
<li><a href="https://docs.ansible.com/" target="_blank">Documentation</a></li>
</ul>
</div>
<a class="DocSite-nav" href="/" style="padding-bottom: 30px;">
<img class="DocSiteNav-logo"
src="../_static/images/Ansible-Mark-RGB_White.png"
alt="Ansible Logo">
<div class="DocSiteNav-title">Ansible Collections Documentation</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">
Ansible collections
</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">
<p class="caption" role="heading"><span class="caption-text">Collections:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="index.html">Collection Index</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Plugin indexes:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="index_become.html">Index of all Become Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="index_connection.html">Index of all Connection Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="index_inventory.html">Index of all Inventory Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="index_module.html">Index of all Modules</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Reference indexes:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Index of all Collection Environment Variables</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">Ansible collections</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">Index of all Collection Environment Variables</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">
<section id="index-of-all-collection-environment-variables">
<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>
<p>The following index documents all environment variables declared by plugins in collections.
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>
<dl class="std envvar">
<dt class="sig sig-object std" id="envvar-ANSIBLE_BECOME_PASS">
<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>
<dd><p>Password to pass to sudo</p>
<p><em>Used by:</em>
<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>
</dd></dl>
<dl class="std envvar">
<dt class="sig sig-object std" id="envvar-ANSIBLE_BUILDAH_EXECUTABLE">
<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>
<dd><p>See the documentations for the options where this environment variable is used.</p>
<p><em>Used by:</em>
<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>,
<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>
</dd></dl>
<dl class="std envvar">
<dt class="sig sig-object std" id="envvar-ANSIBLE_BUILDAH_EXTRA_ARGS">
<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>
<dd><p>Extra arguments to pass to the buildah command line.</p>
<p><em>Used by:</em>
<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>
</dd></dl>
<dl class="std envvar">
<dt class="sig sig-object std" id="envvar-ANSIBLE_BUILDAH_HOST">
<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>
<dd><p>The ID or name of the buildah working container you want to access.</p>
<p><em>Used by:</em>
<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>
</dd></dl>
<dl class="std envvar">
<dt class="sig sig-object std" id="envvar-ANSIBLE_BUILDAH_MOUNT_DETECTION">
<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>
<dd><p>Enable automatic detection and use of container mount points for file operations.</p>
<p><em>Used by:</em>
<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>
</dd></dl>
<dl class="std envvar">
<dt class="sig sig-object std" id="envvar-ANSIBLE_BUILDAH_TIMEOUT">
<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>
<dd><p>Timeout in seconds for container operations. 0 means no timeout.</p>
<p><em>Used by:</em>
<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>
</dd></dl>
<dl class="std envvar">
<dt class="sig sig-object std" id="envvar-ANSIBLE_BUILDAH_WORKING_DIRECTORY">
<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>
<dd><p>Set working directory for commands executed in the container.</p>
<p><em>Used by:</em>
<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>
</dd></dl>
<dl class="std envvar">
<dt class="sig sig-object std" id="envvar-ANSIBLE_PODMAN_EXECUTABLE">
<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>
<dd><p>See the documentations for the options where this environment variable is used.</p>
<p><em>Used by:</em>
<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>,
<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>
</dd></dl>
<dl class="std envvar">
<dt class="sig sig-object std" id="envvar-ANSIBLE_PODMAN_EXTRA_ARGS">
<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>
<dd><p>Extra arguments to pass to the podman command line.</p>
<p><em>Used by:</em>
<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>
</dd></dl>
<dl class="std envvar">
<dt class="sig sig-object std" id="envvar-ANSIBLE_PODMAN_HOST">
<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>
<dd><p>The ID or name of the container you want to access.</p>
<p><em>Used by:</em>
<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>
</dd></dl>
<dl class="std envvar">
<dt class="sig sig-object std" id="envvar-ANSIBLE_PODMAN_MOUNT_DETECTION">
<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>
<dd><p>Enable automatic detection and use of container mount points for file operations.</p>
<p><em>Used by:</em>
<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>
</dd></dl>
<dl class="std envvar">
<dt class="sig sig-object std" id="envvar-ANSIBLE_PODMAN_TIMEOUT">
<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>
<dd><p>Timeout in seconds for container operations. 0 means no timeout.</p>
<p><em>Used by:</em>
<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>
</dd></dl>
<dl class="std envvar">
<dt class="sig sig-object std" id="envvar-ANSIBLE_SUDO_EXE">
<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>
<dd><p>Sudo executable</p>
<p><em>Used by:</em>
<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>
</dd></dl>
<dl class="std envvar">
<dt class="sig sig-object std" id="envvar-ANSIBLE_SUDO_PASS">
<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>
<dd><p>Password to pass to sudo</p>
<p><em>Used by:</em>
<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>
</dd></dl>
<dl class="std envvar">
<dt class="sig sig-object std" id="envvar-ANSIBLE_SUDO_USER">
<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>
<dd><p>User you ‘become’ to execute the task (‘root’ is not a valid value here).</p>
<p><em>Used by:</em>
<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>
</dd></dl>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<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>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright Ansible 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>
View git blame Copy permalink