xref: /openbsd/share/snmp/OPENBSD-CARP-MIB.txt (revision d89ec533) 
1-- $OpenBSD: OPENBSD-CARP-MIB.txt,v 1.4 2018/05/30 18:17:20 sthen Exp $
2--
3-- Copyright (c) 2006-2011 Joel Knight <knight.joel@gmail.com>
4--
5-- Permission to use, copy, modify, and distribute this document for any
6-- purpose with or without fee is hereby granted, provided that the above
7-- copyright notice and this permission notice appear in all copies.
8--
9-- THE DOCUMENT IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10-- WITH REGARD TO THIS DOCUMENT INCLUDING ALL IMPLIED WARRANTIES OF
11-- MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12-- ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13-- WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14-- ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15-- OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS DOCUMENT.
16
17
18OPENBSD-CARP-MIB DEFINITIONS ::= BEGIN
19
20IMPORTS
21	MODULE-IDENTITY, NOTIFICATION-TYPE, OBJECT-TYPE,
22	Counter64, Integer32, enterprises
23		FROM SNMPv2-SMI
24
25	TruthValue
26		FROM SNMPv2-TC
27
28	openBSD
29		FROM OPENBSD-BASE-MIB
30
31	MODULE-COMPLIANCE, OBJECT-GROUP
32		FROM SNMPv2-CONF;
33
34carpMIBObjects MODULE-IDENTITY
35    LAST-UPDATED "201805140000Z"
36    ORGANIZATION "OpenBSD"
37    CONTACT-INFO "
38                  Author:     Joel Knight
39                  email:      knight.joel@gmail.com
40                  www:        www.packetmischief.ca/openbsd-snmp-mibs/
41                 "
42    DESCRIPTION  "The MIB module for gathering information about
43		 Common Address Redundancy Protocol (CARP) interfaces."
44    REVISION     "201805140000Z"
45    DESCRIPTION  "Add the carpGroupTable to OPENBSD-CARP-MIB."
46    REVISION     "201201310000Z"
47    DESCRIPTION  "Add the OPENBSD-CARP-MIB to snmpd."
48    ::= { openBSD 6 }
49
50
51-- define the sections of the MIB
52
53carpSysctl			OBJECT IDENTIFIER ::= { carpMIBObjects 1 }
54carpIf				OBJECT IDENTIFIER ::= { carpMIBObjects 2 }
55carpStats			OBJECT IDENTIFIER ::= { carpMIBObjects 3 }
56
57
58-- carpSysctl
59carpAllow OBJECT-TYPE
60	SYNTAX      TruthValue
61	MAX-ACCESS  read-only
62	STATUS      current
63	DESCRIPTION
64	"Indicates whether the node will respond to CARP packets."
65	::= { carpSysctl 1 }
66
67carpPreempt OBJECT-TYPE
68	SYNTAX      TruthValue
69	MAX-ACCESS  read-only
70	STATUS      current
71	DESCRIPTION
72	"Indicates whether preemption is enabled."
73	::= { carpSysctl 2 }
74
75carpLog OBJECT-TYPE
76	SYNTAX      TruthValue
77	MAX-ACCESS  read-only
78	STATUS      current
79	DESCRIPTION
80	"Indicates whether logging of invalid CARP packets is enabled."
81	::= { carpSysctl 3 }
82
83
84-- carpIf
85
86carpIfNumber OBJECT-TYPE
87	SYNTAX      Integer32
88	MAX-ACCESS  read-only
89	STATUS      current
90	DESCRIPTION
91	"The number of CARP interfaces present on this system."
92	::= { carpIf 1 }
93
94carpIfTable OBJECT-TYPE
95	SYNTAX		SEQUENCE OF CarpIfEntry
96	MAX-ACCESS	not-accessible
97	STATUS		current
98	DESCRIPTION
99	"A list of individual CARP interfaces. The number of entries is
100	given by the value of carpIfNumber."
101	::= { carpIf 2 }
102
103carpIfEntry OBJECT-TYPE
104	SYNTAX      CarpIfEntry
105	MAX-ACCESS  not-accessible
106	STATUS      current
107	DESCRIPTION
108	"An entry containing management information applicable to a
109	particular CARP interface."
110	INDEX   { carpIfIndex }
111	::= { carpIfTable 1 }
112
113CarpIfEntry ::=
114	SEQUENCE {
115		carpIfIndex		Integer32,
116		carpIfDescr		OCTET STRING,
117		carpIfVhid		Integer32,
118		carpIfDev		OCTET STRING,
119		carpIfAdvbase		Integer32,
120		carpIfAdvskew		Integer32,
121		carpIfState		Integer32
122	}
123
124carpIfIndex OBJECT-TYPE
125	SYNTAX		Integer32 (1..2147483647)
126	MAX-ACCESS	read-only
127	STATUS		current
128	DESCRIPTION
129	"A unique value, greater than zero, for each CARP interface."
130	::= { carpIfEntry 1 }
131
132carpIfDescr OBJECT-TYPE
133	SYNTAX		OCTET STRING
134	MAX-ACCESS	read-only
135	STATUS		current
136	DESCRIPTION
137	"The name of the CARP interface."
138	::= { carpIfEntry 2 }
139
140carpIfVhid OBJECT-TYPE
141	SYNTAX		Integer32
142	MAX-ACCESS	read-only
143	STATUS		current
144	DESCRIPTION
145	"The Virtual HostID of the CARP interface."
146	::= { carpIfEntry 3 }
147
148carpIfDev OBJECT-TYPE
149	SYNTAX		OCTET STRING
150	MAX-ACCESS	read-only
151	STATUS		current
152	DESCRIPTION
153	"The parent interface that the CARP interface is bound to."
154	::= { carpIfEntry 4 }
155
156carpIfAdvbase OBJECT-TYPE
157	SYNTAX		Integer32
158	MAX-ACCESS	read-only
159	STATUS		current
160	DESCRIPTION
161	"The advbase value of the CARP interface."
162	::= { carpIfEntry 5 }
163
164carpIfAdvskew OBJECT-TYPE
165	SYNTAX		Integer32
166	MAX-ACCESS	read-only
167	STATUS		current
168	DESCRIPTION
169	"The advskew value of the CARP interface."
170	::= { carpIfEntry 6 }
171
172carpIfState OBJECT-TYPE
173	SYNTAX		INTEGER { init(0), backup(1), master(2) }
174	MAX-ACCESS	read-only
175	STATUS		current
176	DESCRIPTION
177	"Indicates the operational state of the CARP interface."
178	::= { carpIfEntry 7 }
179
180
181-- carpGroup
182
183carpGroupTable OBJECT-TYPE
184	SYNTAX      SEQUENCE OF CarpGroupEntry
185	MAX-ACCESS  not-accessible
186	STATUS      current
187	DESCRIPTION
188	"A list of interface groups."
189	::= { carpMIBObjects 4 }
190
191carpGroupEntry OBJECT-TYPE
192	SYNTAX      CarpGroupEntry
193	MAX-ACCESS  not-accessible
194	STATUS      current
195	DESCRIPTION
196	"An entry containing management information applicable to a
197	particular interface group."
198	INDEX   { carpGroupIndex }
199	::= { carpGroupTable 1 }
200
201CarpGroupEntry ::=
202	SEQUENCE {
203		carpGroupIndex		Integer32,
204		carpGroupName		OCTET STRING,
205		carpGroupDemote		Integer32
206	}
207
208carpGroupIndex OBJECT-TYPE
209	SYNTAX		Integer32 (1..2147483647)
210	MAX-ACCESS	not-accessible
211	STATUS		current
212	DESCRIPTION
213	"The demote value of the interface group."
214	::= { carpGroupEntry 1 }
215
216carpGroupName OBJECT-TYPE
217	SYNTAX		OCTET STRING
218	MAX-ACCESS	read-only
219	STATUS		current
220	DESCRIPTION
221	"The name of the interface group."
222	::= { carpGroupEntry 2 }
223
224carpGroupDemote OBJECT-TYPE
225	SYNTAX		Integer32 (1..2147483647)
226	MAX-ACCESS	read-only
227	STATUS		current
228	DESCRIPTION
229	"The demote value of the interface group."
230	::= { carpGroupEntry 3 }
231
232
233-- carpStats
234
235carpIpPktsRecv OBJECT-TYPE
236	SYNTAX		Counter64
237	MAX-ACCESS	read-only
238	STATUS		current
239	DESCRIPTION
240	"Number of IPv4 CARP packets received on all interfaces."
241	::= { carpStats 1 }
242
243carpIp6PktsRecv OBJECT-TYPE
244	SYNTAX		Counter64
245	MAX-ACCESS	read-only
246	STATUS		current
247	DESCRIPTION
248	"Number of IPv6 CARP packets received on all interfaces."
249	::= { carpStats 2 }
250
251carpPktDiscardsForBadInterface OBJECT-TYPE
252	SYNTAX		Counter64
253	MAX-ACCESS	read-only
254	STATUS		current
255	DESCRIPTION
256	"Number of packets discarded due to being received on a
257	non-CARP interface."
258	::= { carpStats 3 }
259
260carpPktDiscardsForWrongTtl OBJECT-TYPE
261	SYNTAX		Counter64
262	MAX-ACCESS	read-only
263	STATUS		current
264	DESCRIPTION
265	"Number of packets discarded due to having a TTL less
266	than 255."
267	::= { carpStats 4 }
268
269carpPktShorterThanHeader OBJECT-TYPE
270	SYNTAX		Counter64
271	MAX-ACCESS	read-only
272	STATUS		current
273	DESCRIPTION
274	"Number of packets received on any interface that is
275	shorter than the size of the CARP packet header."
276	::= { carpStats 5 }
277
278carpPktDiscardsForBadChecksum OBJECT-TYPE
279	SYNTAX		Counter64
280	MAX-ACCESS	read-only
281	STATUS		current
282	DESCRIPTION
283	"Number of packets discarded due to bad checksum."
284	::= { carpStats 6 }
285
286carpPktDiscardsForBadVersion OBJECT-TYPE
287	SYNTAX		Counter64
288	MAX-ACCESS	read-only
289	STATUS		current
290	DESCRIPTION
291	"Number of packets discarded due to bad version in
292	the packet header."
293	::= { carpStats 7 }
294
295carpPktDiscardsForTooShort OBJECT-TYPE
296	SYNTAX		Counter64
297	MAX-ACCESS	read-only
298	STATUS		current
299	DESCRIPTION
300	"Number of packets discarded due to being too short."
301	::= { carpStats 8 }
302
303carpPktDiscardsForBadAuth OBJECT-TYPE
304	SYNTAX		Counter64
305	MAX-ACCESS	read-only
306	STATUS		current
307	DESCRIPTION
308	"Number of packets discarded because they failed the
309	HMAC authentication check."
310	::= { carpStats 9 }
311
312carpPktDiscardsForBadVhid OBJECT-TYPE
313	SYNTAX		Counter64
314	MAX-ACCESS	read-only
315	STATUS		current
316	DESCRIPTION
317	"Number of packets discarded due to incorrect VHID in
318	the packet header."
319	::= { carpStats 10 }
320
321carpPktDiscardsForBadAddressList OBJECT-TYPE
322	SYNTAX		Counter64
323	MAX-ACCESS	read-only
324	STATUS		current
325	DESCRIPTION
326	"Number of packets discarded due to bad addresses in
327	the CARP packet."
328	::= { carpStats 11 }
329
330carpIpPktsSent OBJECT-TYPE
331	SYNTAX		Counter64
332	MAX-ACCESS	read-only
333	STATUS		current
334	DESCRIPTION
335	"Number of IPv4 CARP packets sent on all interfaces."
336	::= { carpStats 12 }
337
338carpIp6PktsSent OBJECT-TYPE
339	SYNTAX		Counter64
340	MAX-ACCESS	read-only
341	STATUS		current
342	DESCRIPTION
343	"Number of IPv6 CARP packets sent on all interfaces."
344	::= { carpStats 13 }
345
346carpNoMemory OBJECT-TYPE
347	SYNTAX		Counter64
348	MAX-ACCESS	read-only
349	STATUS		current
350	DESCRIPTION
351	"Number of CARP advertisements that failed because memory
352	could not be allocated."
353	::= { carpStats 14 }
354
355carpTransitionsToMaster OBJECT-TYPE
356	SYNTAX		Counter64
357	MAX-ACCESS	read-only
358	STATUS		current
359	DESCRIPTION
360	"Number of times the host has transitioned to MASTER state
361	for any CARP group."
362	::= { carpStats 15 }
363
364END
365
366