Class: Ansible::Ruby::Modules::Yum

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

Overview

Installs, upgrade, downgrades, removes, and lists packages and groups with the I(yum) package manager. This module only works on Python 2. If you require Python 3 support see the M(dnf) module.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#allow_downgrade ⇒ :yes, ...

Returns Specify if the named package and version is allowed to downgrade a maybe already installed higher version of that package. Note that setting allow_downgrade=True can make this module behave in a non-idempotent way. The task could end up with a set of packages that does not match the complete list of specified packages to install (because dependencies between the downgraded package and others can cause changes to the packages which were in the earlier transaction).

Returns:

  • (:yes, :no, nil) —

    Specify if the named package and version is allowed to downgrade a maybe already installed higher version of that package. Note that setting allow_downgrade=True can make this module behave in a non-idempotent way. The task could end up with a set of packages that does not match the complete list of specified packages to install (because dependencies between the downgraded package and others can cause changes to the packages which were in the earlier transaction).



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

attribute :allow_downgrade

#autoremove ⇒ Symbol?

Returns If C(yes), removes all “leaf” packages from the system that were originally installed as dependencies of user-installed packages but which are no longer required by any such package. Should be used alone or when state is I(absent),NOTE: This feature requires yum >= 3.4.3 (RHEL/CentOS 7+).

Returns:

  • (Symbol, nil) —

    If C(yes), removes all “leaf” packages from the system that were originally installed as dependencies of user-installed packages but which are no longer required by any such package. Should be used alone or when state is I(absent),NOTE: This feature requires yum >= 3.4.3 (RHEL/CentOS 7+)



89
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/yum.rb', line 89

attribute :autoremove

#bugfix ⇒ String?

Returns If set to C(yes), and C(state=latest) then only installs updates that have been marked bugfix related.

Returns:

  • (String, nil) —

    If set to C(yes), and C(state=latest) then only installs updates that have been marked bugfix related.



72
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/yum.rb', line 72

attribute :bugfix

#conf_file ⇒ Object?

Returns The remote yum configuration file to use for the transaction.

Returns:

  • (Object, nil) —

    The remote yum configuration file to use for the transaction.



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

attribute :conf_file

#disable_excludes ⇒ Object?

Returns Disable the excludes defined in YUM config files.,If set to C(all), disables all excludes.,If set to C(main), disable excludes defined in [main] in yum.conf.,If set to C(repoid), disable excludes defined for given repo id.

Returns:

  • (Object, nil) —

    Disable the excludes defined in YUM config files.,If set to C(all), disables all excludes.,If set to C(main), disable excludes defined in [main] in yum.conf.,If set to C(repoid), disable excludes defined for given repo id.



93
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/yum.rb', line 93

attribute :disable_excludes

#disable_gpg_check ⇒ :yes, ...

Returns Whether to disable the GPG checking of signatures of packages being installed. Has an effect only if state is I(present) or I(latest).

Returns:

  • (:yes, :no, nil) —

    Whether to disable the GPG checking of signatures of packages being installed. Has an effect only if state is I(present) or I(latest).



44
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/yum.rb', line 44

attribute :disable_gpg_check

#disable_plugin ⇒ Object?

Returns I(Plugin) name to disable for the install/update operation. The disabled plugins will not persist beyond the transaction.

Returns:

  • (Object, nil) —

    I(Plugin) name to disable for the install/update operation. The disabled plugins will not persist beyond the transaction.



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

attribute :disable_plugin

#disablerepo ⇒ Array<String>, ...

Returns I(Repoid) of repositories to disable for the install/update operation. These repos will not persist beyond the transaction. When specifying multiple repos, separate them with a C(“,”).,As of Ansible 2.7, this can alternatively be a list instead of C(“,”) separated string.

Returns:

  • (Array<String>, String, nil) —

    I(Repoid) of repositories to disable for the install/update operation. These repos will not persist beyond the transaction. When specifying multiple repos, separate them with a C(“,”).,As of Ansible 2.7, this can alternatively be a list instead of C(“,”) separated string



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

attribute :disablerepo

#download_only ⇒ :yes, ...

Returns Only download the packages, do not install them.

Returns:

  • (:yes, :no, nil) —

    Only download the packages, do not install them.



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

attribute :download_only

#enable_plugin ⇒ Object?

Returns I(Plugin) name to enable for the install/update operation. The enabled plugin will not persist beyond the transaction.

Returns:

  • (Object, nil) —

    I(Plugin) name to enable for the install/update operation. The enabled plugin will not persist beyond the transaction.



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

attribute :enable_plugin

#enablerepo ⇒ Array<String>, ...

Returns I(Repoid) of repositories to enable for the install/update operation. These repos will not persist beyond the transaction. When specifying multiple repos, separate them with a C(“,”).,As of Ansible 2.7, this can alternatively be a list instead of C(“,”) separated string.

Returns:

  • (Array<String>, String, nil) —

    I(Repoid) of repositories to enable for the install/update operation. These repos will not persist beyond the transaction. When specifying multiple repos, separate them with a C(“,”).,As of Ansible 2.7, this can alternatively be a list instead of C(“,”) separated string



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

attribute :enablerepo

#exclude ⇒ Array<String>, ...

Returns Package name(s) to exclude when state=present, or latest.

Returns:

  • (Array<String>, String, nil) —

    Package name(s) to exclude when state=present, or latest



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

