diff options
Diffstat (limited to 'ansible_collections/containers/podman/docs/podman_connection.html')
| -rw-r--r-- | ansible_collections/containers/podman/docs/podman_connection.html | 280 |
1 files changed, 143 insertions, 137 deletions
diff --git a/ansible_collections/containers/podman/docs/podman_connection.html b/ansible_collections/containers/podman/docs/podman_connection.html index 8b58713f4..666200432 100644 --- a/ansible_collections/containers/podman/docs/podman_connection.html +++ b/ansible_collections/containers/podman/docs/podman_connection.html @@ -1,21 +1,21 @@ - <!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8" /> - <meta name="viewport" content="width=device-width, initial-scale=1.0" /> - <title>containers.podman.podman – Interact with an existing podman container — Python documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> +<meta content="2.5.0" name="antsibull-docs" /> + + <title>containers.podman.podman connection – Interact with an existing podman container — Python documentation</title> <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> <link rel="stylesheet" type="text/css" href="_static/alabaster.css" /> <link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" /> <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> - <script src="_static/jquery.js"></script> - <script src="_static/underscore.js"></script> - <script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script src="_static/doctools.js"></script> + <script src="_static/sphinx_highlight.js"></script> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> + <link rel="prev" title="containers.podman.buildah connection – Interact with an existing buildah container" href="buildah_connection.html" /> <link rel="stylesheet" href="_static/custom.css" type="text/css" /> @@ -32,152 +32,122 @@ <div class="body" role="main"> - <span class="target" id="ansible-collections-containers-podman-podman-connection"></span><div class="section" id="containers-podman-podman-interact-with-an-existing-podman-container"> -<h1>containers.podman.podman – Interact with an existing podman container<a class="headerlink" href="#containers-podman-podman-interact-with-an-existing-podman-container" title="Permalink to this heading">¶</a></h1> + <span class="target" id="ansible-collections-containers-podman-podman-connection"></span><section id="containers-podman-podman-connection-interact-with-an-existing-podman-container"> +<h1>containers.podman.podman connection – Interact with an existing podman container<a class="headerlink" href="#containers-podman-podman-connection-interact-with-an-existing-podman-container" title="Permalink to this heading">¶</a></h1> <div class="admonition note"> <p class="admonition-title">Note</p> -<p>This plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/containers/podman">containers.podman collection</a> (version 1.10.1).</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">containers.podman</span></code>.</p> +<p>This connection plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/containers/podman/">containers.podman collection</a> (version 1.11.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">containers.podman</span></code>.</p> <p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">containers.podman.podman</span></code>.</p> </div> -<div class="contents local topic" id="contents"> +<nav class="contents local" id="contents"> <ul class="simple"> <li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li> <li><p><a class="reference internal" href="#parameters" id="id2">Parameters</a></p></li> </ul> -</div> -<div class="section" id="synopsis"> -<h2><a class="toc-backref" href="#id1">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2> +</nav> +<section id="synopsis"> +<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2> <ul class="simple"> <li><p>Run commands or put/fetch files to an existing container using podman tool.</p></li> </ul> +</section> +<section id="parameters"> +<h2><a class="toc-backref" href="#id2" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2> +<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-podman_executable"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-connection-parameter-podman-executable"><strong>podman_executable</strong></p> +<a class="ansibleOptionLink" href="#parameter-podman_executable" 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>Executable for podman command.</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">"podman"</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p> +<ul class="simple"> +<li><p>Environment variable: <span class="target" id="index-0"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_PODMAN_EXECUTABLE"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_PODMAN_EXECUTABLE</span></code></a></p></li> +<li><p>Variable: ansible_podman_executable</p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-podman_extra_args"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-connection-parameter-podman-extra-args"><strong>podman_extra_args</strong></p> +<a class="ansibleOptionLink" href="#parameter-podman_extra_args" 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>Extra arguments to pass to the podman command line.</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> +<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p> +<ul> +<li><p>INI entry:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">defaults</span><span class="p">]</span> +<span class="n">podman_extra_args</span> <span class="o">=</span> <span class="s2">""</span> +</pre></div> +</div> +</li> +<li><p>Environment variable: <span class="target" id="index-1"></span><a class="reference internal" href="environment_variables.html#envvar-ANSIBLE_PODMAN_EXTRA_ARGS"><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_PODMAN_EXTRA_ARGS</span></code></a></p></li> +<li><p>Variable: ansible_podman_extra_args</p></li> +</ul> +</div></td> +</tr> +<tr class="row-even"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-remote_addr"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-connection-parameter-remote-addr"><strong>remote_addr</strong></p> +<a class="ansibleOptionLink" href="#parameter-remote_addr" 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 ID of the container you want to access.</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">"inventory_hostname"</span></code></p> +<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p> +<ul class="simple"> +<li><p>Variable: ansible_host</p></li> +<li><p>Variable: inventory_hostname</p></li> +<li><p>Variable: ansible_podman_host</p></li> +</ul> +</div></td> +</tr> +<tr class="row-odd"><td><div class="ansible-option-cell"> +<div class="ansibleOptionAnchor" id="parameter-remote_user"></div><p class="ansible-option-title" id="ansible-collections-containers-podman-podman-connection-parameter-remote-user"><strong>remote_user</strong></p> +<a class="ansibleOptionLink" href="#parameter-remote_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>User specified via name or UID which is used to execute commands inside the container. If you specify the user via UID, you must set <code class="docutils literal notranslate"><span class="pre">ANSIBLE_REMOTE_TMP</span></code> to a path that exits inside the container and is writable by Ansible.</p> +<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p> +<ul> +<li><p>INI entry:</p> +<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">defaults</span><span class="p">]</span> +<span class="n">remote_user</span> <span class="o">=</span> <span class="n">VALUE</span> +</pre></div> </div> -<div class="section" id="parameters"> -<h2><a class="toc-backref" href="#id2">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this heading">¶</a></h2> -<table border=0 cellpadding=0 class="documentation-table"> - <tr> - <th colspan="1">Parameter</th> - <th>Choices/<font color="blue">Defaults</font></th> - <th>Configuration</th> - <th width="100%">Comments</th> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-podman_executable"></div> - <b>podman_executable</b> - <a class="ansibleOptionLink" href="#parameter-podman_executable" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"podman"</div> - </td> - <td> - <div> - env:ANSIBLE_PODMAN_EXECUTABLE - </div> - <div> - var: ansible_podman_executable - </div> - </td> - <td> - <div>Executable for podman command.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-podman_extra_args"></div> - <b>podman_extra_args</b> - <a class="ansibleOptionLink" href="#parameter-podman_extra_args" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">""</div> - </td> - <td> - <div> ini entries: - <p> - [defaults]<br>podman_extra_args = - </p> - </div> - <div> - env:ANSIBLE_PODMAN_EXTRA_ARGS - </div> - <div> - var: ansible_podman_extra_args - </div> - </td> - <td> - <div>Extra arguments to pass to the podman command line.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-remote_addr"></div> - <b>remote_addr</b> - <a class="ansibleOptionLink" href="#parameter-remote_addr" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - <b>Default:</b><br/><div style="color: blue">"inventory_hostname"</div> - </td> - <td> - <div> - var: ansible_host - </div> - <div> - var: inventory_hostname - </div> - <div> - var: ansible_podman_host - </div> - </td> - <td> - <div>The ID of the container you want to access.</div> - </td> - </tr> - <tr> - <td colspan="1"> - <div class="ansibleOptionAnchor" id="parameter-remote_user"></div> - <b>remote_user</b> - <a class="ansibleOptionLink" href="#parameter-remote_user" title="Permalink to this option"></a> - <div style="font-size: small"> - <span style="color: purple">string</span> - </div> - </td> - <td> - </td> - <td> - <div> ini entries: - <p> - [defaults]<br>remote_user = None - </p> - </div> - <div> - env:ANSIBLE_REMOTE_USER - </div> - <div> - var: ansible_user - </div> - </td> - <td> - <div>User specified via name or UID which is used to execute commands inside the container. If you specify the user via UID, you must set <code>ANSIBLE_REMOTE_TMP</code> to a path that exits inside the container and is writable by Ansible.</div> - </td> - </tr> - </table> -<br/><div class="section" id="authors"> +</li> +<li><p>Environment variable: <span class="target" id="index-2"></span><code class="xref std std-envvar docutils literal notranslate"><span class="pre">ANSIBLE_REMOTE_USER</span></code></p></li> +<li><p>Variable: ansible_user</p></li> +</ul> +</div></td> +</tr> +</tbody> +</table> +<section id="authors"> <h3>Authors<a class="headerlink" href="#authors" title="Permalink to this heading">¶</a></h3> <ul class="simple"> <li><p>Tomas Tomecek (@TomasTomecek)</p></li> </ul> +<div class="admonition hint"> +<p class="admonition-title">Hint</p> +<p>Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.</p> </div> -</div> -</div> +</section> +<section id="collection-links"> +<h3>Collection links<a class="headerlink" href="#collection-links" title="Permalink to this heading">¶</a></h3> +<ul class="ansible-links"> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc" rel="noopener external" target="_blank">Issue Tracker</a></span></li> +<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/containers/ansible-podman-collections" rel="noopener external" target="_blank">Repository (Sources)</a></span></li> +</ul> +</section> +</section> +</section> </div> @@ -196,11 +166,47 @@ <h3>Navigation</h3> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_container_module.html">containers.podman.podman_container module – Manage podman containers</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_exec_module.html">containers.podman.podman_container_exec module – Executes a command in a running container.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_container_info_module.html">containers.podman.podman_container_info module – Gather facts about containers using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_containers_module.html">containers.podman.podman_containers module – Manage podman containers in a batch</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_export_module.html">containers.podman.podman_export module – Export a podman container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_generate_systemd_module.html">containers.podman.podman_generate_systemd module – Generate systemd unit from a pod or a container</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_module.html">containers.podman.podman_image module – Pull images for use by podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_image_info_module.html">containers.podman.podman_image_info module – Gather info about images using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_import_module.html">containers.podman.podman_import module – Import Podman container from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_load_module.html">containers.podman.podman_load module – Load image from a tar file.</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_module.html">containers.podman.podman_login module – Login to a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_login_info_module.html">containers.podman.podman_login_info module – Return the logged-in user if any for a given registry</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_logout_module.html">containers.podman.podman_logout module – Log out of a container registry using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_module.html">containers.podman.podman_network module – Manage podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_network_info_module.html">containers.podman.podman_network_info module – Gather info about podman networks</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_play_module.html">containers.podman.podman_play module – Play kubernetes YAML file using podman</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_module.html">containers.podman.podman_pod module – Manage Podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_pod_info_module.html">containers.podman.podman_pod_info module – Gather info about podman pods</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_prune_module.html">containers.podman.podman_prune module – Allows to prune various podman objects</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_runlabel_module.html">containers.podman.podman_runlabel module – Run given label from given image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_save_module.html">containers.podman.podman_save module – Saves podman image to tar file</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_module.html">containers.podman.podman_secret module – Manage podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_secret_info_module.html">containers.podman.podman_secret_info module – Gather info about podman secrets</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_tag_module.html">containers.podman.podman_tag module – Add an additional name to a local image</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_module.html">containers.podman.podman_volume module – Manage Podman volumes</a></li> +<li class="toctree-l1"><a class="reference internal" href="podman_volume_info_module.html">containers.podman.podman_volume_info module – Gather info about podman volumes</a></li> +</ul> +<ul> +<li class="toctree-l1"><a class="reference internal" href="podman_unshare_become.html">containers.podman.podman_unshare become – Run tasks using podman unshare</a></li> +</ul> +<ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="buildah_connection.html">containers.podman.buildah connection – Interact with an existing buildah container</a></li> +<li class="toctree-l1 current"><a class="current reference internal" href="#">containers.podman.podman connection – Interact with an existing podman container</a></li> +</ul> <div class="relations"> <h3>Related Topics</h3> <ul> <li><a href="index.html">Documentation overview</a><ul> + <li>Previous: <a href="buildah_connection.html" title="previous chapter">containers.podman.buildah connection – Interact with an existing buildah container</a></li> </ul></li> </ul> </div> @@ -230,8 +236,8 @@ ©. | - Powered by <a href="http://sphinx-doc.org/">Sphinx 5.0.2</a> - & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + Powered by <a href="http://sphinx-doc.org/">Sphinx 7.0.1</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> | <a href="_sources/podman_connection.rst.txt" |