New in version 2.3.
parameter | required | default | choices | comments |
---|---|---|---|---|
name | no | Name of the package to install, upgrade, or remove. | ||
recurse | no |
| When removing a package, also remove its dependencies, provided that they are not required by other packages and were not explicitly installed by a user. | |
state | no | present |
| Desired state of the package. |
update_cache | no | True |
| Whether or not to refresh the master package lists. This can be run as part of a package installation or as a separate step. |
upgrade | no |
| Whether or not to upgrade whole system |
# Install package foo - xbps: name=foo state=present # Upgrade package foo - xbps: name=foo state=latest update_cache=yes # Remove packages foo and bar - xbps: name=foo,bar state=absent # Recursively remove package foo - xbps: name=foo state=absent recurse=yes # Update package cache - xbps: update_cache=yes # Upgrade packages - xbps: upgrade=yes
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
msg | Message about results | success | string | System Upgraded |
packages | Packages that are affected/would be affected | success | list | ['ansible'] |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/xbps_module.html