# bbwarnsetup.cfg # # BIG BROTHER Notification setup configuration file # Sean MacGuire # Version 1.9 # Mar 13th, 2002 # # (c) Copyright Quest Software, Inc. 1997-2002 All rights reserved. # # # IMPORTANT *************** # # Tokens are defined on a single line in this format # # token: parameter(s) # # The ':' must always follow the token name # # IMPORTANT *************** # # # Scope: This means on which host(s) the variable is used # # Most of them are used on the BBPAGER host (obviously) # Others apply also on BBDISPLAY and all BB clients. # because they affect the behavior of the 'bbd' # and 'bb' programs # # Restart: Does BB needs to be restarted for this variable # to be reset # # # The "bbwarn" token specify if you want to use the notification feature or not # Set to TRUE if you want to enable the notification feature # anything else will disable it (FALSE,NO,NIET,...) # Also, if you decide to install this host as a failover BBPAGER # then set bbwarn: to FAILOVER (actually anything by TRUE) # At least this will remind you of that fact. see ext/failover for more info # # Scope: BBPAGER # Reset: No bbwarn: TRUE # # Each message that is sent has a numeric value associated with it. # This value is in the XXXYYYYYYYYYYYY format: # # XXX: service code associated with the column name as # defined in bbinc.sh by "svcerrlist" token # YYYYYYYYYYYY: IP address of host in error, the IP address is # expanded to 12digits to remove any ambiguity # # services are defined by pairs: # # service:code # # NOTE: Don't define any codes in the 7XX ranges because codes starting # with 7 defines TCP errors and is followed with the IP code # e.g. 725 - SMTP error # # Scope: BBPAGER # Reset: No svcerrlist: disk:100 cpu:200 procs:300 msgs:400 conn:500 http:600 dns:800 ERR:999 # # Define the codes sent out in SNMP traps # # Recoveries will send the code+1 (so always use even numbers here) # # Scope: BBPAGER # Reset: No trapcodes: disk:2 cpu:4 procs:6 msgs:8 conn:10 http:12 dns:14 dig:14 ftp:16 smtp:18 fping:20 imap:22 mq:24 mrtg:26 nntp:28 pop3:30 pop-3:30 ssh:32 swap:34 telnet:36 ERR:0 # # What is the Enterprise object ID for BB4 Technologies # # Scope: BBPAGER # Reset: No entoid: .1.3.6.1.4.1.7058 # # Where is the location of the SNMP trap sending program # # Scope: BBPAGER # Reset: No snmptrap_pgm: /usr/bin/snmptrap # # What type of SNMP distribution are you using # Valid values are: CMU # UCD # SOLARIS (located in /usr/sbin/snmp_trapsend I believe) # HPOV (not supported yet) # # Scope: BBPAGER # Reset: No snmptrap_type: CMU # # The "ignforall" token is used to discard all hosts.service that # matches the egrep regexp. # N.B. You build your own egrep regexp # # ignforall: .*.cpu|.*.msgs|host11.* # # Scope: BBPAGER # Reset: No ignforall: # # "pagehelpcode" is the numceric code associated with the # phone # of the user when requesting for help . 911 is the default but I've # requests for customizable code so here it is. # # Scope: BBPAGER # Reset: No pagehelpcode: 911 # # "ttyline" token list the device files that KERMIT uses # The 1st available device will be used # # ttyline: /dev/cuaa0 /dev/cuaa1 # # Scope: BBPAGER # Reset: No ttyline: /dev/cuaa0 # # The dialing "prefix" and "suffix" are defined in these tokens # # Note: for SMS paging please read the doc/README.SMS, also the # prefix defined here does not apply to SMS ... # # Scope: BBPAGER # Reset: No prefix: T9 suffix: # # The "pagedelay" token is used to specify how many minutes between pages # Set it really high to only be paged once... # "pagedelay" can be overridden in the 'bbwarnrules.cfg' file # # Scope: BBPAGER # Reset: No pagedelay: 15 # # The "pagelevels" token specifies on which colors should the 'bb' program # send notification messages to the BBPAGER server. # # e.g. pagelevels: red purple # # If the event color is either red or purple then send a page message # to BBPAGER server # # NOTE ******** This has to be set on all clients as it is used by # the 'bb' and 'bbd' program # # Scope: BBPAGER/BBDISPLAY/all BB clients # Reset: Yes pagelevels: red purple # # The "pagelevelsmail" token indicates that on that color level only # the email recipients get a notification (and that's only if that # particular event has a matching e-mail recipient in etc/bbwarnrules.cfg) # The color is active only if it is also defined in the "pagelevels" token # # **NOTE** Only mail recipient will receive the notifications, any recipients # of the form: ext-XXX-rcpt@somewhere, ep-rcpt@somewhere, ... # are NOT considered by BB to be e-mail recipient. Only rcpt@somewhere # will be considered # # e.g. pagelevelsmail: yellow purple # # If the event is of yellow or purple level, only an email notification # will be sent if the color is also defined in the "pagelevels" token. # # Scope: BBPAGER # Reset: No pagelevelsmail: yellow # # The "pagerecovered" token is set to TRUE when you want to be notify # when the state of the problem has come back to normal # (that is, it is not in the pagelevels colors) # This token is only valid when pagetype=EVENT, any other # pagetype would require lots of color status saving and I ain't # ready for it yet. # # e.g. pagerecovered: TRUE # # Scope: BBPAGER # Reset: No pagerecovered: FALSE # # The "pagetype" token describes how the delay between should be handled. # # RCPT - applicable on the recipient # The recipient (mail/page/sms) won't be # notified until the next "pagedelay" # regardless of event (host.service) error # # EVENT - applicable on the host.service combination (www.bb4.com|disk) # The recipient won't be notified on a specific # event (host.service) error until "pagedelay" # has expired. This will generate the most notifications # # HOST - applicable on the host that is in error # The recipient won't be notified on any # event error from the same HOST until "pagedelay" has expired. # # GROUP - applicable on the display GROUP # The recipient won't be notified on a specific # event within a bb-hosts group until "pagedelay" # has expired. Hosts that do not belong to any # group (defined before the first group/group-compress # directive in bb-hosts) are defined belonging to # the global-grp group # # NOTE: As soon as an error event is resolved (returned to a color not # defined in "pagelevels" then the "pagedelay" is expired # # Scope: BBPAGER # Reset: No pagetype: RCPT # # "pagemaster" token holds email recipients to be sent a warning message # if a notification (physical numeric page) can't be sent out # # If none are specified then no warning mail will be sent # # Scope: BBPAGER # Reset: No pagemaster: root@localhost # # "pageaddhtmlpath" token defines if the email notification will # have the path to the HTML status page # The path is defined in the BBWEBHTMLLOGS variable in bbdef.sh # # default is TRUE # # Scope: BBPAGER # Reset: No pageaddhtmlpath: TRUE # # The "cfgdelim" token specifies the delimiter to use in the rule lines # of the bbwarnrules.cfg file # # i.e. cfgdelim: ; # rule line *;;*;;*;*; 9,1,9999999999 # # ***** NOTE ***** # # Don't use '*' ':' '/' ',' '.' '!' for "cfgdelim" as they will cause the # notification feature to fail. Don't use characters that you # may use in a regular expression in the # hosts/exhosts/services/exservices columns of a rule line # # Scope: BBPAGER # Reset: No cfgdelim: ; # # The "briefrcpt" token specifies which recipients should receive # brief notification messages # # i.e. briefrcpt: robert@localhost 9999999 # # Scope: BBPAGER # Reset: No briefrcpt: # # The "hg-groupname" token specifies specifies that the hosts listed can # be referred to "hg-groupname" in the hosts field in the bbwarnrules.cfg # config file. You can define as many hostgroups that you need # # i.e. hg-routers: rt1 rt2 rt3 router* # in rules: hg-routers host1*;;*;;*;*;root@localhost # # it is the equivalent of # rt1 rt2 rt3 router* host1*;;*;;*;*;root@localhost # # Scope: BBPAGER # Reset: No # # The "pg-groupname" token specifies specifies that the recipients listed can # be referred to "pg-groupname" in the recipients field in the bbwarnrules.cfg # config file. You can define as many pagegroups that you need # # i.e. pg-routeradmins: joe@localhost joey@localhost joanne@localhost # in rules: *;;*;;*;*;pg-routeradmins root@localhost # # it is the equivalen of # *;;*;;*;*;joe@localhost joey@localhost joanne@localhost root@localhost # # Scope: BBPAGER # Reset: No