2.2.1.2.190 MIB_DA_MSG

Article
06/24/2021

The MIB_DA_MSG structure MAY <137> be used for retrieving OSPF MIB entries in the following methods:

RMIBEntryGet (section 3.1.4.30)
RMIBEntryGetFirst (section 3.1.4.31)

 typedef struct _MIB_DA_MSG {
   UINT32 op_code;
   UINT32 ret_code;
   UINT32 in_snmp_id[44];
   UINT32 obj_id[17];
   UINT32 attr_id;
   UINT32 inst_id[23];
   UINT32 next_snmp_id[44];
   UINT32 creator;
   UINT32 attr_type;
   UINT32 inst_cnt;
   UINT32 map_flag;
   ULONG_PTR data[32];
 } MIB_DA_MSG;

op_code: This MUST have one of the following values.

Value	Meaning
ASN_RFC1157_GETREQUEST 0x000000A0	MIB get request: RMIBEntryGet (section 3.1.4.30)
ASN_RFC1157_GETNEXTREQUEST 0x000000A1	MIB get next request: RMIBEntryGetNext (section 3.1.4.32)
ASN_RFC1157_SETREQUEST 0x000000A3	MIB set request: RMIBEntrySet (section 3.1.4.29)

Value

Meaning

ASN_RFC1157_GETREQUEST

0x000000A0

MIB get request: RMIBEntryGet (section 3.1.4.30)

ASN_RFC1157_GETNEXTREQUEST

0x000000A1

MIB get next request: RMIBEntryGetNext (section 3.1.4.32)

ASN_RFC1157_SETREQUEST

0x000000A3

MIB set request: RMIBEntrySet (section 3.1.4.29)

ret_code: This contains a return value which MUST be one of the following values.

Value	Meaning
MIB_OK 0x00000000	The call was successful.
All other values	The call was not successful.

Value

Meaning

MIB_OK

0x00000000

The call was successful.

All other values

The call was not successful.

in_snmp_id: Contains the index of the entry that needs to be retrieved.

in_snmp_id[0] contains the length (excluding the zeroth element) of the data passed in in_snmp_id. in_snmp_id[1] onwards contains the MIB object identifier [RFC1850].

