|
Variables and conditionals | |||||
|---|---|---|---|---|---|
| set <variable> <value>... | Sets a symbol. See the Symbols section for more information | ||||
| if <cond>
elseif <cond> else endif |
Lexical control. See the lexical control section for more information | ||||
| print <message> ... | print <message> to standard output. | ||||
| abort <message> ... | Abort the program, displaying <message>. | ||||
Logging | |||||
| log <type> <to> <level> | Define a logging channel. <type> can be ``file'', ``syslog'' or ``email''. <level> indicates the level of logging required, and can be ``debug'', ``info'', ``warning'', ``error'', ``fatal'' or ``none''. ``fatal'' indicates only fatal errors. If the type is ``file'', <to> is either the file name or ``stderr'' to refer to standard error. If the type is ``syslog'', <to> refers to the facility to use. If type is ``email'', <to> is the email address to mail errors to. Multiple ``file'' or ``email'' channels can be defined, however only one ``syslog'' channel can be specified. Log file names can contain strftime() time specifiers. | ||||
| logdir <dir> | Specify directory to write log files to. | ||||
Device configuration | |||||
|
device <name>
... end device |
Configures a device. Note that the following device attributes may be specified in a device block, or globally. If global, they form defaults for subsequent devices. | ||||
| address <string> | Specifies the address of the device. Defaults to the name of the device. Can be a host name or an IP address. | ||||
| community <string> | Specifies the community string to use. Note that for dynamically created devices, the community string supplied is only used to pass to the configuration script to obtain the configuration. The ``device'' lines output by the script specify the actual community name to use. Default is ``public''. | ||||
| version <v> | <v> may be 1 or 2 for SNMP V1 or V2c. Default 2. | ||||
| script <scriptname> | none | Specifies the name of the script to run to get the configuration. If not specified (or none), the device will not be polled for its configuration, and object lines must be placed in the device configuration to specify the objects to be collected. | ||||
| dumpconf <file> | Specifies a file to dump the configuration data to after a configuration run. | ||||
| frequency <interval> | Frequency of SNMP polls. Polls will be scheduled modulo the time specified, e.g. if the frequency is 60, polls will be scheduled at the start of each minute. Default is 30 seconds. | ||||
| checkevery <interval> | Frequency of configuration runs (if the configuration script is set). Default is not to do regular config runs. | ||||
| maxbps <qty> | Highest likely measurable rate of any one port on the system, used for sanity checking counter values. Default 1 Gbps. | ||||
| querysize <n> | Maximum number of objects (excluding the system uptime) to request in any one query. Default 50. | ||||
| object <name> <oid> | Statically defines an object to count. <name> is the name of the counter, <oid> the name of the SNMP object to collect. | ||||
| options <keyword> ... |
Specifies various flag values. Flag values are as follows:
| ||||
Global options | |||||
| directory <dir> | Specifies the default directory for files. | ||||
| dumpevery <interval> | Specifies the frequency with which to output data records. | ||||
| scriptdir <dir> | Defines directory where configuration scripts are to be found for subsequent device definitions. Default is current directory. | ||||
| auditdir <dir> | Defines directory for audit files to go. Default is current directory. | ||||
| output <file> | Defines file name for output to be written to, using strftime() arguments. Default is standard output. | ||||
| moveto <dir> | Defines a directory to move output files to when a new output file is created. This can be used to ensure that incomplete files are not available to subsequent processing for file transfer functions. | ||||
| threads <n> | Specifies the maximum number of SNMP polls that may be outstanding at any time. Default 16. | ||||
| confthreads <n> | Specifies the maximum number of configuration processes that may be run at one time. Default 2. | ||||
| conftimeout <interval> | Specifies the maximum amount of time that a configuration process may be allowed to run. Default 10 minutes. | ||||
| maxconfbuf <qty> | Specifies the size in bytes of the maximum amount of output a configuration run may produce. Default 1 megabyte. | ||||
| retrydead <interval> | Specifies how long to wait after a failed configuration run before attempting to retry. Default 5 minutes. | ||||
| retrypoll <interval> | Specifies how long to delay the next poll if sending the poll failed. | ||||
| staleafter <interval> | Specifies the maximum age of old data to be recognised and read at startup time. | ||||
|