Class: Ansible::Ruby::Modules::Yum_repository

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb

Overview

Add or remove YUM repositories in RPM-based Linux distributions.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#async ⇒ :yes, ...

Returns If set to C(yes) Yum will download packages and metadata from this repo in parallel, if possible.

Returns:

  • (:yes, :no, nil) —

    If set to C(yes) Yum will download packages and metadata from this repo in parallel, if possible.



11
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 11

attribute :async

#bandwidth ⇒ Integer?

Returns Maximum available network bandwidth in bytes/second. Used with the I(throttle) option.,If I(throttle) is a percentage and bandwidth is C(0) then bandwidth throttling will be disabled. If I(throttle) is expressed as a data rate (bytes/sec) then this option is ignored. Default is C(0) (no bandwidth throttling).

Returns:

  • (Integer, nil) —

    Maximum available network bandwidth in bytes/second. Used with the I(throttle) option.,If I(throttle) is a percentage and bandwidth is C(0) then bandwidth throttling will be disabled. If I(throttle) is expressed as a data rate (bytes/sec) then this option is ignored. Default is C(0) (no bandwidth throttling).



15
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 15

attribute :bandwidth

#baseurl ⇒ String?

Returns URL to the directory where the yum repository’s ‘repodata’ directory lives.,This or the I(mirrorlist) parameter is required if I(state) is set to C(present).

Returns:

  • (String, nil) —

    URL to the directory where the yum repository’s ‘repodata’ directory lives.,This or the I(mirrorlist) parameter is required if I(state) is set to C(present).



19
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 19

attribute :baseurl

#cost ⇒ Integer?

Returns Relative cost of accessing this repository. Useful for weighing one repo’s packages as greater/less than any other.

Returns:

  • (Integer, nil) —

    Relative cost of accessing this repository. Useful for weighing one repo’s packages as greater/less than any other.



23
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 23

attribute :cost

#deltarpm_metadata_percentage ⇒ Integer?

Returns 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 C(100), so C(200) means that the metadata is required to be half the size of the packages. Use C(0) to turn off this check, and always download metadata.

Returns:

  • (Integer, nil) —

    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 C(100), so C(200) means that the metadata is required to be half the size of the packages. Use C(0) to turn off this check, and always download metadata.



27
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 27

attribute :deltarpm_metadata_percentage

#deltarpm_percentage ⇒ Integer?

