opsview

Synchronizes Opsview monitoring tool configuration

Module Stats

8,739 downloads

6,848 latest version

3.6 quality score

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

released Jul 21st 2016

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'opsview-opsview', '0.6.0'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add opsview-opsview

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install opsview-opsview --version 0.6.0

Tags: infrastructure, monitoring

Documentation

opsview/opsview — version 0.6.0 Jul 21st 2016

Stable release download

If you're looking for stable releases, you can download this module at the Puppet Forge.

Introduction

Right now, the module only contains libraries to handle all of the REST requests to a given Opsview server. You will need to create /etc/puppet/opsview.conf with the following format on each client that you wish to connect with an Opsview server:

url: http://example.com/rest
username: foobar
password: foobaz

Please file bugs via the issue tracker above.

Prerequisites

Puppet (of course :)) Tested most recently with puppet 2.7.9
rest-client, json gems.

Puppet Types in this Module

opsview_attribute
opsview_bsmcomponent
opsview_bsmservice
opsview_contact
opsview_hostgroup
opsview_hosttemplate
opsview_keyword
opsview_monitored
opsview_monitoringserver
opsview_notificationmethod
opsview_role
opsview_servicecheck
opsview_servicegroup
opsview_tenancy

List of things to do

Separate out a few get/set methods from Puppet::Provider::Opsview - put them in a utility module instead.
Clean up Puppet::Provider::Opsview in general. Cull any class/instance methods we don't need (there's lots of duplication.)
Add default providers so that Puppet runs don't fail when there's no rest-client / json gems to use.

Contributors

Devon Peters <devon.peters@gmail.com>
Christian Paredes <christian.paredes@sbri.org>
Duncan Ferguson <duncs>
Amos Shapira <amosshapira>
John Kinsella <jlk>
Kellen G <gkelle>

Types in this module release

opsview_servicecheck

Manages servicechecks in an Opsview monitoring system

Parameters
ensure
interval_mode	Controls how to calculate intervals (seconds versus minutes)
name
provider
reload_opsview	True if you want an Opsview reload to be performed when the servicecheck is updated

Properties
action	Action to take when freshness timeout has been reached
alert_every_failure	Raises a notification on every failure, not just the first one
alert_from_failure	General opsview passive servicecheck parameter
calculate_rate	SNMP polling Calculate Rate field
checktype	Type of plugin
critical_comparison	SNMP polling Critical Comparison
dependencies	Array of dependencies for this servicecheck
description	Short description for the servicecheck
internal	Internal use
keywords	Array of keywords for this servicecheck
label	Label for SNMP polling oid
oid	OID for SNMP Polling
record_output_changes	Advanced Tab - Records output for a particular state
servicegroup	The servicegroup that this servicecheck belongs to. This servicegroup must be defined in puppet.
snmptraprules	Array of snmptraprule key pairs for this node
state	Action to take when freshness timeout has been reached
timeout	How many seconds before our results are stale
warning_comparison	SNMP polling Warning Comparison

Providers
opsview

opsview_monitored

Monitors the node from an Opsview monitoring system

Parameters
ensure
interval_mode	Controls how to calculate intervals (seconds versus minutes)
name
provider
reload_opsview	True if you want an Opsview reload to be performed when the host is updated

Properties
check_command	Host check command
enable_snmp	Whether or not SNMP is enabled for the host
encrypted_snmp_community	Encrypted SNMP community string for SNMP protocol 1 and 2c
encrypted_snmpv3_authpassword	Encrypted SNMP v3 Auth Password
encrypted_snmpv3_privpassword	Encrypted SNMP v3 Priv Password
hostattributes	Array of host attribute key pairs for this node
hostgroup	Opsview hostgroup
hosttemplates	Array of Opsview host templates that should be applied to this node
icon_name	Icon to set for the device
internal	Internal use
ip	Node IP address or name
keywords	Array of Opsview keywords should be applied to this node
monitored_by	The Opsview server that monitors this node
parents	Array of parents for this node
servicechecks	Array of Opsview service checks that should be applied to this node
snmp_community	SNMP community string for SNMP protocol 1 and 2c
snmp_extended_throughput_data	Whether or not to gather extended data from interfaces (the unicast, multicasdt, broadcast stats)
snmp_max_msg_size	SNMP message size (default, 1Kio, 2Kio, 4Kio, 8Kio, 16Kio, 42Kio, 64Kio)
snmp_port	SNMP port
snmp_version	SNMP protocol version
snmpinterfaces	Array of snmp interface key pairs for this node
snmpv3_authpassword	SNMP v3 Auth Password (should be 8 chars)
snmpv3_authprotocol	SNMP v3 Auth Protocol (md5 or sha)
snmpv3_privpassword	SNMP v3 Priv Password (should be 8 chars)
snmpv3_privprotocol	SNMP v3 Priv Protocol (des, aes or aes128)
snmpv3_username	SNMP v3 username
tidy_ifdescr_level	Set level of removing common words from ifDescr strings

