Resource Type: yumrepo
NOTE: This page was generated from the Puppet source code on 2018-08-28 06:48:02 -0700 yumrepo —–
Description
The client-side description of a yum repository. 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.
Attributes
yumrepo { 'resource title':
name => # (namevar) The name of the repository. This corresponds to
ensure => # The basic property that the resource should be...
assumeyes => # Determines if yum prompts for confirmation of...
bandwidth => # Use to specify the maximum available network...
baseurl => # The URL for this repository. Set this to...
cost => # Cost of this repository. Set this to `absent` to
deltarpm_metadata_percentage => # Percentage value that determines when to...
deltarpm_percentage => # Percentage value that determines when to use...
descr => # A human-readable description of the repository...
enabled => # Whether this repository is enabled. Valid values
enablegroups => # Whether yum will allow the use of package groups
exclude => # The string of package names or shell globs...
failovermethod => # The failover method for this repository; should...
gpgcakey => # The URL for the GPG CA key for this repository...
gpgcheck => # Whether to check the GPG signature on packages...
gpgkey => # The URL for the GPG key with which packages from
http_caching => # What to cache from this repository. Set this to...
include => # The URL of a remote file containing additional...
includepkgs => # The string of package names or shell globs...
keepalive => # Whether HTTP/1.1 keepalive should be used with...
metadata_expire => # Number of seconds after which the metadata will...
metalink => # Metalink for mirrors. Set this to `absent` to...
mirrorlist => # The URL that holds the list of mirrors for this...
mirrorlist_expire => # Time (in seconds) after which the mirrorlist...
password => # Password to use with the username for basic...
payload_gpgcheck => # Whether to check the GPG signature of the...
priority => # Priority of this repository. Can be any integer...
protect => # Enable or disable protection for this...
provider => # The specific backend to use for this `yumrepo...
proxy => # URL of a proxy server that Yum should use when...
proxy_password => # Password for this proxy. Set this to `absent` to
proxy_username => # Username for this proxy. Set this to `absent` to
repo_gpgcheck => # Whether to check the GPG signature on repodata...
retries => # Set the number of times any attempt to retrieve...
s3_enabled => # Access the repository via S3. Valid values are...
skip_if_unavailable => # Should yum skip this repository if unable to...
sslcacert => # Path to the directory containing the databases...
sslclientcert => # Path to the SSL client certificate yum should...
sslclientkey => # Path to the SSL client key yum should use to...
sslverify => # Should yum verify SSL certificates/hosts at all.
target => # The target parameter will be enabled in a future
throttle => # Enable bandwidth throttling for downloads. This...
timeout => # Number of seconds to wait for a connection...
username => # Username to use for basic authentication to a...
# ...plus any applicable metaparameters.
}name
(Namevar: If omitted, this attribute’s value defaults to the resource’s title.)
The name of the repository. This corresponds to the
repositoryid parameter in yum.conf(5).
(↑ Back to yumrepo attributes)
ensure
(Property: This attribute represents concrete state on the target system.)
The basic property that the resource should be in.
Default: present
Allowed values:
presentabsent
(↑ Back to yumrepo attributes)
assumeyes
(Property: This attribute represents concrete state on the target system.)
Determines if yum prompts for confirmation of critical actions.
Valid values are: false/0/no or true/1/yes.
Set this to absent to remove it from the file completely.
Valid values are absent. Values can match /^(true|false|0|1|no|yes)$/.
(↑ Back to yumrepo attributes)
bandwidth
(Property: This attribute represents concrete state on the target system.)
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.
Set this to absent to remove it from the file completely.
Allowed values:
/^\d+[kMG]?$/absent
(↑ Back to yumrepo attributes)
baseurl
(Property: This attribute represents concrete state on the target system.)
The URL for this repository. Set this to absent to remove it from the file completely.
Allowed values:
/.*/absent
(↑ Back to yumrepo attributes)
cost
(Property: This attribute represents concrete state on the target system.)
Cost of this repository. Set this to absent to remove it from the file completely.
Allowed values:
/^\d+$/absent
(↑ Back to yumrepo attributes)
deltarpm_metadata_percentage
(Property: This attribute represents concrete state on the target system.)
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.
Set this to absent to remove it from the file completely.
Allowed values:
/^\d+$/absent
(↑ Back to yumrepo attributes)
deltarpm_percentage
(Property: This attribute represents concrete state on the target system.)
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.
Set this to absent to remove it from the file completely.
Allowed values:
/^\d+$/absent
(↑ Back to yumrepo attributes)
descr
(Property: This attribute represents concrete state on the target system.)
A human-readable description of the repository.
This corresponds to the name parameter in yum.conf(5).
Set this to absent to remove it from the file completely.
Allowed values:
/.*/absent
(↑ Back to yumrepo attributes)
enabled
(Property: This attribute represents concrete state on the target system.)
Whether this repository is enabled.
Valid values are: false/0/no or true/1/yes.
Set this to absent to remove it from the file completely.
Valid values are absent. Values can match /^(true|false|0|1|no|yes)$/.
(↑ Back to yumrepo attributes)
enablegroups
(Property: This attribute represents concrete state on the target system.)
Whether yum will allow the use of package groups for this
repository.
Valid values are: false/0/no or true/1/yes.
Set this to absent to remove it from the file completely.
Valid values are absent. Values can match /^(true|false|0|1|no|yes)$/.
(↑ Back to yumrepo attributes)
exclude
(Property: This attribute represents concrete state on the target system.)
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.
Set this to absent to remove it from the file completely.
Allowed values:
/.*/absent
(↑ Back to yumrepo attributes)
failovermethod
(Property: This attribute represents concrete state on the target system.)
The failover method for this repository; should be either
roundrobin or priority. Set this to absent to remove it from the file completely.
Allowed values:
/^roundrobin|priority$/absent
(↑ Back to yumrepo attributes)
gpgcakey
(Property: This attribute represents concrete state on the target system.)
The URL for the GPG CA key for this repository. Set this to absent to remove it from the file completely.
Allowed values:
/.*/absent
(↑ Back to yumrepo attributes)
gpgcheck
(Property: This attribute represents concrete state on the target system.)
Whether to check the GPG signature on packages installed
from this repository.
Valid values are: false/0/no or true/1/yes.
Set this to absent to remove it from the file completely.
Valid values are absent. Values can match /^(true|false|0|1|no|yes)$/.
(↑ Back to yumrepo attributes)
gpgkey
(Property: This attribute represents concrete state on the target system.)
The URL for the GPG key with which packages from this
repository are signed. Set this to absent to remove it from the file completely.
Allowed values:
/.*/absent
(↑ Back to yumrepo attributes)
http_caching
(Property: This attribute represents concrete state on the target system.)
What to cache from this repository. Set this to absent to remove it from the file completely.
Allowed values:
/^(packages|all|none)$/absent
(↑ Back to yumrepo attributes)
include
(Property: This attribute represents concrete state on the target system.)
The URL of a remote file containing additional yum configuration
settings. Puppet does not check for this file’s existence or validity.
Set this to absent to remove it from the file completely.
Allowed values:
/.*/absent
(↑ Back to yumrepo attributes)
includepkgs
(Property: This attribute represents concrete state on the target system.)
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. Set this to absent to remove it from the file completely.
Allowed values:
/.*/absent
(↑ Back to yumrepo attributes)
keepalive
(Property: This attribute represents concrete state on the target system.)
Whether HTTP/1.1 keepalive should be used with this repository.
Valid values are: false/0/no or true/1/yes.
Set this to absent to remove it from the file completely.
Valid values are absent. Values can match /^(true|false|0|1|no|yes)$/.
(↑ Back to yumrepo attributes)
metadata_expire
(Property: This attribute represents concrete state on the target system.)
Number of seconds after which the metadata will expire.
Set this to absent to remove it from the file completely.
Allowed values:
/^([0-9]+[dhm]?|never)$/absent
(↑ Back to yumrepo attributes)
metalink
(Property: This attribute represents concrete state on the target system.)
Metalink for mirrors. Set this to absent to remove it from the file completely.
Allowed values:
/.*/absent
(↑ Back to yumrepo attributes)
mirrorlist
(Property: This attribute represents concrete state on the target system.)
The URL that holds the list of mirrors for this repository.
Set this to absent to remove it from the file completely.
Allowed values:
/.*/absent
(↑ Back to yumrepo attributes)
mirrorlist_expire
(Property: This attribute represents concrete state on the target system.)
Time (in seconds) after which the mirrorlist locally cached
will expire. Set this to absent to remove it from the file completely.
Allowed values:
/^[0-9]+$/absent
(↑ Back to yumrepo attributes)
password
(Property: This attribute represents concrete state on the target system.)
Password to use with the username for basic authentication.
Set this to absent to remove it from the file completely.
Allowed values:
/.*/absent
(↑ Back to yumrepo attributes)
payload_gpgcheck
(Property: This attribute represents concrete state on the target system.)
Whether to check the GPG signature of the packages payload.
Valid values are: false/0/no or true/1/yes.
Set this to absent to remove it from the file completely.
Valid values are absent. Values can match /^(true|false|0|1|no|yes)$/.
(↑ Back to yumrepo attributes)
priority
(Property: This attribute represents concrete state on the target system.)
Priority of this repository. Can be any integer value
(including negative). Requires that the priorities plugin
is installed and enabled.
Set this to absent to remove it from the file completely.
Allowed values:
/^-?\d+$/absent
(↑ Back to yumrepo attributes)
protect
(Property: This attribute represents concrete state on the target system.)
Enable or disable protection for this repository. Requires
that the protectbase plugin is installed and enabled.
Valid values are: false/0/no or true/1/yes.
Set this to absent to remove it from the file completely.
Valid values are absent. Values can match /^(true|false|0|1|no|yes)$/.
(↑ Back to yumrepo attributes)
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.
Available providers are:
(↑ Back to yumrepo attributes)
proxy
(Property: This attribute represents concrete state on the target system.)
URL of a proxy server that Yum should use when accessing this repository.
This attribute can also be set to '_none_', which will make Yum bypass any
global proxy settings when accessing this repository.
Set this to absent to remove it from the file completely.
Allowed values:
/.*/absent
(↑ Back to yumrepo attributes)
proxy_password
(Property: This attribute represents concrete state on the target system.)
Password for this proxy. Set this to absent to remove it from the file completely.
Allowed values:
/.*/absent
(↑ Back to yumrepo attributes)
proxy_username
(Property: This attribute represents concrete state on the target system.)
Username for this proxy. Set this to absent to remove it from the file completely.
Allowed values:
/.*/absent
(↑ Back to yumrepo attributes)
repo_gpgcheck
(Property: This attribute represents concrete state on the target system.)
Whether to check the GPG signature on repodata.
Valid values are: false/0/no or true/1/yes.
Set this to absent to remove it from the file completely.
Valid values are absent. Values can match /^(true|false|0|1|no|yes)$/.
(↑ Back to yumrepo attributes)
retries
(Property: This attribute represents concrete state on the target system.)
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.
Set this to absent to remove it from the file completely.
Allowed values:
/^[0-9]+$/absent
(↑ Back to yumrepo attributes)
s3_enabled
(Property: This attribute represents concrete state on the target system.)
Access the repository via S3.
Valid values are: false/0/no or true/1/yes.
Set this to absent to remove it from the file completely.
Valid values are absent. Values can match /^(true|false|0|1|no|yes)$/.
(↑ Back to yumrepo attributes)
skip_if_unavailable
(Property: This attribute represents concrete state on the target system.)
Should yum skip this repository if unable to reach it.
Valid values are: false/0/no or true/1/yes.
Set this to absent to remove it from the file completely.
Valid values are absent. Values can match /^(true|false|0|1|no|yes)$/.
(↑ Back to yumrepo attributes)
sslcacert
(Property: This attribute represents concrete state on the target system.)
Path to the directory containing the databases of the
certificate authorities yum should use to verify SSL certificates.
Set this to absent to remove it from the file completely.
Allowed values:
/.*/absent
(↑ Back to yumrepo attributes)
sslclientcert
(Property: This attribute represents concrete state on the target system.)
Path to the SSL client certificate yum should use to connect
to repositories/remote sites. Set this to absent to remove it from the file completely.
Allowed values:
/.*/absent
(↑ Back to yumrepo attributes)
sslclientkey
(Property: This attribute represents concrete state on the target system.)
Path to the SSL client key yum should use to connect
to repositories/remote sites. Set this to absent to remove it from the file completely.
Allowed values:
/.*/absent
(↑ Back to yumrepo attributes)
sslverify
(Property: This attribute represents concrete state on the target system.)
Should yum verify SSL certificates/hosts at all.
Valid values are: false/0/no or true/1/yes.
Set this to absent to remove it from the file completely.
Valid values are absent. Values can match /^(true|false|0|1|no|yes)$/.
(↑ Back to yumrepo attributes)
target
The target parameter will be enabled in a future release and should not be used.
Default: absent
(↑ Back to yumrepo attributes)
throttle
(Property: This attribute represents concrete state on the target system.)
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.
Set this to absent to remove it from the file completely.
Allowed values:
/^\d+[kMG%]?$/absent
(↑ Back to yumrepo attributes)
timeout
(Property: This attribute represents concrete state on the target system.)
Number of seconds to wait for a connection before timing
out. Set this to absent to remove it from the file completely.
Allowed values:
/^\d+$/absent
(↑ Back to yumrepo attributes)
username
(Property: This attribute represents concrete state on the target system.)
Username to use for basic authentication to a repo or really any url.
Set this to absent to remove it from the file completely.
Allowed values:
/.*/absent
(↑ Back to yumrepo attributes)
Providers
inifile
Manage yum repo configurations by parsing yum INI configuration files.
Fetching instances
When fetching repo instances, directory entries in ‘/etc/yum/repos.d’, ‘/etc/yum.repos.d’, and the directory optionally specified by the reposdir key in ‘/etc/yum.conf’ will be checked. If a given directory does not exist it will be ignored. In addition, all sections in ‘/etc/yum.conf’ aside from ‘main’ will be created as sections.
Storing instances
When creating a new repository, a new section will be added in the first yum repo directory that exists. The custom directory specified by the ‘/etc/yum.conf’ reposdir property is checked first, followed by ‘/etc/yum/repos.d’, and then ‘/etc/yum.repos.d’. If none of these exist, the section will be created in ‘/etc/yum.conf’.
NOTE: This page was generated from the Puppet source code on 2018-08-28 06:48:02 -0700