Skip to content

REFERENCE.md

Latest commit

 

History

History
1590 lines (896 loc) · 41.3 KB

REFERENCE.md

File metadata and controls

1590 lines (896 loc) · 41.3 KB
Raw

Reference

Table of Contents

Classes

  • nscd: Class to manage nscd, Linuxs Name Service Cache Daemon.

Recommend reading the man page, NSCD.CONF(5). This module allows for parameterization of all options specified in the man page.

The module assumes that you want to set enable-cache to true for each of the services (passwd, group, hosts, and services). If this is not the case, you can disable the cache on a per service basis.

To use this module simply include ::nscd

Compatibility

This module has been tested to work on the following systems:

  • Amazon Linux 2015
  • Amazon Linux 2016
  • Amazon Linux 2017
  • Debian 6
  • EL 5
  • EL 6
  • EL 7
  • EL 8
  • EL 9
  • Solaris 10
  • Suse 10
  • Suse 11
  • Suse 12
  • Suse 15
  • OpenSuse 13.1
  • Ubuntu 12.04 LTS
  • Ubuntu 14.04 LTS
  • Ubuntu 16.04 LTS
  • Ubuntu 18.04 LTS
  • Ubuntu 20.04 LTS
  • Ubuntu 22.04 LTS

Compatibility with Dell Authentication Services

When using nscd in combination with Dell Authentication Services (QAS/VAS) [1] it is recommended to turn off caching of passwd and groups.

nscd::passwd_enable_cache: 'no'
nscd::group_enable_cache:  'no'

[1] http://software.dell.com/products/authentication-services/

Classes

nscd

== Class: nscd

Parameters

The following parameters are available in the nscd class:

audit_user_check_files

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

Settings for check-files audit_user in nscd.conf.

Default value: 'yes'

audit_user_enable_cache

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

Settings for enable-cache audit_user in nscd.conf.

Default value: 'yes'

audit_user_keep_hot_count

Data type: Integer

Settings for keep-hot-count audit_user in nscd.conf.

Default value: 2048

audit_user_negative_time_to_live

Data type: Integer

Settings for negative-time-to-live audit_user in nscd.conf.

Default value: 20

audit_user_positive_time_to_live

Data type: Integer

Settings for positive-time-to-live audit_user in nscd.conf.

Default value: 3600

auth_attr_check_files

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

Settings for check-files auth_attr in nscd.conf.

Default value: 'yes'

auth_attr_enable_cache

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

Settings for enable-cache auth_attr in nscd.conf.

Default value: 'yes'

auth_attr_keep_hot_count

Data type: Integer

Settings for keep-hot-count auth_attr in nscd.conf.

Default value: 2048

auth_attr_negative_time_to_live

Data type: Integer

Settings for negative-time-to-live auth_attr in nscd.conf. Must be a number in seconds.

Default value: 20

auth_attr_positive_time_to_live

Data type: Integer

Settings for positive-time-to-live auth_attr in nscd.conf. Must be a number in seconds.

Default value: 3600

bootparams_check_files

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

Settings for check-files bootparams in nscd.conf.

Default value: 'yes'

bootparams_enable_cache

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

Settings for enable-cache bootparams in nscd.conf.

Default value: 'yes'

bootparams_keep_hot_count

Data type: Integer

Settings for keep-hot-count bootparams in nscd.conf.

Default value: 2048

bootparams_negative_time_to_live

Data type: Integer

Settings for negative-time-to-live bootparams in nscd.conf. Must be a number in seconds.

Default value: 20

bootparams_positive_time_to_live

Data type: Integer

Settings for positive-time-to-live bootparams in nscd.conf. Must be a number in seconds.

Default value: 3600

config_group

Data type: String[1]

Group of nscd.conf.

Default value: 'root'

config_mode

Data type: Stdlib::Filemode

Mode of nscd.conf.

Default value: '0644'

config_path

Data type: Stdlib::Absolutepath

Path to nscd.conf.

Default value: '/etc/nscd.conf'

config_owner

Data type: String[1]

Owner of nscd.conf.

Default value: 'root'

debug_level

Data type: Integer

Setting for debug-level in nscd.conf. See nscd.conf(5).

Default value: 0

enable_db_audit_user

Data type: Boolean

Settings for enable_db_audit_user in nscd.conf.

Default value: false

enable_db_auth_attr

Data type: Boolean

Settings for enable_db_auth_attr in nscd.conf.

Default value: false

enable_db_bootparams

Data type: Boolean

Settings for enable_db_bootparams in nscd.conf.

