community.general.atomic_host module – Manage the atomic host platform

Note

This module is part of the community.general collection (version 10.0.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general. You need further requirements to be able to use this module, see Requirements for details.

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

Parameters

Parameter

Comments

revision

aliases: version

string

The version number of the atomic host to be deployed.

Providing latest will upgrade to the latest available version.

Default: "latest"

Attributes

Attribute

Support

Description

check_mode

Support: none

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

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

Description

msg

string

The command standard output

Returned: always

Sample: "Already on latest"

Authors

  • Saravanan KR (@krsacme)