Returns When the relative size of delta vs pkg is larger than this, delta is not used. Use C(0) to turn off delta rpm processing. Local repositories (with file:// I(baseurl)) have delta rpms turned off by default.

Returns:

  • (Integer, nil) —

    When the relative size of delta vs pkg is larger than this, delta is not used. Use C(0) to turn off delta rpm processing. Local repositories (with file:// I(baseurl)) have delta rpms turned off by default.



31
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 31

attribute :deltarpm_percentage

#description ⇒ String?

Returns A human readable string describing the repository.,This parameter is only required if I(state) is set to C(present).

Returns:

  • (String, nil) —

    A human readable string describing the repository.,This parameter is only required if I(state) is set to C(present).



35
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 35

attribute :description

#enabled ⇒ :yes, ...

Returns This tells yum whether or not use this repository.

Returns:

  • (:yes, :no, nil) —

    This tells yum whether or not use this repository.



39
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 39

attribute :enabled

#enablegroups ⇒ :yes, ...

Returns Determines whether yum will allow the use of package groups for this repository.

Returns:

  • (:yes, :no, nil) —

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



43
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 43

attribute :enablegroups

#exclude ⇒ Object?

Returns List of packages to exclude from updates or installs. This should be a space separated list. Shell globs using wildcards (eg. C(*) and C(?)) are allowed.,The list can also be a regular YAML array.

Returns:

  • (Object, nil) —

    List of packages to exclude from updates or installs. This should be a space separated list. Shell globs using wildcards (eg. C(*) and C(?)) are allowed.,The list can also be a regular YAML array.



47
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 47

attribute :exclude

#failovermethod ⇒ :roundrobin, ...

Returns C(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.,C(priority) starts from the first I(baseurl) listed and reads through them sequentially.

Returns:

  • (:roundrobin, :priority, nil) —

    C(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.,C(priority) starts from the first I(baseurl) listed and reads through them sequentially.



50
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 50

attribute :failovermethod

#file ⇒ String?

Returns File to use to save the repo in. Defaults to the value of I(name).

Returns:

  • (String, nil) —

    File to use to save the repo in. Defaults to the value of I(name).



54
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 54

attribute :file

#gpgcakey ⇒ Object?

Returns A URL pointing to the ASCII-armored CA key file for the repository.

Returns:

  • (Object, nil) —

    A URL pointing to the ASCII-armored CA key file for the repository.



58
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 58

attribute :gpgcakey

#gpgcheck ⇒ :yes, ...

Returns Tells yum whether or not it should perform a GPG signature check on packages.

Returns:

  • (:yes, :no, nil) —

    Tells yum whether or not it should perform a GPG signature check on packages.



61
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 61

attribute :gpgcheck

#gpgkey ⇒ String?

Returns A URL pointing to the ASCII-armored GPG key file for the repository.

Returns:

  • (String, nil) —

    A URL pointing to the ASCII-armored GPG key file for the repository.



65
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 65

attribute :gpgkey

#http_caching ⇒ :all, ...

Returns Determines how upstream HTTP caches are instructed to handle any HTTP downloads that Yum does.,C(all) means that all HTTP downloads should be cached.,C(packages) means that only RPM package downloads should be cached (but not repository metadata downloads).,C(none) means that no HTTP downloads should be cached.

Returns:

  • (:all, :packages, :none, nil) —

    Determines how upstream HTTP caches are instructed to handle any HTTP downloads that Yum does.,C(all) means that all HTTP downloads should be cached.,C(packages) means that only RPM package downloads should be cached (but not repository metadata downloads).,C(none) means that no HTTP downloads should be cached.



69
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 69

attribute :http_caching

#include ⇒ Object?

Returns Include external configuration file. Both, local path and URL is supported. Configuration file will be inserted at the position of the I(include=) line. Included files may contain further include lines. Yum will abort with an error if an inclusion loop is detected.

Returns:

  • (Object, nil) —

    Include external configuration file. Both, local path and URL is supported. Configuration file will be inserted at the position of the I(include=) line. Included files may contain further include lines. Yum will abort with an error if an inclusion loop is detected.



73
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 73

attribute :include

#includepkgs ⇒ Object?

Returns List of packages you want to only use from a repository. This should be a space separated list. Shell globs using wildcards (eg. C(*) and C(?)) are allowed. Substitution variables (e.g. C($releasever)) are honored here.,The list can also be a regular YAML array.

Returns:

  • (Object, nil) —

    List of packages you want to only use from a repository. This should be a space separated list. Shell globs using wildcards (eg. C(*) and C(?)) are allowed. Substitution variables (e.g. C($releasever)) are honored here.,The list can also be a regular YAML array.



76
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 76

attribute :includepkgs

#ip_resolve ⇒ 4, ...

Returns Determines how yum resolves host names.,C(4) or C(IPv4) - resolve to IPv4 addresses only.,C(6) or C(IPv6) - resolve to IPv6 addresses only.

Returns:

  • (4, 6, :IPv4, :IPv6, :whatever, nil) —

    Determines how yum resolves host names.,C(4) or C(IPv4) - resolve to IPv4 addresses only.,C(6) or C(IPv6) - resolve to IPv6 addresses only.



79
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 79

attribute :ip_resolve

#keepalive ⇒ :yes, ...

Returns 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.

Returns:

  • (:yes, :no, nil) —

    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.



83
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 83

attribute :keepalive

#keepcache ⇒ 0, ...

Returns Either C(1) or C(0). Determines whether or not yum keeps the cache of headers and packages after successful installation.

Returns:

  • (0, 1, nil) —

    Either C(1) or C(0). Determines whether or not yum keeps the cache of headers and packages after successful installation.



87
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 87

attribute :keepcache

#metadata_expire ⇒ Integer?

Returns Time (in seconds) after which the metadata will expire.,Default value is 6 hours.

Returns:

  • (Integer, nil) —

    Time (in seconds) after which the metadata will expire.,Default value is 6 hours.



91
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 91

attribute :metadata_expire

#metadata_expire_filter ⇒ :never, ...

Returns Filter the I(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”.,C(never) - Nothing is filtered, always obey I(metadata_expire).,C(read-only:past) - Commands that only care about past information are filtered from metadata expiring. Eg. I(yum history) info (if history needs to lookup anything about a previous transaction, then by definition the remote package was available in the past).,C(read-only:present) - Commands that are balanced between past and future. Eg. I(yum list yum).,C(read-only:future) - Commands that are likely to result in running other commands which will require the latest metadata. Eg. I(yum check-update).,Note that this option does not override “yum clean expire-cache”.

Returns:

  • (:never, :"read-only:past", :"read-only:present", :"read-only:future", nil) —

    Filter the I(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”.,C(never) - Nothing is filtered, always obey I(metadata_expire).,C(read-only:past) - Commands that only care about past information are filtered from metadata expiring. Eg. I(yum history) info (if history needs to lookup anything about a previous transaction, then by definition the remote package was available in the past).,C(read-only:present) - Commands that are balanced between past and future. Eg. I(yum list yum).,C(read-only:future) - Commands that are likely to result in running other commands which will require the latest metadata. Eg. I(yum check-update).,Note that this option does not override “yum clean expire-cache”.



95
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 95

attribute :metadata_expire_filter

#metalink ⇒ Object?

Returns 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 I(baseurl).

Returns:

  • (Object, nil) —

    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 I(baseurl).



99
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 99

attribute :metalink

#mirrorlist ⇒ String?

Returns Specifies a URL to a file containing a list of baseurls.,This or the I(baseurl) parameter is required if I(state) is set to C(present).

Returns:

  • (String, nil) —

    Specifies a URL to a file containing a list of baseurls.,This or the I(baseurl) parameter is required if I(state) is set to C(present).



102
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 102

attribute :mirrorlist

#mirrorlist_expire ⇒ Integer?

Returns Time (in seconds) after which the mirrorlist locally cached will expire.,Default value is 6 hours.

Returns:

  • (Integer, nil) —

    Time (in seconds) after which the mirrorlist locally cached will expire.,Default value is 6 hours.



106
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 106

attribute :mirrorlist_expire

#name ⇒ String

Returns Unique repository ID.,This parameter is only required if I(state) is set to C(present) or C(absent).

Returns:

  • (String) —

    Unique repository ID.,This parameter is only required if I(state) is set to C(present) or C(absent).



110
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 110

attribute :name

#params ⇒ String?

Returns Option used to allow the user to overwrite any of the other options. To remove an option, set the value of the option to C(null).

Returns:

  • (String, nil) —

    Option used to allow the user to overwrite any of the other options. To remove an option, set the value of the option to C(null).



114
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 114

attribute :params

#password ⇒ Object?

Returns Password to use with the username for basic authentication.

Returns:

  • (Object, nil) —

    Password to use with the username for basic authentication.



118
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 118

attribute :password

#priority ⇒ Integer?

Returns 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.

Returns:

  • (Integer, nil) —

    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.



121
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 121

attribute :priority

#protect ⇒ :yes, ...

Returns Protect packages from updates from other repositories.

Returns:

  • (:yes, :no, nil) —

    Protect packages from updates from other repositories.



125
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 125

attribute :protect

#proxy ⇒ Object?

Returns URL to the proxy server that yum should use. Set to C(none) to disable the global proxy setting.

Returns:

  • (Object, nil) —

    URL to the proxy server that yum should use. Set to C(none) to disable the global proxy setting.



129
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 129

attribute :proxy

#proxy_password ⇒ Object?

Returns Username to use for proxy.

Returns:

  • (Object, nil) —

    Username to use for proxy.



132
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 132

attribute :proxy_password

#proxy_username ⇒ Object?

Returns Password for this proxy.

Returns:

  • (Object, nil) —

    Password for this proxy.



135
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 135

attribute :proxy_username

#repo_gpgcheck ⇒ :yes, ...

Returns This tells yum whether or not it should perform a GPG signature check on the repodata from this repository.

Returns:

  • (:yes, :no, nil) —

    This tells yum whether or not it should perform a GPG signature check on the repodata from this repository.



138
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 138

attribute :repo_gpgcheck

#reposdir ⇒ String?

Returns Directory where the C(.repo) files will be stored.

Returns:

  • (String, nil) —

    Directory where the C(.repo) files will be stored.



142
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 142

attribute :reposdir

#retries ⇒ Integer?

Returns Set the number of times any attempt to retrieve a file should retry before returning an error. Setting this to C(0) makes yum try forever.

Returns:

  • (Integer, nil) —

    Set the number of times any attempt to retrieve a file should retry before returning an error. Setting this to C(0) makes yum try forever.



146
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 146

attribute :retries

#s3_enabled ⇒ :yes, ...

Returns Enables support for S3 repositories.,This option only works if the YUM S3 plugin is installed.

Returns:

  • (:yes, :no, nil) —

    Enables support for S3 repositories.,This option only works if the YUM S3 plugin is installed.



150
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 150

attribute :s3_enabled

#skip_if_unavailable ⇒ :yes, ...

Returns If set to C(yes) 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.

Returns:

  • (:yes, :no, nil) —

    If set to C(yes) 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.



154
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 154

attribute :skip_if_unavailable

#ssl_check_cert_permissions ⇒ :yes, ...

Returns 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 I(skip_if_unavailable) to be C(yes). This is most useful for non-root processes which use yum on repos that have client cert files which are readable only by root.

Returns:

  • (:yes, :no, nil) —

    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 I(skip_if_unavailable) to be C(yes). This is most useful for non-root processes which use yum on repos that have client cert files which are readable only by root.



158
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 158

attribute :ssl_check_cert_permissions

#sslcacert ⇒ Object?

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

Returns:

  • (Object, nil) —

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



162
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 162

attribute :sslcacert

#sslclientcert ⇒ Object?

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

Returns:

  • (Object, nil) —

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



165
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 165

attribute :sslclientcert

#sslclientkey ⇒ Object?

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

Returns:

  • (Object, nil) —

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



168
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 168

attribute :sslclientkey

#sslverify ⇒ :yes, ...

Returns Defines whether yum should verify SSL certificates/hosts at all.

Returns:

  • (:yes, :no, nil) —

    Defines whether yum should verify SSL certificates/hosts at all.



171
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 171

attribute :sslverify

#state ⇒ :absent, ...

Returns State of the repo file.

Returns:

  • (:absent, :present, nil) —

    State of the repo file.



175
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 175

attribute :state

#throttle ⇒ Object?

Returns 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.

Returns:

  • (Object, nil) —

    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.



179
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 179

attribute :throttle

#timeout ⇒ Integer?

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

Returns:

  • (Integer, nil) —

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



182
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 182

attribute :timeout

#ui_repoid_vars ⇒ String?

Returns When a repository id is displayed, append these yum variables to the string if they are used in the I(baseurl)/etc. Variables are appended in the order listed (and found).

Returns:

  • (String, nil) —

    When a repository id is displayed, append these yum variables to the string if they are used in the I(baseurl)/etc. Variables are appended in the order listed (and found).



186
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 186

attribute :ui_repoid_vars

#username ⇒ Object?

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

Returns:

  • (Object, nil) —

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



190
 
# File 'lib/ansible/ruby/modules/generated/extras/packaging/os/yum_repository.rb', line 190

attribute :username