Skip to content

Latest commit

 

History

History
1149 lines (684 loc) · 35.4 KB

REFERENCE.md

File metadata and controls

1149 lines (684 loc) · 35.4 KB

Reference

Table of Contents

Classes

  • types: Module to manage types Puppet module to manage default types through hashes in Hiera with the create_resources() function. This module adds validation and helper functions, such as ensuring directories. Without specifying any hashes, this module will take no action.

Defined types

Data types

  • Types::Cron::Periodic: Data type for cron periodic values (hour, minute, month, monthday, weekday, or special)

Classes

types

Module to manage types Puppet module to manage default types through hashes in Hiera with the create_resources() function. This module adds validation and helper functions, such as ensuring directories. Without specifying any hashes, this module will take no action.

Parameters

The following parameters are available in the types class:

crons

Data type: Hash

Hash of resource type cron.

Default value: {}

execs

Data type: Hash

Hash of resource type exec.

Default value: {}

file_lines

Data type: Hash

Hash of resource type file_line.

Default value: {}

files

Data type: Hash

Hash of resource type file.

Default value: {}

mounts

Data type: Hash

Hash of resource type mount.

Default value: {}

packages

Data type: Hash

Hash of resource type package.

Default value: {}

selbooleans

Data type: Hash

Hash of resource type selboolean.

Default value: {}

services

Data type: Hash

Hash of resource type service.

Default value: {}

ensure_packages

Data type: Array

Array of packages to install with ensure_packages.

Default value: []

Defined types

types::cron

Define for cron types For a full description of the cron type check: https://github.com/puppetlabs/puppetlabs-cron_core/blob/main/REFERENCE.md

Parameters

The following parameters are available in the types::cron defined type:

command

Data type: String[1]

Value passed to command attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-cron_core/blob/main/REFERENCE.md#command for more information.

ensure

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

Value passed to ensure attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-cron_core/blob/main/REFERENCE.md#ensure for more information.

Default value: 'present'

environment

Data type: Optional[String[1]]

Value passed to environment attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-cron_core/blob/main/REFERENCE.md#environment for more information.

Default value: undef

hour

Data type: Optional[Types::Cron::Periodic]

Value passed to hour attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-cron_core/blob/main/REFERENCE.md#hour for more information.

Default value: undef

minute

Data type: Optional[Types::Cron::Periodic]

Value passed to minute attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-cron_core/blob/main/REFERENCE.md#minute for more information.

Default value: undef

month

Data type: Optional[Types::Cron::Periodic]

Value passed to month attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-cron_core/blob/main/REFERENCE.md#month for more information.

Default value: undef

monthday

Data type: Optional[Types::Cron::Periodic]

Value passed to monthday attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-cron_core/blob/main/REFERENCE.md#monthday for more information.

Default value: undef

provider

Data type: Optional[String[1]]

Value passed to provider attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-cron_core/blob/main/REFERENCE.md#provider for more information.

Default value: undef

special

Data type: Optional[Types::Cron::Periodic]

Value passed to special attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-cron_core/blob/main/REFERENCE.md#special for more information.

Default value: undef

target

Data type: Optional[String[1]]

Value passed to target attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-cron_core/blob/main/REFERENCE.md#target for more information.

Default value: undef

user

Data type: Optional[String[1]]

Value passed to user attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-cron_core/blob/main/REFERENCE.md#user for more information.

Default value: undef

weekday

Data type: Optional[Types::Cron::Periodic]

Value passed to weekday attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-cron_core/blob/main/REFERENCE.md#weekday for more information.

Default value: undef

types::exec

Define for exec types For a full description of the exec type check: https://www.puppet.com/docs/puppet/latest/types/exec.html

Parameters

The following parameters are available in the types::exec defined type:

command

Data type: String[1]

Value passed to command attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/exec.html#exec-attribute-command for more information.

creates

Data type: Optional[Stdlib::Absolutepath]

Value passed to creates attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/exec.html#exec-attribute-creates for more information.

Default value: undef

cwd

Data type: Optional[Stdlib::Absolutepath]

