REFERENCE.md

Reference

Table of Contents

Classes

Public Classes

• nscd: Configures /etc/ncsd.conf and controls nscd service.
• nscd::config: == Class nscd::config Configures nscd.

Private Classes

• nscd::install: installs nscd
• nscd::service: controls nscd service

Data types

• Nscd::Database: hash of configuration in nscd.conf
• Nscd::Database::Settings: all possible settings an nscd database can have

Classes

nscd

nscd class.

Note for each database at least the enable-cache key must be specified.

Examples

class{'nscd':
  dbconfigs  => {
    'passwd' => {'enable-cache'         => true,
                 'maximum-time-to-live' => 100,
                 },
    'group' => {'enable-cache'         => true,
                'maximum-time-to-live' => 100,
               },

  }

Parameters

The following parameters are available in the nscd class:

• pkg_ensure
• service_ensure
• service_enable
• threads
• max_threads
• paranoia
• restart_interval
• user
• stat_user
• debug_level
• reload_count
• logfile
• dbconfig

pkg_ensure

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

state of nscd package.

Default value: 'present'

service_ensure

Data type: Boolean

state of nscd service ensure

Default value: true

service_enable

Data type: Boolean

state of nscd service enable

Default value: true

threads

Data type: Integer

number of threads.

Default value: 5

max_threads

Data type: Integer

maximum number of threads.

Default value: 32

paranoia

Data type: Boolean

enable internal restart mode.

Default value: false

restart_interval

Data type: Optional[Integer]

nscd internal restart interval

Default value: undef

user

Data type: String[1]

specify which user should run nscd

Default value: 'root'

stat_user

Data type: Optional[String[1]]

which users can query statistics

Default value: undef

debug_level

Data type: Integer

debug level

Default value: 0

reload_count

Data type: Integer

any many reload attempts to make

Default value: 5

logfile

Data type: Optional[Stdlib::UnixPath]

specify a debug log file location.

Default value: undef

dbconfig

Data type: Nscd::Database

configuration for each of the passwd, group, hosts and service database.

nscd::config

== Class nscd::config Configures nscd.

Data types

Nscd::Database

hash of configuration in nscd.conf

Alias of

Struct[{
    Optional['passwd']   => Nscd::Database::Settings,
    Optional['group']    => Nscd::Database::Settings,
    Optional['hosts']    => Nscd::Database::Settings,
    Optional['services'] => Nscd::Database::Settings,
    Optional['netgroup'] => Nscd::Database::Settings,
  }]

Nscd::Database::Settings

all possible settings an nscd database can have

Alias of

Struct[{
    'enable-cache'                    => Boolean,
    Optional['positive-time-to-live'] => Integer,
    Optional['negative-time-to-live'] => Integer,
    Optional['suggested-size']        => Integer,
    Optional['check-files']           => Boolean,
    Optional['persistent']            => Boolean,
    Optional['shared']                => Boolean,
    Optional['max-db-size']           => Integer,
    Optional['auto-propagate']        => Boolean,
  }]