Author: | Matthew Williams |
---|
parameter | required | default | choices | comments |
---|---|---|---|---|
cache_valid_time | no | If update_cache is specified and the last run is less or equal than cache_valid_time seconds ago, the update_cache gets skipped. |
||
deb | no | Path to a .deb package on the remote machine. (added in Ansible 1.6) | ||
default_release | no | Corresponds to the -t option for apt and sets pin priorities |
||
dpkg_options | no | force-confdef,force-confold | Add dpkg options to apt command. Defaults to '-o "Dpkg::Options::=--force-confdef" -o "Dpkg::Options::=--force-confold"'Options should be supplied as comma separated list | |
force | no | no |
|
If yes , force installs/removes. |
install_recommends | no | True |
|
Corresponds to the --no-install-recommends option for apt. Default behavior (yes ) replicates apt's default behavior; no does not install recommended packages. Suggested packages are never installed. |
name | no | A package name, like foo , or package specifier with version, like foo=1.0 . Wildcards (fnmatch) like apt* are also supported. |
||
purge | no |
|
Will force purging of configuration files if the module state is set to absent. | |
state | no | present |
|
Indicates the desired package state. latest ensures that the latest version is installed. |
update_cache | no |
|
Run the equivalent of apt-get update before the operation. Can be run as part of the package installation or as a separate step. |
|
upgrade | no | yes |
|
If yes or safe, performs an aptitude safe-upgrade.If full, performs an aptitude full-upgrade.If dist, performs an apt-get dist-upgrade.Note: This does not upgrade a specific package, use state=latest for that. (added in Ansible 1.1) |
Note
Requires python-apt
Note
Requires aptitude
# Update repositories cache and install "foo" package
- apt: name=foo update_cache=yes
# Remove "foo" package
- apt: name=foo state=absent
# Install the package "foo"
- apt: name=foo state=present
# Install the version '1.00' of package "foo"
- apt: name=foo=1.00 state=present
# Update the repository cache and update package "nginx" to latest version using default release squeeze-backport
- apt: name=nginx state=latest default_release=squeeze-backports update_cache=yes
# Install latest version of "openjdk-6-jdk" ignoring "install-recommends"
- apt: name=openjdk-6-jdk state=latest install_recommends=no
# Update all packages to the latest version
- apt: upgrade=dist
# Run the equivalent of "apt-get update" as a separate step
- apt: update_cache=yes
# Only run "update_cache=yes" if the last one is more than 3600 seconds ago
- apt: update_cache=yes cache_valid_time=3600
# Pass options to dpkg on run
- apt: upgrade=dist update_cache=yes dpkg_options='force-confold,force-confdef'
# Install a .deb package
- apt: deb=/tmp/mypackage.deb
Note
Three of the upgrade modes (full, safe and its alias yes) require aptitude, otherwise apt-get suffices.