W3cubDocs

/Ansible 2.10

community.general.atomic_host – Manage the atomic host platform

Note

This plugin is part of the community.general collection.

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.atomic_host.

Synopsis

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

Requirements

The below requirements are needed on the host that executes this module.

  • atomic
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
revision
string
Default:
"latest"
The version number of the atomic host to be deployed.
Providing latest will upgrade to the latest available version.

aliases: version

Notes

Note

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

Examples

- name: Upgrade the atomic host platform to the latest version (atomic host upgrade)
  community.general.atomic_host:
    revision: latest

- name: Deploy a specific revision as the atomic host (atomic host deploy 23.130)
  community.general.atomic_host:
    revision: 23.130

Return Values

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


Authors

  • Saravanan KR (@krsacme)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/atomic_host_module.html