New in version 2.2.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
backend (added in 2.4) |
| Define the backend where the image is pulled. |
name required | Name of the container image. | |
started bool |
| Start or Stop the container. |
state |
| 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. |
Note
atomic
command.- name: Execute the run command on rsyslog container image (atomic run rhel7/rsyslog) atomic_image: name: rhel7/rsyslog state: latest - name: Pull busybox to the OSTree backend atomic_image: name: busybox state: latest backend: ostree
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
msg string | always | The command standard output Sample: [{"u'Using default tag": "latest ...'"}] |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/atomic_image_module.html