Appendix I. FireBrick specific SNMP objects

Appendix I. FireBrick specific SNMP objects

Table of Contents

I.1. Conventions

I.1.1. IP addresses as indices

I.2. Firebrick-specific structures for BGP

I.2.1. Structure definitions

I.2.1.1. The list of BGP peers for this Firebrick

I.2.2. Enum Definitions

I.3. Firebrick-specific structures for IPSec

I.3.1. Structure definitions

I.3.1.1. fbIPsecGeneral
I.3.1.2. The list of IPsec connections for this Firebrick

I.3.2. Enum Definitions

I.4. Firebrick-specific structures for L2TP

I.4.1. Structure definitions

I.4.1.1. fbL2tpGeneralTunnels
I.4.1.2. fbL2tpGeneralSessions
I.4.1.3. The list of L2TP peers for this Firebrick

I.5. Firebrick-specific structures for VoIP/SIP

I.5.1. Structure definitions

I.5.1.1. Globals
I.5.1.2. The list of VoIP carriers for this Firebrick
I.5.1.3. The list of telephones on this Firebrick

I.6. Firebrick CPU usage

I.6.1. Structure definitions

I.6.1.1. CPU usage for this Firebrick

I.7. Firebrick system stats

I.7.1. Structure definitions

I.7.1.1. The table of runtime stats for this Firebrick

I.8. Monitoring for general system features

I.8.1. Structure definitions

I.8.1.1. The list of readings for this Firebrick

I.9. System wide status

I.9.1. Structure definitions

I.9.1.1. fbGlobalMemory
I.9.1.2. fbGlobalBuffers

I.10. Firebrick profiles

I.10.1. Structure definitions

I.10.1.1. Profiles status

I.11. Monitoring information (deprecated)

This appendix details the SNMP objects that are specific to the FireBrick.

I.1. Conventions

To avoid writing out very repetitive (and long) OIDs this appendix uses a substitution notation when describing structures. The OIDs contain the names of indices and an X representing the structure field number given by the matching column in the following table. So if the OID given in the manual is iso.1.2.3.4.X.anIndex then the OID for the first item described in the table row with column X = 3 would be: iso.1.2.3.4.3.1

I.1.1. IP addresses as indices

In some structures IP addresses may be used as indices into SNMP tables. When this is the case the IP must be encoded into the OID for the resource. This encoding consists of the following separated by dots:

The IP type: 1 for IPv4, 2 for IPv6.
A length prefixed array of the bytes of the address in network order.

Example I.1.

For the IPv4 address 10.0.1.12 the IP type is 1 and the length is 4. Therefore the OID fragment 1.4.10.0.1.12 could be used as an index.

Example I.2.

For the IPv6 address 2001::32 the IP type is 2 and the length is 16. Therefore the OID fragment 2.16.32.1.0.0.0.0.0.0.0.0.0.0.0.0.0.50 could be used as an index.


H.7. Change of Authorisation		I.2. Firebrick-specific structures for BGP