<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<linkrel="next"title="community.docker.docker_compose_v2_pull module – Pull a Docker compose project" href="docker_compose_v2_pull_module.html" />
<linkrel="prev"title="community.docker.docker_compose module – Manage multi-container Docker applications with Docker Compose V1"href="docker_compose_module.html"/><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
@ -96,6 +96,7 @@
</li>
</ul>
</li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_compose_v2_pull_module.html">community.docker.docker_compose_v2_pull module – Pull a Docker compose project</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
@ -938,7 +939,7 @@ will change over time. New releases of the Docker compose CLI plugin can break t
<linkrel="prev"title="community.docker.docker_compose_v2 module – Manage multi-container Docker applications with Docker Compose CLI plugin"href="docker_compose_v2_module.html"/><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
</head>
<bodyclass="wy-body-for-nav"><!-- extra body elements for Ansible beyond RTD Sphinx Theme -->
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_exec_module.html">community.docker.docker_container_exec module – Execute command in a docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_info_module.html">community.docker.docker_container_info module – Retrieves facts about docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_host_info_module.html">community.docker.docker_host_info module – Retrieves facts about docker host and lists of objects of the services.</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_image_tag_module.html">community.docker.docker_image_tag module – Tag Docker images with new names and/or tags</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_login_module.html">community.docker.docker_login module – Log into a Docker registry.</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_prune_module.html">community.docker.docker_prune module – Allows to prune various docker objects</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_stack_info_module.html">community.docker.docker_stack_info module – Return information on all docker stacks</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_stack_task_info_module.html">community.docker.docker_stack_task_info module – Return information of the tasks on a docker stack</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_swarm_service_info_module.html">community.docker.docker_swarm_service_info module – Retrieves information about docker services from a Swarm Manager</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_volume_info_module.html">community.docker.docker_volume_info module – Retrieve facts about Docker volumes</a></li>
</ul>
<ul>
<liclass="toctree-l1"><aclass="reference internal"href="docker_connection.html">community.docker.docker connection – Run tasks in docker containers</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_api_connection.html">community.docker.docker_api connection – Run tasks in docker containers</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="nsenter_connection.html">community.docker.nsenter connection – execute on host running controller container</a></li>
<liclass="breadcrumb-item active">community.docker.docker_compose_v2_pull module – Pull a Docker compose project</li>
<liclass="wy-breadcrumbs-aside">
<!-- User defined GitHub URL -->
<ahref="https://github.com/ansible-collections/community.docker/edit/main/plugins/modules/docker_compose_v2_pull.py?description=%23%23%23%23%23%20SUMMARY%0A%3C!—%20Your%20description%20here%20–%3E%0A%0A%0A%23%23%23%23%23%20ISSUE%20TYPE%0A-%20Docs%20Pull%20Request%0A%0A%2Blabel:%20docsite_pr"class="fa fa-github"> Edit on GitHub</a>
<h1>community.docker.docker_compose_v2_pull module – Pull a Docker compose project<aclass="headerlink"href="#community-docker-docker-compose-v2-pull-module-pull-a-docker-compose-project"title="Link to this heading"></a></h1>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<p>This module is part of the <aclass="reference external"href="https://galaxy.ansible.com/ui/repo/published/community/docker/">community.docker collection</a> (version 3.6.0).</p>
<p>It is not included in <codeclass="docutils literal notranslate"><spanclass="pre">ansible-core</span></code>.
To check whether it is installed, run <codeclass="code docutils literal notranslate"><spanclass="pre">ansible-galaxy</span><spanclass="pre">collection</span><spanclass="pre">list</span></code>.</p>
You need further requirements to be able to use this module,
see <aclass="reference internal"href="#ansible-collections-community-docker-docker-compose-v2-pull-module-requirements"><spanclass="std std-ref">Requirements</span></a> for details.</p>
<p>To use it in a playbook, specify: <codeclass="code docutils literal notranslate"><spanclass="pre">community.docker.docker_compose_v2_pull</span></code>.</p>
</div>
<pclass="ansible-version-added">New in community.docker 3.6.0</p>
<h2><aclass="toc-backref"href="#id1"role="doc-backlink">Synopsis</a><aclass="headerlink"href="#synopsis"title="Link to this heading"></a></h2>
<ulclass="simple">
<li><p>Uses Docker Compose to pull images for a project.</p></li>
</ul>
</section>
<sectionid="requirements">
<spanid="ansible-collections-community-docker-docker-compose-v2-pull-module-requirements"></span><h2><aclass="toc-backref"href="#id2"role="doc-backlink">Requirements</a><aclass="headerlink"href="#requirements"title="Link to this heading"></a></h2>
<p>The below requirements are needed on the host that executes this module.</p>
<ulclass="simple">
<li><p>Docker CLI with Docker compose plugin 2.18.0 or later</p></li>
</ul>
</section>
<sectionid="parameters">
<h2><aclass="toc-backref"href="#id3"role="doc-backlink">Parameters</a><aclass="headerlink"href="#parameters"title="Link to this heading"></a></h2>
<aclass="ansibleOptionLink"href="#parameter-api_version"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-aliases">aliases: docker_api_version</span></p>
<td><divclass="ansible-option-cell"><p>The version of the Docker API running on the Docker Host.</p>
<p>Defaults to the latest version of the API supported by this collection and the docker daemon.</p>
<p>If the value is not specified in the task, the value of environment variable <aclass="reference internal"href="docsite/scenario_guide.html#envvar-DOCKER_API_VERSION"><codeclass="xref std std-envvar docutils literal notranslate"><spanclass="pre">DOCKER_API_VERSION</span></code></a> will be used instead. If the environment variable is not set, the default value will be used.</p>
<aclass="ansibleOptionLink"href="#parameter-ca_path"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-aliases">aliases: ca_cert, tls_ca_cert, cacert_path</span></p>
<td><divclass="ansible-option-cell"><p>Use a CA certificate when performing server verification by providing the path to a CA certificate file.</p>
<p>If the value is not specified in the task and the environment variable <aclass="reference internal"href="docsite/scenario_guide.html#envvar-DOCKER_CERT_PATH"><codeclass="xref std std-envvar docutils literal notranslate"><spanclass="pre">DOCKER_CERT_PATH</span></code></a> is set, the file <codeclass="docutils literal notranslate"><spanclass="pre">ca.pem</span></code> from the directory specified in the environment variable <aclass="reference internal"href="docsite/scenario_guide.html#envvar-DOCKER_CERT_PATH"><codeclass="xref std std-envvar docutils literal notranslate"><spanclass="pre">DOCKER_CERT_PATH</span></code></a> will be used.</p>
<aclass="ansibleOptionLink"href="#parameter-cli_context"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>The Docker CLI context to use.</p>
<aclass="ansibleOptionLink"href="#parameter-client_cert"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-aliases">aliases: tls_client_cert, cert_path</span></p>
<td><divclass="ansible-option-cell"><p>Path to the client’s TLS certificate file.</p>
<p>If the value is not specified in the task and the environment variable <aclass="reference internal"href="docsite/scenario_guide.html#envvar-DOCKER_CERT_PATH"><codeclass="xref std std-envvar docutils literal notranslate"><spanclass="pre">DOCKER_CERT_PATH</span></code></a> is set, the file <codeclass="docutils literal notranslate"><spanclass="pre">cert.pem</span></code> from the directory specified in the environment variable <aclass="reference internal"href="docsite/scenario_guide.html#envvar-DOCKER_CERT_PATH"><codeclass="xref std std-envvar docutils literal notranslate"><spanclass="pre">DOCKER_CERT_PATH</span></code></a> will be used.</p>
<aclass="ansibleOptionLink"href="#parameter-client_key"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-aliases">aliases: tls_client_key, key_path</span></p>
<td><divclass="ansible-option-cell"><p>Path to the client’s TLS key file.</p>
<p>If the value is not specified in the task and the environment variable <aclass="reference internal"href="docsite/scenario_guide.html#envvar-DOCKER_CERT_PATH"><codeclass="xref std std-envvar docutils literal notranslate"><spanclass="pre">DOCKER_CERT_PATH</span></code></a> is set, the file <codeclass="docutils literal notranslate"><spanclass="pre">key.pem</span></code> from the directory specified in the environment variable <aclass="reference internal"href="docsite/scenario_guide.html#envvar-DOCKER_CERT_PATH"><codeclass="xref std std-envvar docutils literal notranslate"><spanclass="pre">DOCKER_CERT_PATH</span></code></a> will be used.</p>
<aclass="ansibleOptionLink"href="#parameter-docker_cli"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">path</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>Path to the Docker CLI. If not provided, will search for Docker CLI on the <codeclass="xref std std-envvar docutils literal notranslate"><spanclass="pre">PATH</span></code>.</p>
<aclass="ansibleOptionLink"href="#parameter-docker_host"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-aliases">aliases: docker_url</span></p>
<td><divclass="ansible-option-cell"><p>The URL or Unix socket path used to connect to the Docker API. To connect to a remote host, provide the TCP connection string. For example, <codeclass="ansible-value docutils literal notranslate"><spanclass="pre">tcp://192.0.2.23:2376</span></code>. If TLS is used to encrypt the connection, the module will automatically replace <codeclass="docutils literal notranslate"><spanclass="pre">tcp</span></code> in the connection URL with <codeclass="docutils literal notranslate"><spanclass="pre">https</span></code>.</p>
<p>If the value is not specified in the task, the value of environment variable <aclass="reference internal"href="docsite/scenario_guide.html#envvar-DOCKER_HOST"><codeclass="xref std std-envvar docutils literal notranslate"><spanclass="pre">DOCKER_HOST</span></code></a> will be used instead. If the environment variable is not set, the default value will be used.</p>
<aclass="ansibleOptionLink"href="#parameter-env_files"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">list</span> / <spanclass="ansible-option-elements">elements=path</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>By default environment files are loaded from a <codeclass="docutils literal notranslate"><spanclass="pre">.env</span></code> file located directly under the <codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-docker-docker-compose-v2-pull-module-parameter-project-src"><spanclass="std std-ref"><spanclass="pre">project_src</span></span></a></strong></code> directory.</p>
<p><codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-docker-docker-compose-v2-pull-module-parameter-env-files"><spanclass="std std-ref"><spanclass="pre">env_files</span></span></a></strong></code> can be used to specify the path of one or multiple custom environment files instead.</p>
<p>The path is relative to the <codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-docker-docker-compose-v2-pull-module-parameter-project-src"><spanclass="std std-ref"><spanclass="pre">project_src</span></span></a></strong></code> directory.</p>
<aclass="ansibleOptionLink"href="#parameter-policy"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>Whether to pull images before running. This is used when <codeclass="docutils literal notranslate"><spanclass="pre">docker</span><spanclass="pre">compose</span><spanclass="pre">up</span></code> is ran.</p>
<p><codeclass="ansible-value docutils literal notranslate"><spanclass="pre">always</span></code> ensures that the images are always pulled, even when already present on the Docker daemon.</p>
<p><codeclass="ansible-value docutils literal notranslate"><spanclass="pre">missing</span></code> only pulls them when they are not present on the Docker daemon. This is only supported since Docker Compose 2.22.0.</p>
<aclass="ansibleOptionLink"href="#parameter-profiles"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">list</span> / <spanclass="ansible-option-elements">elements=string</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>List of profiles to enable when starting services.</p>
<p>Equivalent to <codeclass="docutils literal notranslate"><spanclass="pre">docker</span><spanclass="pre">compose</span><spanclass="pre">--profile</span></code>.</p>
<aclass="ansibleOptionLink"href="#parameter-project_name"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>Provide a project name. If not provided, the project name is taken from the basename of <codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-docker-docker-compose-v2-pull-module-parameter-project-src"><spanclass="std std-ref"><spanclass="pre">project_src</span></span></a></strong></code>.</p>
<aclass="ansibleOptionLink"href="#parameter-project_src"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">path</span> / <spanclass="ansible-option-required">required</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>Path to a directory containing a <codeclass="docutils literal notranslate"><spanclass="pre">docker-compose.yml</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">docker-compose.yaml</span></code> file.</p>
<aclass="ansibleOptionLink"href="#parameter-tls"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">boolean</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>Secure the connection to the API by using TLS without verifying the authenticity of the Docker host server. Note that if <codeclass="ansible-option docutils literal notranslate"><strong><aclass="reference internal"href="#ansible-collections-community-docker-docker-compose-v2-pull-module-parameter-validate-certs"><spanclass="std std-ref"><spanclass="pre">validate_certs</span></span></a></strong></code> is set to <codeclass="ansible-value docutils literal notranslate"><spanclass="pre">true</span></code> as well, it will take precedence.</p>
<p>If the value is not specified in the task, the value of environment variable <aclass="reference internal"href="docsite/scenario_guide.html#envvar-DOCKER_TLS"><codeclass="xref std std-envvar docutils literal notranslate"><spanclass="pre">DOCKER_TLS</span></code></a> will be used instead. If the environment variable is not set, the default value will be used.</p>
<aclass="ansibleOptionLink"href="#parameter-tls_hostname"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>When verifying the authenticity of the Docker Host server, provide the expected name of the server.</p>
<p>If the value is not specified in the task, the value of environment variable <aclass="reference internal"href="docsite/scenario_guide.html#envvar-DOCKER_TLS_HOSTNAME"><codeclass="xref std std-envvar docutils literal notranslate"><spanclass="pre">DOCKER_TLS_HOSTNAME</span></code></a> will be used instead. If the environment variable is not set, the default value will be used.</p>
<aclass="ansibleOptionLink"href="#parameter-validate_certs"title="Permalink to this option"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-aliases">aliases: tls_verify</span></p>
<td><divclass="ansible-option-cell"><p>Secure the connection to the API by using TLS and verifying the authenticity of the Docker host server.</p>
<p>If the value is not specified in the task, the value of environment variable <aclass="reference internal"href="docsite/scenario_guide.html#envvar-DOCKER_TLS_VERIFY"><codeclass="xref std std-envvar docutils literal notranslate"><spanclass="pre">DOCKER_TLS_VERIFY</span></code></a> will be used instead. If the environment variable is not set, the default value will be used.</p>
<td><divclass="ansible-option-cell"><p>Use <codeclass="docutils literal notranslate"><spanclass="pre">group/docker</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">group/community.docker.docker</span></code> in <codeclass="docutils literal notranslate"><spanclass="pre">module_defaults</span></code> to set defaults for this module.</p>
<td><divclass="ansible-option-cell"><p>Can run in <codeclass="docutils literal notranslate"><spanclass="pre">check_mode</span></code> and return changed status prediction without modifying target.</p>
<td><divclass="ansible-option-cell"><p>Will return details on what has changed (or possibly needs changing in <codeclass="docutils literal notranslate"><spanclass="pre">check_mode</span></code>), when in diff mode.</p>
</div></td>
</tr>
</tbody>
</table>
</section>
<sectionid="notes">
<h2><aclass="toc-backref"href="#id5"role="doc-backlink">Notes</a><aclass="headerlink"href="#notes"title="Link to this heading"></a></h2>
<divclass="admonition note">
<pclass="admonition-title">Note</p>
<ul>
<li><p>The Docker compose CLI plugin has no stable output format (see for example <aclass="reference external"href="https://github.com/docker/compose/issues/10872">https://github.com/docker/compose/issues/10872</a>),
and for the main operations also no machine friendly output format. The module tries to accomodate this with various
version-dependent behavior adjustments and with testing older and newer versions of the Docker compose CLI plugin.</p>
<p>Currently the module is tested with multiple plugin versions between 2.18.1 and 2.23.3. The exact list of plugin versions
will change over time. New releases of the Docker compose CLI plugin can break this module at any time.</p>
</li>
<li><p>Connect to the Docker daemon by providing parameters with each task or by defining environment variables. You can define <aclass="reference internal"href="docsite/scenario_guide.html#envvar-DOCKER_HOST"><codeclass="xref std std-envvar docutils literal notranslate"><spanclass="pre">DOCKER_HOST</span></code></a>, <aclass="reference internal"href="docsite/scenario_guide.html#envvar-DOCKER_TLS_HOSTNAME"><codeclass="xref std std-envvar docutils literal notranslate"><spanclass="pre">DOCKER_TLS_HOSTNAME</span></code></a>, <aclass="reference internal"href="docsite/scenario_guide.html#envvar-DOCKER_API_VERSION"><codeclass="xref std std-envvar docutils literal notranslate"><spanclass="pre">DOCKER_API_VERSION</span></code></a>, <aclass="reference internal"href="docsite/scenario_guide.html#envvar-DOCKER_CERT_PATH"><codeclass="xref std std-envvar docutils literal notranslate"><spanclass="pre">DOCKER_CERT_PATH</span></code></a>, <aclass="reference internal"href="docsite/scenario_guide.html#envvar-DOCKER_TLS"><codeclass="xref std std-envvar docutils literal notranslate"><spanclass="pre">DOCKER_TLS</span></code></a>, <aclass="reference internal"href="docsite/scenario_guide.html#envvar-DOCKER_TLS_VERIFY"><codeclass="xref std std-envvar docutils literal notranslate"><spanclass="pre">DOCKER_TLS_VERIFY</span></code></a> and <aclass="reference internal"href="docsite/scenario_guide.html#envvar-DOCKER_TIMEOUT"><codeclass="xref std std-envvar docutils literal notranslate"><spanclass="pre">DOCKER_TIMEOUT</span></code></a>. If you are using docker machine, run the script shipped with the product that sets up the environment. It will set these variables for you. See <aclass="reference external"href="https://docs.docker.com/machine/reference/env/">https://docs.docker.com/machine/reference/env/</a> for more details.</p></li>
<li><p>This module does <strong>not</strong> use the <aclass="reference external"href="https://docker-py.readthedocs.io/en/stable/">Docker SDK for Python</a> to communicate with the Docker daemon. It directly calls the Docker CLI program.</p></li>
</ul>
</div>
</section>
<sectionid="see-also">
<h2><aclass="toc-backref"href="#id6"role="doc-backlink">See Also</a><aclass="headerlink"href="#see-also"title="Link to this heading"></a></h2>
<divclass="admonition seealso">
<pclass="admonition-title">See also</p>
<dlclass="simple">
<dt><aclass="reference internal"href="docker_compose_module.html#ansible-collections-community-docker-docker-compose-module"><spanclass="std std-ref">community.docker.docker_compose</span></a></dt><dd><p>Manage multi-container Docker applications with Docker Compose V1.</p>
</dd>
</dl>
</div>
</section>
<sectionid="examples">
<h2><aclass="toc-backref"href="#id7"role="doc-backlink">Examples</a><aclass="headerlink"href="#examples"title="Link to this heading"></a></h2>
<divclass="highlight-yaml+jinja notranslate"><divclass="highlight"><pre><span></span><spanclass="c1"># Examples use the django example at https://docs.docker.com/compose/django. Follow it to create the</span>
<spanclass="c1"># flask directory</span>
<spanclass="p p-Indicator">-</span><spanclass="w"></span><spanclass="nt">name</span><spanclass="p">:</span><spanclass="w"></span><spanclass="l l-Scalar l-Scalar-Plain">Run using a project directory</span>
<spanclass="w"></span><spanclass="p p-Indicator">-</span><spanclass="w"></span><spanclass="nt">name</span><spanclass="p">:</span><spanclass="w"></span><spanclass="l l-Scalar l-Scalar-Plain">Verify that web and db services are not running</span>
<spanclass="w"></span><spanclass="p p-Indicator">-</span><spanclass="w"></span><spanclass="nt">name</span><spanclass="p">:</span><spanclass="w"></span><spanclass="l l-Scalar l-Scalar-Plain">Verify that web and db services are running</span>
<h2><aclass="toc-backref"href="#id8"role="doc-backlink">Return Values</a><aclass="headerlink"href="#return-values"title="Link to this heading"></a></h2>
<p>Common return values are documented <aclass="reference external"href="https://docs.ansible.com/ansible/devel/reference_appendices/common_return_values.html#common-return-values"title="(in Ansible vdevel)"><spanclass="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
<aclass="ansibleOptionLink"href="#return-actions"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">list</span> / <spanclass="ansible-option-elements">elements=dictionary</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>A list of actions that have been applied.</p>
<aclass="ansibleOptionLink"href="#return-actions/id"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-cell"><p>The ID of the resource that was changed.</p>
<aclass="ansibleOptionLink"href="#return-actions/status"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-cell"><p>The status change that happened.</p>
<aclass="ansibleOptionLink"href="#return-actions/what"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-cell"><p>What kind of resource was changed.</p>
<aclass="ansibleOptionLink"href="#return-containers"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">list</span> / <spanclass="ansible-option-elements">elements=dictionary</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>A list of containers associated to the service.</p>
<aclass="ansibleOptionLink"href="#return-containers/Command"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">any</span></p>
<aclass="ansibleOptionLink"href="#return-containers/CreatedAt"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-cell"><p>The timestamp when the container was created.</p>
<aclass="ansibleOptionLink"href="#return-containers/ExitCode"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">integer</span></p>
<aclass="ansibleOptionLink"href="#return-containers/Health"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">any</span></p>
</div></td>
<td><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-cell"><p>The container’s health check.</p>
<aclass="ansibleOptionLink"href="#return-containers/ID"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#return-containers/Image"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#return-containers/Labels"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">dictionary</span></p>
</div></td>
<td><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-cell"><p>Labels for this container.</p>
<aclass="ansibleOptionLink"href="#return-containers/LocalVolumes"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-cell"><p>The local volumes count.</p>
<aclass="ansibleOptionLink"href="#return-containers/Mounts"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#return-containers/Name"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#return-containers/Names"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">list</span> / <spanclass="ansible-option-elements">elements=string</span></p>
</div></td>
<td><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-cell"><p>List of names of the container.</p>
<aclass="ansibleOptionLink"href="#return-containers/Networks"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">list</span> / <spanclass="ansible-option-elements">elements=string</span></p>
</div></td>
<td><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-cell"><p>List of networks attached to this container.</p>
<aclass="ansibleOptionLink"href="#return-containers/Ports"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-cell"><p>List of port assignments as a string.</p>
<aclass="ansibleOptionLink"href="#return-containers/Publishers"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">list</span> / <spanclass="ansible-option-elements">elements=dictionary</span></p>
</div></td>
<td><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-cell"><p>List of port assigments.</p>
<aclass="ansibleOptionLink"href="#return-containers/Publishers/Protocol"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#return-containers/Publishers/PublishedPort"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">integer</span></p>
</div></td>
<td><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-cell"><p>The port that is published.</p>
<aclass="ansibleOptionLink"href="#return-containers/Publishers/TargetPort"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">integer</span></p>
</div></td>
<td><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-cell"><p>The container’s port the published port maps to.</p>
<aclass="ansibleOptionLink"href="#return-containers/Publishers/URL"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-cell"><p>Interface the port is bound to.</p>
<aclass="ansibleOptionLink"href="#return-containers/RunningFor"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-cell"><p>Amount of time the container runs.</p>
<aclass="ansibleOptionLink"href="#return-containers/Service"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-cell"><p>The name of the service.</p>
<aclass="ansibleOptionLink"href="#return-containers/Size"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#return-containers/State"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#return-containers/Status"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#return-images"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">list</span> / <spanclass="ansible-option-elements">elements=dictionary</span></p>
</div></td>
<td><divclass="ansible-option-cell"><p>A list of images associated to the service.</p>
<aclass="ansibleOptionLink"href="#return-images/ContainerName"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-cell"><p>Name of the conainer this image is used by.</p>
<aclass="ansibleOptionLink"href="#return-images/ID"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
<aclass="ansibleOptionLink"href="#return-images/Repository"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-cell"><p>The repository where this image belongs to.</p>
<aclass="ansibleOptionLink"href="#return-images/Size"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">integer</span></p>
</div></td>
<td><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-cell"><p>The image’s size in bytes.</p>
<aclass="ansibleOptionLink"href="#return-images/Tag"title="Permalink to this return value"></a><pclass="ansible-option-type-line"><spanclass="ansible-option-type">string</span></p>
</div></td>
<td><divclass="ansible-option-indent-desc"></div><divclass="ansible-option-cell"><p>The tag of the image.</p>
<linkrel="prev"title="community.docker.docker_compose_v2 module – Manage multi-container Docker applications with Docker Compose CLI plugin" href="docker_compose_v2_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
<linkrel="prev"title="community.docker.docker_compose_v2_pull module – Pull a Docker compose project" href="docker_compose_v2_pull_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
@ -82,6 +82,7 @@
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1 current"><aclass="current reference internal"href="#">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a><ul>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="../current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="../docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
@ -208,6 +209,7 @@
<li><p><aclass="reference internal"href="current_container_facts_module.html#ansible-collections-community-docker-current-container-facts-module"><spanclass="std std-ref">current_container_facts module</span></a>– Return facts about whether the module runs in a container</p></li>
<li><p><aclass="reference internal"href="docker_container_copy_into_module.html#ansible-collections-community-docker-docker-container-copy-into-module"><spanclass="std std-ref">docker_container_copy_into module</span></a>– Copy a file into a Docker container</p></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="current_container_facts_module.html">community.docker.current_container_facts module – Return facts about whether the module runs in a container</a></li>
<liclass="toctree-l1"><aclass="reference internal"href="docker_container_copy_into_module.html">community.docker.docker_container_copy_into module – Copy a file into a Docker container</a></li>
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
felixfontein