Default value: false

enable_db_ethers

Data type: Boolean

Settings for enable_db_ethers in nscd.conf.

Default value: false

enable_db_exec_attr

Data type: Boolean

Settings for enable_db_exec_attr in nscd.conf.

Default value: false

enable_db_group

Data type: Boolean

Switch to show group section in nscd.conf.

Default value: false

enable_db_hosts

Data type: Boolean

Switch to show hosts section in nscd.conf.

Default value: false

enable_db_ipnodes

Data type: Boolean

Settings for enable_db_ipnodes in nscd.conf.

Default value: false

enable_db_netgroup

Data type: Boolean

Switch to show netgroup section in nscd.conf.

Default value: false

enable_db_netmasks

Data type: Boolean

Settings for enable_db_netmasks in nscd.conf.

Default value: false

enable_db_networks

Data type: Boolean

Settings for enable_db_networks in nscd.conf.

Default value: false

enable_db_passwd

Data type: Boolean

Switch to show passwd section in nscd.conf.

Default value: false

enable_db_printers

Data type: Boolean

Settings for enable_db_printers in nscd.conf.

Default value: false

enable_db_prof_attr

Data type: Boolean

Settings for enable_db_prof_attr in nscd.conf.

Default value: false

enable_db_project

Data type: Boolean

Settings for enable_db_project in nscd.conf.

Default value: false

enable_db_protocols

Data type: Boolean

Settings for enable_db_protocols in nscd.conf.

Default value: false

enable_db_rpc

Data type: Boolean

Settings for enable_db_rpc in nscd.conf.

Default value: false

enable_db_services

Data type: Boolean

Switch to show services section in nscd.conf.

Default value: false

enable_db_tnrhdb

Data type: Boolean

Settings for enable_db_tnrhdb in nscd.conf.

Default value: false

enable_db_tnrhtp

Data type: Boolean

Settings for enable_db_tnrhtp in nscd.conf.

Default value: false

enable_db_user_attr

Data type: Boolean

Settings for enable_db_user_attr in nscd.conf.

Default value: false

enable_opt_auto_propagate

Data type: Boolean

Settings for enable_opt_auto_propagate in nscd.conf.

Default value: false

ethers_check_files

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

Settings for check-files ethers in nscd.conf.

Default value: 'yes'

ethers_enable_cache

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

Settings for enable-cache ethers in nscd.conf.

Default value: 'yes'

ethers_keep_hot_count

Data type: Integer

Settings for keep-hot-count ethers in nscd.conf.

Default value: 2048

ethers_negative_time_to_live

Data type: Integer

Settings for negative-time-to-live ethers in nscd.conf.

Default value: 20

ethers_positive_time_to_live

Data type: Integer

Settings for positive-time-to-live ethers in nscd.conf. Must be a number in seconds.

Default value: 3600

exec_attr_check_files

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

Settings for check-files exec_attr in nscd.conf.

Default value: 'yes'

exec_attr_enable_cache

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

Settings for enable-cache exec_attr in nscd.conf.

Default value: 'yes'

exec_attr_keep_hot_count

Data type: Integer

Settings for keep-hot-count exec_attr in nscd.conf.

Default value: 2048

exec_attr_negative_time_to_live

Data type: Integer

Settings for negative-time-to-live exec_attr in nscd.conf.

Default value: 20

exec_attr_positive_time_to_live

Data type: Integer

Settings for positive-time-to-live exec_attr in nscd.conf. Must be a number in seconds.

Default value: 3600

group_auto_propagate

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

Settings for auto-propagate group in nscd.conf.

Default value: 'yes'

group_check_files

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

Settings for check-files group in nscd.conf.

Default value: 'yes'

group_enable_cache

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

Settings for enable-cache netgroup in nscd.conf.

Default value: 'yes'

group_keep_hot_count

Data type: Integer

Settings for keep-hot-count group in nscd.conf.

Default value: 2048

group_max_db_size

Data type: Integer

Settings for max-db-size group in nscd.conf.

Default value: 33554432

group_negative_time_to_live

Data type: Integer

Settings for negative-time-to-live group in nscd.conf.

Default value: 60

group_persistent

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

Settings for persistent group in nscd.conf.

Default value: 'yes'

group_positive_time_to_live

Data type: Integer

Settings for positive-time-to-live group in nscd.conf. Must be a number in seconds.

Default value: 3600

group_shared

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

Settings for shared group in nscd.conf.

Default value: 'yes'

group_suggested_size

Data type: Integer

Settings for suggested-size group in nscd.conf.

