New in version 2.3.
Parameter |
Choices/Defaults |
Comments |
|---|---|---|
|
name
|
|
Name of the package to install, upgrade, or remove.
|
|
recurse
|
|
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
|
|
Desired state of the package.
|
|
update_cache
|
|
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
|
|
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, the following are the fields unique to this module:
Key |
Returned |
Description |
|---|---|---|
|
msg
string
|
success |
Message about results
Sample:
System Upgraded
|
|
packages
list
|
success |
Packages that are affected/would be affected
Sample:
['ansible']
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.