Return to snmpd.8c CVS log

Up to [CSRG BSD Unix] / 43BSDReno / contrib / isode-beta / snmp

Annotation of 43BSDReno/contrib/isode-beta/snmp/snmpd.8c, revision 1.1

1.1     ! root        1: .TH SNMPD 8C "14 Sep 1989"
        !             2: .\" $Header: /f/osi/snmp/RCS/snmpd.8c,v 7.14 90/06/23 01:33:10 mrose Exp $
        !             3: .\"
        !             4: .\" Contributed by NYSERNet Inc.  This work was partially supported by the
        !             5: .\" U.S. Defense Advanced Research Projects Agency and the Rome Air Development
        !             6: .\" Center of the U.S. Air Force Systems Command under contract number
        !             7: .\" F30602-88-C-0016.
        !             8: .\"
        !             9: .\"
        !            10: .\" $Log:      snmpd.8c,v $
        !            11: .\" Revision 7.14  90/06/23  01:33:10  mrose
        !            12: .\" proxy again
        !            13: .\" 
        !            14: .\" Revision 7.13  90/06/21  21:27:03  mrose
        !            15: .\" proxy
        !            16: .\" 
        !            17: .\" Revision 7.12  90/06/20  23:52:55  mrose
        !            18: .\" again
        !            19: .\" 
        !            20: .\" Revision 7.11  90/06/20  21:38:29  mrose
        !            21: .\" update
        !            22: .\" 
        !            23: .\" Revision 7.10  90/06/13  17:58:41  mrose
        !            24: .\" defaultView
        !            25: .\" 
        !            26: .\" Revision 7.9  90/06/12  05:19:02  mrose
        !            27: .\" again
        !            28: .\" 
        !            29: .\" Revision 7.8  90/06/12  02:06:20  mrose
        !            30: .\" views ...
        !            31: .\" 
        !            32: .\" Revision 7.7  90/06/12  02:05:32  mrose
        !            33: .\" views ...
        !            34: .\" 
        !            35: .\" Revision 7.6  90/05/23  18:08:55  mrose
        !            36: .\" 1158
        !            37: .\" 
        !            38: .\" Revision 7.5  90/05/13  17:54:37  mrose
        !            39: .\" views again
        !            40: .\" 
        !            41: .\" Revision 7.4  90/05/13  16:08:10  mrose
        !            42: .\" again
        !            43: .\" 
        !            44: .\" Revision 7.3  90/05/13  15:55:55  mrose
        !            45: .\" update
        !            46: .\" 
        !            47: .\" Revision 7.2  90/02/19  19:17:01  mrose
        !            48: .\" again
        !            49: .\" 
        !            50: .\" Revision 7.1  90/01/11  18:34:30  mrose
        !            51: .\" real-sync
        !            52: .\" 
        !            53: .\" Revision 7.0  89/11/23  22:23:25  mrose
        !            54: .\" Release 6.0
        !            55: .\" 
        !            56: .SH NAME
        !            57: snmpd \- minimal SNMP agent for BSD UNIX
        !            58: .SH SYNOPSIS
        !            59: .in +.5i
        !            60: .ti -.5i
        !            61: .B \*(SDsnmpd
        !            62: \%[-d]
        !            63: \%[\-t] \%[\-x] \%[\-z]
        !            64: \%[-p portno]
        !            65: \%[\-a x121address] \%[\-i\ pid]
        !            66: \%[-r] \%[-s]
        !            67: .in -.5i
        !            68: (under /etc/rc.local)
        !            69: .SH DESCRIPTION
        !            70: The \fIsnmpd\fR server acts as a management agent,
        !            71: implementing the Simple Network Management Protocol for Berkeley UNIX systems.
        !            72: Upon receipt of a message,
        !            73: it \*(lqauthenticates\*(rq the request,
        !            74: attempts the operation,
        !            75: and then returns a response.
        !            76: .PP
        !            77: The managed objects manipulated by \fIsnmpd\fR are defined in the file
        !            78: \fBsnmpd.defs\fR,
        !            79: kept in the system administrator's area.
        !            80: These objects conform to the Internet-standard
        !            81: \fIManagement Information Base\fR (commonly referred to as MIB-I),
        !            82: which is defined in RFC 1156.
        !            83: The rules used for naming and describing objects are taken from the
        !            84: Internet-standard
        !            85: \fIStructure of Management Information\fR (SMI),
        !            86: which is defined in RFC 1155.
        !            87: .PP
        !            88: At present,
        !            89: \fIsnmpd\fR permits only a read-only SNMP access mode.
        !            90: This restriction may be lifted in the future.
        !            91: .PP
        !            92: Most objects are realized via reading \fB/dev/kmem\fR.
        !            93: There are some exceptions,
        !            94: which can be set via a configuration file,
        !            95: which is read once,
        !            96: when the daemon starts.
        !            97: .SH TRANSPORTS
        !            98: For a UDP\-based network service,
        !            99: the server listens on port 161 for SNMP messages.
        !           100: The `\-p' option overrides the default UDP port.
        !           101: .PP
        !           102: For an X.25\-based network service,
        !           103: the server implements the transport class 0 protocol,
        !           104: decodes the connection request packet,
        !           105: and execs the appropriate program to enter the protocol and provide the
        !           106: service.
        !           107: The `\-a' switch is used to specify the X.121 address of the local host
        !           108: \(em this overrides the entry in the \fBisotailor\fP file.
        !           109: In addition,
        !           110: the `\-i' switch is used to specify the protocol ID to listen on
        !           111: \(em the default is 03018200.
        !           112: Note that on most X.25 implementations,
        !           113: if the local X.121 address is not present in the \fBisotailor\fR file,
        !           114: then the `-a' switch must be used in order for the server to
        !           115: receive incoming calls.
        !           116: .PP
        !           117: For a TP4\-based transport service,
        !           118: the server simply listens to any incoming connections for selector
        !           119: \*(lqsnmp\*(rq.
        !           120: .PP
        !           121: By default,
        !           122: all network services are enabled
        !           123: (if defined in the configuration).
        !           124: The `\-t' option specifies TCP\-only operation,
        !           125: the `\-x' option specifies X.25\-only operation,
        !           126: and the `\-z' option specifies TP4\-only operation.
        !           127: .SH SMUX
        !           128: The agent supports the SNMP Multiplexing (SMUX) protocol.
        !           129: To disable this,
        !           130: use the `\-s' option.
        !           131: .SH CONFIGURATION
        !           132: The \fBsnmpd.rc\fR file,
        !           133: which is kept in the system administrator's area,
        !           134: contains customization commands.
        !           135: This file must be owned by root unless the `-r' option is given.
        !           136: At present,
        !           137: the directives are:
        !           138: .TP
        !           139: .B community\fR\0name\0address\0access\0view
        !           140: defines an SNMP community called `name' with the indicated level of `access'.
        !           141: The `address' token is either a hostname, an IP-address, or a
        !           142: network address (using Kille's string syntax).
        !           143: If present and a value other than 0.0.0.0 is used,
        !           144: then incoming messages claiming to belong to the named community must
        !           145: come from this address.
        !           146: The `access' token,
        !           147: if present,
        !           148: is one of \*(lqreadOnly\*(rq, \*(lqreadWrite\*(rq, or \*(lqnone\*(rq,
        !           149: and defaults to \*(lqreadOnly\*(rq.
        !           150: The `view' token,
        !           151: if present,
        !           152: is an object identifier,
        !           153: which names the corresponding view of MIB objects that this community
        !           154: may access;
        !           155: otherwise,
        !           156: it defaults to a view containing all variables known to the agent.
        !           157: .TP
        !           158: .B view\fR\0name\0subtree\0...
        !           159: defines a collection of manageable objects
        !           160: with the given object identifier as its name.
        !           161: All variables scoped by the `subtree' tokens,
        !           162: each an object identifier,
        !           163: given in the directive are placed in the view.
        !           164: If no subtress are listed,
        !           165: the view contains all variables known to the agent.
        !           166: .TP
        !           167: .B proxy\fR\0name\0domain\0address\0community
        !           168: defines an SNMP proxy relationship,
        !           169: in terms of a view called `name'.
        !           170: Management requests for this view will be encapsulated via the access
        !           171: method for `domain' and sent to the named address/community.
        !           172: At present,
        !           173: only the domain `rfc1157' (SNMP over UDP) is supported,
        !           174: and the format of the `address' token is identical to that used by the
        !           175: \fBcommunity\fR directive.
        !           176: .TP
        !           177: .B logging\fR\0ava\0...
        !           178: sets the logging parameters accordingly.
        !           179: The one or more `ava' tokens are of the form \*(lqattribute=value\*(rq.
        !           180: The attributes are:
        !           181: \fIfile\fR,
        !           182: which is the filename for the log,
        !           183: this is interpreted relative to the ISODE logging area,
        !           184: unless the value starts with a slash;
        !           185: \fIsize\fR,
        !           186: which takes an integer value describing the maximum file size
        !           187: (in KBytes) that the log should be allowed to grow;
        !           188: \fIslevel\fR,
        !           189: which takes a string value indicating which events should be logged
        !           190: (one of \fInone\fR, \fIfatal\fR, \fIexceptions\fR, \fInotice\fR, \fItrace\fR,
        !           191: \fIpdus\fR, \fIdebug\fR, or \fIall\fR);
        !           192: \fIdlevel\fR,
        !           193: which says which events should not be logged;
        !           194: \fIsflags\fR,
        !           195: which takes a string value indicating logging options should be enabled
        !           196: (one of \fIclose\fR (to close the log after each entry),
        !           197: \fIcreate\fR (to create the log if it does not already exist),
        !           198: \fIzero\fR (to reset the log if the size is exceeded),
        !           199: and \fItty\fR (to log events to the user's terminal in addition to the file));
        !           200: and,
        !           201: \fIdflags\fR,
        !           202: which says which logging options should be disabled.
        !           203: .TP
        !           204: .B trap\fR\0name\0address\0view
        !           205: defines a trap sink for the SNMP community called `name',
        !           206: on the indicated address,
        !           207: which is either a hostname, an IP-address, or a
        !           208: network address (using Kille's string syntax).
        !           209: Note that at present,
        !           210: traps sinks must be reachable via UDP
        !           211: (the network address must be an IP-address).
        !           212: By default,
        !           213: a view is not named for the trap sink.
        !           214: .TP
        !           215: .B variable\fR\0name\0value
        !           216: sets the named variable to the indicated value.
        !           217: At present,
        !           218: these variables may be set:
        !           219: \fIsysDescr\fR,
        !           220: which takes a string value describing the management agent;
        !           221: \fIsysObjectID\fR,
        !           222: which takes an OBJECT IDENTIFIER value containing similar information;
        !           223: \fIsysContact\fR,
        !           224: which takes a string value describing the person responsible for the
        !           225: node;
        !           226: \fIsysName\fR,
        !           227: which takes a string value giving an administratively assigned name
        !           228: for the node;
        !           229: \fIsysLocation\fR,
        !           230: which takes a string value describing the location of the node;
        !           231: and,
        !           232: \fIsysServices\fR,
        !           233: which takes an integer describing the services offered by the node.
        !           234: See RFC 1156 for a more thorough explanation of these objects.
        !           235: (The last four are defined in MIB-II, RFC 1158,
        !           236: the follow-on to RFC 1156.)
        !           237: .TP
        !           238: .B variable\0snmpEnableAuthTraps\fR\0[ enabled | disabled ]
        !           239: enables (or disables) the generation of authenticationFailure traps.
        !           240: .TP
        !           241: .B variable\0interface\fR\0name\0ava\0...
        !           242: sets attributes for the named interface.
        !           243: The `name' token is an interface name as reported by \*(lqnetstat\0-i\*(rq.
        !           244: The one or more `ava' tokens are of the form \*(lqattribute=value\*(rq.
        !           245: At present,
        !           246: only three attributes may be set for each interface:
        !           247: \fIifType\fR,
        !           248: which takes an integer value describing the kind of interface;
        !           249: \fIifSpeed\fR,
        !           250: which takes an integer value describing the speed of the interface;
        !           251: and,
        !           252: \fIifAdminStatus\fR,
        !           253: which takes an integer value describing the adminstrative state of the
        !           254: interface.
        !           255: See RFC 1156 for a more thorough explanation of these objects.
        !           256: .SH "DEBUG OPERATION"
        !           257: If \fIsnmpd\fR is started interactively,
        !           258: or if the `\-d' switch is given,
        !           259: then debug mode is entered.
        !           260: In this case,
        !           261: all logging activity is displayed on the user's terminal.
        !           262: In addition,
        !           263: the logging information is more verbose.
        !           264: .SH FILES
        !           265: .nf
        !           266: .ta \w'\*(LDsnmpd.log  'u
        !           267: \*(EDsnmpd.defs        MIB definitions
        !           268: \*(EDsnmpd.rc  configuration file
        !           269: \*(LDsnmpd.log log file
        !           270: /etc/snmpd.pid daemon PID file
        !           271: .re
        !           272: .fi
        !           273: .SH "NOTE WELL"
        !           274: The names of the objects in \fBsnmpd.defs\fR are case sensitive.
        !           275: This was necessary to improve the efficiency of the hashing algorithm
        !           276: used for object lookup.
        !           277: .SH "SEE ALSO"
        !           278: RFCs 1155, 1156, and 1157.
        !           279: .PP
        !           280: S.E.\0Kille,
        !           281: \fIA string encoding of Presentation Address\fR,
        !           282: Research Note RN/89/14,
        !           283: Department of Computer Science,
        !           284: University College London,
        !           285: (February, 1989).
        !           286: .SH AUTHOR
        !           287: Marshall T. Rose,
        !           288: NYSERNet Inc.
        !           289: This work was partially supported by the
        !           290: U.S. Defense Advanced Research Projects Agency and the Rome Air Development
        !           291: Center of the U.S. Air Force Systems Command under contract number
        !           292: F30602-88-C-0016.
        !           293: .PP
        !           294: Although this package is distributed with the ISODE,
        !           295: it is not an OSI program, per se.
        !           296: Inasmuch as the continued survival of the Internet hinges on all nodes
        !           297: becoming network manageable,
        !           298: this package was developed using the ISODE and is being freely
        !           299: distributed with releases of Berkeley UNIX.
        !           300: .PP
        !           301: It must be stressed that this package is not a complete network management
        !           302: system.
        !           303: In particular,
        !           304: whilst \fIsnmpd\fR provides a minimal agent functionality,
        !           305: there are no Network Operation Center (NOC) tools--\fIsnmpi\fR is a
        !           306: debugging aid only.

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.