Providers
opsview

opsview_role

Manages roles in an Opsview monitoring system.

Parameters
ensure
name
provider
reload_opsview	True if you want an Opsview reload to be performed when the role is updated.

Properties
access_hostgroups	Array of hostgroups that this role can access.
access_keywords	Array of keywords that this role can access.
access_servicegroups	Array of servicegroups that this role can access.
accesses	Array of access properties defined for this role.
all_bsm_components	Will grant view access to business services for authorised components. Defaults to false.
all_bsm_edit	Whether or not this role has access to edit all bsm services. Defaults to false.
all_bsm_view	Whether or not this role has access to view all bsm services. Defaults to false.
all_hostgroups	Whether or not this role has access to all hostgroups. Defaults to true.
all_keywords	Whether or not this role has access to all keywords. Defaults to false.
all_monitoringservers	Whether or not this role has access to view all bsm services. Defaults to false.
all_servicegroups	Whether or not this role has access to all servicegroups. Defaults to true.
business_services	Array of authorized business service key pairs for this node
description	Short description of this role.
hostgroups	Array of hostgroups that this role can configure, if CONFIGUREHOSTS is defined in accesses.
internal	Internal use
monitoringservers	Array of hostgroups that this role can access.
role	The name of this role.
tenancy	Tenancy that the role is a member of

Providers
opsview

opsview_notificationmethod

Manages notificationmethods in an Opsview monitoring system

Parameters
ensure
name
provider
reload_opsview	True if you want an Opsview reload to be performed when the notificationmethod is updated

Properties
active	Whether or not this is Active
command	The command to run when this method is used
contact_variables	Comman delimited string of variables that are used by this notification method
internal	Internal use
master	Whether or not this is enabled on the master

Providers
opsview

opsview_bsmservice

Manages BSM Services in an Opsview monitoring system

Parameters
ensure
name
provider
reload_opsview	True if you want an Opsview reload to be performed when the component is updated

Properties
components	Array of Opsview BSM components that should be applied to this BSM service
internal	Internal use

Providers
opsview

opsview_hosttemplate

Manages hosttemplates in an Opsview monitoring system

Parameters
ensure
name
provider
reload_opsview	True if you want an Opsview reload to be performed when the hosttemplate is updated

Properties
description	description for this hosttemplate
hosttemplate	This hosttemplate
internal	Internal use
managementurls	Array of management urls for this hosttemplate
servicechecks	Array of servicechecks for this hosttemplate.

Providers
opsview

opsview_hostgroup

Manages hostgroups in an Opsview monitoring system

Parameters
ensure
name
provider
reload_opsview	True if you want an Opsview reload to be performed when the hostgroup is updated

Properties
hostgroup	The name of the hostgroup to manage
internal	Internal use
parent	Parent hostgroup. Any defined parent's will be autorequired.

Providers
opsview

opsview_keyword

Manages keywords in an Opsview monitoring system.

Parameters
ensure
name
provider
reload_opsview	True if you want an Opsview reload to be performed when the keyword is updated.

Properties
all_hosts	Whether or not this keyword is applied to all hosts. Defaults to false.
all_servicechecks	Whether or not this keyword is applied to all servicechecks. Defaults to false.
description	Short description of this keyword.
hosts	Array of hosts to apply this keyword to
internal	Internal use
keyword	The name of this keyword.
roles	Array of roles which can view this keyword
servicechecks	Array of servicechecks to apply this keyword to
style	The viewport display style to use for this keyword. Available styles: `* errors_and_host_cells * group_by_host * group_by_service * host_summary * performance`
viewport	Whether or not the viewport for this keyword is enabled.

Providers
opsview

