NAME
snm.logfile - format of Site/SunNet/Domain Manager log files
DESCRIPTION
All the programs in the Site/SunNet/Domain Manager package write log files in a standard format. The format is designed to be easy to parse, and written in ASCII, so that editors and shell scripts can operate on it.
This is the format read by the results browser, snm_br(1). The log file format is written by:
Each entry is a newline-terminated ASCII string. Fields in the entry are separated by white space. Null strings are represented by a field containing two double quote characters. String values that contain embedded white space (tabs, spaces and newlines) or double quotes are surrounded by double quotes. A double quote is represented by two successive double quote characters, and the field that contains these characters is surrounded by double quotes. Therefore, a field of four double quotes corresponds to a single double quote, as originally returned by the agent.
The layout of the fields is:
1. Report Type - one character:
1. attribute name ``netmgt_service_error'' 2. ``I''
3. service_error value
4. attribute name ``netmgt_agent_error'' 5. ``I''
6. agent_error value
7. attribute name ``netmgt_error_message'' 8. ``S''
9. error message string
An additional field may be present to mark the end of a table row - ``netmgt_endofrow''. This field separates rows of a table in a report. It may or may not appear as the last field in an entry (some agents may not send an end-ofrow marker for the last table entry in the report).
NOTES
Some SNM agents return table keys with the pseudo- attribute ``netmgt_table_key''. If the SNM Console or Results Browser see this pseudo-attribute, they convert it into ``KEY'' for presentation to the user.
The SNMP proxy agent returns a pseudo - attribute ``netmgt_schema.'' The pseudottribute indicates the name of the SNMP schema (Note: not the name of the file) that should be used for processing data and event reports - converting enumerations to text strings, for example. If the SNM Console or Results Browser see this pseudo-attribute, they do not display it. The pseudo-attribute is not returned in traps.
For error reports, the ``netmgt_agent_error'' value is returned as an integer. The only way to find out what the value means is to refer to the agent schema file.
Determining what the enumeration values mean requires the agent schema.
Existing utilities that depend on the version 0 format can use snm_cvtlog(1) to convert the version 1 log files to the old format.