Value passed to cwd attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/exec.html#exec-attribute-cwd for more information.

Default value: undef

environment

Data type: Optional[String[1]]

Value passed to environment attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/exec.html#exec-attribute-environment for more information.

Default value: undef

group

Data type: Optional[String[1]]

Value passed to group attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/exec.html#exec-attribute-group for more information.

Default value: undef

logoutput

Data type: Optional[Variant[Boolean, Enum['on_failure']]]

Value passed to logoutput attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/exec.html#exec-attribute-logoutput for more information.

Default value: undef

onlyif

Data type: Optional[String[1]]

Value passed to onlyif attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/exec.html#exec-attribute-onlyif for more information.

Default value: undef

path

Data type: Optional[String[1]]

Value passed to path attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/exec.html#exec-attribute-path for more information.

Default value: undef

provider

Data type: Optional[Enum['posix', 'shell', 'windows']]

Value passed to provider attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/exec.html#exec-attribute-provider for more information.

Default value: undef

refresh

Data type: Optional[String[1]]

Value passed to refresh attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/exec.html#exec-attribute-refresh for more information.

Default value: undef

refreshonly

Data type: Optional[Boolean]

Value passed to refreshonly attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/exec.html#exec-attribute-refreshonly for more information.

Default value: undef

returns

Data type: Optional[Integer]

Value passed to returns attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/exec.html#exec-attribute-returns for more information.

Default value: undef

timeout

Data type: Optional[Integer]

Value passed to timeout attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/exec.html#exec-attribute-timeout for more information.

Default value: undef

tries

Data type: Optional[Integer]

Value passed to tries attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/exec.html#exec-attribute-tries for more information.

Default value: undef

try_sleep

Data type: Optional[Integer]

Value passed to try_sleep attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/exec.html#exec-attribute-try_sleep for more information.

Default value: undef

unless

Data type: Optional[String[1]]

Value passed to unless attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/exec.html#exec-attribute-unless for more information.

Default value: undef

user

Data type: Optional[String[1]]

Value passed to user attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/exec.html#exec-attribute-user for more information.

Default value: undef

types::file

Define for file types For a full description of the exec type check: https://www.puppet.com/docs/puppet/latest/types/file.html

Parameters

The following parameters are available in the types::file defined type:

ensure

Data type: Stdlib::Ensure::File

Value passed to ensure attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-ensure for more information.

Default value: 'present'

owner

Data type: String[1]

Value passed to owner attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-owner for more information.

Default value: 'root'

group

Data type: String[1]

Value passed to group attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-group for more information.

Default value: 'root'

mode

Data type: Stdlib::Filemode

Value passed to mode attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-mode for more information.

Default value: '0644'

backup

Data type: Optional[String[1]]

Value passed to backup attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-backup for more information.

Default value: undef

checksum

Data type: Optional[String[1]]

Value passed to checksum attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-checksum for more information.

Default value: undef

content

Data type: Optional[String[1]]

Value passed to content attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-content for more information.

Default value: undef

force

Data type: Optional[String[1]]

Value passed to force attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-force for more information.

Default value: undef

ignore

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

Value passed to ignore attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-ignore for more information.

Default value: undef

links

Data type: Optional[String[1]]

Value passed to links attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-links for more information.

Default value: undef

provider

Data type: Optional[String[1]]

Value passed to provider attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-provider for more information.

Default value: undef

purge

Data type: Optional[Variant[Boolean, Stdlib::Yes_no]]

Value passed to purge attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-purge for more information.

Default value: undef

recurse

Data type: Optional[Variant[Boolean, Enum['remote']]]

Value passed to recurse attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-recurse for more information.

Default value: undef

recurselimit

Data type: Optional[Integer]

Value passed to recurselimit attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-recurselimit for more information.

Default value: undef

replace

Data type: Optional[Variant[Boolean, Stdlib::Yes_no]]

Value passed to replace attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-replace for more information.

Default value: undef

selinux_ignore_defaults

Data type: Optional[Boolean]

Value passed to selinux_ignore_defaults attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-selinux_ignore_defaults for more information.

Default value: undef

selrange