Value in_snmp_id[1] and beyond	Meaning [RFC 1850]
g_oidOspfAreaEntry { 4, 1, 18, 3, 5, 3, 2, 3, 2, 1 }	Open Shortest Path First (OSPF) area entry. See ospfAreaEntry, section 3.2 in [RFC1850]. Information describing the configured parameters and cumulative statistics of one of the router's attached areas.
g_oidOspfLsdbEntry { 4, 1, 18, 3, 5, 3, 2, 3, 3, 1 }	A single link state advertisement. See ospfLsdbEntry, section 3.4 in [RFC1850].
g_oidOspfNbrEntry { 4, 1, 18, 3, 5, 3, 2, 3, 7, 1 }	The information regarding a single neighbor. See OspfNbrEntry, section 3.10 in [RFC1850].
g_oidOspfVIEntry { 4, 1, 18, 3, 5, 3, 2, 3, 6, 1 }	The information about a single Virtual Interface. See OspfVirtIfEntry, section 3.9 in [RFC1850].
g_oidOspfAreaState { 4, 1, 18, 3, 5, 3, 2, 3, 2, 1, 3 }	Retrieves the state. This value indicates the state of the OSPF Area, either up(0x00000001), or down(0x00000002). See ospfAreaStatus, section 3.2 in [RFC1850].
g_oidOspfAreaSpfCount { 4, 1, 18, 3, 5, 3, 2, 3, 2, 1, 9 }	Retrieves the number of times the SPF algorithm has run for the area. See ospfSpfRuns, section 3.2 in [RFC1850].
g_oidOspfLsdbAge { 4, 1, 18, 3, 5, 3, 2, 3, 3, 1, 6 }	Retrieves the age of the link state advertisement in seconds. See ospfLsdbAge, section 3.4 in [RFC1850] and section 12.1.1 LS age in [RFC2328].
g_oidOspfLsdbSequence { 4, 1, 18, 3, 5, 3, 2, 3, 3, 1, 5 }	Retrieves the sequence. The OSPF Sequence Number is a 32-bit signed integer. It starts with the value '80000001'h, or '7FFFFFFF'h, and increments until '7FFFFFFF'h. Thus, a typical sequence number will be very negative. The sequence number field is a signed 32-bit integer. It is used to detect old and duplicate link state advertisements. The space of sequence numbers is linearly ordered. The larger the sequence number the more recent the advertisement. See ospfLsdbSequence, section 3.4 of [RFC1850] and LS sequence number, section 12.1.6 in [RFC2328].
g_oidOspfNbrRtrId { 4, 1, 18, 3, 5, 3, 2, 3, 7, 1, 7 }	Retrieves the router ID. A 32-bit integer uniquely identifying the neighboring router in the autonomous system. See ospfNbrRtrId, section 3.10 in [RFC1850].
g_oidOspfNbrState { 4, 1, 18, 3, 5, 3, 2, 3, 7, 1, 3 }	Retrieves the state. The state of the Virtual Neighbor Relationship. It can be down (0x00000001), attempt (0x00000002), init (0x00000003), twoWay (0x00000004), exchangeStart (0x00000005), exchange (0x00000006), loading (0x00000007), and full (0x00000008) See ospfNbrState, section 3.10 in [RFC1850].
g_oidOspfNbrPriority { 4, 1, 18, 3, 5, 3, 2, 3, 7, 1, 9 }	Retrieves the priority. The priority of this neighbor in the designated router election algorithm. The value 0 signifies that the neighbor is not eligible to become the designated router on this particular network. See ospfNbrPriority, section 3.10 in [RFC1850].
g_oidOspfNbrEvents { 4, 1, 18, 3, 5, 3, 2, 3, 7, 1, 10 }	Retrieves the event count. The number of times this neighbor relationship has changed state, or that an error has occurred. See ospfNbrEvents, section 3.10 in [RFC1850].
g_oidOspfNbrLSRetransQLen { 4, 1, 18, 3, 5, 3, 2, 3, 7, 1, 11 }	Retrieves the queue length. See ospfNbrLsRetransQLen, section 3.10 in [RFC1850].
g_oidOspfVIState { 4, 1, 18, 3, 5, 3, 2, 3, 6, 1, 3 }	Retrieves the state. See ospfVirtIfState, section 3.9 in [RFC1850].
g_oidOspfVIDrops { 4, 1, 18, 3, 5, 3, 2, 3, 6, 1, 21}	The number of OSPF packets dropped on Virtual Interfaces. The data returned is a 32-bit integer.
g_oidOspfVIRxHellos { 4, 1, 18, 3, 5, 3, 2, 3, 6, 1, 16 }	The number of OSPF Hello packets received on Virtual Interfaces. Data returned is a 32-bit integer.
g_oidOspfVITxHellos { 4, 1, 18, 3, 5, 3, 2, 3, 6, 1, 11 }	The number of OSPF Hello packets transmitted on the Virtual Interfaces. The data returned is a 32-bit integer.
g_oidOspfIfArea { 4, 1, 18, 3, 5, 3, 2, 3, 5, 1, 6 }	See ospfIfAreaId, section 3.7 in [RFC1850].
g_oidOspfIfType { 4, 1, 18, 3, 5, 3, 2, 3, 5, 1, 7 }	See ospfIfType, section 3.7 in [RFC1850].
g_oidOspfIfState { 4, 1, 18, 3, 5, 3, 2, 3, 5, 1, 3 }	See ospfIfState, section 3.7 in [RFC1850].
g_oidOspfIfRxDBDescripts { 4, 1, 18, 3, 5, 3, 2, 3, 5, 1, 24 }	The number of OSPF DataBase Description packets received. The data returned is a 32-bit integer.
g_oidOspfIfRxLinkStateAcks { 4, 1, 18, 3, 5, 3, 2, 3, 5, 1, 27 }	The number of OSPF Link State Acknowledgements received. The data returned is a 32-bit integer.
g_oidOspfIfRxLinkStateReqs { 4, 1, 18, 3, 5, 3, 2, 3, 5, 1, 25 }	The number of OSPF Link State Requests received. The data returned is a 32-bit integer.
g_oidOspfIfRxLinkStateUpds { 4, 1, 18, 3, 5, 3, 2, 3, 5, 1, 26 }	The number of OSPF Link State Updates received. The ata returned is a 32-bit integer.
g_oidOspfIfTxDBDescripts { 4, 1, 18, 3, 5, 3, 2, 3, 5, 1, 19 }	The number of OSPF DataBase Description packets transmitted. The data returned is a 32-bit integer.
g_oidOspfIfTxLinkStateAcks { 4, 1, 18, 3, 5, 3, 2, 3, 5, 1, 22 }	The number of OSPF Link State Update packets transmitted. The data returned is a 32-bit integer.
g_oidOspfIfTxLinkStateReqs { 4, 1, 18, 3, 5, 3, 2, 3, 5, 1, 20 }	The number of OSPF Link State Request packets transmitted. The data returned is a 32-bit integer.
g_oidOspfIfTxLinkStateUpds { 4, 1, 18, 3, 5, 3, 2, 3, 5, 1, 21 }	The number of OSPF Link State Update packets transmitted. The data returned is a 32-bit integer.
g_oidOspfIfDrops { 4, 1, 18, 3, 5, 3, 2, 3, 5, 1, 28 }	The number of OSPF packets dropped because of invalid information in the packet. The data returned is a 32-bit integer.

obj_id: Unused and MUST be set to zero (0).

attr_id: Unused and MUST be set to zero (0).

inst_id: Unused and MUST be set to zero (0).

next_snmp_id: Unused and MUST be set to zero (0).

creator: Unused and MUST be set to zero (0).

attr_type: Unused and MUST be set to zero (0).

inst_cnt: Unused and MUST be set to zero (0).

map_flag: Unused and MUST be set to zero (0).

data: Contains the data returned by the OSPF MIB based on the entry requested in the previous table. See [RFC1850] for more information about how to interpret the returned data. The length of the data returned is specified in dwMibOutEntrySize of pInfoStruct in the call to RMIBEntryGet, RMIBEntryGetFirst, and RMIBEntryGetNext.

2.2.1.2.190 MIB_DA_MSG

Additional resources