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

Note

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

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

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

Will return 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

# 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
  dealy: 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"

changed

boolean

State changes.

Returned: always

Sample: true

cmd

string

Full command used for performed action.

Returned: always

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

packages

list / elements=string

A list of packages specified.

Returned: always

Sample: ["nfs-utils"]

rc

integer

Return code of rpm-ostree command.

Returned: always

Sample: 0

stderr

string

Stderr of rpm-ostree command.

Returned: always

Sample: ""

stdout

string

Stdout of rpm-ostree command.

Returned: always

Sample: "Staging deployment...done\\n..."

Authors

  • Dusty Mabe (@dustymabe)

  • Abhijeet Kasurde (@Akasurde)