Skip to content

Latest commit

 

History

History
610 lines (337 loc) · 13.1 KB

REFERENCE.md

File metadata and controls

610 lines (337 loc) · 13.1 KB
Raw

Reference

Table of Contents

Classes

Defined types

Classes

smokeping

Manage SmokePing

Parameters

The following parameters are available in the smokeping class:

mode

Data type: Enum['master', 'slave', 'standalone']

SmokePing mode: master, slave, or standalone

master_url

Data type: Stdlib::HTTPUrl

URL to master cgi for slave mode

shared_secret

Data type: Stdlib::Absolutepath

Path to slavesecrets file

Default value: '/etc/smokeping/slavesecrets.conf'

slave_secrets

Data type: Stdlib::Absolutepath

Path to smokeping_secrets file

Default value: '/etc/smokeping/smokeping_secrets'

slave_name

Data type: String[1]

Name of slave. Only used in slave mode

Default value: 'slave1'

slave_dir

Data type: Stdlib::Absolutepath

Path to slave definitions on master

Default value: '/etc/smokeping/config.d/slaves.d'

slave_location

Data type: Optional[String[1]]

Location of slave

Default value: undef

slave_display_name

Data type: Optional[String[1]]

Name of slave, displayed on Webpage

Default value: undef

slave_color

Data type: Optional[Integer[0]]

Color of slave in the graph, as a RRGGBB hex integer.

Default value: undef

master_name

Data type: String[1]

Name of the master, in case of more than one SmokePing Master/Slave

Default value: 'default'

owner

Data type: String[1]

Owner of this SmokePing instance

Default value: 'Peter Random'

contact

Data type: Stdlib::Email

Contact E-Mail of this SmokePing instance

Default value: 'root@localhost'

mailhost

Data type: Optional[Stdlib::Host]

Where to send mails to

Default value: undef

cgiurl

Data type: Stdlib::HTTPUrl

URL of SmokePing CGI

syslogfacility

Data type: Stdlib::Syslogfacility

Syslog Facility

Default value: 'local0'

probes

Data type: Array[Hash]

Probe definitions as Array of Hashes

Default value: []

default_probe

Data type: String[1]

Default Probe

Default value: 'FPing'

alerts_to

Data type: Stdlib::Email

E-Mail address or tool to send Alerts to

Default value: 'root@localhost'

alerts_from

Data type: Stdlib::Email

Sender E-Mail of Alerts

Default value: 'root@localhost'

alerts

Data type: Array[Hash]

Alert definitions as Array of Hashes

Default value:

[
    {
      name        => 'someloss',
      alert_type  => 'loss',
      pattern     => '>0%,*12*,>0%,*12*,>0%',
      edgetrigger => false,
      comment     => 'loss 3 times in a row',
    },
  ]
cgi_remark_top

Data type: String[1]

Remark on Website

Default value: 'Welcome to the SmokePing website of xxx Company. Here you will learn all about the latency of our network.'

cgi_title_top

Data type: String[1]

Title on Website

Default value: 'Network Latency Grapher'

targets_dir

Data type: Stdlib::Absolutepath

Where to save target definitions

Default value: '/etc/smokeping/config.d/targets.d'

targets

Data type: Hash

Target definitions as a Hash of Smokeping::Target

Default value: {}

daemon_user

Data type: String[1]

User to run SmokePing

daemon_group

Data type: String[1]

Group of SmokePing

path_sendmail

Data type: Stdlib::Absolutepath

Path to sendmail binary

Default value: '/usr/sbin/sendmail'

webserver_user

Data type: String[1]

User of webserver, owner of image-files

webserver_group

Data type: String[1]

Group of webserver

path_imgcache

Data type: Stdlib::Absolutepath

Path to image cache dir

path_imgurl

Data type: String[1]

URL path to images for CGI

path_datadir

Data type: Stdlib::Absolutepath

Path to smokeping data

path_piddir

Data type: Stdlib::Absolutepath

Path to PID file

Default value: '/var/run/smokeping'

path_smokemail

Data type: Stdlib::Absolutepath

Path to smokemail binary

Default value: '/etc/smokeping/smokemail'

path_tmail

Data type: Stdlib::Absolutepath

Path to tmail binary

Default value: '/etc/smokeping/tmail'

version

Data type: String[1]

Version which should be installed

Default value: 'present'

enable

Data type: Boolean

Should the service be enabled during boot time?

Default value: true

start

Data type: Boolean

Should the service be started by Puppet?

Default value: true

manage_apache

Data type: Boolean

Should we manage the Apache config with puppetlabs/apache?

Default value: false

manage_firewall

Data type: Boolean

Should we manage a firewall rule for Smokeping with puppetlabs/firewall?

Default value: false

manage_selinux

Data type: Boolean

Should we load an SELinux policy to allow Smokeping to work on Red Hat distros?

Default value: false

manage_datadir

Data type: Boolean

Should we manage the data directory?

Default value: true

manage_imgcache

Data type: Boolean

Should we manage the permissions on the imgcache directory?

Default value: true

package_perldoc

Data type: String[1]

syslogpriority

Data type: String[1]

Default value: 'info'

default_slaves

Data type: Array[String[1]]

Default value: []

servername

Data type: Stdlib::Fqdn

Default value: $facts['networking']['fqdn']

smokeping::apache

Manage Apache config

smokeping::config

Manage SmokePing configuration

smokeping::install

Manage SmokePing installation

smokeping::service

Manage SmokePing service

Defined types

smokeping::slave

SmokePing slave

Parameters

The following parameters are available in the smokeping::slave defined type:

location

Data type: Optional[String[1]]

Location of slave

Default value: undef

display_name

Data type: String[1]

Name of the slave

color

Data type: Integer[0]

Color of this slave

master

Data type: Any

Name of the smokeping master, in case there are more than one.

Default value: 'default'

smokeping::target

SmokePing target

Parameters

The following parameters are available in the smokeping::target defined type:

pagetitle

Data type: Optional[String[1]]

Title. If empty, menu will be used as Title

Default value: undef

menu

Data type: Optional[String[1]]

Menu name.

Default value: undef

hierarchy_level

Data type: Integer

Level of this target on the menu hierarchy.

Default value: 1

hierarchy_parent

Data type: Optional[String[1]]

If hierarchy_level > 1, this specifies the parent.

Default value: undef

probe

Data type: Optional[String[1]]

Which probe to use.

Default value: undef

host

Data type: Optional[String[1]]

Target host name/IP.

Default value: undef

alerts

Data type: Array

Array of Alerts to apply to this target

Default value: []

slaves

Data type: Array

Array of slaves on which to run this target

Default value: []

nomasterpoll

Data type: Boolean

Disable data-polling from master

Default value: false

remark

Data type: Optional[String[1]]

Remark displayed on Website

Default value: undef

options

Data type: Hash

Default value: {}