W3cubDocs

/Ansible

atomic_host - Manage the atomic host platform

New in version 2.2.

Synopsis

  • Manage the atomic host platform
  • Rebooting of Atomic host platform should be done outside this module

Requirements (on host that executes module)

  • atomic
  • python >= 2.6

Options

parameter required default choices comments
revision
 no latest
The version number of the atomic host to be deployed. Providing latest will upgrade to the latest available version.
aliases: version

Examples

# Upgrade the atomic host platform to the latest version (atomic host upgrade)
- atomic_host:
    revision: latest

# Deploy a specific revision as the atomic host (atomic host deploy 23.130)
- atomic_host:
    revision: 23.130

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 Already on latest

Notes

Note

  • Host should be an atomic platform (verified by existence of ‘/run/ostree-booted’ file)

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.

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