You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

atomic_image - Manage the container images on the atomic host platform¶

New in version 2.2.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
Notes
- Status

Synopsis ¶

Manage the container images on the atomic host platform
Allows to execute the commands specified by the RUN label in the container image when present

Requirements (on host that executes module)¶

atomic

python >= 2.6

Options ¶

parameter	required	default	choices	comments
backend (added in 2.4)	no	None	docker ostree	Define the backend where the image is pulled.
name	yes			Name of the container image
started	no	True	yes no	Start or Stop the container
state	no	latest	present absent latest	The state of the container image. The state `latest` will ensure container image is upgraded to the latest version and forcefully restart container, if running.

Examples ¶

# Execute the run command on rsyslog container image (atomic run rhel7/rsyslog)
- atomic_image:
    name: rhel7/rsyslog
    state: latest

# Pull busybox to the OSTree backend
- atomic_image:
    name: busybox
    state: latest
    backend: ostree

Return Values ¶

Common return values are documented here Return Values, the following are the fields unique to this module:

name	description	returned	type	sample
msg	The command standard output	always	string	[{"u'Using default tag": "latest ...'"}]

Notes ¶

Note

Host should support atomic command

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.