added parameter documentation
This commit is contained in:
@@ -25,6 +25,9 @@
|
||||
# ng_hostgroup_name => 'example_hostgroup',
|
||||
# ng_hostgroup_alias => 'Example Hostgroup',
|
||||
# }
|
||||
# @param [string] ng_hostgroup_name Specify the hostgroup short name.
|
||||
# @param [string] ng_hostgroup_alias Specify the hostgroup alias (long name).
|
||||
# @param [string] ng_hostgroup_register Whether to register the hostgroup.
|
||||
###############################################################################
|
||||
define cd_nagios::nagios::objects::add_hostgroups (
|
||||
|
||||
|
||||
@@ -18,8 +18,8 @@
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
# @summary Class manages /etc/nagios/conf.d/nagios_timeperiods_add.cfg. incl.
|
||||
# additional timeperiods via define.
|
||||
# @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':
|
||||
# ng_timeperiod_name => 'example_timeperiod',
|
||||
# ng_timeperiod_alias => 'Example timeperiod',
|
||||
|
||||
@@ -22,8 +22,15 @@
|
||||
# extermal Puppet rules.
|
||||
# @example
|
||||
# cd_nagios::nagios::objects::add_timeperiods { 'example_timeperiod':
|
||||
# ng_timeperiod_name => 'example_timeperiod',
|
||||
# ng_timeperiod_alias => 'Example timeperiod',
|
||||
# ng_timeperiod_name => 'example_timeperiod',
|
||||
# ng_timeperiod_alias => 'Example timeperiod',
|
||||
# ng_timep_monday => '00:00-00:00',
|
||||
# ng_timep_tuesday => '00:00-00:00',
|
||||
# ng_timep_wednesday => '00:00-00:00',
|
||||
# ng_timep_thursday => '00:00-00:00',
|
||||
# ng_timep_friday => '00:00-00:00',
|
||||
# ng_timep_saturday => '00:00-00:00',
|
||||
# ng_timep_sunday => '00:00-00:00',
|
||||
# }
|
||||
# @param [string] ng_timep_name Specify the timeperiod short name.
|
||||
# @param [string] ng_timep_alias Specify the timeperiod alias (long name)
|
||||
|
||||
@@ -96,7 +96,6 @@
|
||||
# @param [string] ng_retry_interval Re-check the service every x minutes
|
||||
# until a hard state can be determined.
|
||||
# @param [string] ng_host_check_command the check command for host checks
|
||||
# @param [string]
|
||||
################################################################################
|
||||
define cd_nagios::nagios::objects::templates (
|
||||
$ng_template_object = undef,
|
||||
|
||||
Reference in New Issue
Block a user