Opsview Knowledge Center

Supported Opsview Monitor Types

Available puppet methods and attributes

opsview_attribute

Parameter/Property Description Format
name Name of the attribute String
reload_opsview Whether to perform a reload True or false
attribute Name of the attribute String
value Attribute value String
label1 Attribute 1 label String
label2 Attribute 2 label String
label3 Attribute 3 label String
label4 Attribute 4 label String
secured1 arg1 is an encrypted value 0 or 1
secured2 arg2 is an encrypted value 0 or 1
secured3 arg3 is an encrypted value 0 or 1
secured4 arg4 is an encrypted value 0 or 1
arg1 Value for arg1 String
arg2 Value for arg2 String
arg3 Value for arg3 String
arg4 Value for arg4 String
encrypted_arg1 Encrypted value for arg1 String
encrypted_arg2 Encrypted value for arg2 String
encrypted_arg3 Encrypted value for arg3 String
encrypted_arg4 Encrypted value for arg4 String

Example

opsview_attribute{"NORMALATTRIBUTE":
    reload_opsview => false,
    ensure => present,
    value => 'This is the value',
    arg1 => 'arg1',
    arg2 => 'arg2',
    arg3 => 'arg3',
    arg4 => 'arg4'
}
opsview_attribute {"BLANKENCRYPTEDATTRIBUTE":
    reload_opsview => false,
    ensure => present,
    value => 'This is the value',
    secured1 => 1,
    secured2 => 1,
    secured3 => 1,
    secured4 => 1
}
opsview_attribute {"ENCRYPTEDATTRIBUTE":
    reload_opsview => false,
    ensure => present,
    value => 'This is the value',
    label1 => 'label1',
    label2 => 'label2',
    label3 => 'label3',
    label4 => 'label4',
    encrypted_arg1 => 'b8a98ef9a82aa1012a8cbec292224ee4413c4a1b1343afe4f5adcb51191bd77c',
    encrypted_arg2 => 'b8a98ef9a82aa1012a8cbec292224ee4413c4a1b1343afe4f5adcb51191bd77c',
    encrypted_arg3 => 'b8a98ef9a82aa1012a8cbec292224ee4413c4a1b1343afe4f5adcb51191bd77c',
    encrypted_arg4 => 'b8a98ef9a82aa1012a8cbec292224ee4413c4a1b1343afe4f5adcb51191bd77c'
}

opsview_bsmcomponent

Parameter/Property Description Format
name Name of the business component String
reload_opsview Whether to perform a reload True or false
hosts List of hosts that are included in the component Array of strings
hosttemplate Host template to use String
required_online How many hosts need to be online Integer
has_icon
Integer

Example

opsview_bsmcomponent {"networkstack":
    ensure => present,
    hosts => [
        "ciscoswitch1", 
        "ciscoswitch2" 
    ],
    hosttemplate => 'Network - Base',
    required_online => 1
}

opsview_bsmservice

Parameter/Property Description Format
name Name of the business service String
reload_opsview Whether to perform a reload True or false
components Components that are part of the BSM service Array of strings

Example

opsview_bsmservice {"companywebsite":
    reload_opsview => 'false',
    ensure => present,
    components => [
        "bsmcomponenttest1", 
        "bsmcomponenttest2"
    ]
}

opsview_contact

Parameter/Property Description Format
name Name of the contact String
reload_opsview Whether to perform a reload True or false
fullname Full name of user String
description Description of contact String
role Role that the user is in String
encrypted_password User’s password String
language User’s language String
variables User variables Hash - e.g. {'EMAIL' => 'address@email.com'}

opsview_hostgroup

Parameter/Property Description Format
name Name of the host group String
reload_opsview Whether to perform a reload True or false
hostgroup Name of the hostgroup String
parent Parent of hostgroup String

Example

opsview_hostgroup {"myhostgroupname":
    ensure => present,
    reload_opsview => false,
    parent => "linux"
}

opsview_hosttemplate

Parameter/Property Description Format
name Name of the host template String
reload_opsview Whether to perform a reload True or false
hosttemplate Name of the host template String
description Description of template String
servicechecks List of service checks to include Array of strings
managementurls List of management URLs Array of hashes. Available keys are name and url

Example

opsview_hosttemplate {'mytemplate':
    managementurls => [ 
        { 'name' => 'wiki', 'url' =>'https://www.google.com/ ' } 
    ],
    description => 'networking template',
    servicechecks =>  [
        'ping check',
        'uptime restart' 
    ],
}

opsview_keyword

Parameter/Property Description Format
name Name of the keyword String
reload_opsview Whether to perform a reload True or false
keyword Name of the keyword String
description Description of keyword String
viewport Viewport is enabled 0 or 1
all_hosts Keyword applied to all hosts 0 or 1
all_servicechecks Keyword applied to all service checks 0 or 1
style Viewport display style errors_and_host_cells, group_by_host, group_by_service, host_summary, performance
hosts List of hosts to tag Array of strings
servicechecks List of service checks to tag Array of strings
roles List of roles that can view keyword Array of strings

opsview_monitored