Data type: Optional[String[1]]

Value passed to selrange attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-selrange for more information.

Default value: undef

selrole

Data type: Optional[String[1]]

Value passed to selrole attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-selrole for more information.

Default value: undef

seltype

Data type: Optional[String[1]]

Value passed to seltype attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-seltype for more information.

Default value: undef

seluser

Data type: Optional[String[1]]

Value passed to seluser attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-seluser for more information.

Default value: undef

show_diff

Data type: Optional[Variant[Boolean, Stdlib::Yes_no]]

Value passed to show_diff attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-show_diff for more information.

Default value: undef

source

Data type: Optional[Stdlib::Filesource]

Value passed to source attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-source for more information.

Default value: undef

sourceselect

Data type: Optional[String[1]]

Value passed to sourceselect attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-sourceselect for more information.

Default value: undef

target

Data type: Optional[String[1]]

Value passed to target attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/file.html#file-attribute-target for more information.

Default value: undef

types::file_line

Define for file_line types For a full description of the exec type check: https://github.com/puppetlabs/puppetlabs-stdlib/blob/main/REFERENCE.md#file_line

Parameters

The following parameters are available in the types::file_line defined type:

path

Data type: Stdlib::Absolutepath

Value passed to path attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-stdlib/blob/main/REFERENCE.md#-file_line--path for more information.

line

Data type: String[1]

Value passed to line attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-stdlib/blob/main/REFERENCE.md#line for more information.

match

Data type: Optional[String[1]]

Value passed to match attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-stdlib/blob/main/REFERENCE.md#-file_line--match for more information.

Default value: undef

ensure

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

Value passed to ensure attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-stdlib/blob/main/REFERENCE.md#ensure for more information.

Default value: 'present'

types::mount

Define for mount types For a full description of the mount type check: https://github.com/puppetlabs/puppetlabs-mount_core/blob/main/REFERENCE.md

Parameters

The following parameters are available in the types::mount defined type:

device

Data type: String[1]

Value passed to device attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-mount_core/blob/main/REFERENCE.md#device for more information.

fstype

Data type: String[1]

Value passed to fstype attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-mount_core/blob/main/REFERENCE.md#fstype for more information.

ensure

Data type: Enum['defined', 'present', 'unmounted', 'absent', 'mounted']

Value passed to ensure attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-mount_core/blob/main/REFERENCE.md#ensure for more information.

Default value: 'mounted'

atboot

Data type: Boolean

Value passed to atboot attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-mount_core/blob/main/REFERENCE.md#atboot for more information.

Default value: true

blockdevice

Data type: Optional[String[1]]

Value passed to blockdevice attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-mount_core/blob/main/REFERENCE.md#blockdevice for more information.

Default value: undef

dump

Data type: Optional[String[1]]

Value passed to dump attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-mount_core/blob/main/REFERENCE.md#dump for more information.

Default value: undef

options

Data type: Optional[String[1]]

Value passed to options attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-mount_core/blob/main/REFERENCE.md#options for more information.

Default value: undef

pass

Data type: Optional[String[1]]

Value passed to pass attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-mount_core/blob/main/REFERENCE.md#pass for more information.

Default value: undef

provider

Data type: Optional[String[1]]

Value passed to provider attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-mount_core/blob/main/REFERENCE.md#provider for more information.

Default value: undef

remounts

Data type: Optional[Boolean]

Value passed to remounts attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-mount_core/blob/main/REFERENCE.md#remounts for more information.

Default value: undef

target

Data type: Optional[String[1]]

Value passed to target attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-mount_core/blob/main/REFERENCE.md#target for more information.

Default value: undef

types::package

Define for package types For a full description of the exec type check: https://www.puppet.com/docs/puppet/latest/types/package.html

Parameters

The following parameters are available in the types::package defined type:

ensure

Data type: Stdlib::Ensure::Package

Value passed to ensure attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/package.html#package-attribute-ensure for more information.

Default value: 'present'

adminfile

Data type: Optional[Stdlib::Absolutepath]

Value passed to adminfile attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/package.html#package-attribute-adminfile for more information.