opsview_contact

Manages contacts in an Opsview monitoring system

Parameters
ensure
name
provider
reload_opsview	True if you want an Opsview reload to be performed when the contact is updated

Properties
allhostgroups24x7	A boolean defining whether or not all hostgroups will have 24x7 notifications for this contact.
allhostgroups8x5	A boolean defining whether or not all hostgroups will have 8x5 notifications for this contact.
allservicegroups24x7	A boolean defining whether or not all servicegroups will have 24x7 notifications for this contact.
allservicegroups8x5	A boolean defining whether or not all servicegroups will have 8x5 notifications for this contact.
description	Short description for the contact
encrypted_password	The user's encrypted password. Defaults to "password" if not specified.
fullname	Full name of the user
host_notification_options24x7	The host notification options for the 24x7 notification profile.
host_notification_options8x5	The host notification options for the 8x5 notification profile.
hostgroups24x7	An array of hostgroups for the 24x7 notification profile.
hostgroups8x5	An array of hostgroups for the 8x5 notification profile.
internal	Internal use
language	The user's language
notificationmethods24x7	An array of notificationmethods for the 24x7 notification profile.
notificationmethods8x5	An array of notificationmethods for the 8x5 notification profile.
role	The role that the user is in. Defaults are: Administrator View all, change none View all, change some View some, change none View some, change some
service_notification_options24x7	The service notification options for the 24x7 notification profile.
service_notification_options8x5	The service notification options for the 8x5 notification profile.
servicegroups24x7	An array of servicegroups for the 24x7 notification profile.
servicegroups8x5	An array of servicegroups for the 8x5 notification profile.
variables	A hash containing the contact notification variables and their values. Example: ... variables => { 'EMAIL' => 'someone@example.com', 'PAGER' => '555-1234' }, ...

Providers
opsview

opsview_monitoringserver

Manages distributed monitoring configuration in an Opsview monitoring system

Parameters
ensure
name
provider
reload_opsview	True if you want an Opsview reload to be performed when the component is updated

Properties
activated	Whether monitoring server is active or not
internal	Internal use
nodes	Array of Opsview slave nodes that should be applied to this monitoring server
passive	Whether configuration is sent to slave or not
ssh_tunnel	Type of SSH tunnel (forward [1] or reverse [0])

Providers
opsview

opsview_tenancy

Manages tenancies in an Opsview monitoring system

Parameters
ensure
name
provider
reload_opsview	True if you want an Opsview reload to be performed when the component is updated

Properties
description	Description field
internal	Internal use
primary_role	Primary role to use for tenancy
priority	Priority

Providers
opsview

opsview_servicegroup

Manages servicegroups in an Opsview monitoring system

Parameters
ensure
name
provider
reload_opsview	True if you want an Opsview reload to be performed when the servicegroup is updated

Properties
internal	Internal use
servicegroup	This servicegroup

Providers
opsview

opsview_bsmcomponent

Manages BSM Components in an Opsview monitoring system

Parameters
ensure
name
provider
reload_opsview	True if you want an Opsview reload to be performed when the component is updated

Properties
has_icon	Set to zero if no icon available, otherwise number of seconds since icon was last updated
hosts	Array of Opsview hosts that should be applied to this component
hosttemplate	Opsview host template for BSM component
internal	Internal use
required_online	The number of hosts that are required online

Providers
opsview

opsview_attribute

Manages attributes in an Opsview monitoring system

Parameters
ensure
name
provider
reload_opsview	True if you want an Opsview reload to be performed when the attribute is updated

Properties
arg1	Optional argument 1 value.
arg2	Optional argument 2 value.
arg3	Optional argument 3 value.
arg4	Optional argument 4 value.
attribute	The name of the attribute to manage
encrypted_arg1	Optional encrypted argument 1 value.
encrypted_arg2	Optional encrypted argument 2 value.
encrypted_arg3	Optional encrypted argument 3 value.
encrypted_arg4	Optional encrypted argument 4 value.
internal	Internal use
label1	Optional label 1 value.
label2	Optional label 2 value.
label3	Optional label 3 value.
label4	Optional label 4 value.
secured1	Optional secured 1 value.
secured2	Optional secured 2 value.
secured3	Optional secured 3 value.
secured4	Optional secured 4 value.
value	Optional default attribute value.

Providers
opsview