Parameter/Property Description Format
name Name of the host String
reload_opsview Whether to perform a reload True or false
ip IP address of host String
hostgroup Hostgroup to put host in String
hosttemplates Templates assigned to host Array of strings
servicechecks Service checks assigned to host Array of strings
keywords Keywords assigned to host Array of strings
monitored_by Name of the monitoring server for the host String
parents Parents of the host Array of strings
enable_snmp Whether snmp is enabled 0 or 1
notification_interval How long between host notifications Integer
encrypted_snmp_community Community string for host String
snmp_version SNMP version String
snmp_port SNMP port number Integer
snmpv3_username Username for V3 String
encrypted_snmpv3_authpassword Auth password for V3 String
snmpv3_authprotocol Auth protocol for V3 md5 or sha
encrypted_snmpv3_privpassword Priv password for V3 String
snmpv3_privprotocol Priv protocol des, aes, aes128
snmp_max_msg_size SNMP Message size default, 1Kio, 2Kio, 4Kio, 8Kio, 16Kio, 4Kio, 64Kio
tidy_ifdescr_level Level for tidying ifdescr string off, level1, level2, level3
snmp_extended_throughput_data Gather extended data
icon_name Name of icon String
check_command Host check command String
hostattributes Host attributes for the host Array of hashes. Available keys are name, value, arg1, arg2, arg3, arg4, encrypted_arg1, encrypted_arg2, encrypted_arg3, encrypted_arg4
snmpinterfaces List of available SNMP interfaces Array of hashes. Available keys are interfacename, active, discards_critical, errors_critical, throughput_critical, throughput_warning

Example

opsview_monitored {"snmpdevice":
    ensure => present,
    reload_opsview => false,
    ip => 'localhost',
    hosttemplates => ['SNMP - MIB-II'],
    hostgroup => 'networking',
    enable_snmp => 1,
    snmp_version => "2c",
    notification_interval => 60,
    snmpinterfaces => [
        {"interfacename"=>"", "active"=>"0", "discards_critical"=>"15", "errors_critical"=>"10", "throughput_critical"=>"0:50%", "throughput_warning"=>"0:25%"},
         {"interfacename"=>"Ethernet0/1", "active"=>"1", "discards_critical"=>"", "discards_warning"=>"", "errors_critical"=>"", "throughput_critical"=>"", "throughput_warning"=>"0:75%"},
        {"interfacename"=>"Null0", "active"=>"0", "discards_critical"=>"", "discards_warning"=>"", "errors_critical"=>"", "throughput_critical"=>"", "throughput_warning"=>""},
    ]
}
opsview_monitored {"hostwithencryptedargs":
    ensure => present,
    reload_opsview => false,
    ip => "localhost",
    hostgroup => 'puppet',
    hostattributes => [
        { name => "MYSQLCREDENTIALS", value => "/", arg1 => 'dbuser', encrypted_arg2 => 'c5aeaf4f0546ca70d6a89b9056eade8228162c8abcbc4e021c46a3a4309d1a7c'},
        { name => "SOMEENCRYPTEDATTRIBUTE", value => "placeholder", encrypted_arg1 => 'c5aeaf4f0546ca70d6a89b9056eade8228162c8abcbc4e021c46a3a4309d1a7c'},
    ]
}

opsview_monitoringserver

Parameter/Property Description Format
name Name of the monitoring server String
reload_opsview Whether to perform a reload True or false
activated Whether the monitoring server is activated 0 or 1
nodes List of slave nodes Array of strings
passive Whether passive is on 0 or 1
ssh_tunnel Type of tunnel forward, reverse, 0, 1

opsview_notificationmethod

Parameter/Property Description Format
name Name of the notification method String
reload_opsview Whether to perform a reload True or false
master Enabled on master
active Whether or not active
command Command to run String
contact_variables Comma separated list of values String

opsview_role

Parameter/Property Description Format
name Name of the role String
reload_opsview Whether to perform a reload True or false
role Name of the role String
description Description of role String
all_hostgroups Access to all hostgroups true or false
all_servicegroups Access to all service groups true or false
all_keywords Access to all keywords true or false
all_bsm_components Access to all BSM components true or false
all_bsm_edit Can edit all BSM services true or false
all_bsm_view Can view all BSM services true or false
all_monitoringservers Can configure on all monitoring servers true or false
access_hostgroups Host groups role can access Array of strings
access_servicegroups Service groups role can access Array of strings
access_keywords Keywords role can access Array of strings
accesses List of access properties Array of strings
business_services Authorized services for role Array of hashes. Available keys are name and edit
hostgroups List of hostgroups role can configure Array of strings
monitoringservers List of monitoringservers role can configure Array of strings
tenancy Tenancy role is a member of String

Example

opsview_role {"myrole":
    ensure => present,
    reload_opsview => false,
    all_bsm_edit => true,
    all_bsm_view => true,
    all_bsm_components => true,
    all_monitoringservers => true,
    accesses => [
        'BSM',
        'CONFIGUREBSM',
        'CONFIGUREBSMCOMPONENT'
    ]      
}
opsview_role {"myrole2":
    ensure => present,
    reload_opsview => false,
    accesses => [
        'BSM',
        'CONFIGUREBSM',
        'CONFIGUREBSMCOMPONENT'
    ],
    business_services => [ 
        { name => 'company website', edit => 1 }, {name => 'sales team'} 
    ],
    monitoringservers => ['Master Monitoring Server']   
}