Default value: undef

allowcdrom

Data type: Optional[String[1]]

Value passed to allowcdrom attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/package.html#package-attribute-allowcdrom for more information.

Default value: undef

configfiles

Data type: Optional[Enum['keep', 'replace']]

Value passed to configfiles attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/package.html#package-attribute-configfiles for more information.

Default value: undef

install_options

Data type: Optional[String[1]]

Value passed to install_options attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/package.html#package-attribute-install_options for more information.

Default value: undef

provider

Data type: Optional[String[1]]

Value passed to provider attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/package.html#package-attribute-provider for more information.

Default value: undef

responsefile

Data type: Optional[Stdlib::Absolutepath]

Value passed to responsefile attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/package.html#package-attribute-responsefile for more information.

Default value: undef

source

Data type: Optional[String[1]]

Value passed to source attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/package.html#package-attribute-source for more information.

Default value: undef

uninstall_options

Data type: Optional[String[1]]

Value passed to uninstall_options attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/package.html#package-attribute-uninstall_options for more information.

Default value: undef

types::selboolean

Define for selboolean types For a full description of the cron type check: https://github.com/puppetlabs/puppetlabs-selinux_core/blob/main/REFERENCE.md

Parameters

The following parameters are available in the types::selboolean defined type:

value

Data type: Enum['on', 'off']

Value passed to value attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-selinux_core/blob/main/REFERENCE.md#value for more information.

persistent

Data type: Boolean

Value passed to persistent attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-selinux_core/blob/main/REFERENCE.md#persistent for more information.

Default value: false

provider

Data type: Optional[String[1]]

Value passed to provider attribute. Unused if empty. Check https://github.com/puppetlabs/puppetlabs-selinux_core/blob/main/REFERENCE.md#provider for more information.

Default value: undef

types::service

Define for service types For a full description of the exec type check: https://www.puppet.com/docs/puppet/latest/types/service.html

Parameters

The following parameters are available in the types::service defined type:

ensure

Data type: Stdlib::Ensure::Service

Value passed to ensure attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/service.html#service-attribute-ensure for more information.

Default value: 'running'

binary

Data type: Optional[String[1]]

Value passed to binary attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/service.html#service-attribute-binary for more information.

Default value: undef

control

Data type: Optional[String[1]]

Value passed to control attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/service.html#service-attribute-control for more information.

Default value: undef

enable

Data type: Variant[Boolean, Enum['manual']]

Value passed to enable attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/service.html#service-attribute-enable for more information.

Default value: true

hasrestart

Data type: Optional[Boolean]

Value passed to hasrestart attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/service.html#service-attribute-hasrestart for more information.

Default value: undef

hasstatus

Data type: Optional[Boolean]

Value passed to hasstatus attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/service.html#service-attribute-hasstatus for more information.

Default value: undef

manifest

Data type: Optional[String[1]]

Value passed to manifest attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/service.html#service-attribute-manifest for more information.

Default value: undef

path

Data type: Optional[String[1]]

Value passed to path attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/service.html#service-attribute-path for more information.

Default value: undef

pattern

Data type: Optional[String[1]]

Value passed to pattern attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/service.html#service-attribute-pattern for more information.

Default value: undef

provider

Data type: Optional[String[1]]

Value passed to provider attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/service.html#service-attribute-provider for more information.

Default value: undef

restart

Data type: Optional[String[1]]

Value passed to restart attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/service.html#service-attribute-restart for more information.

Default value: undef

start

Data type: Optional[String[1]]

Value passed to start attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/service.html#service-attribute-start for more information.

Default value: undef

status

Data type: Optional[String[1]]

Value passed to status attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/service.html#service-attribute-status for more information.

Default value: undef

stop

Data type: Optional[String[1]]

Value passed to stop attribute. Unused if empty. Check https://www.puppet.com/docs/puppet/latest/types/service.html#service-attribute-stop for more information.

Default value: undef

Data types

Types::Cron::Periodic

Data type for cron periodic values (hour, minute, month, monthday, weekday, or special)

Alias of Variant[Array, Integer, String[1]]