Hannah Kirk

API Reference Content This document is from an SNMP MIBs manual I wrote for Ericsson. It’s not exactly an API, but it is highly technical, reference material, and quite similar in structure and purpose. I have the XML version only and the DTD to render it is long gone. I cleaned it up a bit, but it isn’t pretty. Still, I hope it gives you a sense of what I can do in writing API reference content. ● ● ● ● ● ● ● ● Who is the target audience? Network administrators How much of the content did you write? 75% Does the document represent original writing or existing content that you revised? Original writing and some revisions. How did you source the content? From feature specs and the command line interface. Did you follow a style guide? Yes. Definitely. It’s highly structured. There was a robust style guide that I followed for all documentation. Since this was technical reference material it had a specific structure and styles. Was the document edited? I can’t recall. We did have technical editors, but I don’t remember if they reviewed this reference content. How did you obtain any code samples? I generated them myself or used examples from specs. How did you verify the content? For this, it was an engineer reviewer as it would not have been possible to test each MIB. Each one represents a different use case that would have to be set up, which would have been time-consuming for little benefit. Content —---------------------------------------------- The contents of this document are an example only of the author's work and are in no way intended to resemble existing documentation for any specific product. Any resemblance to existing documentation past, present, or future is purely accidental. SNMP MIB Notifications Simple network management protocol (SNMP) Management Information Bases (MIBs) contain notifications. Some MIBs contain numerous notifications. Others contain none. To use notifications: Use a tool to integrate SNMP in your network and access the MIBs. You must download the MIB file that comes with your system in order to use the MIBs with your network. Enable notifications that are not enabled by default. Refer to this Guide when a notification raises or clears a flag in the interface to identify the meaning of the notification and any necessary solution. The product supports notifications for IETF-standard MIBs described in the following sections. SNMP examples in this document utilize the open source tool Net-SNMP. Depending on the product you use to monitor your network, the examples may appear different from your system. Setting up SNMP Alarm Models for Notifications You can use ALARM-MIB to create alarm models to specify the types of alarms and alarm states to raise for existing notifications. To configure an alarm model: Use the snmp alarm command to enter the SNMP alarm model command mode. Use one of the following commands to set up the SNMP alarm model with additional parameters: description eventtype notify probablecause res-prefix sp-pointer vb-index vb-subtree Use the following show commands to display information about SNMP alarm models: show snmp alarm model to display information about each alarm model. show snmp alarm active to display information about active alarm models show snmp alarm cleared to display information about cleared alarm models show snmp alarm stats to display general statistics about all alarm models, including how many have been configured Enable debugging for snmp alarm models by using the debug snmp mib alarm command. Entity Notifications This section organizes the relevant notifications into two tables. The first table lists the event, Object Identifier (OID), description and cause, recommended action, reporting module (the location where the event will be raised or cleared), the severity of the event, and the related events and interface commands. The second table lists the OIDs identified in each notification and the associated values. lists notifications generated by the router to indicate entity notification as defined in RFC 2037, Entity MIB using SMIv2. Entity Notifications Event and OID Description and Cause Recommended Action Reporting Module SeverityThe recommended severity level. Related Events and Commands entConfigChange- ENTITY-MIB The system generates this event when the entity configuration changes. It can be utilized by an NMS to trigger logical and physical entity table maintenance polls. This notification signifies that a physical entity of a chassis changed in the last 5 seconds (for example, card addition or removal), and the SNMP manager can reread the entity and act on the change. Cause: Hardware has been inserted or removed, or a card has failed. Use the show hardware, show diag, and show log commands to identify any failed or missing hardware. Node Minor Events: coldStart cardAlarm Command: None describes the objects for system management notifications. Entity Objects Notification Objects and Values entConfigChange ENTITY-MIB See RFC 2037, Entity MIB using SMIv2 RMON Notifications This section organizes the relevant notifications into two tables. The first table lists the event, Object Identifier (OID), description and cause, recommended action, reporting module (the location where the event will be raised or cleared), the severity of the event, and the related events and interface commands. The second table lists the OIDs identified in each notification and the associated values. lists notifications generated by the router to indicate RMON notifications as defined in RFC 2819, RMON Notifications Event and OID Description and Cause Recommended Action Reporting Module SeverityThe recommended severity level. Related Events and Commands fallingAlarm- RMON-MIB The system clears this notification when remote monitoring (RMON) falls. Cause: The value of a MIB object decreases. For example, you can monitor whether the temperature of the router decreases. Dependent upon which MIB object you set up for this notification to monitor. Node Warning Events: risingAlarm Commands: None.