Default value: 211

hosts_check_files

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

Settings for check-files hosts in nscd.conf.

Default value: 'yes'

hosts_enable_cache

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

Settings for enable-cache hosts in nscd.conf.

Default value: 'yes'

hosts_keep_hot_count

Data type: Integer

Settings for keep-hot-count hosts in nscd.conf.

Default value: 2048

hosts_max_db_size

Data type: Integer

Settings for max-db-size hosts in nscd.conf. Must be a number in bytes.

Default value: 33554432

hosts_negative_time_to_live

Data type: Integer

Settings for negative-time-to-live hosts in nscd.conf. Must be a number in seconds.

Default value: 20

hosts_persistent

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

Settings for persistent hosts in nscd.conf.

Default value: 'yes'

hosts_positive_time_to_live

Data type: Integer

Settings for positive-time-to-live hosts in nscd.conf. Must be a number in seconds.

Default value: 3600

hosts_shared

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

Settings for shared hosts in nscd.conf.

Default value: 'yes'

hosts_suggested_size

Data type: Integer

Settings for suggested-size hosts in nscd.conf.

Default value: 211

ipnodes_check_files

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

Settings for check-files ipnodes in nscd.conf.

Default value: 'yes'

ipnodes_enable_cache

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

Settings for enable-cache ipnodes in nscd.conf.

Default value: 'yes'

ipnodes_keep_hot_count

Data type: Integer

Settings for keep-hot-count ipnodes in nscd.conf.

Default value: 2048

ipnodes_negative_time_to_live

Data type: Integer

Settings for negative-time-to-live ipnodes in nscd.conf. Must be a number in seconds.

Default value: 20

ipnodes_positive_time_to_live

Data type: Integer

Settings for positive-time-to-live ipnodes in nscd.conf. Must be a number in seconds.

Default value: 3600

logfile

Data type: Stdlib::Absolutepath

Setting for logfile in nscd.conf. See nscd.conf(5).

Default value: '/var/log/nscd.log'

max_threads

Data type: Integer

Setting for max-threads in nscd.conf. See nscd.conf(5).

Default value: 32

netgroup_check_files

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

Settings for check-files netgroup in nscd.conf.

Default value: 'yes'

netgroup_enable_cache

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

Settings for enable-cache netgroup in nscd.conf.

Default value: 'yes'

netgroup_max_db_size

Data type: Integer

Settings for max-db-size netgroup in nscd.conf. Must be a number in bytes.

Default value: 33554432

netgroup_negative_time_to_live

Data type: Integer

Settings for negative-time-to-live netgroup in nscd.conf. Must be a number in seconds.

Default value: 20

netgroup_persistent

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

Settings for persistent netgroup in nscd.conf.

Default value: 'yes'

netgroup_positive_time_to_live

Data type: Integer

Settings for positive-time-to-live netgroup in nscd.conf. Must be a number in seconds.

Default value: 28800

netgroup_shared

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

Settings for shared netgroup in nscd.conf.

Default value: 'yes'

netgroup_suggested_size

Data type: Integer

Settings for suggested-size netgroup in nscd.conf.

Default value: 211

netmasks_check_files

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

Settings for check-files netmasks in nscd.conf.

Default value: 'yes'

netmasks_enable_cache

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

Settings for enable-cache netmasks in nscd.conf.

Default value: 'yes'

netmasks_keep_hot_count

Data type: Integer

Settings for keep-hot-count netmasks in nscd.conf.

Default value: 2048

netmasks_negative_time_to_live

Data type: Integer

Settings for negative-time-to-live netmasks in nscd.conf. Must be a number in seconds.

Default value: 20

netmasks_positive_time_to_live

Data type: Integer

Settings for positive-time-to-live netmasks in nscd.conf. Must be a number in seconds.

Default value: 3600

networks_check_files

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

Settings for check-files networks in nscd.conf.

Default value: 'yes'

networks_enable_cache

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

Settings for enable-cache networks in nscd.conf.

Default value: 'yes'

networks_keep_hot_count

Data type: Integer

Settings for keep-hot-count networks in nscd.conf.

Default value: 2048

networks_negative_time_to_live

Data type: Integer

Settings for negative-time-to-live networks in nscd.conf. Must be a number in seconds.

Default value: 20

networks_positive_time_to_live

Data type: Integer

Settings for positive-time-to-live networks in nscd.conf. Must be a number in seconds.

Default value: 3600

package_adminfile

Data type: Optional[Stdlib::Absolutepath]

Solaris specific adminfile attribute of package resource.

