Parameter |
Choices/Defaults |
Comments |
|---|---|---|
|
allow_downgrade
(added in 2.4) |
|
Specify if the named package and version is allowed to downgrade a maybe already installed higher version of that package. Note that setting allow_downgrade=True can make this module behave in a non-idempotent way. The task could end up with a set of packages that does not match the complete list of specified packages to install (because dependencies between the downgraded package and others can cause changes to the packages which were in the earlier transaction).
|
|
conf_file
|
|
The remote yum configuration file to use for the transaction.
|
|
disable_gpg_check
|
|
Whether to disable the GPG checking of signatures of packages being installed. Has an effect only if state is present or latest.
|
|
disable_plugin
(added in 2.5) |
|
Plugin name to disable for the install/update operation. The disabled plugins will not persist beyond the transaction.
|
|
disablerepo
|
|
Repoid of repositories to disable for the install/update operation. These repos will not persist beyond the transaction. When specifying multiple repos, separate them with a ",".
|
|
enable_plugin
(added in 2.5) |
|
Plugin name to enable for the install/update operation. The enabled plugin will not persist beyond the transaction.
|
|
enablerepo
|
|
Repoid of repositories to enable for the install/update operation. These repos will not persist beyond the transaction. When specifying multiple repos, separate them with a ",".
|
|
exclude
(added in 2.0) |
|
Package name(s) to exclude when state=present, or latest
|
|
installroot
(added in 2.3) |
Default:
/
|
Specifies an alternative installroot, relative to which all packages will be installed.
|
|
list
|
|
Package name to run the equivalent of yum list <package> against. In addition to listing packages, use can also list the following:
installed, updates, available and repos. |
|
name
required |
|
A package name or package specifier with version, like
name-1.0.If a previous version is specified, the task also needs to turn
allow_downgrade on. See the allow_downgrade documentation for caveats with downgrading packages.When using state=latest, this can be '*' which means run
yum -y update.You can also pass a url or a local path to a rpm file (using state=present). To operate on several packages this can accept a comma separated list of packages or (as of 2.0) a list of packages.
aliases: pkg |
|
security
(added in 2.4) |
|
If set to
yes, and state=latest then only installs updates that have been marked security related. |
|
skip_broken
(added in 2.3) |
|
Resolve depsolve problems by removing packages that are causing problems from the trans‐ action.
|
|
state
|
|
Whether to install (
present or installed, latest), or remove (absent or removed) a package.present and installed will simply ensure that a desired package is installed.latest will update the specified package if it's not of the latest available version.absent and removed will remove the specified package. |
|
update_cache
(added in 1.9) |
|
Force yum to check if cache is out of date and redownload if needed. Has an effect only if state is present or latest.
aliases: expire-cache |
|
update_only
(added in 2.5) |
|
When using latest, only update installed packages. Do not install packages.
Has an effect only if state is latest
|
|
validate_certs
(added in 2.1) |
|
This only applies if using a https url as the source of the rpm. e.g. for localinstall. If set to
no, the SSL certificates will not be validated.This should only set to
no used on personally controlled sites using self-signed certificates as it avoids verifying the source site.Prior to 2.1 the code worked as if this was set to
yes. |
Note
- name: install the latest version of Apache
yum:
name: httpd
state: latest
- name: ensure a list of packages installed
yum:
name: "{{ packages }}"
vars:
packages:
- httpd
- httpd-tools
- name: remove the Apache package
yum:
name: httpd
state: absent
- name: install the latest version of Apache from the testing repo
yum:
name: httpd
enablerepo: testing
state: present
- name: install one specific version of Apache
yum:
name: httpd-2.2.29-1.4.amzn1
state: present
- name: upgrade all packages
yum:
name: '*'
state: latest
- name: upgrade all packages, excluding kernel & foo related packages
yum:
name: '*'
state: latest
exclude: kernel*,foo*
- name: install the nginx rpm from a remote repo
yum:
name: http://nginx.org/packages/centos/6/noarch/RPMS/nginx-release-centos-6-0.el6.ngx.noarch.rpm
state: present
- name: install nginx rpm from a local file
yum:
name: /usr/local/src/nginx-release-centos-6-0.el6.ngx.noarch.rpm
state: present
- name: install the 'Development tools' package group
yum:
name: "@Development tools"
state: present
- name: install the 'Gnome desktop' environment group
yum:
name: "@^gnome-desktop-environment"
state: present
- name: List ansible packages and register result to print with debug later.
yum:
list: ansible
register: result
- name: Install package with multiple repos enabled
yum:
name: sos
enablerepo: "epel,ol7_latest"
- name: Install package with multiple repos disabled
yum:
name: sos
disablerepo: "epel,ol7_latest"
This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.
For more information about Red Hat’s support of this module, please refer to this Knowledge Base article
Hint
If you notice any issues in this documentation you can edit this document to improve it.