W3cubDocs

/Ansible

atomic_image - Manage the container images on the atomic host platform

New in version 2.2.

Synopsis

Manage the container images on the atomic host platform Allows to execute the commands on the container images

Requirements (on host that executes module)

  • atomic
  • python >= 2.6

Options

parameter required default choices comments
name
yes
Name of the container image
started
no True
  • yes
  • no
Start or Stop the continer
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

Return Values

Common return values are documented here Common 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 be support `atomic` command

This is an Extras Module

For more information on what this means please read Extras Modules

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

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/atomic_image_module.html