REFERENCE.md

Reference

Table of Contents

Classes

Public Classes

• mlocate: mlocate class, install and configure mlocate or plocate

Private Classes

• mlocate::config: This class handles configuration of mlocate
• mlocate::install: This class handles installation of mlocate

Classes

mlocate

mlocate class, install and configure mlocate or plocate

Examples

Simple Case

class{'mlocate':
  prunepaths   => ['/afs', '/mnt' ],
  prunefs      => ['afs', 'fuse'],
  prunenames   => ['.cache', '.git'],
  period       => weekly,
  force_update => true,
}

Use plocate rather than mlocate

class{ 'mlocate':
  locate => 'plocate',
}

Parameters

The following parameters are available in the mlocate class:

• package_names
• locate
• ensure
• prunefs
• prune_bind_mounts
• prunepaths
• prunenames
• period
• package_cron
• force_updatedb

package_names

Data type: Optional[Array[String[1]]]

Deprecated

Default value: undef

locate

Data type: Enum['mlocate','plocate']

Use plocate or mlocate, default per OS in hiera

ensure

Data type: Boolean

Install mlocate or remove mlocate

Default value: true

prunefs

Data type: Array[String[1]]

List of filesystem types to ignore

Default value: []

prune_bind_mounts

Data type: Boolean

Should bind mounts be searched?

Default value: true

prunepaths

Data type: Array[Stdlib::Unixpath]

List of file systems paths not to search

Default value: []

prunenames

Data type: Array[String[1]]

List of directory or files names to match adn not include.

Default value: []

period

Data type: Enum['infinite','daily','weekly','monthly']

Should the update interval be daily, weekly, monthly or infinite.

Default value: 'daily'

package_cron

Data type: Optional[Stdlib::Unixpath]

Path to a cron file entry to be purged.

Default value: undef

force_updatedb

Data type: Boolean

Should puppet run updatedb if no database already exists.

Default value: false