Class: Ansible::Ruby::Modules::Dnf

Inherits:

Base

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

Defined in:

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

Overview

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

Instance Method Summary

• #allow_downgrade ⇒ Symbol^?

  Specify if the named package and version is allowed to downgrade a maybe already installed higher version of that package.

• #autoremove ⇒ Symbol^?

  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.

• #bugfix ⇒ :yes, ...

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

• #conf_file ⇒ Object^?

  The remote dnf configuration file to use for the transaction.

• #disable_excludes ⇒ Object^?

  Disable the excludes defined in DNF 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.

• #disable_gpg_check ⇒ :yes, ...

  Whether to disable the GPG checking of signatures of packages being installed.

• #disable_plugin ⇒ Object^?

  I(Plugin) name to disable for the install/update operation.

• #disablerepo ⇒ Object^?

  I(Repoid) of repositories to disable for the install/update operation.

• #download_only ⇒ :yes, ...

  Only download the packages, do not install them.

• #enable_plugin ⇒ Object^?

  I(Plugin) name to enable for the install/update operation.

• #enablerepo ⇒ String^?

  I(Repoid) of repositories to enable for the install/update operation.

• #exclude ⇒ Object^?

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

• #install_repoquery ⇒ Boolean^?

  This is effectively a no-op in DNF as it is not needed with DNF, but is an accepted parameter for feature parity/compatibility with the I(yum) module.

• #installroot ⇒ String^?

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

• #list ⇒ Object^?

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

• #name ⇒ String

  A package name or package specifier with version, like C(name-1.0).

• #releasever ⇒ Object^?

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

• #security ⇒ :yes, ...

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

• #skip_broken ⇒ :yes, ...

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

• #state ⇒ :absent, ...

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

• #update_cache ⇒ :yes, ...

  Force yum to check if cache is out of date and redownload if needed.

• #update_only ⇒ :yes, ...

  When using latest, only update installed packages.

• #validate_certs ⇒ :yes, ...

  This only applies if using a https url as the source of the rpm.

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 ⇒ Symbol^?

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:

• (Symbol, 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).

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

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

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)

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

attribute :autoremove

#bugfix ⇒ :yes, ...

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

Returns:

• (:yes, :no, nil) —

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

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

attribute :bugfix

#conf_file ⇒ Object^?

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

Returns:

• (Object, nil) —

  The remote dnf configuration file to use for the transaction.

# File 'lib/ansible/ruby/modules/generated/packaging/os/dnf.rb', line 30

attribute :conf_file

#disable_excludes ⇒ Object^?

Returns Disable the excludes defined in DNF 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 DNF 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.

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

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

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

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.

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

attribute :disable_plugin

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

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

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.

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

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.

# File 'lib/ansible/ruby/modules/generated/packaging/os/dnf.rb', line 71

attribute :enable_plugin

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

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

attribute :enablerepo

#exclude ⇒ Object^?

Returns Package name(s) to exclude when state=present, or latest. This can be a list or a comma separated string.

Returns:

• (Object, nil) —

  Package name(s) to exclude when state=present, or latest. This can be a list or a comma separated string.

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

attribute :exclude

#install_repoquery ⇒ Boolean^?

Returns This is effectively a no-op in DNF as it is not needed with DNF, but is an accepted parameter for feature parity/compatibility with the I(yum) module.

Returns:

• (Boolean, nil) —

  This is effectively a no-op in DNF as it is not needed with DNF, but is an accepted parameter for feature parity/compatibility with the I(yum) module.

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

attribute :install_repoquery

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

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

attribute :installroot

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

# File 'lib/ansible/ruby/modules/generated/packaging/os/dnf.rb', line 16

attribute :list

#name ⇒ String

Returns A package name or package specifier with version, like C(name-1.0). When using state=latest, this can be ‘*’ which means run: dnf -y update. You can also pass a url or a local path to a rpm file. To operate on several packages this can accept a comma separated string of packages or a list of packages.

Returns:

• (String) —

  A package name or package specifier with version, like C(name-1.0). When using state=latest, this can be ‘*’ which means run: dnf -y update. You can also pass a url or a local path to a rpm file. To operate on several packages this can accept a comma separated string of packages or a list of packages.

# File 'lib/ansible/ruby/modules/generated/packaging/os/dnf.rb', line 12

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.

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

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.

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

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.

# File 'lib/ansible/ruby/modules/generated/packaging/os/dnf.rb', line 51

attribute :skip_broken

#state ⇒ :absent, ...

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

Returns:

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

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

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

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

# File 'lib/ansible/ruby/modules/generated/packaging/os/dnf.rb', line 55

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)

# File 'lib/ansible/ruby/modules/generated/packaging/os/dnf.rb', line 59

attribute :update_only

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

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.

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

attribute :validate_certs