attribute :exclude

#installroot ⇒ String?

Returns Specifies an alternative installroot, relative to which all packages will be installed.

Returns:

  • (String, nil) —

    Specifies an alternative installroot, relative to which all packages will be installed.



64
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/yum.rb', line 64

attribute :installroot

#list ⇒ String?

Returns Package name to run the equivalent of yum list <package> against. In addition to listing packages, use can also list the following: C(installed), C(updates), C(available) and C(repos).

Returns:

  • (String, nil) —

    Package name to run the equivalent of yum list <package> against. In addition to listing packages, use can also list the following: C(installed), C(updates), C(available) and C(repos).



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

attribute :list

#name ⇒ Array<String>, ...

Returns A package name or package specifier with version, like C(name-1.0).,If a previous version is specified, the task also needs to turn C(allow_downgrade) on. See the C(allow_downgrade) documentation for caveats with downgrading packages.,When using state=latest, this can be C(‘*’) which means run C(yum -y update).,You can also pass a url or a local path to a rpm file (using state=present). To operate on several packages this can accept a comma separated string of packages or (as of 2.0) a list of packages.

Returns:

  • (Array<String>, String, nil) —

    A package name or package specifier with version, like C(name-1.0).,If a previous version is specified, the task also needs to turn C(allow_downgrade) on. See the C(allow_downgrade) documentation for caveats with downgrading packages.,When using state=latest, this can be C(‘*’) which means run C(yum -y update).,You can also pass a url or a local path to a rpm file (using state=present). To operate on several packages this can accept a comma separated string of packages or (as of 2.0) a list of packages.



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

attribute :name

#releasever ⇒ Object?

Returns Specifies an alternative release from which all packages will be installed.

Returns:

  • (Object, nil) —

    Specifies an alternative release from which all packages will be installed.



86
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/yum.rb', line 86

attribute :releasever

#security ⇒ :yes, ...

Returns If set to C(yes), and C(state=latest) then only installs updates that have been marked security related.

Returns:

  • (:yes, :no, nil) —

    If set to C(yes), and C(state=latest) then only installs updates that have been marked security related.



68
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/yum.rb', line 68

attribute :security

#skip_broken ⇒ :yes, ...

Returns Skip packages with broken dependencies(devsolve) and are causing problems.

Returns:

  • (:yes, :no, nil) —

    Skip packages with broken dependencies(devsolve) and are causing problems.



48
 
# File 'lib/ansible/ruby/modules/generated/packaging/os/yum.rb', line 48

attribute :skip_broken

#state ⇒ :absent, ...

Returns Whether to install (C(present) or C(installed), C(latest)), or remove (C(absent) or C(removed)) a package.,C(present) and C(installed) will simply ensure that a desired package is installed.,C(latest) will update the specified package if it’s not of the latest available version.,C(absent) and C(removed) will remove the specified package.

Returns:

  • (:absent, :installed, :latest, :present, :removed, nil) —

    Whether to install (C(present) or C(installed), C(latest)), or remove (C(absent) or C(removed)) a package.,C(present) and C(installed) will simply ensure that a desired package is installed.,C(latest) will update the specified package if it’s not of the latest available version.,C(absent) and C(removed) will remove the specified package.



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

attribute :state

#update_cache ⇒ :yes, ...

Returns Force yum to check if cache is out of date and redownload if needed. Has an effect only if state is I(present) or I(latest).

Returns:

  • (:yes, :no, nil) —

    Force yum to check if cache is out of date and redownload if needed. Has an effect only if state is I(present) or I(latest).



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

attribute :update_cache

#update_only ⇒ :yes, ...

Returns When using latest, only update installed packages. Do not install packages.,Has an effect only if state is I(latest).

Returns:

  • (:yes, :no, nil) —

    When using latest, only update installed packages. Do not install packages.,Has an effect only if state is I(latest)



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

attribute :update_only

#use_backend ⇒ :auto, ...

Returns This module supports C(yum) (as it always has), this is known as C(yum3)/C(YUM3)/C(yum-deprecated) by upstream yum developers. As of Ansible 2.7+, this module also supports C(YUM4), which is the “new yum” and it has an C(dnf) backend.,By default, this module will select the backend based on the C(ansible_pkg_mgr) fact.

Returns:

  • (:auto, :yum, :yum4, :dnf, nil) —

    This module supports C(yum) (as it always has), this is known as C(yum3)/C(YUM3)/C(yum-deprecated) by upstream yum developers. As of Ansible 2.7+, this module also supports C(YUM4), which is the “new yum” and it has an C(dnf) backend.,By default, this module will select the backend based on the C(ansible_pkg_mgr) fact.



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

attribute :use_backend

#validate_certs ⇒ :yes, ...

Returns This only applies if using a https url as the source of the rpm. e.g. for localinstall. If set to C(no), the SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates as it avoids verifying the source site.,Prior to 2.1 the code worked as if this was set to C(yes).

Returns:

  • (:yes, :no, nil) —

    This only applies if using a https url as the source of the rpm. e.g. for localinstall. If set to C(no), the SSL certificates will not be validated.,This should only set to C(no) used on personally controlled sites using self-signed certificates as it avoids verifying the source site.,Prior to 2.1 the code worked as if this was set to C(yes).



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

attribute :validate_certs