Skip to content

Latest commit

 

History

History
242 lines (145 loc) · 6.32 KB

REFERENCE.md

File metadata and controls

242 lines (145 loc) · 6.32 KB

Reference

Table of Contents

Classes

  • qpage: This is the base qpage class that should orchestrate the installation of all the other pieces that make up the software.
  • qpage::config: This class takes care of all necessary configuration
  • qpage::install: This class takes care of all necessary package installations
  • qpage::service: This class takes care of all necessary services

Classes

qpage

Document parameters here.

Examples

Basic example to include the class
include qpage
Include the class with options
class { 'qpage':
  config_ensure  => 'absent',
  package_ensure => 'absent',
  service_ensure => 'stopped',
}

Parameters

The following parameters are available in the qpage class:

administrator

Data type: String

The e-mail address of the QuickPage administrator.

config_ensure

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

Specifies the ensure parameter to the configuration file.

config_group

Data type: String

The group of the configuration file.

config_mode

Data type: String

The file mode for the configuration file.

config_owner

Data type: String

The owner of the configuration file.

config_path

Data type: String

The path to the configuration file.

forcehostname

Data type: Enum['false', 'true']

Force the destination address to be qualified with a hostname when sending e-mail status notification to users.

groups

Data type: Optional[Hash]

A hash of hashes to define pager groups. The keys of the top-level hashes are the names of the groups. The sub hashes should contain key/value pairs with keys consisting of: text and members (which should be an array).

identtimeout

Data type: String

The number of seconds to wait for a reply before giving up on RFC-1413 queries.

include

Data type: Optional[String]

Specifies the name of another configuration file that should be processed.

lockdir

Data type: Optional[String]

The location of the lock directory.

modems

Data type: Hash

A hash of hashes to define modems. The keys of the top-level hashes are the names of the modem device. The sub hashes should contain key/value pairs with keys consisting of: text, device, initcmd, and dialcmd.

package_ensure

Data type: Enum['absent', 'held', 'installed', 'lastest', 'present', 'purged']

Whether or not to install the package (Default: 'present')

package_name

Data type: String

The name of the package to install (Default: 'qpage')

package_provider

Data type: String

The provider used to install the package

pagers

Data type: Hash

A hash of hashes to define pagers. The keys of the top-level hashes are the names of the pagers. The sub hashes should contain key/value pairs with keys consisting of: text, pagerid, and service.

pidfile

Data type: String

Specifies a file into which the server should write its process ID.

queuedir

Data type: String

The location of the page queue.

service_defs

Data type: Hash

A hash of hashes to define services. The keys of the top-level hashes are the names of the services. The sub hashes should contain key/value pairs with keys consisting of: text, device, dialcmd, phone, password, baudrate, parity, maxmsgsize, maxpages, maxtries, identfrom, allowpid, and msgprefix.

service_enable

Data type: Boolean

Whether or not to enable the service (Default: true)

service_ensure

Data type: Enum['running', 'stopped']

The ensure value for the service (Default: 'running')

service_name

Data type: String

The name of the service (Default: 'qpage')

sigfile

Data type: String

Specifies a file containing an alternate signature that QuickPage should append to e-mail status notification messages sent to page submitters.

snpptimeout

Data type: String

The number of seconds to wait for an SNPP command before terminating the connection.

synchronous

Data type: String

Whether or not queue runs are synchronized with new pages.

qpage::config

This class takes care of all necessary configuration

qpage::install

This class takes care of all necessary package installations

qpage::service

This class takes care of all necessary services