Default value: undef

package_ensure

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

Solaris specific source attribute of package resource.

Default value: 'present'

package_name

Data type: Array

Array for name of package(s).

Default value: ['nscd']

package_source

Data type: Optional[Stdlib::Absolutepath]

Solaris specific source attribute of package resource.

Default value: undef

paranoia

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

Setting for paranoia in nscd.conf. See nscd.conf(5).

Default value: 'no'

passwd_auto_propagate

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

Settings for auto-propagate passwd in nscd.conf.

Default value: 'yes'

passwd_check_files

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

Settings for check-files passwd in nscd.conf.

Default value: 'yes'

passwd_enable_cache

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

Settings for enable-cache passwd in nscd.conf.

Default value: 'yes'

passwd_keep_hot_count

Data type: Integer

Settings for keep-hot-count passwd in nscd.conf.

Default value: 2048

passwd_max_db_size

Data type: Integer

Settings for max-db-size passwd in nscd.conf.

Default value: 33554432

passwd_negative_time_to_live

Data type: Integer

Settings for negative-time-to-live passwd in nscd.conf. Must be a number in seconds.

Default value: 20

passwd_persistent

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

Settings for persistent passwd in nscd.conf.

Default value: 'yes'

passwd_positive_time_to_live

Data type: Integer

Settings for positive-time-to-live passwd in nscd.conf. Must be a number in seconds.

Default value: 600

passwd_shared

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

Settings for shared passwd in nscd.conf.

Default value: 'yes'

passwd_suggested_size

Data type: Integer

Settings for suggested-size passwd in nscd.conf.

Default value: 211

printers_check_files

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

Settings for check-files printers in nscd.conf.

Default value: 'yes'

printers_enable_cache

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

Settings for enable-cache printers in nscd.conf.

Default value: 'yes'

printers_keep_hot_count

Data type: Integer

Settings for keep-hot-count printers in nscd.conf.

Default value: 2048

printers_negative_time_to_live

Data type: Integer

Settings for negative-time-to-live printers in nscd.conf. Must be a number in seconds.

Default value: 20

printers_positive_time_to_live

Data type: Integer

Settings for positive-time-to-live printers in nscd.conf. Must be a number in seconds.

Default value: 3600

prof_attr_check_files

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

Settings for check-files prof_attr in nscd.conf.

Default value: 'yes'

prof_attr_enable_cache

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

Settings for enable-cache prof_attr in nscd.conf.

Default value: 'yes'

prof_attr_keep_hot_count

Data type: Integer

Settings for keep-hot-count prof_attr in nscd.conf.

Default value: 2048

prof_attr_negative_time_to_live

Data type: Integer

Settings for negative-time-to-live prof_attr in nscd.conf. Must be a number in seconds.

Default value: 20

prof_attr_positive_time_to_live

Data type: Integer

Settings for positive-time-to-live prof_attr in nscd.conf. Must be a number in seconds.

Default value: 3600

project_check_files

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

Settings for check-files project in nscd.conf.

Default value: 'yes'

project_enable_cache

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

Settings for enable-cache project in nscd.conf.

Default value: 'yes'

project_keep_hot_count

Data type: Integer

Settings for keep-hot-count project in nscd.conf.

Default value: 2048

project_negative_time_to_live

Data type: Integer

Settings for negative-time-to-live project in nscd.conf. Must be a number in seconds.

Default value: 20

project_positive_time_to_live

Data type: Integer

Settings for positive-time-to-live project in nscd.conf. Must be a number in seconds.

Default value: 3600

protocols_check_files

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

Settings for check-files protocols in nscd.conf.

Default value: 'yes'

protocols_enable_cache

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

Settings for enable-cache protocols in nscd.conf.

Default value: 'yes'

protocols_keep_hot_count

Data type: Integer

Settings for keep-hot-count protocols in nscd.conf.

Default value: 2048

protocols_negative_time_to_live

Data type: Integer

Settings for negative-time-to-live protocols in nscd.conf. Must be a number in seconds.

Default value: 20

protocols_positive_time_to_live

Data type: Integer

Settings for positive-time-to-live protocols in nscd.conf. Must be a number in seconds.

Default value: 3600

reload_count

Data type: Variant[Integer, Enum['unlimited']]

Settings for reload-count in nscd.conf. See nscd.conf(5).

Default value: 5

restart_interval

Data type: Integer

Setting for restart-interval in nscd.conf. See nscd.conf(5).

Default value: 3600

rpc_check_files

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

Settings for check-files rpc in nscd.conf.

Default value: 'yes'