opsview_servicecheck

Parameter/Property Description Format
name Name of the host String
reload_opsview Whether to perform a reload True or false
checktype Type of service check Active Plugin, SNMP trap, Passive, SNMP Polling
description Description of service check String
servicegroup Service group to put check into String
dependencies List of dependent services Array of strings
keywords List of keywords Array of string
calculate_rate SNMP polling rate field no, per_second, per_minute, per_hour
critical_comparison SNMP critical comparison number, ==, <, >, separator, string, eq, ne, regex
warning_comparison SNMP warning comparison numeric,==,<,>
label SNMP OID label String
oid SNMP OID String
critical_value SNMP Polling threshold String
warning_value SNMP Polling threshold String
notification_interval Interval to notify Integer
notification_options Notification options String - i.e. ‘w,u,o’
notification_period Period to notify String
attribute Attribute to use String
event_handler Event handler to run String
flap_detection Flap detection 0 or 1
markdown_filter Markdown filter 0 or 1
sensitive_arguments Sensitive arguments 0 or 1
alert_every_failure Alert every failure 0, 1, 2, enable, disable, enable with re-notification interval
record_output_changes Record output changes 0 or 1
action Passive check action set_stale, renotify, resend notifications, submit results
state Passive state to submit WARNING, CRITICAL, OK, UNKNOWN, 0, 1, 2, 3
timeout Passive timeout time syntax - i.e. 5, 10s, 20m, 1h, 2d, 18h 20m
alert_from_failure Notification counter to alert on Integer
cascaded_from Passive cascaded service String
check_freshness Whether to check freshness 0 or 1
text Text for passive message String
snmptraprules SNMP Trap rule definition Array of hashes. Available keys are action, alert_level, rule, name
check_period Check period to run String
check_interval Check interval for service Integer
check_attempts Check attempt for service Integer
retry_check_interval Retry check interval for service Integer
plugin Which plugin to use String
args Arguments to plugin String
invertresults Invert results 0 or 1

Example

opsview_servicecheck {"snmptrap":
    ensure => present,
    servicegroup => 'snmp',
    reload_opsview => false,
    checktype => 'SNMP trap',
    snmptraprules => [
        {'action' => 'Send Alert', 'alert_level' => 'WARNING', 'message' => 'This is the message ${DUMP}', 'name' => 'Rule 1', 'rule' => '"${TRAPNAME}" eq "trap"'},
        {'action' => 'Stop Processing', 'alert_level' => 'CRITICAL', 'message' => 'This is the message ${DUMP}', 'name' => 'Rule 2', 'rule' => '"${TRAPNAME}" eq "trap"'},
        {'action' => 'Send Alert', 'alert_level' => 'WARNING', 'message' => 'This is the message ${DUMP}', 'name' => 'Rule 3', 'rule' => '"${TRAPNAME}" eq "trap"'}
    ]
}
opsview_servicecheck {"snmppolling":
    ensure => present,
    servicegroup => 'snmp',
    reload_opsview => false,
    checktype => 'SNMP Polling',
    calculate_rate => 'per_second',
    oid => 'IF-MIB::ifInNUcastPkts.1',
    label => 'OidLabel',
    warning_value => 3,
    warning_comparison => '==',
    critical_value => 5,
    critical_comparison => '>'
}
opsview_servicecheck {"passivecheck":
    ensure => present,
    servicegroup => 'externalhosts',
    reload_opsview => false,
    checktype => 'Passive',
    check_freshness => 1,
    cascaded_from => 'DHCP',
    action => 'Submit Result',
    timeout => '30h 10m',
    text => "This is the stale text"
}
opsview_servicecheck {"activetest3":
    ensure => present,
    description => 'Managed by puppet',
    servicegroup => 'puppet-testing',
    reload_opsview => false,
    interval_mode => clever,
    checktype => 'Active Plugin',
    plugin => 'check_tcp',
    args => '-H localhost -p 443',
    check_interval => '30'
}

opsview_servicegroup

Parameter/Property Description Format
name Name of the service group String
reload_opsview Whether to perform a reload True or false
servicegroup Name of the service group String

Example

opsview_servicegroup {"nameofgroup":
    ensure => present
}

opsview_tenancy

Parameter/Property Description Format
name Name of the tenancy String
reload_opsview Whether to perform a reload True or false
primary_role Primary role to use String
priority
description Description of tenancy String

Example

opsview_tenancy {"mytenancy":
    ensure => present,
    description => 'Managed by puppet',
    reload_opsview => false,
    primary_role => 'myrole',      
}
opsview_role {"tenancyrole":
    ensure => present,
    reload_opsview => false,
    tenancy => 'mytenancy'
}

Supported Opsview Monitor Types

Available puppet methods and attributes