Skip to content

yum_repository

Collection Note

This module is part of the ansible.builtin collection. To install the collection, use:

ansible-galaxy collection install ansible.builtin
Added in version 2.1.

Synopsis

  • Add or remove YUM repositories in RPM-based Linux distributions.
  • If you wish to update an existing repository definition use M(community.general.ini_file) instead.

Parameters

Parameter Defaults / Choices Comments
async
bool		 If set to V(true) Yum will download packages and metadata from this repo in parallel, if possible.
In ansible-core 2.11, 2.12, and 2.13 the default value is V(true).
This option has been removed in RHEL 8. If you're using one of the versions listed above, you can set this option to V(null) to avoid passing an unknown configuration option.
This parameter is deprecated as it has been removed on systems supported by ansible-core and will be removed in ansible-core 2.22.
attributes
str		 The attributes the resulting filesystem object should have.
To get supported flags look at the man page for C(chattr) on the target system.
This string should contain the attributes in the same order as the one displayed by C(lsattr).
The C(=) operator is assumed as default, otherwise C(+) or C(-) operators need to be included in the string.
Version Added: 2.3
bandwidth
str		 Maximum available network bandwidth in bytes/second. Used with the O(throttle) option.
If O(throttle) is a percentage and bandwidth is V(0) then bandwidth throttling will be disabled. If O(throttle) is expressed as a data rate (bytes/sec) then this option is ignored. Default is V(0) (no bandwidth throttling).
baseurl
list / elements=str		 URL to the directory where the yum repository's 'repodata' directory lives.
It can also be a list of multiple URLs.
This, the O(metalink) or O(mirrorlist) parameters are required if O(state) is set to V(present).
cost
str		 Relative cost of accessing this repository. Useful for weighing one repo's packages as greater/less than any other.
countme
bool		 Whether a special flag should be added to a randomly chosen metalink/mirrorlist query each week. This allows the repository owner to estimate the number of systems consuming it.
Version Added: 2.18
deltarpm_metadata_percentage
str		 When the relative size of deltarpm metadata vs pkgs is larger than this, deltarpm metadata is not downloaded from the repo. Note that you can give values over V(100), so V(200) means that the metadata is required to be half the size of the packages. Use V(0) to turn off this check, and always download metadata.
This parameter is deprecated as it has no effect with dnf as an underlying package manager and will be removed in ansible-core 2.22.
deltarpm_percentage
str		 When the relative size of delta vs pkg is larger than this, delta is not used. Use V(0) to turn off delta rpm processing. Local repositories (with file://O(baseurl)) have delta rpms turned off by default.
description
str		 A human-readable string describing the repository. This option corresponds to the C(name) property in the repo file.
This parameter is only required if O(state=present).
enabled
bool		 This tells yum whether or not use this repository.
Yum default value is V(true).
enablegroups
bool		 Determines whether yum will allow the use of package groups for this repository.
Yum default value is V(true).
exclude
list / elements=str		 List of packages to exclude from updates or installs. This should be a space separated list. Shell globs using wildcards (for example V(*) and V(?)) are allowed.
The list can also be a regular YAML array.
O(excludepkgs) alias was added in ansible-core 2.18.
failovermethod
str		 Choices: roundrobin, priority V(roundrobin) randomly selects a URL out of the list of URLs to start with and proceeds through each of them as it encounters a failure contacting the host.
V(priority) starts from the first O(baseurl) listed and reads through them sequentially.
file
str		 File name without the C(.repo) extension to save the repo in. Defaults to the value of O(name).
gpgcakey
str		 A URL pointing to the ASCII-armored CA key file for the repository.
This parameter is deprecated as it has no effect with dnf as an underlying package manager and will be removed in ansible-core 2.22.
gpgcheck
bool		 Tells yum whether or not it should perform a GPG signature check on packages.
No default setting. If the value is not set, the system setting from C(/etc/yum.conf) or system default of V(false) will be used.
gpgkey
list / elements=str		 A URL pointing to the ASCII-armored GPG key file for the repository.
It can also be a list of multiple URLs.
group
str		 Name of the group that should own the filesystem object, as would be fed to C(chown).
When left unspecified, it uses the current group of the current user unless you are root, in which case it can preserve the previous ownership.
http_caching
str		 Choices: all, packages, none Determines how upstream HTTP caches are instructed to handle any HTTP downloads that Yum does.
V(all) means that all HTTP downloads should be cached.
V(packages) means that only RPM package downloads should be cached (but not repository metadata downloads).
V(none) means that no HTTP downloads should be cached.
This parameter is deprecated as it has no effect with dnf as an underlying package manager and will be removed in ansible-core 2.22.
include
str		 Include external configuration file. Both, local path and URL is supported. Configuration file will be inserted at the position of the C(include=) line. Included files may contain further include lines. Yum will abort with an error if an inclusion loop is detected.
includepkgs
list / elements=str		 List of packages you want to only use from a repository. This should be a space separated list. Shell globs using wildcards (for example V(*) and V(?)) are allowed. Substitution variables (for example V($releasever)) are honored here.
The list can also be a regular YAML array.
ip_resolve
str		 Choices: 4, 6, IPv4, IPv6, whatever Determines how yum resolves host names.
V(4) or V(IPv4) - resolve to IPv4 addresses only.
V(6) or V(IPv6) - resolve to IPv6 addresses only.
keepalive
bool		 This tells yum whether or not HTTP/1.1 keepalive should be used with this repository. This can improve transfer speeds by using one connection when downloading multiple files from a repository.
This parameter is deprecated as it has no effect with dnf as an underlying package manager and will be removed in ansible-core 2.22.
keepcache
str		 Choices: 0, 1 Either V(1) or V(0). Determines whether or not yum keeps the cache of headers and packages after successful installation.
This parameter is deprecated as it is only valid in the main configuration and will be removed in ansible-core 2.20.
metadata_expire
str		 Time (in seconds) after which the metadata will expire.
Default value is 6 hours.
metadata_expire_filter
str		 Choices: never, read-only:past, read-only:present, read-only:future Filter the O(metadata_expire) time, allowing a trade of speed for accuracy if a command doesn't require it. Each yum command can specify that it requires a certain level of timeliness quality from the remote repos. from "I'm about to install/upgrade, so this better be current" to "Anything that's available is good enough".
V(never) - Nothing is filtered, always obey O(metadata_expire).
V(read-only:past) - Commands that only care about past information are filtered from metadata expiring. Eg. C(yum history) info (if history needs to lookup anything about a previous transaction, then by definition the remote package was available in the past).
V(read-only:present) - Commands that are balanced between past and future. Eg. C(yum list yum).
V(read-only:future) - Commands that are likely to result in running other commands which will require the latest metadata. Eg. C(yum check-update).
Note that this option does not override C(yum clean expire-cache).
This parameter is deprecated as it has no effect with dnf as an underlying package manager and will be removed in ansible-core 2.22.
metalink
str		 Specifies a URL to a metalink file for the repomd.xml, a list of mirrors for the entire repository are generated by converting the mirrors for the repomd.xml file to a O(baseurl).
This, the O(baseurl) or O(mirrorlist) parameters are required if O(state) is set to V(present).
mirrorlist
str		 Specifies a URL to a file containing a list of baseurls.
This, the O(baseurl) or O(metalink) parameters are required if O(state) is set to V(present).
mirrorlist_expire
str		 Time (in seconds) after which the mirrorlist locally cached will expire.
Default value is 6 hours.
This parameter is deprecated as it has no effect with dnf as an underlying package manager and will be removed in ansible-core 2.22.
mode
raw		 The permissions the resulting filesystem object should have.
For those used to C(/usr/bin/chmod) remember that modes are actually octal numbers. You must give Ansible enough information to parse them correctly. For consistent results, quote octal numbers (for example, V('644') or V('1777')) so Ansible receives a string and can do its own conversion from string into number. Adding a leading zero (for example, V(0755)) works sometimes, but can fail in loops and some other circumstances.
Giving Ansible a number without following either of these rules will end up with a decimal number which will have unexpected results.
As of Ansible 1.8, the mode may be specified as a symbolic mode (for example, V(u+rwx) or V(u=rw,g=r,o=r)).
If O(mode) is not specified and the destination filesystem object B(does not) exist, the default C(umask) on the system will be used when setting the mode for the newly created filesystem object.
If O(mode) is not specified and the destination filesystem object B(does) exist, the mode of the existing filesystem object will be used.
Specifying O(mode) is the best way to ensure filesystem objects are created with the correct permissions. See CVE-2020-1736 for further details.
module_hotfixes
bool		 Disable module RPM filtering and make all RPMs from the repository available. The default is V(null).
Version Added: 2.11
name
str
required		 Unique repository ID. This option builds the section name of the repository in the repo file.
This parameter is only required if O(state) is set to V(present) or V(absent).
owner
str		 Name of the user that should own the filesystem object, as would be fed to C(chown).
When left unspecified, it uses the current user unless you are root, in which case it can preserve the previous ownership.
Specifying a numeric username will be assumed to be a user ID and not a username. Avoid numeric usernames to avoid this confusion.
password
str		 Password to use with the username for basic authentication.
priority
str		 Enforce ordered protection of repositories. The value is an integer from 1 to 99.
This option only works if the YUM Priorities plugin is installed.
protect
bool		 Protect packages from updates from other repositories.
This parameter is deprecated as it has no effect with dnf as an underlying package manager and will be removed in ansible-core 2.22.
proxy
str		 URL to the proxy server that yum should use. Set to V(_none_) to disable the global proxy setting.
proxy_password
str		 Password for this proxy.
proxy_username
str		 Username to use for proxy.
repo_gpgcheck
bool		 This tells yum whether or not it should perform a GPG signature check on the repodata from this repository.
reposdir
path		 Default: /etc/yum.repos.d
 Directory where the C(.repo) files will be stored.
retries
str		 Set the number of times any attempt to retrieve a file should retry before returning an error. Setting this to V(0) makes yum try forever.
s3_enabled
bool		 Enables support for S3 repositories.
This option only works if the YUM S3 plugin is installed.
selevel
str		 The level part of the SELinux filesystem object context.
This is the MLS/MCS attribute, sometimes known as the C(range).
When set to V(_default), it will use the C(level) portion of the policy if available.
serole
str		 The role part of the SELinux filesystem object context.
When set to V(_default), it will use the C(role) portion of the policy if available.
setype
str		 The type part of the SELinux filesystem object context.
When set to V(_default), it will use the C(type) portion of the policy if available.
seuser
str		 The user part of the SELinux filesystem object context.
By default it uses the V(system) policy, where applicable.
When set to V(_default), it will use the C(user) portion of the policy if available.
skip_if_unavailable
bool		 If set to V(true) yum will continue running if this repository cannot be contacted for any reason. This should be set carefully as all repos are consulted for any given command.
ssl_check_cert_permissions
bool		 Whether yum should check the permissions on the paths for the certificates on the repository (both remote and local).
If we can't read any of the files then yum will force O(skip_if_unavailable) to be V(true). This is most useful for non-root processes which use yum on repos that have client cert files which are readable only by root.
This parameter is deprecated as it has no effect with dnf as an underlying package manager and will be removed in ansible-core 2.22.
sslcacert
str		 Path to the directory containing the databases of the certificate authorities yum should use to verify SSL certificates.
sslclientcert
str		 Path to the SSL client certificate yum should use to connect to repos/remote sites.
sslclientkey
str		 Path to the SSL client key yum should use to connect to repos/remote sites.
sslverify
bool		 Defines whether yum should verify SSL certificates/hosts at all.
state
str		 Default: present
Choices: absent, present		 State of the repo file.
throttle
str		 Enable bandwidth throttling for downloads.
This option can be expressed as a absolute data rate in bytes/sec. An SI prefix (k, M or G) may be appended to the bandwidth value.
timeout
str		 Number of seconds to wait for a connection before timing out.
ui_repoid_vars
str		 When a repository id is displayed, append these yum variables to the string if they are used in the O(baseurl)/etc. Variables are appended in the order listed (and found).
This parameter is deprecated as it has no effect with dnf as an underlying package manager and will be removed in ansible-core 2.22.
unsafe_writes
bool		 Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target filesystem object.
By default this module uses atomic operations to prevent data corruption or inconsistent reads from the target filesystem objects, but sometimes systems are configured or just broken in ways that prevent this. One example is docker mounted filesystem objects, which cannot be updated atomically from inside the container and can only be written in an unsafe manner.
This option allows Ansible to fall back to unsafe methods of updating filesystem objects when atomic operations fail (however, it doesn't force Ansible to perform unsafe writes).
IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption.
Version Added: 2.2
username
str		 Username to use for basic authentication to a repo or really any url.

Notes

Note

  • All comments will be removed if modifying an existing repo file.
  • Section order is preserved in an existing repo file.
  • Parameters in a section are ordered alphabetically in an existing repo file.
  • The repo file will be automatically deleted if it contains no repository.
  • When removing a repository, beware that the metadata cache may still remain on disk until you run C(yum clean all). Use a notification handler for this.
  • The O(ignore:params) parameter was removed in Ansible 2.5 due to circumventing Ansible's parameter handling

Examples

- name: Add repository
  ansible.builtin.yum_repository:
    name: epel
    description: EPEL YUM repo
    baseurl: https://download.fedoraproject.org/pub/epel/$releasever/$basearch/

- name: Add multiple repositories into the same file (1/2)
  ansible.builtin.yum_repository:
    name: epel
    description: EPEL YUM repo
    file: external_repos
    baseurl: https://download.fedoraproject.org/pub/epel/$releasever/$basearch/
    gpgcheck: no

- name: Add multiple repositories into the same file (2/2)
  ansible.builtin.yum_repository:
    name: rpmforge
    description: RPMforge YUM repo
    file: external_repos
    baseurl: http://apt.sw.be/redhat/el7/en/$basearch/rpmforge
    mirrorlist: http://mirrorlist.repoforge.org/el7/mirrors-rpmforge
    enabled: no

# Handler showing how to clean yum metadata cache
- name: yum-clean-metadata
  ansible.builtin.command: yum clean metadata

# Example removing a repository and cleaning up metadata cache
- name: Remove repository (and clean up left-over metadata)
  ansible.builtin.yum_repository:
    name: epel
    state: absent
  notify: yum-clean-metadata

- name: Remove repository from a specific repo file
  ansible.builtin.yum_repository:
    name: epel
    file: external_repos
    state: absent

Return Values

Key Data Type Description Returned
repo str repository name success
state str state of the target, after execution success

Authors

  • Jiri Tyr (@jtyr)