New in version 2.2.
- atomic
- python >= 2.6
parameter | required | default | choices | comments |
---|---|---|---|---|
name |
yes | Name of the container image | ||
started |
no | True |
|
Start or Stop the container |
state |
no | 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. |
# Execute the run command on rsyslog container image (atomic run rhel7/rsyslog) - atomic_image: name: rhel7/rsyslog state: latest
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 ...'"}] |
Note
atomic
commandThis module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is community maintained without core committer oversight.
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.