2256 lines
171 KiB
HTML
2256 lines
171 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>containers.podman.podman_container – Manage podman containers — Python documentation</title>
|
||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||
<script src="_static/jquery.js"></script>
|
||
<script src="_static/underscore.js"></script>
|
||
<script src="_static/doctools.js"></script>
|
||
<script src="_static/language_data.js"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
|
||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||
|
||
</head><body>
|
||
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
|
||
|
||
<div class="body" role="main">
|
||
|
||
<span class="target" id="ansible-collections-containers-podman-podman-container-module"></span><div class="section" id="containers-podman-podman-container-manage-podman-containers">
|
||
<h1>containers.podman.podman_container – Manage podman containers<a class="headerlink" href="#containers-podman-podman-container-manage-podman-containers" title="Permalink to this headline">¶</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.9.3).</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_container</span></code>.</p>
|
||
</div>
|
||
<div class="versionadded">
|
||
<p><span class="versionmodified added">New in version 1.0.0: </span>of containers.podman</p>
|
||
</div>
|
||
<div class="contents local topic" 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="#requirements" id="id2">Requirements</a></p></li>
|
||
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
||
<li><p><a class="reference internal" href="#examples" id="id4">Examples</a></p></li>
|
||
<li><p><a class="reference internal" href="#return-values" id="id5">Return Values</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 headline">¶</a></h2>
|
||
<ul class="simple">
|
||
<li><p>Start, stop, restart and manage Podman containers</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="requirements">
|
||
<h2><a class="toc-backref" href="#id2">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this headline">¶</a></h2>
|
||
<p>The below requirements are needed on the host that executes this module.</p>
|
||
<ul class="simple">
|
||
<li><p>podman</p></li>
|
||
</ul>
|
||
</div>
|
||
<div class="section" id="parameters">
|
||
<h2><a class="toc-backref" href="#id3">Parameters</a><a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
|
||
<table border=0 cellpadding=0 class="documentation-table">
|
||
<tr>
|
||
<th colspan="2">Parameter</th>
|
||
<th>Choices/<font color="blue">Defaults</font></th>
|
||
<th width="100%">Comments</th>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-annotation"></div>
|
||
<b>annotation</b>
|
||
<a class="ansibleOptionLink" href="#parameter-annotation" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">dictionary</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Add an annotation to the container. The format is key value, multiple times.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-authfile"></div>
|
||
<b>authfile</b>
|
||
<a class="ansibleOptionLink" href="#parameter-authfile" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">path</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Path of the authentication file. Default is ``${XDG_RUNTIME_DIR}/containers/auth.json`` (Not available for remote commands) You can also override the default path of the authentication file by setting the ``REGISTRY_AUTH_FILE`` environment variable. ``export REGISTRY_AUTH_FILE=path``</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-blkio_weight"></div>
|
||
<b>blkio_weight</b>
|
||
<a class="ansibleOptionLink" href="#parameter-blkio_weight" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">integer</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Block IO weight (relative weight) accepts a weight value between 10 and 1000</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-blkio_weight_device"></div>
|
||
<b>blkio_weight_device</b>
|
||
<a class="ansibleOptionLink" href="#parameter-blkio_weight_device" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">dictionary</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Block IO weight (relative device weight, format DEVICE_NAME[:]WEIGHT).</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-cap_add"></div>
|
||
<b>cap_add</b>
|
||
<a class="ansibleOptionLink" href="#parameter-cap_add" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>List of capabilities to add to the container.</div>
|
||
<div style="font-size: small; color: darkgreen"><br/>aliases: capabilities</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-cap_drop"></div>
|
||
<b>cap_drop</b>
|
||
<a class="ansibleOptionLink" href="#parameter-cap_drop" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>List of capabilities to drop from the container.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-cgroup_parent"></div>
|
||
<b>cgroup_parent</b>
|
||
<a class="ansibleOptionLink" href="#parameter-cgroup_parent" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">path</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Path to cgroups under which the cgroup for the container will be created. If the path is not absolute, the path is considered to be relative to the cgroups path of the init process. Cgroups will be created if they do not already exist.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-cgroupns"></div>
|
||
<b>cgroupns</b>
|
||
<a class="ansibleOptionLink" href="#parameter-cgroupns" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Path to cgroups under which the cgroup for the container will be created.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-cgroups"></div>
|
||
<b>cgroups</b>
|
||
<a class="ansibleOptionLink" href="#parameter-cgroups" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Determines whether the container will create CGroups. Valid values are enabled and disabled, which the default being enabled. The disabled option will force the container to not create CGroups, and thus conflicts with CGroup options cgroupns and cgroup-parent.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-cidfile"></div>
|
||
<b>cidfile</b>
|
||
<a class="ansibleOptionLink" href="#parameter-cidfile" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">path</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Write the container ID to the file</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-cmd_args"></div>
|
||
<b>cmd_args</b>
|
||
<a class="ansibleOptionLink" href="#parameter-cmd_args" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Any additional command options you want to pass to podman command, cmd_args - ['--other-param', 'value'] Be aware module doesn't support idempotency if this is set.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-command"></div>
|
||
<b>command</b>
|
||
<a class="ansibleOptionLink" href="#parameter-command" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">raw</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Override command of container. Can be a string or a list.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-conmon_pidfile"></div>
|
||
<b>conmon_pidfile</b>
|
||
<a class="ansibleOptionLink" href="#parameter-conmon_pidfile" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">path</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Write the pid of the conmon process to a file. conmon runs in a separate process than Podman, so this is necessary when using systemd to restart Podman containers.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-cpu_period"></div>
|
||
<b>cpu_period</b>
|
||
<a class="ansibleOptionLink" href="#parameter-cpu_period" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">integer</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Limit the CPU real-time period in microseconds</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-cpu_rt_period"></div>
|
||
<b>cpu_rt_period</b>
|
||
<a class="ansibleOptionLink" href="#parameter-cpu_rt_period" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">integer</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Limit the CPU real-time period in microseconds. Limit the container's Real Time CPU usage. This flag tell the kernel to restrict the container's Real Time CPU usage to the period you specify.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-cpu_rt_runtime"></div>
|
||
<b>cpu_rt_runtime</b>
|
||
<a class="ansibleOptionLink" href="#parameter-cpu_rt_runtime" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">integer</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Limit the CPU real-time runtime in microseconds. This flag tells the kernel to limit the amount of time in a given CPU period Real Time tasks may consume.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-cpu_shares"></div>
|
||
<b>cpu_shares</b>
|
||
<a class="ansibleOptionLink" href="#parameter-cpu_shares" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">integer</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>CPU shares (relative weight)</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-cpus"></div>
|
||
<b>cpus</b>
|
||
<a class="ansibleOptionLink" href="#parameter-cpus" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Number of CPUs. The default is 0.0 which means no limit.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-cpuset_cpus"></div>
|
||
<b>cpuset_cpus</b>
|
||
<a class="ansibleOptionLink" href="#parameter-cpuset_cpus" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>CPUs in which to allow execution (0-3, 0,1)</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-cpuset_mems"></div>
|
||
<b>cpuset_mems</b>
|
||
<a class="ansibleOptionLink" href="#parameter-cpuset_mems" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Memory nodes (MEMs) in which to allow execution (0-3, 0,1). Only effective on NUMA systems.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-debug"></div>
|
||
<b>debug</b>
|
||
<a class="ansibleOptionLink" href="#parameter-debug" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">boolean</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li><div style="color: blue"><b>no</b> ←</div></li>
|
||
<li>yes</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Return additional information which can be helpful for investigations.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-detach"></div>
|
||
<b>detach</b>
|
||
<a class="ansibleOptionLink" href="#parameter-detach" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">boolean</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li>no</li>
|
||
<li><div style="color: blue"><b>yes</b> ←</div></li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Run container in detach mode</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-detach_keys"></div>
|
||
<b>detach_keys</b>
|
||
<a class="ansibleOptionLink" href="#parameter-detach_keys" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Override the key sequence for detaching a container. Format is a single character or ctrl-value</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-device"></div>
|
||
<b>device</b>
|
||
<a class="ansibleOptionLink" href="#parameter-device" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Add a host device to the container. The format is <device-on-host>[:<device-on-container>][:<permissions>] (e.g. device /dev/sdc:/dev/xvdc:rwm)</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-device_read_bps"></div>
|
||
<b>device_read_bps</b>
|
||
<a class="ansibleOptionLink" href="#parameter-device_read_bps" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Limit read rate (bytes per second) from a device (e.g. device-read-bps /dev/sda:1mb)</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-device_read_iops"></div>
|
||
<b>device_read_iops</b>
|
||
<a class="ansibleOptionLink" href="#parameter-device_read_iops" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Limit read rate (IO per second) from a device (e.g. device-read-iops /dev/sda:1000)</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-device_write_bps"></div>
|
||
<b>device_write_bps</b>
|
||
<a class="ansibleOptionLink" href="#parameter-device_write_bps" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Limit write rate (bytes per second) to a device (e.g. device-write-bps /dev/sda:1mb)</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-device_write_iops"></div>
|
||
<b>device_write_iops</b>
|
||
<a class="ansibleOptionLink" href="#parameter-device_write_iops" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Limit write rate (IO per second) to a device (e.g. device-write-iops /dev/sda:1000)</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-dns"></div>
|
||
<b>dns</b>
|
||
<a class="ansibleOptionLink" href="#parameter-dns" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Set custom DNS servers</div>
|
||
<div style="font-size: small; color: darkgreen"><br/>aliases: dns_servers</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-dns_option"></div>
|
||
<b>dns_option</b>
|
||
<a class="ansibleOptionLink" href="#parameter-dns_option" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Set custom DNS options</div>
|
||
<div style="font-size: small; color: darkgreen"><br/>aliases: dns_opts</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-dns_search"></div>
|
||
<b>dns_search</b>
|
||
<a class="ansibleOptionLink" href="#parameter-dns_search" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Set custom DNS search domains (Use dns_search with '' if you don't wish to set the search domain)</div>
|
||
<div style="font-size: small; color: darkgreen"><br/>aliases: dns_search_domains</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-entrypoint"></div>
|
||
<b>entrypoint</b>
|
||
<a class="ansibleOptionLink" href="#parameter-entrypoint" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Overwrite the default ENTRYPOINT of the image</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-env"></div>
|
||
<b>env</b>
|
||
<a class="ansibleOptionLink" href="#parameter-env" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">dictionary</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Set environment variables. This option allows you to specify arbitrary environment variables that are available for the process that will be launched inside of the container.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-env_file"></div>
|
||
<b>env_file</b>
|
||
<a class="ansibleOptionLink" href="#parameter-env_file" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">path</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Read in a line delimited file of environment variables. Doesn't support idempotency. If users changes the file with environment variables it's on them to recreate the container.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-env_host"></div>
|
||
<b>env_host</b>
|
||
<a class="ansibleOptionLink" href="#parameter-env_host" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">boolean</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li>no</li>
|
||
<li>yes</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Use all current host environment variables in container. Defaults to false.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-etc_hosts"></div>
|
||
<b>etc_hosts</b>
|
||
<a class="ansibleOptionLink" href="#parameter-etc_hosts" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">dictionary</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Dict of host-to-IP mappings, where each host name is a key in the dictionary. Each host name will be added to the container's ``/etc/hosts`` file.</div>
|
||
<div style="font-size: small; color: darkgreen"><br/>aliases: add_hosts</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-executable"></div>
|
||
<b>executable</b>
|
||
<a class="ansibleOptionLink" href="#parameter-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>Path to <code>podman</code> executable if it is not in the <code>$PATH</code> on the machine running <code>podman</code></div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-expose"></div>
|
||
<b>expose</b>
|
||
<a class="ansibleOptionLink" href="#parameter-expose" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Expose a port, or a range of ports (e.g. expose "3300-3310") to set up port redirection on the host system.</div>
|
||
<div style="font-size: small; color: darkgreen"><br/>aliases: exposed, exposed_ports</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-force_restart"></div>
|
||
<b>force_restart</b>
|
||
<a class="ansibleOptionLink" href="#parameter-force_restart" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">boolean</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li><div style="color: blue"><b>no</b> ←</div></li>
|
||
<li>yes</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Force restart of container.</div>
|
||
<div style="font-size: small; color: darkgreen"><br/>aliases: restart</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-generate_systemd"></div>
|
||
<b>generate_systemd</b>
|
||
<a class="ansibleOptionLink" href="#parameter-generate_systemd" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">dictionary</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<b>Default:</b><br/><div style="color: blue">{}</div>
|
||
</td>
|
||
<td>
|
||
<div>Generate systemd unit file for container.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="elbow-placeholder"></td>
|
||
<td colspan="1">
|
||
<div class="ansibleOptionAnchor" id="parameter-generate_systemd/container_prefix"></div>
|
||
<b>container_prefix</b>
|
||
<a class="ansibleOptionLink" href="#parameter-generate_systemd/container_prefix" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Set the systemd unit name prefix for containers. The default is "container".</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="elbow-placeholder"></td>
|
||
<td colspan="1">
|
||
<div class="ansibleOptionAnchor" id="parameter-generate_systemd/names"></div>
|
||
<b>names</b>
|
||
<a class="ansibleOptionLink" href="#parameter-generate_systemd/names" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">boolean</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li>no</li>
|
||
<li><div style="color: blue"><b>yes</b> ←</div></li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Use names of the containers for the start, stop, and description in the unit file. Default is true.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="elbow-placeholder"></td>
|
||
<td colspan="1">
|
||
<div class="ansibleOptionAnchor" id="parameter-generate_systemd/new"></div>
|
||
<b>new</b>
|
||
<a class="ansibleOptionLink" href="#parameter-generate_systemd/new" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">boolean</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li><div style="color: blue"><b>no</b> ←</div></li>
|
||
<li>yes</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Create containers and pods when the unit is started instead of expecting them to exist. The default is "false". Refer to podman-generate-systemd(1) for more information.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="elbow-placeholder"></td>
|
||
<td colspan="1">
|
||
<div class="ansibleOptionAnchor" id="parameter-generate_systemd/no_header"></div>
|
||
<b>no_header</b>
|
||
<a class="ansibleOptionLink" href="#parameter-generate_systemd/no_header" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">boolean</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li><div style="color: blue"><b>no</b> ←</div></li>
|
||
<li>yes</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Do not generate the header including meta data such as the Podman version and the timestamp. From podman version 3.1.0.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="elbow-placeholder"></td>
|
||
<td colspan="1">
|
||
<div class="ansibleOptionAnchor" id="parameter-generate_systemd/path"></div>
|
||
<b>path</b>
|
||
<a class="ansibleOptionLink" href="#parameter-generate_systemd/path" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Specify a path to the directory where unit files will be generated. Required for this option. If it doesn't exist, the directory will be created.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="elbow-placeholder"></td>
|
||
<td colspan="1">
|
||
<div class="ansibleOptionAnchor" id="parameter-generate_systemd/pod_prefix"></div>
|
||
<b>pod_prefix</b>
|
||
<a class="ansibleOptionLink" href="#parameter-generate_systemd/pod_prefix" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Set the systemd unit name prefix for pods. The default is "pod".</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="elbow-placeholder"></td>
|
||
<td colspan="1">
|
||
<div class="ansibleOptionAnchor" id="parameter-generate_systemd/restart_policy"></div>
|
||
<b>restart_policy</b>
|
||
<a class="ansibleOptionLink" href="#parameter-generate_systemd/restart_policy" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li>no</li>
|
||
<li>on-success</li>
|
||
<li>on-failure</li>
|
||
<li>on-abnormal</li>
|
||
<li>on-watchdog</li>
|
||
<li>on-abort</li>
|
||
<li>always</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Specify a restart policy for the service. The restart-policy must be one of "no", "on-success", "on-failure", "on-abnormal", "on-watchdog", "on-abort", or "always". The default policy is "on-failure".</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="elbow-placeholder"></td>
|
||
<td colspan="1">
|
||
<div class="ansibleOptionAnchor" id="parameter-generate_systemd/separator"></div>
|
||
<b>separator</b>
|
||
<a class="ansibleOptionLink" href="#parameter-generate_systemd/separator" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Set the systemd unit name separator between the name/id of a container/pod and the prefix. The default is "-" (dash).</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="elbow-placeholder"></td>
|
||
<td colspan="1">
|
||
<div class="ansibleOptionAnchor" id="parameter-generate_systemd/time"></div>
|
||
<b>time</b>
|
||
<a class="ansibleOptionLink" href="#parameter-generate_systemd/time" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">integer</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Override the default stop timeout for the container with the given value.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-gidmap"></div>
|
||
<b>gidmap</b>
|
||
<a class="ansibleOptionLink" href="#parameter-gidmap" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Run the container in a new user namespace using the supplied mapping.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-group_add"></div>
|
||
<b>group_add</b>
|
||
<a class="ansibleOptionLink" href="#parameter-group_add" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Add additional groups to run as</div>
|
||
<div style="font-size: small; color: darkgreen"><br/>aliases: groups</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-healthcheck"></div>
|
||
<b>healthcheck</b>
|
||
<a class="ansibleOptionLink" href="#parameter-healthcheck" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Set or alter a healthcheck command for a container.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-healthcheck_interval"></div>
|
||
<b>healthcheck_interval</b>
|
||
<a class="ansibleOptionLink" href="#parameter-healthcheck_interval" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Set an interval for the healthchecks (a value of disable results in no automatic timer setup) (default "30s")</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-healthcheck_retries"></div>
|
||
<b>healthcheck_retries</b>
|
||
<a class="ansibleOptionLink" href="#parameter-healthcheck_retries" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">integer</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>The number of retries allowed before a healthcheck is considered to be unhealthy. The default value is 3.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-healthcheck_start_period"></div>
|
||
<b>healthcheck_start_period</b>
|
||
<a class="ansibleOptionLink" href="#parameter-healthcheck_start_period" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>The initialization time needed for a container to bootstrap. The value can be expressed in time format like 2m3s. The default value is 0s</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-healthcheck_timeout"></div>
|
||
<b>healthcheck_timeout</b>
|
||
<a class="ansibleOptionLink" href="#parameter-healthcheck_timeout" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>The maximum time allowed to complete the healthcheck before an interval is considered failed. Like start-period, the value can be expressed in a time format such as 1m22s. The default value is 30s</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-hostname"></div>
|
||
<b>hostname</b>
|
||
<a class="ansibleOptionLink" href="#parameter-hostname" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Container host name. Sets the container host name that is available inside the container.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-http_proxy"></div>
|
||
<b>http_proxy</b>
|
||
<a class="ansibleOptionLink" href="#parameter-http_proxy" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">boolean</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li>no</li>
|
||
<li>yes</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>By default proxy environment variables are passed into the container if set for the podman process. This can be disabled by setting the http_proxy option to false. The environment variables passed in include http_proxy, https_proxy, ftp_proxy, no_proxy, and also the upper case versions of those. Defaults to true</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-image"></div>
|
||
<b>image</b>
|
||
<a class="ansibleOptionLink" href="#parameter-image" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Repository path (or image name) and tag used to create the container. If an image is not found, the image will be pulled from the registry. If no tag is included, <code>latest</code> will be used.</div>
|
||
<div>Can also be an image ID. If this is the case, the image is assumed to be available locally.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-image_strict"></div>
|
||
<b>image_strict</b>
|
||
<a class="ansibleOptionLink" href="#parameter-image_strict" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">boolean</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li><div style="color: blue"><b>no</b> ←</div></li>
|
||
<li>yes</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Whether to compare images in idempotency by taking into account a full name with registry and namespaces.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-image_volume"></div>
|
||
<b>image_volume</b>
|
||
<a class="ansibleOptionLink" href="#parameter-image_volume" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li>bind</li>
|
||
<li>tmpfs</li>
|
||
<li>ignore</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Tells podman how to handle the builtin image volumes. The options are bind, tmpfs, or ignore (default bind)</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-init"></div>
|
||
<b>init</b>
|
||
<a class="ansibleOptionLink" href="#parameter-init" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">boolean</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li>no</li>
|
||
<li>yes</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Run an init inside the container that forwards signals and reaps processes. The default is false.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-init_path"></div>
|
||
<b>init_path</b>
|
||
<a class="ansibleOptionLink" href="#parameter-init_path" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Path to the container-init binary.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-interactive"></div>
|
||
<b>interactive</b>
|
||
<a class="ansibleOptionLink" href="#parameter-interactive" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">boolean</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li>no</li>
|
||
<li>yes</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Keep STDIN open even if not attached. The default is false. When set to true, keep stdin open even if not attached. The default is false.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-ip"></div>
|
||
<b>ip</b>
|
||
<a class="ansibleOptionLink" href="#parameter-ip" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Specify a static IP address for the container, for example '10.88.64.128'. Can only be used if no additional CNI networks to join were specified via 'network:', and if the container is not joining another container's network namespace via 'network container:<name|id>'. The address must be within the default CNI network's pool (default 10.88.0.0/16).</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-ipc"></div>
|
||
<b>ipc</b>
|
||
<a class="ansibleOptionLink" href="#parameter-ipc" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Default is to create a private IPC namespace (POSIX SysV IPC) for the container</div>
|
||
<div style="font-size: small; color: darkgreen"><br/>aliases: ipc_mode</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-kernel_memory"></div>
|
||
<b>kernel_memory</b>
|
||
<a class="ansibleOptionLink" href="#parameter-kernel_memory" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Kernel memory limit (format <number>[<unit>], where unit = b, k, m or g) Note - idempotency is supported for integers only.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-label"></div>
|
||
<b>label</b>
|
||
<a class="ansibleOptionLink" href="#parameter-label" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">dictionary</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Add metadata to a container, pass dictionary of label names and values</div>
|
||
<div style="font-size: small; color: darkgreen"><br/>aliases: labels</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-label_file"></div>
|
||
<b>label_file</b>
|
||
<a class="ansibleOptionLink" href="#parameter-label_file" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Read in a line delimited file of labels</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-log_driver"></div>
|
||
<b>log_driver</b>
|
||
<a class="ansibleOptionLink" href="#parameter-log_driver" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li>k8s-file</li>
|
||
<li>journald</li>
|
||
<li>json-file</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Logging driver. Used to set the log driver for the container. For example log_driver "k8s-file".</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-log_level"></div>
|
||
<b>log_level</b>
|
||
<a class="ansibleOptionLink" href="#parameter-log_level" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li>debug</li>
|
||
<li>info</li>
|
||
<li>warn</li>
|
||
<li>error</li>
|
||
<li>fatal</li>
|
||
<li>panic</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Logging level for Podman. Log messages above specified level ("debug"|"info"|"warn"|"error"|"fatal"|"panic") (default "error")</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-log_opt"></div>
|
||
<b>log_opt</b>
|
||
<a class="ansibleOptionLink" href="#parameter-log_opt" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">dictionary</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Logging driver specific options. Used to set the path to the container log file.</div>
|
||
<div style="font-size: small; color: darkgreen"><br/>aliases: log_options</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="elbow-placeholder"></td>
|
||
<td colspan="1">
|
||
<div class="ansibleOptionAnchor" id="parameter-log_opt/max_size"></div>
|
||
<b>max_size</b>
|
||
<a class="ansibleOptionLink" href="#parameter-log_opt/max_size" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Specify a max size of the log file (e.g 10mb).</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="elbow-placeholder"></td>
|
||
<td colspan="1">
|
||
<div class="ansibleOptionAnchor" id="parameter-log_opt/path"></div>
|
||
<b>path</b>
|
||
<a class="ansibleOptionLink" href="#parameter-log_opt/path" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Specify a path to the log file (e.g. /var/log/container/mycontainer.json).</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td class="elbow-placeholder"></td>
|
||
<td colspan="1">
|
||
<div class="ansibleOptionAnchor" id="parameter-log_opt/tag"></div>
|
||
<b>tag</b>
|
||
<a class="ansibleOptionLink" href="#parameter-log_opt/tag" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Specify a custom log tag for the container.</div>
|
||
</td>
|
||
</tr>
|
||
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-mac_address"></div>
|
||
<b>mac_address</b>
|
||
<a class="ansibleOptionLink" href="#parameter-mac_address" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Specify a MAC address for the container, for example '92:d0:c6:0a:29:33'. Don't forget that it must be unique within one Ethernet network.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-memory"></div>
|
||
<b>memory</b>
|
||
<a class="ansibleOptionLink" href="#parameter-memory" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Memory limit (format 10k, where unit = b, k, m or g) Note - idempotency is supported for integers only.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-memory_reservation"></div>
|
||
<b>memory_reservation</b>
|
||
<a class="ansibleOptionLink" href="#parameter-memory_reservation" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Memory soft limit (format 100m, where unit = b, k, m or g) Note - idempotency is supported for integers only.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-memory_swap"></div>
|
||
<b>memory_swap</b>
|
||
<a class="ansibleOptionLink" href="#parameter-memory_swap" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>A limit value equal to memory plus swap. Must be used with the -m (--memory) flag. The swap LIMIT should always be larger than -m (--memory) value. By default, the swap LIMIT will be set to double the value of --memory Note - idempotency is supported for integers only.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-memory_swappiness"></div>
|
||
<b>memory_swappiness</b>
|
||
<a class="ansibleOptionLink" href="#parameter-memory_swappiness" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">integer</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Tune a container's memory swappiness behavior. Accepts an integer between 0 and 100.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-mount"></div>
|
||
<b>mount</b>
|
||
<a class="ansibleOptionLink" href="#parameter-mount" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Attach a filesystem mount to the container. bind or tmpfs For example mount "type=bind,source=/path/on/host,destination=/path/in/container"</div>
|
||
<div style="font-size: small; color: darkgreen"><br/>aliases: mounts</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-name"></div>
|
||
<b>name</b>
|
||
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
/ <span style="color: red">required</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Name of the container</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-network"></div>
|
||
<b>network</b>
|
||
<a class="ansibleOptionLink" href="#parameter-network" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Set the Network mode for the container * bridge create a network stack on the default bridge * none no networking * container:<name|id> reuse another container's network stack * host use the podman host network stack. * <network-name>|<network-id> connect to a user-defined network * ns:<path> path to a network namespace to join * slirp4netns use slirp4netns to create a user network stack. This is the default for rootless containers</div>
|
||
<div style="font-size: small; color: darkgreen"><br/>aliases: net, network_mode</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-network_aliases"></div>
|
||
<b>network_aliases</b>
|
||
<a class="ansibleOptionLink" href="#parameter-network_aliases" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Add network-scoped alias for the container. A container will only have access to aliases on the first network that it joins. This is a limitation that will be removed in a later release.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-no_hosts"></div>
|
||
<b>no_hosts</b>
|
||
<a class="ansibleOptionLink" href="#parameter-no_hosts" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">boolean</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li>no</li>
|
||
<li>yes</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Do not create /etc/hosts for the container Default is false.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-oom_kill_disable"></div>
|
||
<b>oom_kill_disable</b>
|
||
<a class="ansibleOptionLink" href="#parameter-oom_kill_disable" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">boolean</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li>no</li>
|
||
<li>yes</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Whether to disable OOM Killer for the container or not. Default is false.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-oom_score_adj"></div>
|
||
<b>oom_score_adj</b>
|
||
<a class="ansibleOptionLink" href="#parameter-oom_score_adj" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">integer</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Tune the host's OOM preferences for containers (accepts -1000 to 1000)</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-pid"></div>
|
||
<b>pid</b>
|
||
<a class="ansibleOptionLink" href="#parameter-pid" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Set the PID mode for the container</div>
|
||
<div style="font-size: small; color: darkgreen"><br/>aliases: pid_mode</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-pids_limit"></div>
|
||
<b>pids_limit</b>
|
||
<a class="ansibleOptionLink" href="#parameter-pids_limit" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Tune the container's PIDs limit. Set -1 to have unlimited PIDs for the container.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-pod"></div>
|
||
<b>pod</b>
|
||
<a class="ansibleOptionLink" href="#parameter-pod" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Run container in an existing pod. If you want podman to make the pod for you, preference the pod name with "new:"</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-privileged"></div>
|
||
<b>privileged</b>
|
||
<a class="ansibleOptionLink" href="#parameter-privileged" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">boolean</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li>no</li>
|
||
<li>yes</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Give extended privileges to this container. The default is false.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-publish"></div>
|
||
<b>publish</b>
|
||
<a class="ansibleOptionLink" href="#parameter-publish" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Publish a container's port, or range of ports, to the host. Format - ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort | containerPort In case of only containerPort is set, the hostPort will chosen randomly by Podman.</div>
|
||
<div style="font-size: small; color: darkgreen"><br/>aliases: ports, published, published_ports</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-publish_all"></div>
|
||
<b>publish_all</b>
|
||
<a class="ansibleOptionLink" href="#parameter-publish_all" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">boolean</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li>no</li>
|
||
<li>yes</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Publish all exposed ports to random ports on the host interfaces. The default is false.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-read_only"></div>
|
||
<b>read_only</b>
|
||
<a class="ansibleOptionLink" href="#parameter-read_only" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">boolean</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li>no</li>
|
||
<li>yes</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Mount the container's root filesystem as read only. Default is false</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-read_only_tmpfs"></div>
|
||
<b>read_only_tmpfs</b>
|
||
<a class="ansibleOptionLink" href="#parameter-read_only_tmpfs" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">boolean</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li>no</li>
|
||
<li>yes</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>If container is running in --read-only mode, then mount a read-write tmpfs on /run, /tmp, and /var/tmp. The default is true</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-recreate"></div>
|
||
<b>recreate</b>
|
||
<a class="ansibleOptionLink" href="#parameter-recreate" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">boolean</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li><div style="color: blue"><b>no</b> ←</div></li>
|
||
<li>yes</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Use with present and started states to force the re-creation of an existing container.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-requires"></div>
|
||
<b>requires</b>
|
||
<a class="ansibleOptionLink" href="#parameter-requires" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Specify one or more requirements. A requirement is a dependency container that will be started before this container. Containers can be specified by name or ID.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-restart_policy"></div>
|
||
<b>restart_policy</b>
|
||
<a class="ansibleOptionLink" href="#parameter-restart_policy" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Restart policy to follow when containers exit. Restart policy will not take effect if a container is stopped via the podman kill or podman stop commands. Valid values are * no - Do not restart containers on exit * on-failure[:max_retries] - Restart containers when they exit with a non-0 exit code, retrying indefinitely or until the optional max_retries count is hit * always - Restart containers when they exit, regardless of status, retrying indefinitely</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-rm"></div>
|
||
<b>rm</b>
|
||
<a class="ansibleOptionLink" href="#parameter-rm" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">boolean</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li>no</li>
|
||
<li>yes</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Automatically remove the container when it exits. The default is false.</div>
|
||
<div style="font-size: small; color: darkgreen"><br/>aliases: remove, auto_remove</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-rootfs"></div>
|
||
<b>rootfs</b>
|
||
<a class="ansibleOptionLink" href="#parameter-rootfs" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">boolean</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li>no</li>
|
||
<li>yes</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>If true, the first argument refers to an exploded container on the file system. The default is false.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-secrets"></div>
|
||
<b>secrets</b>
|
||
<a class="ansibleOptionLink" href="#parameter-secrets" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Add the named secrets into the container. The format is <code>secret[,opt=opt...]</code>, see <a href='https://docs.podman.io/en/latest/markdown/podman-run.1.html#secret-secret-opt-opt'>documentation</a> for more details.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-security_opt"></div>
|
||
<b>security_opt</b>
|
||
<a class="ansibleOptionLink" href="#parameter-security_opt" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Security Options. For example security_opt "seccomp=unconfined"</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-shm_size"></div>
|
||
<b>shm_size</b>
|
||
<a class="ansibleOptionLink" href="#parameter-shm_size" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Size of /dev/shm. The format is <number><unit>. number must be greater than 0. Unit is optional and can be b (bytes), k (kilobytes), m(megabytes), or g (gigabytes). If you omit the unit, the system uses bytes. If you omit the size entirely, the system uses 64m</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-sig_proxy"></div>
|
||
<b>sig_proxy</b>
|
||
<a class="ansibleOptionLink" href="#parameter-sig_proxy" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">boolean</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li>no</li>
|
||
<li>yes</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Proxy signals sent to the podman run command to the container process. SIGCHLD, SIGSTOP, and SIGKILL are not proxied. The default is true.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-state"></div>
|
||
<b>state</b>
|
||
<a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li>absent</li>
|
||
<li>present</li>
|
||
<li>stopped</li>
|
||
<li><div style="color: blue"><b>started</b> ←</div></li>
|
||
<li>created</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div><em>absent</em> - A container matching the specified name will be stopped and removed.</div>
|
||
<div><em>present</em> - Asserts the existence of a container matching the name and any provided configuration parameters. If no container matches the name, a container will be created. If a container matches the name but the provided configuration does not match, the container will be updated, if it can be. If it cannot be updated, it will be removed and re-created with the requested config. Image version will be taken into account when comparing configuration. Use the recreate option to force the re-creation of the matching container.</div>
|
||
<div><em>started</em> - Asserts there is a running container matching the name and any provided configuration. If no container matches the name, a container will be created and started. Use recreate to always re-create a matching container, even if it is running. Use force_restart to force a matching container to be stopped and restarted.</div>
|
||
<div><em>stopped</em> - Asserts that the container is first <em>present</em>, and then if the container is running moves it to a stopped state.</div>
|
||
<div><em>created</em> - Asserts that the container exists with given configuration. If container doesn't exist, the module creates it and leaves it in 'created' state. If configuration doesn't match or 'recreate' option is set, the container will be recreated</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-stop_signal"></div>
|
||
<b>stop_signal</b>
|
||
<a class="ansibleOptionLink" href="#parameter-stop_signal" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">integer</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Signal to stop a container. Default is SIGTERM.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-stop_timeout"></div>
|
||
<b>stop_timeout</b>
|
||
<a class="ansibleOptionLink" href="#parameter-stop_timeout" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">integer</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Timeout (in seconds) to stop a container. Default is 10.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-subgidname"></div>
|
||
<b>subgidname</b>
|
||
<a class="ansibleOptionLink" href="#parameter-subgidname" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Run the container in a new user namespace using the map with 'name' in the /etc/subgid file.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-subuidname"></div>
|
||
<b>subuidname</b>
|
||
<a class="ansibleOptionLink" href="#parameter-subuidname" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Run the container in a new user namespace using the map with 'name' in the /etc/subuid file.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-sysctl"></div>
|
||
<b>sysctl</b>
|
||
<a class="ansibleOptionLink" href="#parameter-sysctl" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">dictionary</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Configure namespaced kernel parameters at runtime</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-systemd"></div>
|
||
<b>systemd</b>
|
||
<a class="ansibleOptionLink" href="#parameter-systemd" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Run container in systemd mode. The default is true.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-timezone"></div>
|
||
<b>timezone</b>
|
||
<a class="ansibleOptionLink" href="#parameter-timezone" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Set timezone in container. This flag takes area-based timezones, GMT time, as well as local, which sets the timezone in the container to match the host machine. See /usr/share/zoneinfo/ for valid timezones. Remote connections use local containers.conf for defaults.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-tmpfs"></div>
|
||
<b>tmpfs</b>
|
||
<a class="ansibleOptionLink" href="#parameter-tmpfs" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">dictionary</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Create a tmpfs mount. For example tmpfs "/tmp" "rw,size=787448k,mode=1777"</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-tty"></div>
|
||
<b>tty</b>
|
||
<a class="ansibleOptionLink" href="#parameter-tty" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">boolean</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
<ul style="margin: 0; padding: 0"><b>Choices:</b>
|
||
<li>no</li>
|
||
<li>yes</li>
|
||
</ul>
|
||
</td>
|
||
<td>
|
||
<div>Allocate a pseudo-TTY. The default is false.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-uidmap"></div>
|
||
<b>uidmap</b>
|
||
<a class="ansibleOptionLink" href="#parameter-uidmap" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Run the container in a new user namespace using the supplied mapping.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-ulimit"></div>
|
||
<b>ulimit</b>
|
||
<a class="ansibleOptionLink" href="#parameter-ulimit" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Ulimit options</div>
|
||
<div style="font-size: small; color: darkgreen"><br/>aliases: ulimits</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-user"></div>
|
||
<b>user</b>
|
||
<a class="ansibleOptionLink" href="#parameter-user" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Sets the username or UID used and optionally the groupname or GID for the specified command.</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-userns"></div>
|
||
<b>userns</b>
|
||
<a class="ansibleOptionLink" href="#parameter-userns" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Set the user namespace mode for the container. It defaults to the PODMAN_USERNS environment variable. An empty value means user namespaces are disabled.</div>
|
||
<div style="font-size: small; color: darkgreen"><br/>aliases: userns_mode</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-uts"></div>
|
||
<b>uts</b>
|
||
<a class="ansibleOptionLink" href="#parameter-uts" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Set the UTS mode for the container</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-volume"></div>
|
||
<b>volume</b>
|
||
<a class="ansibleOptionLink" href="#parameter-volume" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Create a bind mount. If you specify, volume /HOST-DIR:/CONTAINER-DIR, podman bind mounts /HOST-DIR in the host to /CONTAINER-DIR in the podman container.</div>
|
||
<div style="font-size: small; color: darkgreen"><br/>aliases: volumes</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-volumes_from"></div>
|
||
<b>volumes_from</b>
|
||
<a class="ansibleOptionLink" href="#parameter-volumes_from" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">list</span>
|
||
/ <span style="color: purple">elements=string</span> </div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Mount volumes from the specified container(s).</div>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="2">
|
||
<div class="ansibleOptionAnchor" id="parameter-workdir"></div>
|
||
<b>workdir</b>
|
||
<a class="ansibleOptionLink" href="#parameter-workdir" title="Permalink to this option"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">string</span>
|
||
</div>
|
||
</td>
|
||
<td>
|
||
</td>
|
||
<td>
|
||
<div>Working directory inside the container. The default working directory for running binaries within a container is the root directory (/).</div>
|
||
<div style="font-size: small; color: darkgreen"><br/>aliases: working_dir</div>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<br/></div>
|
||
<div class="section" id="examples">
|
||
<h2><a class="toc-backref" href="#id4">Examples</a><a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
|
||
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Run container</span>
|
||
<span class="nt">containers.podman.podman_container</span><span class="p">:</span>
|
||
<span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">container</span>
|
||
<span class="nt">image</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">quay.io/bitnami/wildfly</span>
|
||
<span class="nt">state</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">started</span>
|
||
|
||
<span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Create a data container</span>
|
||
<span class="nt">containers.podman.podman_container</span><span class="p">:</span>
|
||
<span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">mydata</span>
|
||
<span class="nt">image</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">busybox</span>
|
||
<span class="nt">volume</span><span class="p">:</span>
|
||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">/tmp/data</span>
|
||
|
||
<span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Re-create a redis container with systemd service file generated in /tmp/</span>
|
||
<span class="nt">containers.podman.podman_container</span><span class="p">:</span>
|
||
<span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">myredis</span>
|
||
<span class="nt">image</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">redis</span>
|
||
<span class="nt">command</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">redis-server --appendonly yes</span>
|
||
<span class="nt">state</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">present</span>
|
||
<span class="nt">recreate</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">yes</span>
|
||
<span class="nt">expose</span><span class="p">:</span>
|
||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">6379</span>
|
||
<span class="nt">volumes_from</span><span class="p">:</span>
|
||
<span class="p p-Indicator">-</span> <span class="l l-Scalar l-Scalar-Plain">mydata</span>
|
||
<span class="nt">generate_systemd</span><span class="p">:</span>
|
||
<span class="nt">path</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">/tmp/</span>
|
||
<span class="nt">restart_policy</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">always</span>
|
||
<span class="nt">time</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">120</span>
|
||
<span class="nt">names</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">true</span>
|
||
<span class="nt">container_prefix</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ainer</span>
|
||
|
||
<span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Restart a container</span>
|
||
<span class="nt">containers.podman.podman_container</span><span class="p">:</span>
|
||
<span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">myapplication</span>
|
||
<span class="nt">image</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">redis</span>
|
||
<span class="nt">state</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">started</span>
|
||
<span class="nt">restart</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">yes</span>
|
||
<span class="nt">etc_hosts</span><span class="p">:</span>
|
||
<span class="nt">other</span><span class="p">:</span> <span class="s">"127.0.0.1"</span>
|
||
<span class="nt">restart_policy</span><span class="p">:</span> <span class="s">"no"</span>
|
||
<span class="nt">device</span><span class="p">:</span> <span class="s">"/dev/sda:/dev/xvda:rwm"</span>
|
||
<span class="nt">ports</span><span class="p">:</span>
|
||
<span class="p p-Indicator">-</span> <span class="s">"8080:9000"</span>
|
||
<span class="p p-Indicator">-</span> <span class="s">"127.0.0.1:8081:9001/udp"</span>
|
||
<span class="nt">env</span><span class="p">:</span>
|
||
<span class="nt">SECRET_KEY</span><span class="p">:</span> <span class="s">"ssssh"</span>
|
||
<span class="nt">BOOLEAN_KEY</span><span class="p">:</span> <span class="s">"yes"</span>
|
||
|
||
<span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Container present</span>
|
||
<span class="nt">containers.podman.podman_container</span><span class="p">:</span>
|
||
<span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">mycontainer</span>
|
||
<span class="nt">state</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">present</span>
|
||
<span class="nt">image</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ubuntu:14.04</span>
|
||
<span class="nt">command</span><span class="p">:</span> <span class="s">"sleep</span><span class="nv"> </span><span class="s">1d"</span>
|
||
|
||
<span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Stop a container</span>
|
||
<span class="nt">containers.podman.podman_container</span><span class="p">:</span>
|
||
<span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">mycontainer</span>
|
||
<span class="nt">state</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">stopped</span>
|
||
|
||
<span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Start 4 load-balanced containers</span>
|
||
<span class="nt">containers.podman.podman_container</span><span class="p">:</span>
|
||
<span class="nt">name</span><span class="p">:</span> <span class="s">"container</span><span class="cp">{{</span> <span class="nv">item</span> <span class="cp">}}</span><span class="s">"</span>
|
||
<span class="nt">recreate</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">yes</span>
|
||
<span class="nt">image</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">someuser/anotherappimage</span>
|
||
<span class="nt">command</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">sleep 1d</span>
|
||
<span class="nt">with_sequence</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">count=4</span>
|
||
|
||
<span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">remove container</span>
|
||
<span class="nt">containers.podman.podman_container</span><span class="p">:</span>
|
||
<span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">ohno</span>
|
||
<span class="nt">state</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">absent</span>
|
||
|
||
<span class="p p-Indicator">-</span> <span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">Writing output</span>
|
||
<span class="nt">containers.podman.podman_container</span><span class="p">:</span>
|
||
<span class="nt">name</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">myservice</span>
|
||
<span class="nt">image</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">busybox</span>
|
||
<span class="nt">log_options</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">path=/var/log/container/mycontainer.json</span>
|
||
<span class="nt">log_driver</span><span class="p">:</span> <span class="l l-Scalar l-Scalar-Plain">k8s-file</span>
|
||
</pre></div>
|
||
</div>
|
||
</div>
|
||
<div class="section" id="return-values">
|
||
<h2><a class="toc-backref" href="#id5">Return Values</a><a class="headerlink" href="#return-values" title="Permalink to this headline">¶</a></h2>
|
||
<p>Common return values are documented <span class="xref std std-ref">here</span>, the following are the fields unique to this module:</p>
|
||
<table border=0 cellpadding=0 class="documentation-table">
|
||
<tr>
|
||
<th colspan="1">Key</th>
|
||
<th>Returned</th>
|
||
<th width="100%">Description</th>
|
||
</tr>
|
||
<tr>
|
||
<td colspan="1">
|
||
<div class="ansibleOptionAnchor" id="return-container"></div>
|
||
<b>container</b>
|
||
<a class="ansibleOptionLink" href="#return-container" title="Permalink to this return value"></a>
|
||
<div style="font-size: small">
|
||
<span style="color: purple">dictionary</span>
|
||
</div>
|
||
</td>
|
||
<td>always</td>
|
||
<td>
|
||
<div>Facts representing the current state of the container. Matches the podman inspection output.</div>
|
||
<div>Note that facts are part of the registered vars since Ansible 2.8. For compatibility reasons, the facts are also accessible directly as <code>podman_container</code>. Note that the returned fact will be removed in Ansible 2.12.</div>
|
||
<div>Empty if <code>state</code> is <em>absent</em>.</div>
|
||
<br/>
|
||
<div style="font-size: smaller"><b>Sample:</b></div>
|
||
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">{ "AppArmorProfile": "", "Args": [ "sh" ], "BoundingCaps": [ "CAP_CHOWN", ... ], "Config": { "Annotations": { "io.kubernetes.cri-o.ContainerType": "sandbox", "io.kubernetes.cri-o.TTY": "false" }, "AttachStderr": false, "AttachStdin": false, "AttachStdout": false, "Cmd": [ "sh" ], "Domainname": "", "Entrypoint": "", "Env": [ "PATH=/usr/sbin:/usr/bin:/sbin:/bin", "TERM=xterm", "HOSTNAME=", "container=podman" ], "Hostname": "", "Image": "docker.io/library/busybox:latest", "Labels": null, "OpenStdin": false, "StdinOnce": false, "StopSignal": 15, "Tty": false, "User": { "gid": 0, "uid": 0 }, "Volumes": null, "WorkingDir": "/" }, "ConmonPidFile": "...", "Created": "2019-06-17T19:13:09.873858307+03:00", "Dependencies": [], "Driver": "overlay", "EffectiveCaps": [ "CAP_CHOWN", ... ], "ExecIDs": [], "ExitCommand": [ "/usr/bin/podman", "--root", ... ], "GraphDriver": { ... }, "HostConfig": { ... }, "HostnamePath": "...", "HostsPath": "...", "ID": "...", "Image": "...", "ImageName": "docker.io/library/busybox:latest", "IsInfra": false, "LogPath": "/tmp/container/mycontainer.json", "MountLabel": "system_u:object_r:container_file_t:s0:c282,c782", "Mounts": [ ... ], "Name": "myservice", "Namespace": "", "NetworkSettings": { "Bridge": "", ... }, "Path": "sh", "ProcessLabel": "system_u:system_r:container_t:s0:c282,c782", "ResolvConfPath": "...", "RestartCount": 0, "Rootfs": "", "State": { "Dead": false, "Error": "", "ExitCode": 0, "FinishedAt": "2019-06-17T19:13:10.157518963+03:00", "Healthcheck": { "FailingStreak": 0, "Log": null, "Status": "" }, "OOMKilled": false, "OciVersion": "1.0.1-dev", "Paused": false, "Pid": 4083, "Restarting": false, "Running": false, "StartedAt": "2019-06-17T19:13:10.152479729+03:00", "Status": "exited" }, "StaticDir": "..." ... }</div>
|
||
</td>
|
||
</tr>
|
||
</table>
|
||
<br/><br/><div class="section" id="authors">
|
||
<h3>Authors<a class="headerlink" href="#authors" title="Permalink to this headline">¶</a></h3>
|
||
<ul class="simple">
|
||
<li><p>Sagi Shnaidman (@sshnaidm)</p></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||
<div class="sphinxsidebarwrapper">
|
||
<h1 class="logo"><a href="index.html">Python</a></h1>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h3>Navigation</h3>
|
||
|
||
<div class="relations">
|
||
<h3>Related Topics</h3>
|
||
<ul>
|
||
<li><a href="index.html">Documentation overview</a><ul>
|
||
</ul></li>
|
||
</ul>
|
||
</div>
|
||
<div id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script>$('#searchbox').show(0);</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="footer">
|
||
©.
|
||
|
||
|
|
||
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.3.1</a>
|
||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||
|
||
|
|
||
<a href="_sources/podman_container_module.rst.txt"
|
||
rel="nofollow">Page source</a>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |