community.general.rpm_ostree_pkg module – Install or uninstall overlay additional packages

Note

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

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.

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

New in community.general 2.0.0

Synopsis

  • Install or uninstall overlay additional packages using rpm-ostree command.

Parameters

Parameter

Comments

apply_live

boolean

added in community.general 10.1.0

Adds the options --apply-live when state=present.

Option is ignored when state=absent.

For more information, please see https://coreos.github.io/rpm-ostree/apply-live/.

Choices:

  • false ← (default)

  • true

name

aliases: pkg

list / elements=string / required

Name of overlay package to install or remove.

state

string

State of the overlay package.

present simply ensures that a desired package is installed.

absent removes the specified package.

Choices:

  • "absent"

  • "present" ← (default)

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

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

Examples

- name: Install overlay package
  community.general.rpm_ostree_pkg:
    name: nfs-utils
    state: present

- name: Remove overlay package
  community.general.rpm_ostree_pkg:
    name: nfs-utils
    state: absent

- name: Apply the overlay package live
  community.general.rpm_ostree_pkg:
    name: nfs-utils
    state: present
    apply_live: true

# In case a different transaction is currently running the module would fail.
# Adding a delay can help mitigate this problem:
- name: Install overlay package
  community.general.rpm_ostree_pkg:
    name: nfs-utils
    state: present
  register: rpm_ostree_pkg
  until: rpm_ostree_pkg is not failed
  retries: 10
  delay: 30

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

action

string

Action performed.

Returned: always

Sample: "install"

cmd

string

Full command used for performed action.

Returned: always

Sample: "rpm-ostree uninstall --allow-inactive --idempotent --unchanged-exit-77 nfs-utils"

needs_reboot

boolean

added in community.general 10.1.0

Determine if machine needs a reboot to apply current changes.

Returned: success

Sample: true

packages

list / elements=string

A list of packages specified.

Returned: always

Sample: ["nfs-utils"]

Authors

  • Dusty Mabe (@dustymabe)

  • Abhijeet Kasurde (@Akasurde)