rpc_enable_cache

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

Settings for enable-cache rpc in nscd.conf.

Default value: 'yes'

rpc_keep_hot_count

Data type: Integer

Settings for keep-hot-count rpc in nscd.conf.

Default value: 2048

rpc_negative_time_to_live

Data type: Integer

Settings for negative-time-to-live rpc in nscd.conf. Must be a number in seconds.

Default value: 20

rpc_positive_time_to_live

Data type: Integer

Settings for positive-time-to-live rpc in nscd.conf. Must be a number in seconds.

Default value: 3600

server_user

Data type: Optional[String[1]]

Setting for server-user in nscd.conf. See nscd.conf(5).

Default value: undef

service_enable

Data type: Boolean

Value of enable attribute of nscd service. This determines if the service will start at boot or not.

Default value: true

service_ensure

Data type: Stdlib::Ensure::Service

Value of ensure attribute of nscd service.

Default value: 'running'

service_name

Data type: String[1]

Name of service(s)

Default value: 'nscd'

service_provider

Data type: Optional[String[1]]

String for value of the provider attribute of nscd service. Specifying here will allow you to change the platforms default.

Default value: undef

services_check_files

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

Settings for check-files services in nscd.conf.

Default value: 'yes'

services_enable_cache

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

Settings for enable-cache services in nscd.conf.

Default value: 'yes'

services_keep_hot_count

Data type: Integer

Settings for keep-hot-count services in nscd.conf.

Default value: 2048

services_max_db_size

Data type: Integer

Settings for max-db-size servicess in nscd.conf. Must be a number in bytes.

Default value: 33554432

services_negative_time_to_live

Data type: Integer

Settings for negative-time-to-live services in nscd.conf. Must be a number in seconds.

Default value: 20

services_persistent

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

Settings for persistent services in nscd.conf.

Default value: 'yes'

services_positive_time_to_live

Data type: Integer

Settings for positive-time-to-live services in nscd.conf. Must be a number in seconds.

Default value: 28800

services_shared

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

Settings for shared services in nscd.conf.

Default value: 'yes'

services_suggested_size

Data type: Integer

Settings for suggested-size services in nscd.conf.

Default value: 211

stat_user

Data type: String[1]

Setting for stat-user in nscd.conf. See nscd.conf(5).

Default value: 'root'

threads

Data type: Integer

Setting for threads in nscd.conf. See nscd.conf(5).

Default value: 5

tnrhdb_check_files

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

Settings for check-files tnrhdb in nscd.conf.

Default value: 'yes'

tnrhdb_enable_cache

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

Settings for enable-cache tnrhdb in nscd.conf.

Default value: 'yes'

tnrhdb_keep_hot_count

Data type: Integer

Settings for keep-hot-count tnrhdb in nscd.conf.

Default value: 2048

tnrhdb_negative_time_to_live

Data type: Integer

Settings for negative-time-to-live tnrhdb in nscd.conf. Must be a number in seconds.

Default value: 20

tnrhdb_positive_time_to_live

Data type: Integer

Settings for positive-time-to-live tnrhdb in nscd.conf. Must be a number in seconds.

Default value: 3600

tnrhtp_check_files

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

Settings for check-files tnrhdb in nscd.conf.

Default value: 'yes'

tnrhtp_enable_cache

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

Settings for enable-cache tnrhdb in nscd.conf.

Default value: 'yes'

tnrhtp_keep_hot_count

Data type: Integer

Settings for keep-hot-count tnrhdb in nscd.conf.

Default value: 2048

tnrhtp_negative_time_to_live

Data type: Integer

Settings for negative-time-to-live tnrhdb in nscd.conf. Must be a number in seconds.

Default value: 20

tnrhtp_positive_time_to_live

Data type: Integer

Settings for positive-time-to-live tnrhdb in nscd.conf. Must be a number in seconds.

Default value: 3600

user_attr_check_files

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

Settings for check-files user_attr in nscd.conf.

Default value: 'yes'

user_attr_enable_cache

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

Settings for enable-cache user_attr in nscd.conf.

Default value: 'yes'

user_attr_keep_hot_count

Data type: Integer

Settings for keep-hot-count user_attr in nscd.conf.

Default value: 2048

user_attr_negative_time_to_live

Data type: Integer

Settings for negative-time-to-live user_attr in nscd.conf. Must be a number in seconds.

Default value: 20

user_attr_positive_time_to_live

Data type: Integer

Settings for positive-time-to-live user_attr in nscd.conf. Must be a number in seconds.

Default value: 3600