NAME
snm schema - format of Site/SunNet/Domain Manager schema
SYNOPSIS
*.schema
DESCRIPTION
A schema provides information in ASCII form used to build the management database. A schema file consists of one or more:
Agent Definitions
Record Definitions
Instance Definitions
Cluster Definitions
Enumeration Definitions
Agent Definition
An agent definition provides information on the attributes an agent manages. The format of an agent definition is: agent | proxy agentName
[description description text]
[map mappings]
[serial integer]
[rpcid program-number]
(
[Enumeration Definition]
...
Group/Table Definition
...
[Agent Errors]
)
Group/Table Definition
A group/table definition is part of an agent definition. A group is a logical set of the attributes in an agent. A table is a special case of a group that can return multiple instances of the group. One of the fields in a table is the key that is used to select a single instance of the table. The format of a table/group definition is: group | table groupName
[description description text]
[characteristics characteristics options] (
Field Definition
...
)
Record Definition
Record definitions are used to provide internal definition for the console or to define element types. The format of a record definition is:
record recordName (
Field Definition
...
)
Field Definition
A field definition defines a field in either a record, group, or table. Optional description and units fields can be provided. Each field consists of an access type and and a field name. The format is:
[ Access ] Type fieldName
[ descriptiondescription text
[ characteristics characteristics options] [ units units text]
(
Access
The following access types are defined:
readwrite | rw
readonly | ro
writeonly | wo
notaccessible | na
Type
The following field types are defined:
[ unsigned ] int | short | long
string[length]
octet[length]
enum enumName
float | double
unixtime | timeticks
inetaddr | netaddr
counter | gauge
objectid
Enumeration Definition
Enumerations can be defined that map between integers and strings. The format of an enumeration definition is: enum enumName (
value "description"
...
)
Agent Errors
Agents may define their own errors in the agentErrors section of an agent definition. This section provides the mapping between the agent error codes and the error strings. Its format is:
agentErrors (
errorCode "description"
...
)
Cluster definition
A cluster record is a group of records that make up an instance of an element or request. Its format is: cluster (
recordName ( field_value field_value ... ) ...
)
Instance Definition
One or more instances of a record can be defined using an instance definition. Its format is:
instance (
( field_value field_value ... ) ...
)
Characteristics Options
The characteristics options are used in schema files which describe snmp devices. The characteristics are passed along to the snmp agent when SNMP requests are made, supplying addtional information used in fufilling the request. See the schema files (e.g. snmp.schema) for more information. The valid characteristics are:
For Groups
-K key
For Tables
-K Key
For Attributes (Field Definitions)
-N <attribute name> e.g. sysDescr
-O <object identifier> e.g. 1.4.6.1.2.1.1.1 -T <type> where <type> is STRING, INTEGER, OBJECTID,
etc.
-A <access>
-X <translation>
-F <fake out value>
-C <format string>