Resource Type: yumrepo

Defined in:

lib/puppet/type/yumrepo.rb

Providers:

inifile

Summary

The client-side description of a yum repository.

Overview

Repository configurations are found by parsing ‘/etc/yum.conf` and the files indicated by the `reposdir` option in that file (see `yum.conf(5)` for details).

Most parameters are identical to the ones documented in the ‘yum.conf(5)` man page.

Continuation lines that yum supports (for the ‘baseurl`, for example) are not supported. This type does not attempt to read or verify the existence of files listed in the `include` attribute.“

Properties

• assumeyes

  Determines if yum prompts for confirmation of critical actions.

  Supported values:

  • YUM_BOOLEAN
  • absent
• bandwidth

  Use to specify the maximum available network bandwidth in bytes/second. Used with the ‘throttle` option. If `throttle` is a percentage and `bandwidth` is `0` then bandwidth throttling will be disabled. If `throttle` is expressed as a data rate then this option is ignored.n

  Supported values:

  • %r{^\d+[kMG]?$}
  • absent
• baseurl

  The URL for this repository.

  Supported values:

  • %r{.*}
  • absent
• cost

  Cost of this repository.

  Supported values:

  • %r{^\d+$}
  • absent
• deltarpm_metadata_percentage

  Percentage value that determines when to download deltarpm metadata. When the deltarpm metadata is larger than this percentage value of the package, deltarpm metadata is not downloaded.

  Supported values:

  • %r{^\d+$}
  • absent
• deltarpm_percentage

  Percentage value that determines when to use deltas for this repository. When the delta is larger than this percentage value of the package, the delta is not used.

  Supported values:

  • %r{^\d+$}
  • absent
• descr

  A human-readable description of the repository. This corresponds to the name parameter in ‘yum.conf(5)`.

  Supported values:

  • %r{.*}
  • absent
• enabled

  Whether this repository is enabled.

  Supported values:

  • YUM_BOOLEAN
  • absent
• enablegroups

  Whether yum will allow the use of package groups for this repository.

  Supported values:

  • YUM_BOOLEAN
  • absent
• ensure (defaults to: present)

  The basic property that the resource should be in.

  Supported values:

  • present
  • absent
• exclude

  The string of package names or shell globs separated by spaces to exclude. Packages that match the package name given or shell globs will never be considered in updates or installs for this repo.

  Supported values:

  • %r{.*}
  • absent
• failovermethod

  The failover method for this repository; should be either ‘roundrobin` or `priority`.

  Supported values:

  • %r{^roundrobin|priority$}
  • absent
• gpgcakey

  The URL for the GPG CA key for this repository.

  Supported values:

  • %r{.*}
  • absent
• gpgcheck

  Whether to check the GPG signature on packages installed from this repository.

  Supported values:

  • YUM_BOOLEAN
  • absent
• gpgkey

  The URL for the GPG key with which packages from this repository are signed.

  Supported values:

  • %r{.*}
  • absent
• http_caching

  What to cache from this repository.

  Supported values:

  • %r{^(packages|all|none)$}
  • absent
• include

  The URL of a remote file containing additional yum configuration settings. Puppet does not check for this file’s existence or validity.

  Supported values:

  • %r{.*}
  • absent
• includepkgs

  The string of package names or shell globs separated by spaces to include. If this is set, only packages matching one of the package names or shell globs will be considered for update or install from this repository.

  Supported values:

  • %r{.*}
  • absent
• keepalive

  Whether HTTP/1.1 keepalive should be used with this repository.

  Supported values:

  • YUM_BOOLEAN
  • absent
• metadata_expire

  Number of seconds after which the metadata will expire.

  Supported values:

  • %r{^([0-9]+[dhm]?|never)$}
  • absent
• metalink

  Metalink for mirrors.

  Supported values:

  • %r{.*}
  • absent
• minrate

  Sets the low speed threshold in bytes per second. If the server is sending data slower than this for at least ‘timeout` seconds, Yum aborts the connection. The default is `1000`.

  Supported values:

  • %r{^\d+$}
  • absent
• mirrorlist

  The URL that holds the list of mirrors for this repository.

  Supported values:

  • %r{.*}
  • absent
• mirrorlist_expire

  Time (in seconds) after which the mirrorlist locally cached will expire.n

  Supported values:

  • %r{^[0-9]+$}
  • absent
• module_hotfixes

  Whether packages from this repo can be installed into modules.

  Supported values:

  • YUM_BOOLEAN
  • absent
• password

  Password to use with the username for basic authentication.

  Supported values:

  • %r{.*}
  • absent
• payload_gpgcheck

  Whether to check the GPG signature of the packages payload.

  Supported values:

  • YUM_BOOLEAN
  • absent
• priority

  Priority of this repository. Can be any integer value (including negative). Requires that the ‘priorities` plugin is installed and enabled.

  Supported values:

  • %r{^-?\d+$}
  • absent
• protect

  Enable or disable protection for this repository. Requires that the ‘protectbase` plugin is installed and enabled.

  Supported values:

  • YUM_BOOLEAN
  • absent
• proxy

  URL of a proxy server that Yum should use when accessing this repository. This attribute can also be set to ‘none’ (or ” for EL >= 8 only), which will make Yum bypass any global proxy settings when accessing this repository.

  Supported values:

  • %r{.*}
  • absent
• proxy_password

  Password for this proxy.

  Supported values:

  • %r{.*}
  • absent
• proxy_username

  Username for this proxy.

  Supported values:

  • %r{.*}
  • absent
• repo_gpgcheck

  Whether to check the GPG signature on repodata.

  Supported values:

  • YUM_BOOLEAN
  • absent
• retries

  Set the number of times any attempt to retrieve a file should

  retry before returning an error. Setting this to `0` makes yum
  

  try forever.n

  Supported values:

  • %r{^[0-9]+$}
  • absent
• s3_enabled

  Access the repository via S3.

  Supported values:

  • YUM_BOOLEAN
  • absent
• skip_if_unavailable

  Should yum skip this repository if unable to reach it.

  Supported values:

  • YUM_BOOLEAN
  • absent
• sslcacert

  Path to the directory containing the databases of the certificate authorities yum should use to verify SSL certificates.

  Supported values:

  • %r{.*}
  • absent
• sslclientcert

  Path to the SSL client certificate yum should use to connect to repositories/remote sites.

  Supported values:

  • %r{.*}
  • absent
• sslclientkey

  Path to the SSL client key yum should use to connect to repositories/remote sites.

  Supported values:

  • %r{.*}
  • absent
• sslverify

  Should yum verify SSL certificates/hosts at all.

  Supported values:

  • YUM_BOOLEAN
  • absent
• throttle

  Enable bandwidth throttling for downloads. This option can be expressed as a absolute data rate in bytes/sec or a percentage ‘60%`. An SI prefix (k, M or G) may be appended to the data rate values.n

  Supported values:

  • %r{^\d+[kMG%]?$}
  • absent
• timeout

  Number of seconds to wait for a connection before timing out.

  Supported values:

  • %r{^\d+$}
  • absent
• username

  Username to use for basic authentication to a repo or really any url.

  Supported values:

  • %r{.*}
  • absent

Parameters

• name (namevar)

  The name of the repository. This corresponds to the ‘repositoryid` parameter in `yum.conf(5)`.

• provider

  The specific backend to use for this ‘yumrepo` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

• target (defaults to: absent)

  The target parameter will be enabled in a future release and should not be used.