Puppet Class: asterisk

Inherits:
asterisk::params
Inherited by:
asterisk::config
asterisk::install
asterisk::service
Defined in:
manifests/init.pp

Overview

init.pp

Class: asterisk

This module installs asterisk, configures it, and can ensure it is running

Examples

  • Installation: class { ‘asterisk’: }

Authors

License

Copyright © 2014, Truphone All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of Truphone nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Parameters

service_enable

Boolean. Default: false.

service_ensure

String. Ensure the service is running or stopped. Options: running, stopped Default: running

service_manage

Boolean. Whether Puppet should manage this service. Default: false

package_ensure

String. Ensure the package is present or not. Options: present, latest, absent Default: present

package_name

String. What package name to use for asterisk. Default: asterisk

manage_config

Boolean. Whether Puppet should manage the configuration files. Default: true

asteriskuser

String. The user that runs the asterisk service. Default: OS specific

asteriskgroup

String. The group that runs the asterisk service. Default: OS specific

ari_enabled

String. Enable the ARI interface in Asterisk. Options: ‘yes’, ‘no’ Default: ‘no’

ast_dumpcore

String. Whether Asterisk should create core dumps

'no' is false, anything else is true.

Default: ‘no’

astbinary

String. Pointing to the ‘asterisk’ binary. Default: OS specific

astetcdir

String. Directory configuration option in asterisk.conf Default: OS specific

astmoddir

String. Directory configuration option in asterisk.conf Default: OS specific

astvarlibdir

String. Directory configuration option in asterisk.conf Default: OS specific

astdbdir

String. Directory configuration option in asterisk.conf Default: OS specific

astkeydir

String. Directory configuration option in asterisk.conf Default: OS specific

astdatadir

String. Directory configuration option in asterisk.conf Default: OS specific

astagidir

String. Directory configuration option in asterisk.conf Default: OS specific

astspooldir

String. Directory configuration option in asterisk.conf Default: OS specific

astrundir

String. Directory configuration option in asterisk.conf Default: OS specific

astlogdir

String. Directory configuration option in asterisk.conf Default: OS specific

http_bindaddr

String. Interface to bind HTTP service. Default: ‘0.0.0.0’

http_enabled

String. Enable the HTTP interface in Asterisk.

Should be 'yes' if you also enable ARI.

Options: ‘yes’, ‘no’ Default: ‘no’

http_port

String. Port to bind HTTP service. Default: ‘8088’

manager_bindaddr

String. Interface to bind AMI service. Default: ‘0.0.0.0’

manager_enabled

String. Enable the Manager(AMI) interface in Asterisk. Options: ‘yes’, ‘no’ Default: ‘no’

manager_port

String. Port to bind AMI service. Default: ‘5038’

manager_webenabled

String. Web Enable the Manager(AMI) interface in Asterisk. Options: ‘yes’, ‘no’ Default: ‘no’

register_sip

String. When acting as SIP client to an upstream SIP provider or other

asterisk, this is the registration string.

Default: ”

rtpstart

String. Lower limit for RTP port range Default: 10000

rtpend

String. Upper limit for RTP port range Default: 20000

udpbindaddr

String. Interface to bind UDP Default: 0.0.0.0

tcpenable

String. Whether to enable TCP (‘no’ to disable) Default: ‘no’

tcpbindaddr

String. Interface to bind TCP Default: ‘0.0.0.0’

tlsenable

String. Whether to enable TLS (‘no’ to disable) Default: ‘no’

tlsbindaddr

String. Interface to bind TLS Default: ‘0.0.0.0:5061’

tlscertfile

String. Path to TLS certificate Default: ‘./asterisk.pem’

tlsprivatekey

String. Path to TLS certificate private key Default: ‘./asterisk.pem’

tlscafile

String. Path to TLS CA certificate Default: ”

tlscapath

String. Path to the path of TLS CA certificates folder Default: ”

tlsdontverifyserver

