W3cubDocs

/Ansible 2.11

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

Note

This plugin is part of the community.general collection (version 2.0.1).

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

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

New in version 2.0.0: of community.general

Synopsis

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

Parameters

Parameter Choices/Defaults Comments
name
list / elements=string / required
Name of overlay package to install or remove.

aliases: pkg
state
string
    Choices:
  • absent
  • present ←
State of the overlay package.
present simply ensures that a desired package is installed.
absent removes the specified package.

Notes

Note

  • Does not support check_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

Return Values

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

Key Returned Description
action
string
always
Action performed.

Sample:
install
changed
boolean
always
State changes.

Sample:
True
cmd
string
always
Full command used for performed action.

Sample:
rpm-ostree uninstall --allow-inactive --idempotent --unchanged-exit-77 nfs-utils
packages
list / elements=string
always
A list of packages specified.

Sample:
['nfs-utils']
rc
integer
always
Return code of rpm-ostree command.
stderr
string
always
Stderr of rpm-ostree command.
stdout
string
always
Stdout of rpm-ostree command.

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


Authors

  • Dusty Mabe (@dustymabe)
  • Abhijeet Kasurde (@Akasurde)

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