1-- This file is corresponding to Release 9.1.10.101 from 2014/08/11 00:00:00
2
3
4---------------------------------------------------------------------------
5-- (C)opyright 2007-2014 bintec elmeg GmbH
6-- $RCSfile: mib-soip,v $
7-- $Revision: 1.7 $
8-- $Date: 2014-02-07 10:37:49 $
9---------------------------------------------------------------------------
10
11-- **************************** WARNING **********************************
12-- * MIB is not finally defined and subjected to change, in terms of     *
13-- * variable names, order and meaning.                                  *
14-- ***********************************************************************
15
16FEC-SOIP-MIB DEFINITIONS ::= BEGIN
17
18IMPORTS
19    MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE,
20    IpAddress, Counter32, Gauge32,
21    mib-2, enterprises
22        FROM SNMPv2-SMI
23
24    TruthValue
25        FROM SNMPv2-TC
26
27    MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP
28        FROM SNMPv2-CONF
29
30    bibo
31	FROM BINTEC-MIB;
32
33
34---------------------------------------------------------------------------
35
36soip MODULE-IDENTITY
37	LAST-UPDATED "200707041400Z"
38	ORGANIZATION "bintec elmeg GmbH"
39	CONTACT-INFO
40	    "EMail:   info@bintec-elmeg.com
41	     Web:     www.bintec-elmeg.com
42	    "
43	DESCRIPTION
44	    "The MIB module for Serial over IP functionality.
45	     Contains both config and statistic data."
46	REVISION     "200707041400Z"
47	DESCRIPTION
48	    "SoIP specific MIB."
49
50	::= { bibo 58 }
51
52---------------------------------------------------------------------------
53
54-- **********************************************************************
55-- *    soipTable  TABLE
56-- **********************************************************************
57
58soipConfigTable OBJECT-TYPE
59	SYNTAX  SEQUENCE OF SoipConfigEntry
60	MAX-ACCESS  not-accessible
61	STATUS      current
62	DESCRIPTION
63	    "The soipConfigTable contains configuration data of the SoIP module.
64	     It configures both the IP and the UART side."
65	::= { soip 1 }
66
67	soipConfigEntry OBJECT-TYPE
68	    SYNTAX      SoipConfigEntry
69	    MAX-ACCESS  not-accessible
70	    STATUS      current
71	    DESCRIPTION
72			"The soipConfigEntry contains configuration data of the SoIP module."
73	    INDEX  { soipConfigIndex }
74	::= { soipConfigTable 1 }
75
76	SoipConfigEntry ::=
77	SEQUENCE {
78	    soipConfigIndex			INTEGER,
79	    -- ***** UART Config *****
80	    soipConfigUartBaud			INTEGER,
81	    soipConfigUartDataBits		INTEGER,
82	    soipConfigUartParity		INTEGER,
83	    soipConfigUartStopBits		INTEGER,
84	    soipConfigUartHandshake		INTEGER,
85	    soipConfigUartSendGraciousXonXoff	TruthValue,
86	    -- ***** IP Config *****
87	    soipConfigIpProtocol		INTEGER,
88	    soipConfigIpReconnectTimeout	INTEGER,
89	    soipConfigIpLocalIp			IpAddress,
90	    soipConfigIpLocalPort		INTEGER,
91	    soipConfigIpRemoteIp		IpAddress,
92	    soipConfigIpRemotePort		INTEGER,
93	    soipConfigIpIfIndex			INTEGER,
94	    -- ***** Trigger Config *****
95	    soipConfigTriggerByteCount		INTEGER,
96	    soipConfigTriggerDelay		INTEGER,
97	    soipConfigTriggerTimeout		INTEGER,
98	    -- ***** Buffer Config *****
99	    soipConfigBufferClear		INTEGER
100	}
101
102	soipConfigIndex OBJECT-TYPE
103	    SYNTAX      INTEGER
104	    MAX-ACCESS  read-write
105	    STATUS      current
106	    DESCRIPTION
107			"Reference to the used serial port."
108	::= { soipConfigEntry 1 }
109
110	-- ***** UART Config *****
111
112	soipConfigUartBaud OBJECT-TYPE
113	    SYNTAX      INTEGER (1..115200)
114	    MAX-ACCESS  read-write
115	    STATUS      current
116	    DESCRIPTION
117			"Baud rate of serial port."
118	    DEFVAL { 9600 }
119	::= { soipConfigEntry 2 }
120
121	soipConfigUartDataBits OBJECT-TYPE
122	    SYNTAX      INTEGER (7..8)
123	    MAX-ACCESS  read-write
124	    STATUS      current
125	    DESCRIPTION
126			"Data bits of serial port."
127	    DEFVAL { 8 }
128	::= { soipConfigEntry 3 }
129
130	soipConfigUartParity OBJECT-TYPE
131	    SYNTAX      INTEGER {
132			none(1),
133			even(2),
134			odd(3)
135	    }
136	    MAX-ACCESS  read-write
137	    STATUS      current
138	    DESCRIPTION
139			"Type of serial port.
140			 none(1) -- No parity bit
141			 even(2) -- Even parity bit
142			 odd(3)  -- Odd parity bit"
143	    DEFVAL { none }
144	::= { soipConfigEntry 4 }
145
146	soipConfigUartStopBits OBJECT-TYPE
147	    SYNTAX      INTEGER (1..2)
148	    MAX-ACCESS  read-write
149	    STATUS      current
150	    DESCRIPTION
151			"Stop bits of serial port."
152	    DEFVAL { 1 }
153	::= { soipConfigEntry 5 }
154
155	soipConfigUartHandshake OBJECT-TYPE
156	    SYNTAX      INTEGER {
157			none(1),
158			rts-cts(2),
159			xon-xoff(3)
160	    }
161	    MAX-ACCESS  read-write
162	    STATUS      current
163	    DESCRIPTION
164			"Handshake used on serial port.
165			 none(1)     -- no handshake
166			 rts-cts(2)  -- RTS/CTS signal pair used for handshake (hardware)
167			 xon-xoff(3) -- XOn/XOff bytes used for handshake (software)
168			                Received XOn/XOff characters are not forwarded via IP."
169	    DEFVAL { none }
170	::= { soipConfigEntry 6 }
171
172	soipConfigUartSendGraciousXonXoff OBJECT-TYPE
173	    SYNTAX      TruthValue
174	    MAX-ACCESS  read-write
175	    STATUS      current
176	    DESCRIPTION
177			"Send gracious XOn/XOff.
178			 TCP: if IP connection is established/closed
179			 UDP: send XOn on startup"
180	    DEFVAL { true }
181	::= { soipConfigEntry 7 }
182
183	-- ***** IP Config *****
184
185	soipConfigIpProtocol OBJECT-TYPE
186	    SYNTAX      INTEGER {
187			tcp-server(1),
188			tcp-client(2),
189			udp(3),
190                        delete(15)
191	    }
192	    MAX-ACCESS  read-write
193	    STATUS      current
194	    DESCRIPTION
195			"IP protocol and mode to use.
196			 tcp-server(1) -- Wait for incoming TCP connections
197			 tcp-client(2) -- Active connect via TCP
198			 udp(3)        -- UDP
199                         With delete(15) the entry will be deleted"
200	    DEFVAL { tcp-server }
201	::= { soipConfigEntry 8 }
202
203	soipConfigIpReconnectTimeout OBJECT-TYPE
204	    SYNTAX      INTEGER (0..65535)
205	    UNITS	"seconds"
206	    MAX-ACCESS  read-write
207	    STATUS      current
208	    DESCRIPTION
209			"TCP client: Retry connect after n seconds if connection is refused or not answered.
210			             0 = do not reconnect"
211	    DEFVAL { 10 }
212	::= { soipConfigEntry 9 }
213
214	soipConfigIpLocalIp OBJECT-TYPE
215	    SYNTAX      IpAddress
216	    MAX-ACCESS  read-write
217	    STATUS      current
218	    DESCRIPTION
219			"TCP server: accept connection only on this IP.  0=any.
220			 TCP client: issue connection from this IP. 0=automatic.
221			 UDP unicast: send data from and accept on this IP. 0=automatic.
222			 UDP multicast master (1:n): master unicast IP. 0=automatic.
223			 UDP multicast slave (1:n): multicast group IP.
224			 UDP multicast multi-master (n:m): multicast group IP."
225	::= { soipConfigEntry 10 }
226
227	soipConfigIpLocalPort OBJECT-TYPE
228	    SYNTAX      INTEGER (0..65535)
229	    MAX-ACCESS  read-write
230	    STATUS      current
231	    DESCRIPTION
232			"TCP server: local port to listen on for connections
233			 TCP client: local port to issue connection from. 0=automatic.
234			 UDP unicast: port to send from / receive on. 0=automatic.
235			 UDP multicast: port to send from / receive on. 0=automatic."
236	::= { soipConfigEntry 11 }
237
238	soipConfigIpRemoteIp OBJECT-TYPE
239	    SYNTAX      IpAddress
240	    MAX-ACCESS  read-write
241	    STATUS      current
242	    DESCRIPTION
243			"TCP server: accept connection only from this IP.  0=any.
244			 TCP client: issue connection to this IP.
245			 UDP unicast: send data to this IP.
246			 UDP multicast master (1:n): multicast group IP.
247			 UDP multicast slave (1:n): master unicast IP.
248			 UDP multicast multi-master (n:m): multicast group IP."
249	::= { soipConfigEntry 12 }
250
251	soipConfigIpRemotePort OBJECT-TYPE
252	    SYNTAX      INTEGER (0..65535)
253	    MAX-ACCESS  read-write
254	    STATUS      current
255	    DESCRIPTION
256			"TCP server: remote port to accept connections from. 0=any.
257			 TCP client: remote port to connect to
258			 UDP unicast: port to send to / receive from.
259			 UDP multicast: port to send to / receive on"
260	::= { soipConfigEntry 13 }
261
262	soipConfigIpIfIndex OBJECT-TYPE
263	    SYNTAX      INTEGER
264	    MAX-ACCESS  read-write
265	    STATUS      current
266	    DESCRIPTION
267			"Interface index to bind to.
268			 TCP server: ignored
269			 TCP client: ignored
270			 UDP unicast: ignored
271			 UDP multicast: multicast interface index"
272	::= { soipConfigEntry 14 }
273
274	-- ***** Trigger Config *****
275
276	soipConfigTriggerByteCount OBJECT-TYPE
277	    SYNTAX      INTEGER (1..1460)
278	    UNITS	"byte"
279	    MAX-ACCESS  read-write
280	    STATUS      current
281	    DESCRIPTION
282			"Send an IP packet after receiving n bytes from serial port."
283	    DEFVAL { 128 }
284	::= { soipConfigEntry 15 }
285
286	soipConfigTriggerDelay OBJECT-TYPE
287	    SYNTAX      INTEGER (0..65535)
288	    UNITS	"milliseconds"
289	    MAX-ACCESS  read-write
290	    STATUS      current
291	    DESCRIPTION
292			"Send an IP packet n milliseconds after receiving the first byte from serial port.
293			 0 = trigger disabled"
294	    DEFVAL { 100 }
295	::= { soipConfigEntry 16 }
296
297	soipConfigTriggerTimeout OBJECT-TYPE
298	    SYNTAX      INTEGER (0..65535)
299	    UNITS	"milliseconds"
300	    MAX-ACCESS  read-write
301	    STATUS      current
302	    DESCRIPTION
303			"Send an IP packet n milliseconds after receiving the last byte from serial port.
304			 0 = trigger disabled"
305	    DEFVAL { 0 }
306	::= { soipConfigEntry 17 }
307
308	-- ***** Buffer Config *****
309
310	soipConfigBufferClear OBJECT-TYPE
311	    SYNTAX      INTEGER {
312			no-action(1),
313			serial-rx(2),
314			serial-tx(3),
315			serial-rx-tx(4)
316			-- serial-ip-rx(5)
317			-- serial-ip-tx(6)
318			-- serial-ip-rx-tx(7)
319	    }
320	    MAX-ACCESS  read-write
321	    STATUS      current
322	    DESCRIPTION
323			"Trigger clearing of buffers. Variable falls back to no-action after clearing the buffers.
324			 no-action(1)    -- clear nothing, normal operation
325			 serial-rx(2)    -- clear serial Rx buffer
326			 serial-tx(3)    -- clear serial Tx buffer
327			 serial-rx-tx(4) -- clear serial Rx and Tx buffer"
328	    DEFVAL { no-action }
329	::= { soipConfigEntry 18 }
330
331
332-- **********************************************************************
333-- *    soipStatusTable  TABLE
334-- **********************************************************************
335
336soipStatusTable OBJECT-TYPE
337	SYNTAX      SEQUENCE OF SoipStatusEntry
338	MAX-ACCESS  not-accessible
339	STATUS      current
340	DESCRIPTION
341	    "The soipStatusTable contains status and statistic information related
342	     to the SoIP interface."
343	::= { soip 2 }
344
345	soipStatusEntry OBJECT-TYPE
346	    SYNTAX      SoipStatusEntry
347	    MAX-ACCESS  not-accessible
348	    STATUS      current
349	    DESCRIPTION
350			"The soipStatusEntry contains status and statistic information
351			 of a SoIP interface."
352	    INDEX  { soipStatusIndex }
353	::= { soipStatusTable 1 }
354
355	SoipStatusEntry ::=
356	SEQUENCE {
357	    soipStatusIndex			INTEGER,
358	    -- ***** UART Statistics *****
359	    soipStatusUartRxBytes		Counter32,
360	    soipStatusUartTxBytes		Counter32,
361	    soipStatusUartRxParityErrors	Counter32,
362	    soipStatusUartRxOtherErrors		Counter32,
363	    soipStatusUartRxFifoErrors		Counter32,
364	    soipStatusUartSentXon		Counter32,
365	    soipStatusUartSentXoff		Counter32,
366	    soipStatusUartReceivedXon		Counter32,
367	    soipStatusUartReceivedXoff		Counter32,
368	    -- ***** IP Statistics *****
369	    soipStatusIpRxBytes			Counter32,
370--	    soipStatusIpRxPackets		Counter32,
371	    soipStatusIpTxBytes			Counter32,
372--	    soipStatusIpTxPackets		Counter32,
373	    soipStatusIpRxFifoErrors		Counter32,
374	    -- ***** UART Status *****
375	    soipStatusUartLocalHandshakeStatus	INTEGER,
376	    soipStatusUartRemoteHandshakeStatus	INTEGER,
377--	    soipStatusUartControlLines		BITS,
378	    -- ***** Buffer Status *****
379--	    soipStatusUartToIpBytesBuffered	Gauge32,
380--	    soipStatusIpToUartBytesBuffered	Gauge32,
381	    -- ***** IP Status *****
382	    soipStatusIpStatus			INTEGER,
383	    soipStatusIpLocalIp			IpAddress,
384	    soipStatusIpLocalPort		INTEGER,
385	    soipStatusIpRemoteIp		IpAddress,
386	    soipStatusIpRemotePort		INTEGER
387	}
388
389	soipStatusIndex OBJECT-TYPE
390	    SYNTAX      INTEGER
391	    MAX-ACCESS  read-only
392	    STATUS      current
393	    DESCRIPTION
394			"Reference to the concerned serial port."
395	::= { soipStatusEntry 1 }
396
397	-- ***** UART Statistics *****
398
399	soipStatusUartRxBytes OBJECT-TYPE
400	    SYNTAX      Counter32
401	    MAX-ACCESS  read-only
402	    STATUS      current
403	    DESCRIPTION
404			"Successful received bytes on the serial port."
405	::= { soipStatusEntry 2 }
406
407	soipStatusUartTxBytes OBJECT-TYPE
408	    SYNTAX      Counter32
409	    MAX-ACCESS  read-only
410	    STATUS      current
411	    DESCRIPTION
412			"Successful transmitted bytes on the serial port."
413	::= { soipStatusEntry 3 }
414
415	soipStatusUartRxParityErrors OBJECT-TYPE
416	    SYNTAX      Counter32
417	    MAX-ACCESS  read-only
418	    STATUS      current
419	    DESCRIPTION
420			"Receive parity errors on the serial port."
421	::= { soipStatusEntry 4 }
422
423	soipStatusUartRxOtherErrors OBJECT-TYPE
424	    SYNTAX      Counter32
425	    MAX-ACCESS  read-only
426	    STATUS      current
427	    DESCRIPTION
428			"Receive errors of all other types (framing, noise, ...) on the serial port."
429	::= { soipStatusEntry 5 }
430
431	soipStatusUartRxFifoErrors OBJECT-TYPE
432	    SYNTAX      Counter32
433	    MAX-ACCESS  read-only
434	    STATUS      current
435	    DESCRIPTION
436			"Receive buffer overflow on the serial port."
437	::= { soipStatusEntry 6 }
438
439	soipStatusUartSentXon OBJECT-TYPE
440	    SYNTAX      Counter32
441	    MAX-ACCESS  read-only
442	    STATUS      current
443	    DESCRIPTION
444			"XOn bytes sent by the local device on the serial port."
445	::= { soipStatusEntry 7 }
446
447	soipStatusUartSentXoff OBJECT-TYPE
448	    SYNTAX      Counter32
449	    MAX-ACCESS  read-only
450	    STATUS      current
451	    DESCRIPTION
452			"XOff bytes sent by the local device on the serial port."
453	::= { soipStatusEntry 8 }
454
455	soipStatusUartReceivedXon OBJECT-TYPE
456	    SYNTAX      Counter32
457	    MAX-ACCESS  read-only
458	    STATUS      current
459	    DESCRIPTION
460			"XOn bytes received from the remote device on the serial port."
461	::= { soipStatusEntry 9 }
462
463	soipStatusUartReceivedXoff OBJECT-TYPE
464	    SYNTAX      Counter32
465	    MAX-ACCESS  read-only
466	    STATUS      current
467	    DESCRIPTION
468			"XOff bytes received from the remote device on the serial port."
469	::= { soipStatusEntry 10 }
470
471	-- ***** IP Statistics *****
472
473	soipStatusIpRxBytes OBJECT-TYPE
474	    SYNTAX      Counter32
475	    MAX-ACCESS  read-only
476	    STATUS      current
477	    DESCRIPTION
478			"Successful received bytes via IP."
479	::= { soipStatusEntry 11 }
480
481--	soipStatusIpRxPackets OBJECT-TYPE
482--	::= { soipStatusEntry 12 }
483
484	soipStatusIpTxBytes OBJECT-TYPE
485	    SYNTAX      Counter32
486	    MAX-ACCESS  read-only
487	    STATUS      current
488	    DESCRIPTION
489			"Successful transmitted bytes via IP."
490	::= { soipStatusEntry 13 }
491
492--	soipStatusIpTxPackets OBJECT-TYPE
493--	::= { soipStatusEntry 14 }
494
495	soipStatusIpRxFifoErrors OBJECT-TYPE
496	    SYNTAX      Counter32
497	    MAX-ACCESS  read-only
498	    STATUS      current
499	    DESCRIPTION
500			"Receive buffer overflow on IP side."
501	::= { soipStatusEntry 15 }
502
503	-- ***** UART Status *****
504
505	soipStatusUartLocalHandshakeStatus OBJECT-TYPE
506	    SYNTAX      INTEGER {
507			on(1),
508			off(2)
509	    }
510	    MAX-ACCESS  read-only
511	    STATUS      current
512	    DESCRIPTION
513			"Current local handshake status.
514			 on(1)  -- receiving enabled
515			 off(2) -- receiving disabled"
516	::= { soipStatusEntry 16 }
517
518	soipStatusUartRemoteHandshakeStatus OBJECT-TYPE
519	    SYNTAX      INTEGER {
520			on(1),
521			off(2)
522	    }
523	    MAX-ACCESS  read-only
524	    STATUS      current
525	    DESCRIPTION
526			"Current remote handshake status.
527			 on(1)  -- receiving enabled
528			 off(2) -- receiving disabled"
529	::= { soipStatusEntry 17 }
530
531--	soipStatusUartControlLines OBJECT-TYPE
532--	::= { soipStatusEntry 18 }
533
534	-- ***** Buffer Status *****
535
536--	soipStatusUartToIpBytesBuffered OBJECT-TYPE
537--	::= { soipStatusEntry 19 }
538
539--	soipStatusIpToUartBytesBuffered OBJECT-TYPE
540--	::= { soipStatusEntry 20 }
541
542	-- ***** IP Status *****
543
544	soipStatusIpStatus OBJECT-TYPE
545	    SYNTAX      INTEGER {
546			not-connected(1),
547			connecting(2),
548			connected(3),
549			conn-refused(4),
550			peer-unreabable(5),
551			peer-timeout(6)
552	    }
553	    MAX-ACCESS  read-only
554	    STATUS      current
555	    DESCRIPTION
556			"Current connection status.
557			 not-connected(1)   -- not connected
558			 connecting(2)      -- connecting
559			 connected(3)       -- connected
560			 conn-refused(4)    -- connection refused
561			 peer-unreabable(5) -- peer unreachable
562			 peer-timeout(6)    -- peer not answering (timeout)"
563	::= { soipStatusEntry 21 }
564
565	soipStatusIpLocalIp OBJECT-TYPE
566	    SYNTAX      IpAddress
567	    MAX-ACCESS  read-only
568	    STATUS      current
569	    DESCRIPTION
570			"TCP server: Local IP. 0 = not connected.
571			 TCP client: Local IP. 0 = not connected.
572			 UDP unicast: Local IP packets get send from.
573			 UDP multicast: Local IP packets get send from."
574	::= { soipStatusEntry 22 }
575
576	soipStatusIpLocalPort OBJECT-TYPE
577	    SYNTAX      INTEGER (0..65535)
578	    MAX-ACCESS  read-only
579	    STATUS      current
580	    DESCRIPTION
581			"TCP server: Local port.
582			 TCP client: Local port.
583			 UDP unicast: Local port packets get send from.
584			 UDP multicast: Local port packets get send from."
585	::= { soipStatusEntry 23 }
586
587	soipStatusIpRemoteIp OBJECT-TYPE
588	    SYNTAX      IpAddress
589	    MAX-ACCESS  read-only
590	    STATUS      current
591	    DESCRIPTION
592			"TCP server: Remote IP. 0 = not connected.
593			 TCP client: Remote IP. 0 = not connected.
594			 UDP unicast: Remote IP the last packet was received from.
595			 UDP multicast: Remote IP the last packet was received from."
596	::= { soipStatusEntry 24 }
597
598	soipStatusIpRemotePort OBJECT-TYPE
599	    SYNTAX      INTEGER (0..65535)
600	    MAX-ACCESS  read-only
601	    STATUS      current
602	    DESCRIPTION
603			"TCP server: Remote port.
604			 TCP client: Remote port.
605			 UDP unicast: Remote port the last packet was received from.
606			 UDP multicast: Remote port the last packet was received from."
607	::= { soipStatusEntry 25 }
608
609
610-- **********************************************************************
611-- *    END
612-- **********************************************************************
613END
614