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

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Yum_repository

Defined in:

lib/ansible/ruby/modules/generated/packaging/os/yum_repository.rb

Overview

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

Instance Method Summary

• #async ⇒ :yes, ...

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

• #bandwidth ⇒ Integer^?

  Maximum available network bandwidth in bytes/second.

• #baseurl ⇒ String^?

  URL to the directory where the yum repository’s ‘repodata’ directory lives.,It can also be a list of multiple URLs.,This, the I(metalink) or I(mirrorlist) parameters are required if I(state) is set to C(present).

• #cost ⇒ Integer^?

  Relative cost of accessing this repository.

• #deltarpm_metadata_percentage ⇒ Integer^?

  When the relative size of deltarpm metadata vs pkgs is larger than this, deltarpm metadata is not downloaded from the repo.

• #deltarpm_percentage ⇒ Integer^?

  When the relative size of delta vs pkg is larger than this, delta is not used.

• #description ⇒ String^?

  A human readable string describing the repository.

• #enabled ⇒ :yes, ...

  This tells yum whether or not use this repository.

• #enablegroups ⇒ :yes, ...

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

• #exclude ⇒ Object^?

  List of packages to exclude from updates or installs.

• #failovermethod ⇒ :roundrobin, ...

  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.

• #file ⇒ String^?

  File name without the C(.repo) extension to save the repo in.

• #gpgcakey ⇒ Object^?

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

• #gpgcheck ⇒ Symbol^?

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

• #gpgkey ⇒ Object^?

  A URL pointing to the ASCII-armored GPG key file for the repository.,It can also be a list of multiple URLs.

• #http_caching ⇒ :all, ...

  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.

• #include ⇒ Object^?

  Include external configuration file.

• #includepkgs ⇒ Object^?

  List of packages you want to only use from a repository.

• #ip_resolve ⇒ 4, ...

  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.

• #keepalive ⇒ :yes, ...

  This tells yum whether or not HTTP/1.1 keepalive should be used with this repository.

• #keepcache ⇒ 0, ...

  Either C(1) or C(0).

• #metadata_expire ⇒ Integer^?

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

• #metadata_expire_filter ⇒ :never, ...

  Filter the I(metadata_expire) time, allowing a trade of speed for accuracy if a command doesn’t require it.

• #metalink ⇒ Object^?

  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).,This, the I(baseurl) or I(mirrorlist) parameters are required if I(state) is set to C(present).

• #mirrorlist ⇒ String^?

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

• #mirrorlist_expire ⇒ Integer^?

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

• #name ⇒ String

  Unique repository ID.

• #password ⇒ Object^?

  Password to use with the username for basic authentication.

• #priority ⇒ Integer^?

  Enforce ordered protection of repositories.

• #protect ⇒ :yes, ...

  Protect packages from updates from other repositories.

• #proxy ⇒ Object^?

  URL to the proxy server that yum should use.

• #proxy_password ⇒ Object^?

  Username to use for proxy.

• #proxy_username ⇒ Object^?

  Password for this proxy.

• #repo_gpgcheck ⇒ :yes, ...

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

• #reposdir ⇒ String^?

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

• #retries ⇒ Integer^?

  Set the number of times any attempt to retrieve a file should retry before returning an error.

• #s3_enabled ⇒ :yes, ...

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

• #skip_if_unavailable ⇒ :yes, ...

  If set to C(yes) yum will continue running if this repository cannot be contacted for any reason.

• #ssl_check_cert_permissions ⇒ :yes, ...

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

• #sslcacert ⇒ Object^?

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

• #sslclientcert ⇒ Object^?

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

• #sslclientkey ⇒ Object^?

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

• #sslverify ⇒ :yes, ...

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

• #state ⇒ :absent, ...

  State of the repo file.

• #throttle ⇒ Object^?

  Enable bandwidth throttling for downloads.,This option can be expressed as a absolute data rate in bytes/sec.

• #timeout ⇒ Integer^?

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

• #ui_repoid_vars ⇒ String^?

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

• #username ⇒ Object^?

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

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

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

attribute :async

#bandwidth ⇒ Integer^?

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

attribute :bandwidth

#baseurl ⇒ String^?

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

attribute :baseurl

#cost ⇒ Integer^?

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

attribute :cost

#deltarpm_metadata_percentage ⇒ Integer^?

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

attribute :deltarpm_metadata_percentage

#deltarpm_percentage ⇒ Integer^?

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

attribute :deltarpm_percentage

#description ⇒ String^?

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

attribute :description

#enabled ⇒ :yes, ...

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

attribute :enabled

#enablegroups ⇒ :yes, ...

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

attribute :enablegroups

#exclude ⇒ Object^?

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

attribute :exclude

#failovermethod ⇒ :roundrobin, ...

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

attribute :failovermethod

#file ⇒ String^?

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

attribute :file

#gpgcakey ⇒ Object^?

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

attribute :gpgcakey

#gpgcheck ⇒ Symbol^?

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

attribute :gpgcheck

#gpgkey ⇒ Object^?

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

attribute :gpgkey

#http_caching ⇒ :all, ...

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

attribute :http_caching

#include ⇒ Object^?

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

attribute :include

#includepkgs ⇒ Object^?

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

attribute :includepkgs

#ip_resolve ⇒ 4, ...

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

attribute :ip_resolve

#keepalive ⇒ :yes, ...

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

attribute :keepalive

#keepcache ⇒ 0, ...

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

attribute :keepcache

#metadata_expire ⇒ Integer^?

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

attribute :metadata_expire

#metadata_expire_filter ⇒ :never, ...

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

attribute :metadata_expire_filter

#metalink ⇒ Object^?

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

attribute :metalink

#mirrorlist ⇒ String^?

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

attribute :mirrorlist

#mirrorlist_expire ⇒ Integer^?

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

attribute :mirrorlist_expire

#name ⇒ String

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

attribute :name

#password ⇒ Object^?

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

attribute :password

#priority ⇒ Integer^?

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

attribute :priority

#protect ⇒ :yes, ...

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

attribute :protect

#proxy ⇒ Object^?

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

attribute :proxy

#proxy_password ⇒ Object^?

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

attribute :proxy_password

#proxy_username ⇒ Object^?

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

attribute :proxy_username

#repo_gpgcheck ⇒ :yes, ...

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

attribute :repo_gpgcheck

#reposdir ⇒ String^?

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

attribute :reposdir

#retries ⇒ Integer^?

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

attribute :retries

#s3_enabled ⇒ :yes, ...

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

attribute :s3_enabled

#skip_if_unavailable ⇒ :yes, ...

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

attribute :skip_if_unavailable

#ssl_check_cert_permissions ⇒ :yes, ...

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

attribute :ssl_check_cert_permissions

#sslcacert ⇒ Object^?

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

attribute :sslcacert

#sslclientcert ⇒ Object^?

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

attribute :sslclientcert

#sslclientkey ⇒ Object^?

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

attribute :sslclientkey

#sslverify ⇒ :yes, ...

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

attribute :sslverify

#state ⇒ :absent, ...

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

attribute :state

#throttle ⇒ Object^?

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

attribute :throttle

#timeout ⇒ Integer^?

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

attribute :timeout

#ui_repoid_vars ⇒ String^?

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

attribute :ui_repoid_vars

#username ⇒ Object^?

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

attribute :username