Skip to content

Latest commit

 

History

History
218 lines (118 loc) · 4.71 KB

REFERENCE.md

File metadata and controls

218 lines (118 loc) · 4.71 KB

Reference

Table of Contents

Classes

Resource types

Classes

opendmarc

main class to include

Parameters

The following parameters are available in the opendmarc class:

configs

Data type: Hash

configurations to load

Default value: {}

defaults

Data type: Hash

defaults to load

Default value: {}

opendmarc::install

Internal class, that ensures opendmarc is installed.

Parameters:

Parameters

The following parameters are available in the opendmarc::install class:

packages

Data type: Array

Array of packages to install

Default value: ['opendmarc']

package_ensure

Data type: String

ensure for package install defaults to 'installed'

Default value: 'installed'

opendmarc::service

create the opendmarc Service

Parameters:

Parameters

The following parameters are available in the opendmarc::service class:

service_name

Data type: String

The name of the service Defaults to 'opendmarc'

Default value: 'opendmarc'

service_ensure

Data type: String

state of the service. Defaults to 'running'

Default value: 'running'

service_enable

Data type: Boolean

if service should be enabled Defaults to true

Default value: true

Resource types

opendmarc_config

setting name to manage from opendmarc

Properties

The following properties are available in the opendmarc_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 opendmarc_config type.

name

Valid values: %r{\S+}

namevar

setting name to manage from opendmarc

provider

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

secret

Valid values: true, false

Whether to hide the value from Puppet logs. Defaults to false.

Default value: false

opendmarc_default

setting name to manage default opendmarc

Properties

The following properties are available in the opendmarc_default 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 opendmarc_default type.

name

Valid values: %r{\S+}

namevar

setting name to manage default opendmarc

provider

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

secret

Valid values: true, false

Whether to hide the value from Puppet logs. Defaults to false.

Default value: false