[unix-history] / .ref-BSD-4_3_Net_2 / usr / src / contrib / isode / snmp / snmpi.1c

.TH SNMPI 1C "14 Sep 1989"
.\" $Header: /f/osi/snmp/RCS/snmpi.1c,v 7.6 91/02/22 09:44:32 mrose Interim $
.\"
.\" Contributed by NYSERNet Inc.  This work was partially supported by the
.\" U.S. Defense Advanced Research Projects Agency and the Rome Air Development
.\" Center of the U.S. Air Force Systems Command under contract number
.\" F30602-88-C-0016.
.\"
.\"
.\" $Log:	snmpi.1c,v $
.\" Revision 7.6  91/02/22  09:44:32  mrose
.\" Interim 6.8
.\" 
.\" Revision 7.5  90/10/18  11:34:09  mrose
.\" psi
.\" 
.\" Revision 7.4  90/08/29  15:04:14  mrose
.\" doc
.\" 
.\" Revision 7.3  90/05/13  15:55:57  mrose
.\" update
.\" 
.\" Revision 7.2  90/02/19  19:17:03  mrose
.\" again
.\" 
.\" Revision 7.1  90/01/11  18:34:41  mrose
.\" real-sync
.\" 
.\" Revision 7.0  89/11/23  22:23:29  mrose
.\" Release 6.0
.\" 
.SH NAME
snmpi \- really minimal SNMP initiator
.SH SYNOPSIS
.in +.5i
.ti -.5i
.B snmpi
\%[-a\0agent]
\%[-c\0community]
\%[-f\0file]
\%[-p\0portno]
\%[-d]
\%[-v]
\%[-w]
.in -.5i
.SH DESCRIPTION
The \fIsnmpi\fR program is an extremely simple program,
used to test \fIsnmpd\fR.
Once \fIsnmpd\fR is started,
to see if it's running,
do:
.sp
.in +.5i
.nf
% snmpi dump
.fi
.in -.5i
.sp
This should generate voluminous output.
.SH OPTIONS
The `-a' switch sets the address of the SNMP agent.
Either a hostname, an IP-address, or a transport address (using
Kille's string syntax) may be used.
The default is the localhost.
Similarly,
the `-p' switch sets the UDP port number that the agent resides on
(if an IP-style address is given, obviously).
The default is UDP port 161.
.PP
The `-c' switch sets the community name for the SNMP request.
The default is public.
.PP
The `-d' switch enables debugging.
This doesn't do anything yet.
.PP
The `-f' switch selects a file containing compiled MIB module definitions.
The default is \fIobjects.defs\fR.
.PP
The `-w' switch enables watching.
When SNMP messages are exchanged,
they will be pretty-printed on the terminal if the user is watching.
.PP
The `-v' switch enables verbose interaction.
This doesn't do anything yet.
.SH FILES
.nf
.ta \w'\*(EDobjects.defs  'u
\*(EDobjects.defs	MIB definitions
.re
.fi
.SH "NOTE WELL"
The names of the objects in \fBobjects.defs\fR are case sensitive.
This was necessary to improve the efficiency of the hashing algorithm
used for object lookup.
.SH "SEE ALSO"
RFCs 1155, 1156, and 1157.
.PP
S.E.\0Kille,
\fIA string encoding of Presentation Address\fR,
Research Note RN/89/14,
Department of Computer Science,
University College London,
(February, 1989).
.SH AUTHOR
Marshall T. Rose,
Performance Systems International
.PP
This work was partially supported by the
U.S. Defense Advanced Research Projects Agency and the Rome Air Development
Center of the U.S. Air Force Systems Command under contract number
F30602-88-C-0016.
.PP
Although this package is distributed with the ISODE,
it is not an OSI program, per se.
Inasmuch as the continued survival of the Internet hinges on all nodes
becoming network manageable,
this package was developed using the ISODE and is being freely
distributed with releases of Berkeley UNIX.
.PP
It must be stressed that this package is not a complete network management
system.
In particular,
whilst \fIsnmpd\fR provides a minimal agent functionality,
there are no Network Operation Center (NOC) tools--\fIsnmpi\fR is a
debugging aid only.
Commit	Line	Data
9319b3c3 C	1	.TH SNMPI 1C "14 Sep 1989"
	2	.\" $Header: /f/osi/snmp/RCS/snmpi.1c,v 7.6 91/02/22 09:44:32 mrose Interim $
	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: snmpi.1c,v $
	11	.\" Revision 7.6 91/02/22 09:44:32 mrose
	12	.\" Interim 6.8
	13	.\"
	14	.\" Revision 7.5 90/10/18 11:34:09 mrose
	15	.\" psi
	16	.\"
	17	.\" Revision 7.4 90/08/29 15:04:14 mrose
	18	.\" doc
	19	.\"
	20	.\" Revision 7.3 90/05/13 15:55:57 mrose
	21	.\" update
	22	.\"
	23	.\" Revision 7.2 90/02/19 19:17:03 mrose
	24	.\" again
	25	.\"
	26	.\" Revision 7.1 90/01/11 18:34:41 mrose
	27	.\" real-sync
	28	.\"
	29	.\" Revision 7.0 89/11/23 22:23:29 mrose
	30	.\" Release 6.0
	31	.\"
	32	.SH NAME
	33	snmpi \- really minimal SNMP initiator
	34	.SH SYNOPSIS
	35	.in +.5i
	36	.ti -.5i
	37	.B snmpi
	38	\%[-a\0agent]
	39	\%[-c\0community]
	40	\%[-f\0file]
	41	\%[-p\0portno]
	42	\%[-d]
	43	\%[-v]
	44	\%[-w]
	45	.in -.5i
	46	.SH DESCRIPTION
	47	The \fIsnmpi\fR program is an extremely simple program,
	48	used to test \fIsnmpd\fR.
	49	Once \fIsnmpd\fR is started,
	50	to see if it's running,
	51	do:
	52	.sp
	53	.in +.5i
	54	.nf
	55	% snmpi dump
	56	.fi
	57	.in -.5i
	58	.sp
	59	This should generate voluminous output.
	60	.SH OPTIONS
	61	The `-a' switch sets the address of the SNMP agent.
	62	Either a hostname, an IP-address, or a transport address (using
	63	Kille's string syntax) may be used.
	64	The default is the localhost.
65	Similarly,
66	the `-p' switch sets the UDP port number that the agent resides on
67	(if an IP-style address is given, obviously).
68	The default is UDP port 161.
69	.PP
70	The `-c' switch sets the community name for the SNMP request.
71	The default is public.
72	.PP
73	The `-d' switch enables debugging.
74	This doesn't do anything yet.
75	.PP
76	The `-f' switch selects a file containing compiled MIB module definitions.
77	The default is \fIobjects.defs\fR.
78	.PP
79	The `-w' switch enables watching.
80	When SNMP messages are exchanged,
81	they will be pretty-printed on the terminal if the user is watching.
82	.PP
83	The `-v' switch enables verbose interaction.
84	This doesn't do anything yet.
85	.SH FILES
86	.nf
87	.ta \w'\*(EDobjects.defs 'u
88	\*(EDobjects.defs MIB definitions
89	.re
90	.fi
91	.SH "NOTE WELL"
92	The names of the objects in \fBobjects.defs\fR are case sensitive.
93	This was necessary to improve the efficiency of the hashing algorithm
94	used for object lookup.
95	.SH "SEE ALSO"
96	RFCs 1155, 1156, and 1157.
97	.PP
98	S.E.\0Kille,
99	\fIA string encoding of Presentation Address\fR,
100	Research Note RN/89/14,
101	Department of Computer Science,
102	University College London,
103	(February, 1989).
104	.SH AUTHOR
105	Marshall T. Rose,
106	Performance Systems International
107	.PP
108	This work was partially supported by the
109	U.S. Defense Advanced Research Projects Agency and the Rome Air Development
110	Center of the U.S. Air Force Systems Command under contract number
111	F30602-88-C-0016.
112	.PP
113	Although this package is distributed with the ISODE,
114	it is not an OSI program, per se.
115	Inasmuch as the continued survival of the Internet hinges on all nodes
116	becoming network manageable,
117	this package was developed using the ISODE and is being freely
118	distributed with releases of Berkeley UNIX.
119	.PP
120	It must be stressed that this package is not a complete network management
121	system.
122	In particular,
123	whilst \fIsnmpd\fR provides a minimal agent functionality,
124	there are no Network Operation Center (NOC) tools--\fIsnmpi\fR is a
125	debugging aid only.