String. When acting as TLS client, whether asterisk should

verify the server certificate 'yes' or 'no'

Default: ‘no’

extension.conf Options

ext_static

String. If ‘no’ or omitted, then the pbx_config will rewrite the

extensions.conf file when extensions are modified.

Default: ‘yes’

CAUTION: Changing to ‘no’ may have unpredictable results when

configuring with Puppet.
ext_writeprotect

String. If static=yes and writeprotect=no, you can save dialplan

by CLI command "dialplan save" in the extensions.conf file.

Default: ‘yes’

CAUTION: Changing to ‘no’ may have unpredictable results when

configuring with Puppet.
ext_autofallthrough

String. If an extention runs out of things to do,

wait 'yes' or terminate 'no'

Default: ‘yes’ (strongly recommended)

ext_patternmatchnew

String. Beta feature for new patern matching behavior for extensions. Default: ‘no’

ext_clearglobalvars

String. Clear global variables on a dialplan reload or Asterisk reload. Default: ‘no’

ext_userscontext

String. Context is where entries from users.conf are registered Default: ‘default’

ext_includes

Array of Strings. Specify paths of files to ‘#include` in the

extensions.conf file.

Default: []

ext_execs

Array of Strings. Execute a program(s) or script that produces config files Default: []

Parameters:

  • asteriskuser (Any) (defaults to: $asterisk::params::asteriskuser)
  • asteriskgroup (Any) (defaults to: $asterisk::params::asteriskgroup)
  • service_enable (Any) (defaults to: $asterisk::params::service_enable)
  • service_ensure (Any) (defaults to: $asterisk::params::service_ensure)
  • service_manage (Any) (defaults to: $asterisk::params::service_manage)
  • package_ensure (Any) (defaults to: $asterisk::params::package_ensure)
  • package_name (Any) (defaults to: $asterisk::params::package_name)
  • manage_config (Any) (defaults to: $asterisk::params::manage_config)
  • ari_enabled (Any) (defaults to: $asterisk::params::ari_enabled)
  • ast_dumpcore (Any) (defaults to: $asterisk::params::ast_dumpcore)
  • astbinary (Any) (defaults to: $asterisk::params::astbinary)
  • astetcdir (Any) (defaults to: $asterisk::params::astetcdir)
  • astmoddir (Any) (defaults to: $asterisk::params::astmoddir)
  • astvarlibdir (Any) (defaults to: $asterisk::params::astvarlibdir)
  • astdbdir (Any) (defaults to: $asterisk::params::astdbdir)
  • astkeydir (Any) (defaults to: $asterisk::params::astkeydir)
  • astdatadir (Any) (defaults to: $asterisk::params::astdatadir)
  • astagidir (Any) (defaults to: $asterisk::params::astagidir)
  • astspooldir (Any) (defaults to: $asterisk::params::astspooldir)
  • astrundir (Any) (defaults to: $asterisk::params::astrundir)
  • astlogdir (Any) (defaults to: $asterisk::params::astlogdir)
  • http_enabled (Any) (defaults to: $asterisk::params::http_enabled)
  • http_bindaddr (Any) (defaults to: $asterisk::params::http_bindaddr)
  • http_port (Any) (defaults to: $asterisk::params::http_port)
  • manager_bindaddr (Any) (defaults to: $asterisk::params::manager_bindaddr)
  • manager_enabled (Any) (defaults to: $asterisk::params::manager_enabled)
  • manager_port (Any) (defaults to: $asterisk::params::manager_port)
  • manager_webenabled (Any) (defaults to: $asterisk::params::manager_webenabled)
  • register_sip (Any) (defaults to: $asterisk::params::register_sip)
  • rtpstart (Any) (defaults to: $asterisk::params::rtpstart)
  • rtpend (Any) (defaults to: $asterisk::params::rtpend)
  • udpbindaddr (Any) (defaults to: $asterisk::params::udpbindaddr)
  • tcpenable (Any) (defaults to: $asterisk::params::tcpenable)
  • tcpbindaddr (Any) (defaults to: $asterisk::params::tcpbindaddr)
  • tlsenable (Any) (defaults to: $asterisk::params::tlsenable)
  • tlsbindaddr (Any) (defaults to: $asterisk::params::tlsbindaddr)
  • tlscertfile (Any) (defaults to: $asterisk::params::tlscertfile)
  • tlsprivatekey (Any) (defaults to: $asterisk::params::tlsprivatekey)
  • tlscafile (Any) (defaults to: $asterisk::params::tlscafile)
  • tlscapath (Any) (defaults to: $asterisk::params::tlscapath)
  • tlsdontverifyserver (Any) (defaults to: $asterisk::params::tlsdontverifyserver)
  • ext_static (Any) (defaults to: $asterisk::params::ext_static)
  • ext_writeprotect (Any) (defaults to: $asterisk::params::ext_writeprotect)
  • ext_autofallthrough (Any) (defaults to: $asterisk::params::ext_autofallthrough)
  • ext_patternmatchnew (Any) (defaults to: $asterisk::params::ext_patternmatchnew)
  • ext_clearglobalvars (Any) (defaults to: $asterisk::params::ext_clearglobalvars)
  • ext_userscontext (Any) (defaults to: $asterisk::params::ext_userscontext)
  • ext_includes (Any) (defaults to: $asterisk::params::ext_includes)
  • ext_execs (Any) (defaults to: $asterisk::params::ext_execs) 


