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/extras/packaging/os/yum_repository.rb

Overview

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

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

• #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 to use to save the repo in.

• #gpgcakey ⇒ Object^?

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

• #gpgcheck ⇒ :yes, ...

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

• #gpgkey ⇒ String^?

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

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

• #mirrorlist ⇒ String^?

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

• #mirrorlist_expire ⇒ Integer^?

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

• #name ⇒ String

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

• #params ⇒ String^?

  Option used to allow the user to overwrite any of the other options.

• #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/extras/packaging/os/yum_repository.rb', line 11

attribute :async

#bandwidth ⇒ Integer^?

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

attribute :bandwidth

#baseurl ⇒ String^?

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

attribute :baseurl

#cost ⇒ Integer^?

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

attribute :cost

#deltarpm_metadata_percentage ⇒ Integer^?

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

attribute :deltarpm_metadata_percentage

#deltarpm_percentage ⇒ Integer^?

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

attribute :deltarpm_percentage

#description ⇒ String^?

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

attribute :description

#enabled ⇒ :yes, ...

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

attribute :enabled

#enablegroups ⇒ :yes, ...

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

attribute :enablegroups

#exclude ⇒ Object^?

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

attribute :exclude

#failovermethod ⇒ :roundrobin, ...

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

attribute :failovermethod

#file ⇒ String^?

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

attribute :file

#gpgcakey ⇒ Object^?

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

attribute :gpgcakey

#gpgcheck ⇒ :yes, ...

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

attribute :gpgcheck

#gpgkey ⇒ String^?

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

attribute :gpgkey

#http_caching ⇒ :all, ...

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

attribute :http_caching

#include ⇒ Object^?

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

attribute :include

#includepkgs ⇒ Object^?

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

attribute :includepkgs

#ip_resolve ⇒ 4, ...

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

attribute :ip_resolve

#keepalive ⇒ :yes, ...

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

attribute :keepalive

#keepcache ⇒ 0, ...

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

attribute :keepcache

#metadata_expire ⇒ Integer^?

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

attribute :metadata_expire

#metadata_expire_filter ⇒ :never, ...

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

attribute :metadata_expire_filter

#metalink ⇒ Object^?

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

attribute :metalink

#mirrorlist ⇒ String^?

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

attribute :mirrorlist

#mirrorlist_expire ⇒ Integer^?

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

attribute :mirrorlist_expire

#name ⇒ String

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

attribute :name

#params ⇒ String^?

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

attribute :params

#password ⇒ Object^?

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

attribute :password

#priority ⇒ Integer^?

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

attribute :priority

#protect ⇒ :yes, ...

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

attribute :protect

#proxy ⇒ Object^?

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

attribute :proxy

#proxy_password ⇒ Object^?

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

attribute :proxy_password

#proxy_username ⇒ Object^?

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

attribute :proxy_username

#repo_gpgcheck ⇒ :yes, ...

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

attribute :repo_gpgcheck

#reposdir ⇒ String^?

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

attribute :reposdir

#retries ⇒ Integer^?

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

attribute :retries

#s3_enabled ⇒ :yes, ...

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

attribute :s3_enabled

#skip_if_unavailable ⇒ :yes, ...

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

attribute :skip_if_unavailable

#ssl_check_cert_permissions ⇒ :yes, ...

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

attribute :ssl_check_cert_permissions

#sslcacert ⇒ Object^?

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

attribute :sslcacert

#sslclientcert ⇒ Object^?

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

attribute :sslclientcert

#sslclientkey ⇒ Object^?

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

attribute :sslclientkey

#sslverify ⇒ :yes, ...

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

attribute :sslverify

#state ⇒ :absent, ...

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

attribute :state

#throttle ⇒ Object^?

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

attribute :throttle

#timeout ⇒ Integer^?

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

attribute :timeout

#ui_repoid_vars ⇒ String^?

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

attribute :ui_repoid_vars

#username ⇒ Object^?

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

attribute :username