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

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

Overview

Installs, upgrade, removes, and lists packages and groups with the I(yum) package manager.

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

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



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

attribute :conf_file

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



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

attribute :disable_gpg_check

#disablerepo ⇒ Object?

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

Returns:

  • (Object, 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 “,”.



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

attribute :disablerepo

#enablerepo ⇒ 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 “,”.

Returns:

  • (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 “,”.



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

attribute :enablerepo

#exclude ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

attribute :exclude

#list ⇒ Object?

Returns Various (non-idempotent) commands for usage with C(/usr/bin/ansible) and I(not) playbooks. See examples.

Returns:

  • (Object, nil) —

    Various (non-idempotent) commands for usage with C(/usr/bin/ansible) and I(not) playbooks. See examples.



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

attribute :list

#name ⇒ String

Returns Package name, or package specifier with version, like C(name-1.0). When using state=latest, this can be ‘*’ which means run: 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 list of packages or (as of 2.0) a list of packages.

Returns:

  • (String) —

    Package name, or package specifier with version, like C(name-1.0). When using state=latest, this can be ‘*’ which means run: 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 list of packages or (as of 2.0) a list of packages.



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

attribute :name

#state ⇒ :present, ...

Returns Whether to install (C(present) or C(installed), C(latest)), or remove (C(absent) or C(removed)) a package.

Returns:

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

    Whether to install (C(present) or C(installed), C(latest)), or remove (C(absent) or C(removed)) a package.



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

attribute :state

#update_cache ⇒ :yes, ...

Returns Force updating the cache. Has an effect only if state is I(present) or I(latest).

Returns:

  • (:yes, :no, nil) —

    Force updating the cache. Has an effect only if state is I(present) or I(latest).



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

attribute :update_cache

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



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

attribute :validate_certs