246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'manifests/init.pp', line 246

class asterisk(
  $asteriskuser             = $asterisk::params::asteriskuser,
  $asteriskgroup            = $asterisk::params::asteriskgroup,
  $service_enable           = $asterisk::params::service_enable,
  $service_ensure           = $asterisk::params::service_ensure,
  $service_manage           = $asterisk::params::service_manage,
  $package_ensure           = $asterisk::params::package_ensure,
  $package_name             = $asterisk::params::package_name,
  $manage_config            = $asterisk::params::manage_config,
  $ari_enabled              = $asterisk::params::ari_enabled,
  $ast_dumpcore             = $asterisk::params::ast_dumpcore,
  $astbinary                = $asterisk::params::astbinary,
  $astetcdir                = $asterisk::params::astetcdir,
  $astmoddir                = $asterisk::params::astmoddir,
  $astvarlibdir             = $asterisk::params::astvarlibdir,
  $astdbdir                 = $asterisk::params::astdbdir,
  $astkeydir                = $asterisk::params::astkeydir,
  $astdatadir               = $asterisk::params::astdatadir,
  $astagidir                = $asterisk::params::astagidir,
  $astspooldir              = $asterisk::params::astspooldir,
  $astrundir                = $asterisk::params::astrundir,
  $astlogdir                = $asterisk::params::astlogdir,
  $http_enabled             = $asterisk::params::http_enabled,
  $http_bindaddr            = $asterisk::params::http_bindaddr,
  $http_port                = $asterisk::params::http_port,
  $manager_bindaddr         = $asterisk::params::manager_bindaddr,
  $manager_enabled          = $asterisk::params::manager_enabled,
  $manager_port             = $asterisk::params::manager_port,
  $manager_webenabled       = $asterisk::params::manager_webenabled,
  $register_sip             = $asterisk::params::register_sip,
  $rtpstart                 = $asterisk::params::rtpstart,
  $rtpend                   = $asterisk::params::rtpend,
  $udpbindaddr              = $asterisk::params::udpbindaddr,
  $tcpenable                = $asterisk::params::tcpenable,
  $tcpbindaddr              = $asterisk::params::tcpbindaddr,
  $tlsenable                = $asterisk::params::tlsenable,
  $tlsbindaddr              = $asterisk::params::tlsbindaddr,
  $tlscertfile              = $asterisk::params::tlscertfile,
  $tlsprivatekey            = $asterisk::params::tlsprivatekey,
  $tlscafile                = $asterisk::params::tlscafile,
  $tlscapath                = $asterisk::params::tlscapath,
  $tlsdontverifyserver      = $asterisk::params::tlsdontverifyserver,
  $ext_static               = $asterisk::params::ext_static,
  $ext_writeprotect         = $asterisk::params::ext_writeprotect,
  $ext_autofallthrough      = $asterisk::params::ext_autofallthrough,
  $ext_patternmatchnew      = $asterisk::params::ext_patternmatchnew,
  $ext_clearglobalvars      = $asterisk::params::ext_clearglobalvars,
  $ext_userscontext         = $asterisk::params::ext_userscontext,
  $ext_includes             = $asterisk::params::ext_includes,
  $ext_execs                = $asterisk::params::ext_execs,
) inherits asterisk::params {

  validate_string($package_ensure, $package_name)
  validate_bool($service_enable, $service_manage, $manage_config)
  validate_string($manager_enabled, $manager_webenabled)
  validate_string($manager_bindaddr, $manager_port)
  validate_string($ari_enabled, $http_enabled, $http_bindaddr, $http_port)
  validate_string($udpbindaddr, $tcpenable, $tcpbindaddr)
  validate_string($tlsenable, $tlsbindaddr, $tlscertfile)
  validate_string($tlsprivatekey, $tlscafile, $tlscapath, $tlsdontverifyserver)
  validate_string($ext_writeprotect, $ext_autofallthrough, $ext_patternmatchnew)
  validate_string($ext_static, $ext_clearglobalvars, $ext_userscontext)
  validate_array($ext_includes, $ext_execs)

  class { '::asterisk::install':
    package_ensure => $package_ensure,
    package_name   => $package_name,
  } ->
  class { '::asterisk::config':
    manage_config       => $manage_config,
    asteriskuser        => $asteriskuser,
    asteriskgroup       => $asteriskgroup,
    ari_enabled         => $ari_enabled,
    ast_dumpcore        => $ast_dumpcore,
    astbinary           => $astbinary,
    astetcdir           => $astetcdir,
    astmoddir           => $astmoddir,
    astvarlibdir        => $astvarlibdir,
    astdbdir            => $astdbdir,
    astkeydir           => $astkeydir,
    astdatadir          => $astdatadir,
    astagidir           => $astagidir,
    astspooldir         => $astspooldir,
    astrundir           => $astrundir,
    astlogdir           => $astlogdir,
    http_bindaddr       => $http_bindaddr,
    http_enabled        => $http_enabled,
    http_port           => $http_port,
    manager_bindaddr    => $manager_bindaddr,
    manager_enabled     => $manager_enabled,
    manager_port        => $manager_port,
    manager_webenabled  => $manager_webenabled,
    register_sip        => $register_sip,
    rtpstart            => $rtpstart,
    rtpend              => $rtpend,
    udpbindaddr         => $udpbindaddr,
    tcpenable           => $tcpenable,
    tcpbindaddr         => $tcpbindaddr,
    tlsenable           => $tlsenable,
    tlsbindaddr         => $tlsbindaddr,
    tlscertfile         => $tlscertfile,
    tlsprivatekey       => $tlsprivatekey,
    tlscafile           => $tlscafile,
    tlscapath           => $tlscapath,
    tlsdontverifyserver => $tlsdontverifyserver,
    ext_static          => $ext_static,
    ext_writeprotect    => $ext_writeprotect,
    ext_autofallthrough => $ext_autofallthrough,
    ext_patternmatchnew => $ext_patternmatchnew,
    ext_clearglobalvars => $ext_clearglobalvars,
    ext_userscontext    => $ext_userscontext,
    ext_includes        => $ext_includes,
    ext_execs           => $ext_execs,
  }  ->
  class { '::asterisk::service':
    service_ensure => $service_ensure,
    service_manage => $service_manage,
    service_enable => $service_enable,
  }
}