Auto-Generated Documentation - Detailed Params

alias::objecttarget of alias (object)
used in: Alias
alias::targettarget of alias (name)
used in: Alias
fdThe objects filehandle
attr: internal
used in: BaseIO
opentimeWhen the file descriptor was last opened
used in: BaseIO
timeoutWhen should object should stop waiting
attr: internal
used in: BaseIO
typedescriptive name of object type, for debugging
used in: BaseIO
wantreadThis object is waiting for data to read
attr: internal
used in: BaseIO
wantwritThis object is waiting to output data
attr: internal
used in: BaseIO
control::authokconnection is permitted
used in: Control
control::closemeundocumented
used in: Control
control::cursequndocumented
used in: Control
control::rbufferundocumented
used in: Control
control::srcaddrsource address of connection
used in: Control
control::wbufferundocumented
used in: Control
cron::argsarg to pass to func
attr: internal
used in: Cron
cron::freqhow often should the cronjob run
attr: internal
used in: Cron
cron::funcref to func to run
attr: internal
used in: Cron
cron::queuewhich queue should job be placed on
attr: internal
vals: general service
used in: Cron
cron::textdescription of job, used for debugging
attr: internal
used in: Cron
cron::timetime at which the job should run
attr: internal
used in: Cron
slave::ipundocumented
used in: DARP_Slave (slave)
slave::portundocumented
used in: DARP_Slave (slave)
dns::classquery class
attr: config
vals: ANY CH CS HS IN
used in: DNS  see also: dns docs
this feature is new or changed in version 3.2
dns::queryquery type
attr: config
vals: STAT A AAAA AFS ANY CNAME HINFO LOC MX NS PTR SOA SRV TXT WKS
used in: DNS  see also: dns docs
this feature is new or changed in version 3.2
dns::recurserecursion desired?
attr: config bool
used in: DNS  see also: dns docs
this feature is new or changed in version 3.2
dns::testhow to test the result
attr: config
vals: none noerror authok serial answer nanswers
used in: DNS  see also: dns docs
this feature is new or changed in version 3.2
dns::zoneDNS zone to test
attr: config
for example: example.com
used in: DNS  see also: dns docs
this feature is new or changed in version 3.2
db::dsndatabase dsn in DBI syntax
attr: config inherit
for example: dbi:Pg:dbname=mydb;host=dbhost.example.com
used in: DataBase (db)  see also: database docs
this feature is new or changed in version 3.2
db::passdatabase password
attr: config inherit
used in: DataBase (db)  see also: database docs
this feature is new or changed in version 3.2
db::pidpid of child program
used in: DataBase (db)  see also: database docs
this feature is new or changed in version 3.2
db::rbufferread buffer
used in: DataBase (db)  see also: database docs
this feature is new or changed in version 3.2
db::sqla select statement
attr: config inherit
for example: select COUNT(*) from mytable where myfield = 'value'
used in: DataBase (db)  see also: database docs
this feature is new or changed in version 3.2
db::userdatabase username
attr: config inherit
used in: DataBase (db)  see also: database docs
this feature is new or changed in version 3.2
_ctl_debugundocumented
used in: MonEl
_dont_ntfyundocumented
used in: MonEl
_hide_commundocumented
used in: MonEl
_hide_exprundocumented
used in: MonEl
_no_addtnlundocumented
used in: MonEl
_no_imagesundocumented
used in: MonEl
_save_lessundocumented
used in: MonEl
acl_aboutextended mode access control list - for debugging page access
attr: config acl
used in: MonEl  see also: acl docs
this feature is new or changed in version 3.1
acl_annotateextended mode access control list - add/remove annotation access
attr: config acl
used in: MonEl  see also: acl docs
this feature is new or changed in version 3.1
acl_flushextended mode access control list - flush page access
attr: config acl
used in: MonEl  see also: acl docs
this feature is new or changed in version 3.1
acl_getconfextended mode access control list - display config page access
attr: config acl
used in: MonEl  see also: acl docs
this feature is new or changed in version 3.1
acl_logfileextended mode access control list - logfile access
attr: config acl
used in: MonEl  see also: acl docs
this feature is new or changed in version 3.1
acl_modemode for access control list configuration
attr: config inherit
vals: simple extended
default: simple
used in: MonEl  see also: acl docs
this feature is new or changed in version 3.1
acl_ntfyackextended mode access control list - ack notifications access
attr: config acl
used in: MonEl  see also: acl docs
this feature is new or changed in version 3.1
acl_ntfyackallextended mode access control list - ack all notifications access
attr: config acl
used in: MonEl  see also: acl docs
this feature is new or changed in version 3.1
acl_ntfydetailextended mode access control list - notification details page access
attr: config acl
used in: MonEl  see also: acl docs
this feature is new or changed in version 3.1
acl_ntfylistextended mode access control list - notification list access
attr: config acl
used in: MonEl  see also: acl docs
this feature is new or changed in version 3.1
acl_overrideextended mode access control list - set/clear override access
attr: config acl
used in: MonEl  see also: acl docs
this feature is new or changed in version 3.1
acl_pageextended mode access control list - for web page access
attr: config acl
used in: MonEl  see also: acl docs
this feature is new or changed in version 3.1
acl_rootsimple mode access control list - full web page access
attr: config acl
default: root
used in: MonEl  see also: acl docs
this feature is new or changed in version 3.1
acl_staffsimple mode access control list - some read/write web page access
attr: config acl
default: staff root
used in: MonEl  see also: acl docs
this feature is new or changed in version 3.1
acl_usersimple mode access control list - read-only web page access
attr: config acl
default: user staff root
used in: MonEl  see also: acl docs
this feature is new or changed in version 3.1
alarmis the siren currently ringing
attr: bool
used in: MonEl
anc_in_ovan ancestor is in override
used in: MonEl
autogeneratedwas this object generated automagically
attr: config bool inherit not-currently-implemented
default: no
used in: MonEl
childrenlist of objects children
used in: MonEl
chmod_controlcontrol socket permissions (in octal)
attr: config top
for example: 777
used in: MonEl
this feature is new or changed in version 3.1.3
commentinformational text displayed on webpage
attr: config
used in: MonEl  see also: webpretty docs
confckundocumented
used in: MonEl
countstopdo not recurse and count children in count mode (the numbers on Top webpage)
attr: config bool
default: no
used in: MonEl
debugsend all sorts of gibberish to the log
attr: config bool
default: no
used in: MonEl  see also: troubleshooting docs
definedattimetime the object was defined
used in: MonEl
definedinfilefile the object was defined in
used in: MonEl
definedonlineline number the object was defined on
used in: MonEl
depend::culpritname of dependency object preventing us from transitioning to down
used in: MonEl (depend)
depend::onmelist of objects for which I am the dependancy culprit
used in: MonEl (depend)
dependslist of dependency objects
attr: config
for example: Top:Foo:SMTP Top:Bar:HTTP Top:Bar:IMAP
used in: MonEl
this feature is new or changed in version 3.2
detailsinformational text displayed on webpage - usually a link to more details
attr: config
used in: MonEl  see also: webpretty docs
flagsvarious config data, summarized and displayed on webpage
attr: internal
used in: MonEl
graphgenerate graphs?
attr: config bool inherit
default: no
used in: MonEl  see also: graphing docs
this feature is new or changed in version 3.2
gravitygoverns group state transitions: down => group is down if any child is down, up => group is up if any child is up
attr: config
vals: up down
default: down
used in: MonEl
i_am_topundocumented
used in: MonEl
image::barstylestyle of summary range bars
attr: config inherit
vals: minmax stddev none
default: minmax
used in: MonEl (image)  see also: graphing docs
this feature is new or changed in version 3.2
image::drawborderdraw a border on the graph image
attr: config inherit bool
default: yes
used in: MonEl (image)  see also: graphing docs
this feature is new or changed in version 3.2
image::drawgriddraw a grid on the graphs
attr: config inherit bool
used in: MonEl (image)  see also: graphing docs
this feature is new or changed in version 3.2
image::gr_binarylabel the y axis in powers of 2 on graphs
attr: config inherit bool
used in: MonEl (image)  see also: graphing docs
this feature is new or changed in version 3.2
image::gr_colorscolors used on graphs - list of RRGGBB RRGGBB ...
attr: config inherit
for example: FF2222 4456CC CCFF44
used in: MonEl (image)  see also: graphing docs
this feature is new or changed in version 3.2
image::gr_rangerange of values for the y-axis on graphs ([min]-[max])
attr: config inherit
for example: 0-1500
used in: MonEl (image)  see also: graphing docs
this feature is new or changed in version 3.2
image::gr_whatwhat should be graphed?
attr: config inherit
vals: result elapsed status
default: result
used in: MonEl (image)  see also: graphing docs
this feature is new or changed in version 3.2
image::gridontopdraw grid over the graph
attr: config inherit bool
used in: MonEl (image)  see also: graphing docs
this feature is new or changed in version 3.2
image::logscalemake the y-axis logarithmic on graphs
attr: config inherit bool not-currently-implemented
used in: MonEl (image)  see also: graphing docs
this feature is new or changed in version 3.2
image::titletitle to put on graph
attr: config inherit
used in: MonEl (image)  see also: graphing docs
this feature is new or changed in version 3.2
image::transparentshould the background of graphs be transparent
attr: config inherit bool
default: yes
used in: MonEl (image)  see also: graphing docs
this feature is new or changed in version 3.2
image::whichgraphswhich of the 3 graphs should be shown
attr: config inherit
default: 123
used in: MonEl (image)  see also: graphing docs
this feature is new or changed in version 3.2
image::xlabellabel to use on x-axis of graphs
attr: config inherit
used in: MonEl (image)  see also: graphing docs
this feature is new or changed in version 3.2
image::ylabellabel to use on y-axis of graphs
attr: config inherit
used in: MonEl (image)  see also: graphing docs
this feature is new or changed in version 3.2
infoinformational text displayed on webpage
attr: config
used in: MonEl  see also: webpretty docs
labellabel to use on right and/or left side of the webpage
attr: config
used in: MonEl
label_leftlabel to use on the left side of the webpage
attr: config
used in: MonEl
label_left_maybeundocumented
used in: MonEl
label_rightlabel to use on the right side of the webpage
attr: config
used in: MonEl
label_right_maybeundocumented
used in: MonEl
logsizeMaximum number of log entries to keep
attr: config inherit
default: 200
used in: MonEl
namerelative name of this object
used in: MonEl
nostatsdo not record any statistics
attr: config bool
default: no
used in: MonEl
nostatusshould the status be ignored
attr: config inherit bool
default: no
used in: MonEl
noteinformational text displayed on webpage
attr: config
used in: MonEl  see also: webpretty docs
notify::ackonupautomatically ack notifications when it comes up
attr: config inherit bool
default: no
used in: MonEl (notify)
this feature is new or changed in version 3.2
notify::autoackdo notifications not require ack
attr: config inherit bool
default: no
used in: MonEl (notify)  see also: notif docs
notify::escalatelist of times (in minutes) and addresses for notification escalation: time method:address ...; time method:address ...
attr: config inherit
for example: 30 qpage:manager qpage:noc; 60 qpage:ceo
used in: MonEl (notify)  see also: notif docs
notify::listlist of all outstanding notifications
used in: MonEl (notify)
notify::mail_fromaddress to use as From: on notification email
attr: config inherit
default: Argus
for example: joebob@example.com
used in: MonEl (notify)  see also: notif docs
this feature is new or changed in version 3.1.3
notify::message_lotsdnmessage to transmit for lots DOWN summary notifications
attr: config top
used in: MonEl (notify)  see also: notif docs
this feature is new or changed in version 3.2
notify::message_lotsupmessage to transmit for lots UP summary notifications
attr: config top
used in: MonEl (notify)  see also: notif docs
this feature is new or changed in version 3.2
notify::messagednmessage to transmit for DOWN notifications
attr: config
used in: MonEl (notify)  see also: notif docs
notify::messageupmessage to transmit for UP notifications
attr: config
used in: MonEl (notify)  see also: notif docs
notify::notifylist of addresses to notify: method:address method:address ...
attr: config inherit
used in: MonEl (notify)  see also: notif docs
notify::notifydnlist of addresses to notify when down
attr: config inherit
used in: MonEl (notify)  see also: notif docs
this feature is new or changed in version 3.2
notify::notifyuplist of addresses to notify when up
attr: config inherit
used in: MonEl (notify)  see also: notif docs
this feature is new or changed in version 3.2
notify::prioritypriority level of notifications
attr: config inherit
used in: MonEl (notify)  see also: notif docs
notify::renotifyre-send time period in seconds
attr: config inherit
default: 300
used in: MonEl (notify)  see also: notif docs
notify::sendnotifyshould notifications be sent for this object
attr: config bool
used in: MonEl (notify)  see also: notif docs
notify::sendnotify2should notifications be sent for this Service
attr: config bool inherit
default: yes
used in: MonEl (notify)  see also: notif docs
notify::shortmessagesuse shorter default notification messages
attr: config inherit bool
default: no
used in: MonEl (notify)  see also: notif docs
this feature is new or changed in version 3.2
notify::timezoneundocumented
attr: config inherit not-currently-implemented
used in: MonEl (notify)
this feature is new or changed in version 3.2
overridablecan this object be overridden
attr: config bool
default: yes
used in: MonEl  see also: override docs
overrideoverride data
used in: MonEl
ovstatuscurrent status
vals: up down override
used in: MonEl
parentslist of objects parents
used in: MonEl
passivemarks object as passive - sets nostatus=yes, siren=no, sendnotify=no
attr: config inherit bool
default: no
used in: MonEl
prevovstatusprevious value of ovstatus
used in: MonEl
prevstatusprevious value of status
used in: MonEl
runatstartupcommand to run at startup
attr: config top
used in: MonEl
this feature is new or changed in version 3.2
sirenshould alarm ring
attr: config inherit bool
default: on
used in: MonEl
sirentimehush siren timestamp
used in: MonEl
sortsort the entries on web page
attr: config bool
default: yes
used in: MonEl
stats::dailydaily statistics
used in: MonEl (stats)
stats::lasttimetime stats were last updated
used in: MonEl (stats)
stats::logobject event log - array of [Time, status, ovstatus, tag, msg]
used in: MonEl (stats)
stats::monthlymonthly statistics
used in: MonEl (stats)
stats::statusstatus at time of last stats update
used in: MonEl (stats)
stats::yearlyyearly statistics
used in: MonEl (stats)
statuscurrent real status
vals: up down
used in: MonEl
syslogsyslog facility to use for syslogging if desired
attr: config top
for example: daemon
used in: MonEl  see also: troubleshooting docs
transientobject is temporary
used in: MonEl
transtimetime of last transition
used in: MonEl
typetype of object
used in: MonEl
unamerelative unique name for this object
attr: config
used in: MonEl
uniquefull unique name of this object
used in: MonEl
watch::watchedundocumented
used in: MonEl (watch)
watch::watchingundocumented
used in: MonEl (watch)
web::alwaysbaseundocumented
attr: config bool inherit
used in: MonEl (web)
this feature is new or changed in version 3.2
web::bkgimageweb page background image
attr: config inherit
used in: MonEl (web)  see also: webpretty docs
web::bldtimetime the web page was last generated
used in: MonEl (web)
web::bldtimetoptime the web page (top version) was last generated
used in: MonEl (web)
web::buttons_bottom_htmlundocumented
attr: config inherit
used in: MonEl (web)
this feature is new or changed in version 3.2
web::buttons_top_htmlundocumented
attr: config inherit
used in: MonEl (web)
this feature is new or changed in version 3.2
web::footerstuff to put at the bottom of the webpage
attr: config
used in: MonEl (web)  see also: webpretty docs
web::footer_allstuff to put at the bottom of the webpage
attr: config inherit
used in: MonEl (web)  see also: webpretty docs
web::footer_argusargus version footer
attr: config inherit
default:

Argus: 3.2_RC-20030414
used in: MonEl (web)  see also: webpretty docs
this feature is new or changed in version 3.1.3

web::headerstuff to put at the top of the webpage
attr: config
used in: MonEl (web)  see also: webpretty docs
web::header_allstuff to put at the top of the webpage
attr: config inherit
used in: MonEl (web)  see also: webpretty docs
web::hiddenundocumented
attr: config bool
used in: MonEl (web)
this feature is new or changed in version 3.2
web::icon16x16 icon shown in some browsers
attr: config inherit
used in: MonEl (web)  see also: webpretty docs
web::icon_down16x16 icon shown in some browsers - when object is down
attr: config inherit
used in: MonEl (web)  see also: webpretty docs
web::icon_up16x16 icon shown in some browsers - when object is up
attr: config inherit
used in: MonEl (web)  see also: webpretty docs
web::nospkr_iconhushed siren icon
attr: config inherit
used in: MonEl (web)  see also: webpretty docs
web::refreshweb page refresh period
attr: config inherit
default: 60
used in: MonEl (web)  see also: webpretty docs
web::shownotiflistshow the list of notifications on the web page
attr: config inherit bool
default: yes
used in: MonEl (web)  see also: webpretty docs
this feature is new or changed in version 3.2
web::showstatsshow stats on the web page
attr: config bool
default: yes
used in: MonEl (web)  see also: webpretty docs
web::sirensongwav file for browser to play when object is down
attr: config inherit
used in: MonEl (web)  see also: webpretty docs
web::transtimelast time the object changed
used in: MonEl (web)
commandcommand to run
attr: config
used in: NotMe  see also: notif docs
this feature is new or changed in version 3.2
functionundocumented
used in: NotMe  see also: notif docs
this feature is new or changed in version 3.2
qtimeundocumented
attr: config
used in: NotMe  see also: notif docs
this feature is new or changed in version 3.2
sendtext to send to command on stdin
attr: config
used in: NotMe  see also: notif docs
this feature is new or changed in version 3.2
ping::addraddress to ping
used in: Ping
ping::datadata returned by fping
used in: Ping
ping::hostnamehostname or IP address to test
attr: config inherit
used in: Ping
ping::ipverIP version (4 or 6)
used in: Ping
ping::rbufferread buffer
used in: Ping
ping::rttround trip time of last ping test
used in: Ping
ping::runningis a ping already running?
used in: Ping
prog::commandcommand to run
attr: config
used in: Prog  see also: services docs
prog::errorreason for failure
used in: Prog  see also: services docs
prog::exitprocess's exit status
used in: Prog  see also: services docs
prog::pidprocess PID
used in: Prog  see also: services docs
snmp::communitySNMP community
attr: config inherit
used in: SNMP  see also: services docs
snmp::oidSNMP OID to query
attr: config
used in: SNMP  see also: services docs
snmp::snmpcalcdeprecated, use calc instead
attr: config
used in: SNMP  see also: services docs
this feature is new or changed in version 3.2
self::paramundocumented
attr: config
used in: Self  see also: self docs
this feature is new or changed in version 3.2
server::classundocumented
used in: Server
server::typeundocumented
used in: Server
srvc::deadis this service dead
used in: Service  see also: services docs
srvc::elapsedhow long did the test take
used in: Service  see also: services docs
srvc::finishedfor detecting buggy code
used in: Service  see also: services docs
srvc::frequencyhow often the test should occur - in seconds
attr: config inherit
default: 60
used in: Service  see also: services docs
srvc::lasttesttimetime of last test
used in: Service  see also: services docs
srvc::nexttesttimetime of next test
used in: Service  see also: services docs
srvc::phiphase - a scheduling parameter
used in: Service  see also: services docs
srvc::reasonreason the test failed
used in: Service  see also: services docs
srvc::resultany result data returned by the test
used in: Service  see also: services docs
srvc::retriesnumber of times to retry a service before declaring it down
attr: config inherit
default: 2
used in: Service  see also: services docs
srvc::retrydelayhow soon to retry after a failure, instead of waiting until the next scheduled test
attr: config inherit
used in: Service  see also: services docs
srvc::showreasondisplay the reason the service is down on the web page
attr: config inherit bool
default: no
used in: Service  see also: services docs
this feature is new or changed in version 3.2
srvc::statestate of the test underway
used in: Service  see also: services docs
srvc::timeouthow long to wait for a response before giving up
attr: config inherit
default: 60
used in: Service  see also: services docs
srvc::triesnumber of times tried
used in: Service  see also: services docs
test::alphatime constant for decaying average calculation
attr: config inherit
default: 1
used in: Service (test)  see also: xtservices docs
this feature is new or changed in version 3.2
test::calcmanipulate value in some manner
attr: config
for example: rate, ave, bits
used in: Service (test)  see also: xtservices docs
this feature is new or changed in version 3.2
test::calcdataassorted data
used in: Service (test)  see also: services docs
test::currvaluemost recent value returned by query
used in: Service (test)  see also: services docs
test::eqvaluetest value - fail test if value does not equal this
attr: config
used in: Service (test)  see also: xtservices docs
this feature is new or changed in version 3.2
test::expecttest value - fail test if value does not match regex
attr: config
used in: Service (test)  see also: services docs
test::maxvaluetest value - fail test if value rises above this
attr: config
used in: Service (test)  see also: xtservices docs
this feature is new or changed in version 3.2
test::minvaluetest value - fail test if value falls below this
attr: config
used in: Service (test)  see also: xtservices docs
this feature is new or changed in version 3.2
test::nevaluetest value - fail test if value equals this
attr: config
used in: Service (test)  see also: xtservices docs
this feature is new or changed in version 3.2
test::nexpecttest value - fail test if value does match regex
attr: config
used in: Service (test)  see also: xtservices docs
this feature is new or changed in version 3.2
test::pluckuse this regex to pluck a value to test out of the result. should contain ()s
attr: config
for example: \s+(\d+)%
used in: Service (test)  see also: xtservices docs
this feature is new or changed in version 3.2
test::rawvalueundocumented
used in: Service (test)  see also: services docs
test::scalescale factor
attr: config
used in: Service (test)  see also: xtservices docs
this feature is new or changed in version 3.2
test::snmpcalcdeprecated, use calc instead
attr: config
used in: Service (test)  see also: services docs
this feature is new or changed in version 3.2
test::testedpis there a test configured?
used in: Service (test)  see also: services docs
test::unpacktemplate for unpacking a binary data structure
attr: config
for example: x8 N
used in: Service (test)  see also: xtservices docs
this feature is new or changed in version 3.2
sys::argoptional arguement
attr: config
used in: SysAgent (sys)
this feature is new or changed in version 3.2
sys::paramthe parameter to fetch (uptime, load, ...)
attr: config
used in: SysAgent (sys)
this feature is new or changed in version 3.2
tcp::addrencoded IP address
used in: TCP  see also: services docs
tcp::altsendtext to send once connected, instead of normal value
used in: TCP  see also: services docs
tcp::browserbrowser spoofing for URL checks
attr: config inherit
for example: Mozilla/1.0 (compatible; MSIE 1.0; Windblows 19100; Argus Test)
used in: TCP  see also: services docs
tcp::hostnamehostname or IP address to test
attr: config inherit
used in: TCP  see also: services docs
tcp::portTCP port to test
attr: config
used in: TCP  see also: services docs
tcp::rbufferread buffer
used in: TCP  see also: services docs
tcp::readhowhow much data should be read from the server before checking expect
attr: config
vals: banner toeof once
used in: TCP  see also: services docs
tcp::redircountnumber of times we have gotten an HTTP redirect
used in: TCP  see also: services docs
tcp::refererreferer spoofing for URL checks
attr: config inherit
for example: http://argus.tcp4me.com/
used in: TCP  see also: services docs
this feature is new or changed in version 3.2
tcp::sendtext to send once connected
attr: config
used in: TCP  see also: services docs
tcp::srcaddrlocal IP address
attr: config inherit
used in: TCP  see also: services docs
this feature is new or changed in version 3.2
tcp::srcipencoded local IP address
used in: TCP  see also: services docs
tcp::urlurl to check
attr: config
for example: http://www.example.com/cgi-bin/shopping.pl
used in: TCP  see also: services docs
tcp::wbufferwrite buffer
used in: TCP  see also: services docs
udp::addrencoded IP address
used in: UDP  see also: services docs
udp::hostnamehostname or IP address to test
attr: config inherit
used in: UDP  see also: services docs
udp::portUDP port to test
attr: config
used in: UDP  see also: services docs
udp::rbufferread buffer
used in: UDP  see also: services docs
udp::sendtext to send once connected
attr: config
used in: UDP  see also: services docs
udp::srcaddrlocal IP address
attr: config inherit
used in: UDP  see also: services docs
this feature is new or changed in version 3.2
udp::srcipencoded local IP address
used in: UDP  see also: services docs
udp::wbufferwrite buffer
used in: UDP  see also: services docs
usage::paramundocumented
attr: config
used in: Usage
this feature is new or changed in version 3.2

Generated by Argus Version: 3.2_RC-20030414