From 960c34b9edd9b3017a99907020ed2a7c74a21005 Mon Sep 17 00:00:00 2001 From: Arne Teuke Date: Fri, 28 Jul 2017 12:27:58 +0100 Subject: [PATCH] edited README and parameter documentation --- manifests/nagios/objects/add_contact_rules.pp | 3 +-- manifests/nagios/objects/add_servicegroups.pp | 5 +++++ manifests/nagios/objects/add_timeperiod_rules.pp | 2 +- 3 files changed, 7 insertions(+), 3 deletions(-) diff --git a/manifests/nagios/objects/add_contact_rules.pp b/manifests/nagios/objects/add_contact_rules.pp index 4a4b682..df1580a 100644 --- a/manifests/nagios/objects/add_contact_rules.pp +++ b/manifests/nagios/objects/add_contact_rules.pp @@ -20,8 +20,7 @@ # along with this program. If not, see . # @summary Class manages /etc/nagios/conf.d/nagios_add_contact.cfg through # concat. -# @example -# cd_nagios::nagios::objects::add_contact { 'example_user': +# @example cd_nagios::nagios::objects::add_contact { 'example_user': # ng_contact_name => 'example_user', # ng_contact_alias => 'Example User', # ng_contact_groups => 'admins', diff --git a/manifests/nagios/objects/add_servicegroups.pp b/manifests/nagios/objects/add_servicegroups.pp index 77f9314..0890e9b 100644 --- a/manifests/nagios/objects/add_servicegroups.pp +++ b/manifests/nagios/objects/add_servicegroups.pp @@ -25,6 +25,11 @@ # ng_servicegroup_name => 'example_servicegroup', # ng_servicegroup_alias => 'Example servicegroup', # } +# @param [string] ng_servicegroup_name Specify the servicegroup short name +# @param [string] ng_servicegroup_name Specify the servicegroup alias +# (long name). +# @param [string] ng_servicegroup_register Whether you want to register the +# servicegroup ############################################################################### define cd_nagios::nagios::objects::add_servicegroups ( diff --git a/manifests/nagios/objects/add_timeperiod_rules.pp b/manifests/nagios/objects/add_timeperiod_rules.pp index 697c13b..4685c6c 100644 --- a/manifests/nagios/objects/add_timeperiod_rules.pp +++ b/manifests/nagios/objects/add_timeperiod_rules.pp @@ -20,7 +20,7 @@ # along with this program. If not, see . # @summary Class manages /etc/nagios_conf.d/nagios_timeperiods_add.cfg and # add. hostgroups through external Puppet rules via define. -# cd_nagios::nagios::objects::add_timeperiods { 'example_timeperiod': +# @example cd_nagios::nagios::objects::add_timeperiods { 'example_timeperiod': # ng_timep_name => 'example_timeperiod', # ng_timep_alias => 'Example timeperiod', # ng_timep_monday => '00:00-00:00',