Puppet Class: nfsen

Defined in:
manifests/init.pp

Overview

Class: nfsen

This class installs/configures/manages nfsen.

Parameters

basedir

String. Base directory for nfsen.

bindir

String. Default ‘$BASEDIR/bin’

libexecdir

String. Default ‘$BASEDIR/libexec’

confdir

String. Default ‘$BASEDIR/etc’

htmldir

String. Default ‘/var/www/nfsen’

docdir

String. Default ‘$BASEDIR/doc’

vardir

String. Default ‘$BASEDIR/var’

piddir

String. Default ‘$BASEDIR/run’

filterdir

String. Default ‘$BASEDIR/filters’

formatdir

String. Default ‘$BASEDIR/fmt’,

profilestatdir

String. Default ‘$BASEDIR/profiles-stat’,

profiledatadir

String. Default “#BASEDIR/profiles-data’,

backend_plugindir

String. Default “#BASEDIR/plugins’,

frontend_plugindir

String. Default “#HTMLDIR/plugins’,

prefix

String. Default ‘/usr/bin’,

commsocket

String. Default ‘$PIDDIR/nfsen.comm’,

user

String. Default ‘netflow’,

wwwuser

String. Default ‘www-data’

wwwgroup

String. Default ‘www-group’

bufflen

Integer. Default 200000 (bytes)

extensions

String. Default ‘all’

subdirlayout

Integer. Default 2 (see nfdump/nfsen doc)

zipcollected

Boolean. Default true

zipprofiles

Boolean. Default true

profilers

Integer. Default 2

disklimit

Integer. Default 98

low_water

Integer. Default 90

syslog_facility

String. Default ‘local3’

mail_from

String. Default ‘your@from.example.net’

mail_body

String. Default ‘q{ Alert '@alert@' triggered at timeslot @timeslot@ };’

sources

Array of Hashes. See examples.

version

String. Version of nfsen to install when not using a custom repository source

custom_repo

Boolean. Whether to source the NfSen repository from a custom source (via vcsrepo)

custom_repo_provider

String. Custom repositiory provider e.g. git

custom_repo_source

String. Where the custom repository resides

web

Boolean. Whether to install the secure web frontend

web_ssl_verify_client

String. Apache2 compatible client verify string e.g. none, required

web_ssl_verify_depth

Integer. Number of (intermediate) CA certificates to verify

Parameters:

  • basedir (Any) (defaults to: '/var/lib/nfsen')
  • bindir (Any) (defaults to: '${BASEDIR}/bin')
  • libexecdir (Any) (defaults to: '${BASEDIR}/libexec')
  • confdir (Any) (defaults to: '${BASEDIR}/etc')
  • htmldir (Any) (defaults to: '/var/www/html/nfsen/')
  • docdir (Any) (defaults to: '${BASEDIR}/doc')
  • vardir (Any) (defaults to: '${BASEDIR}/var')
  • piddir (Any) (defaults to: '${BASEDIR}/run')
  • filterdir (Any) (defaults to: '${VARDIR}/filters')
  • formatdir (Any) (defaults to: '${VARDIR}/fmt')
  • profilestatdir (Any) (defaults to: '${BASEDIR}/profiles-stat')
  • profiledatadir (Any) (defaults to: '${BASEDIR}/profiles-data')
  • backend_plugindir (Any) (defaults to: '${BASEDIR}/plugins')
  • frontend_plugindir (Any) (defaults to: '${HTMLDIR}/plugins')
  • prefix (Any) (defaults to: '/usr/bin')
  • commsocket (Any) (defaults to: '${PIDDIR}/nfsen.comm')
  • user (Any) (defaults to: 'netflow')
  • wwwuser (Any) (defaults to: 'www-data')
  • wwwgroup (Any) (defaults to: 'www-data')
  • bufflen (Any) (defaults to: 200000)
  • extensions (Any) (defaults to: 'all')
  • subdirlayout (Any) (defaults to: 1)
  • zipcollected (Any) (defaults to: true)
  • zipprofiles (Any) (defaults to: true)
  • profilers (Any) (defaults to: 2)
  • disklimit (Any) (defaults to: 98)
  • low_water (Any) (defaults to: 90)
  • syslog_facility (Any) (defaults to: 'local3')
  • mail_from (Any) (defaults to: "netflow@${::fqdn}")
  • smtp_server (Any) (defaults to: 'localhost')
  • mail_body (Any) (defaults to: 'q{ Alert \'@alert@\' triggered at timeslot @timeslot@ };')
  • sources (Any) (defaults to: [ { 'name' => 'all', 'port' => '9995', 'col' => '#0000ff', 'type' => 'netflow', }, ])
  • version (Any) (defaults to: '1.3.6p1')
  • custom_repo (Any) (defaults to: false)
  • custom_repo_provider (Any) (defaults to: undef)
  • custom_repo_source (Any) (defaults to: undef)
  • web (Any) (defaults to: true)
  • web_ssl_verify_client (Any) (defaults to: 'none')
  • web_ssl_verify_depth (Any) (defaults to: 1) 


121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'manifests/init.pp', line 121

class nfsen (
  $basedir = '/var/lib/nfsen',
  $bindir = '${BASEDIR}/bin',
  $libexecdir = '${BASEDIR}/libexec',
  $confdir = '${BASEDIR}/etc',
  $htmldir = '/var/www/html/nfsen/',
  $docdir = '${BASEDIR}/doc',
  $vardir = '${BASEDIR}/var',
  $piddir = '${BASEDIR}/run',
  $filterdir = '${VARDIR}/filters',
  $formatdir = '${VARDIR}/fmt',
  $profilestatdir = '${BASEDIR}/profiles-stat',
  $profiledatadir = '${BASEDIR}/profiles-data',
  $backend_plugindir = '${BASEDIR}/plugins',
  $frontend_plugindir = '${HTMLDIR}/plugins',
  $prefix = '/usr/bin',
  $commsocket = '${PIDDIR}/nfsen.comm',
  $user = 'netflow',
  $wwwuser = 'www-data',
  $wwwgroup = 'www-data',
  $bufflen = 200000,
  $extensions = 'all',
  $subdirlayout = 1,
  $zipcollected = true,
  $zipprofiles = true,
  $profilers = 2,
  $disklimit = 98,
  $low_water = 90,
  $syslog_facility = 'local3',
  $mail_from = "netflow@${::fqdn}",
  $smtp_server = 'localhost',
  $mail_body = 'q{ Alert \'@alert@\' triggered at timeslot @timeslot@ };',
  $sources = [
    {
      'name' => 'all',
      'port' => '9995',
      'col'  => '#0000ff',
      'type' => 'netflow',
    },
  ],
  $version = '1.3.6p1',
  $custom_repo = false,
  $custom_repo_provider = undef,
  $custom_repo_source = undef,
  $web = true,
  $web_ssl_verify_client = 'none',
  $web_ssl_verify_depth = 1,
) {

  include ::nfsen::nfdump
  include ::nfsen::repo
  include ::nfsen::install
  include ::nfsen::configure
  include ::nfsen::service
  include ::nfsen::web

  Class['::nfsen::nfdump'] ->
  Class['::nfsen::repo'] ->
  Class['::nfsen::install'] ->
  Class['::nfsen::configure'] ->
  Class['::nfsen::service'] ->
  Class['::nfsen::web']

}