Skip to content

Latest commit

 

History

History
399 lines (227 loc) · 10.1 KB

REFERENCE.md

File metadata and controls

399 lines (227 loc) · 10.1 KB
Raw

Reference

Table of Contents

Classes

Public Classes

Private Classes

  • yum_cron::config: Manage yum-cron configs
  • yum_cron::install: Install yum-cron
  • yum_cron::service: Manage yum-cron service

Resource types

Data types

Classes

yum_cron

Manage yum-cron

Parameters

The following parameters are available in the yum_cron class:

ensure

Data type: Enum['present', 'absent']

Defines the presence of yum-cron.

Default value: 'present'

enable

Data type: Boolean

Boolean that defines the state of yum-cron.

Default value: true

download_updates

Data type: Boolean

Boolean that determines if updates should be automatically downloaded.

Default value: true

apply_updates

Data type: Boolean

Boolean that determines if updates should be automatically installed. If set to true then download_updates ignored.

Default value: false

upgrade_type

Data type: Enum['default','security']

The kind of updates to perform. Applies only to EL8, EL9.

Default value: 'default'

debug_level

Data type: Pattern[/^(?:-)?[0-9]$/]

Sets debug level.

Default value: '-2'

exclude_packages

Data type: Array

Packages to exclude from updates.

Default value: []

randomwait

Data type: Pattern[/^[0-9]+$/]

Sets random wait time.

Default value: '360'

mailto

Data type: String

Address notified about updates.

Default value: 'root'

systemname

Data type: String

Name of system used in notifications.

Default value: $facts['networking']['fqdn']

email_host

Data type: String

Host used to send email messages.

Default value: 'localhost'

update_cmd

Data type: Yum_cron::Update_cmd

The kind of updates to use. Applies only to EL7. Valid values:

  • default = yum upgrade
  • security = yum --security upgrade
  • security-severity:Critical = yum --sec-severity=Critical upgrade
  • minimal = yum --bugfix upgrade-minimal
  • minimal-security = yum --security upgrade-minimal
  • minimal-security-severity:Critical = --sec-severity=Critical upgrade-minimal

Default value: 'default'

update_messages

Data type: Enum['yes','no']

Determines whether a message should be emitted when updates are available, downloaded, and applied. Applies only to EL7.

Default value: 'yes'

extra_configs

Data type: Hash

Hash that can be used to define additional configurations. Applies only to EL7, EL8, and EL9.

For EL8 and EL9 the hash defines additonal dnf_automatic_config resources. For EL7 the hash defines additional yum_cron_config resources.

Default value: {}

extra_hourly_configs

Data type: Hash

Hash that can be used to define additional hourly configurations. Applies only to EL7.

For EL7 the hash defines additional yum_cron_hourly_config resources.

Default value: {}

yum_autoupdate_ensure

Data type: Enum['undef', 'UNSET', 'absent', 'disabled']

Defines how to handle yum-autoupdate on Scientific Linux systems. Applies only to Scientific Linux. Valid values:

  • 'disabled' (default) - Sets ENABLED='false' in /etc/sysconfig/yum-autoupdate.
  • 'absent' - Uninstall the yum-autoupdate package.
  • 'undef' or 'UNSET' - Leave yum-autoupdate unmanaged.

Default value: 'disabled'

package_ensure

Data type: Optional[String]

The ensure value passed to yum-cron package resource. When undef, the value passed to the package resources is based on this class' ensure parameter value.

Default value: undef

package_name

Data type: String

yum-cron package name. Default is based on OS version.

service_name

Data type: String

yum-cron service name. Default is based on OS version.

service_ensure

Data type: Optional[String]

The ensure value passed to yum-cron service resource. When undef, the value passed to the service resources is based on this class' ensure and enable parameter values.

Default value: undef

service_enable

Data type: Optional[Boolean]

The ensure value passed to yum-cron package resource. When undef, the value passed to the service resources is based on this class' ensure and enable parameter values.

Default value: undef

service_hasstatus

Data type: Boolean

Service hasstatus property.

Default value: true

service_hasrestart

Data type: Boolean

Service hasrestart property.

Default value: true

config_path

Data type: Stdlib::Absolutepath

Path to yum-cron configuration. Default is based on OS version.

Resource types

dnf_automatic_config

Section/setting name to manage from dnf-automatic.conf

Properties

The following properties are available in the dnf_automatic_config type.

ensure

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

value

The value of the setting to be defined.

Parameters

The following parameters are available in the dnf_automatic_config type.

name

namevar

Section/setting name to manage from dnf-automatic.conf

provider

The specific backend to use for this dnf_automatic_config resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

yum_cron_config

Section/setting name to manage from yum-cron.conf

Properties

The following properties are available in the yum_cron_config type.

ensure

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

value

The value of the setting to be defined.

Parameters

The following parameters are available in the yum_cron_config type.

name

namevar

Section/setting name to manage from yum-cron.conf

provider

The specific backend to use for this yum_cron_config resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

yum_cron_hourly_config

Section/setting name to manage from yum-cron-hourly.conf

Properties

The following properties are available in the yum_cron_hourly_config type.

ensure

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

value

The value of the setting to be defined.

Parameters

The following parameters are available in the yum_cron_hourly_config type.

name

namevar

Section/setting name to manage from yum-cron-hourly.conf

provider

The specific backend to use for this yum_cron_hourly_config resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

Data types

Yum_cron::Update_cmd

yum-cron update cmd

Alias of Enum['default', 'security', 'security-severity:Critical', 'minimal', 'minimal-security', 'minimal-security-severity:Critical']