Cisco FXOS MIB Reference Guide - Cisco - Global Home … · Cisco FXOS MIB Reference Guide 3 About...

Cisco FXOS MIB Reference GuideFirst Published: 2017-08-18

Americas HeadquartersCisco Systems, Inc.170 West Tasman DriveSan Jose, CA 95134-1706USAhttp://www.cisco.comTel: 408 526-4000 800 553-NETS (6387)Fax: 408 527-0883

THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL STATEMENTS,INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.

THE SOFTWARE LICENSE AND LIMITEDWARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT SHIPPED WITHTHE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE OR LIMITED WARRANTY,CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.

The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB's public domain versionof the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.

NOTWITHSTANDINGANYOTHERWARRANTYHEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS"WITH ALL FAULTS.CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THOSE OFMERCHANTABILITY, FITNESS FORA PARTICULAR PURPOSEANDNONINFRINGEMENTORARISING FROMACOURSEOFDEALING, USAGE, OR TRADE PRACTICE.

IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUTLIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO OR ITS SUPPLIERSHAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, networktopology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentionaland coincidental.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: http://www.cisco.com/go/trademarks. Third-party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnershiprelationship between Cisco and any other company. (1110R)

© 2017 Cisco Systems, Inc. All rights reserved.

http://www.cisco.com/go/trademarks

http://www.cisco.com/go/trademarks

C O N T E N T S

P r e f a c e About This Guide v

Conventions v

Related Documentation vi

Obtaining Documentation and Submitting a Service Request vii

C H A P T E R 1 About Cisco FXOS MIB Files 1

Cisco FXOS MIB Files 1

Downloading Cisco FXOS MIB Files from Cisco.com 2

Cisco FXOS Faults 2

Use Cases for Cisco FXOS MIBs 4

Receiving Fault Event Notifications 4

Gathering Inventory Information 5

Gathering Statistics 5

Types of MIBs 7

Cisco Extensions to the IF-MIB 7

C H A P T E R 2 Loading Cisco FXOS MIBs Into a Network Management System 9

Load Cisco FXOS MIBs 9

Prerequisite MIBs 9

MIB Loading Order 10

Order for Loading MIBs in Cisco FXOS 10

C H A P T E R 3 Purpose of the Cisco FXOS MIBs 13

Purpose of the Cisco FXOS MIBs 13

Cisco FXOS MIB Reference Guide iii

Cisco FXOS MIB Reference Guideiv

Contents

About This Guide

• Conventions, page v

• Related Documentation, page vi

• Obtaining Documentation and Submitting a Service Request, page vii

ConventionsIndicationText Type

GUI elements such as tab titles, area names, and field labels appear in this font.

Main titles such as window, dialog box, and wizard titles appear in this font.

GUI elements

Text the user should enter exactly as shown or keys a user should press appearin this font.

User input

Document titles appear in this font.Document titles

In a Text-based User Interface, text the system displays appears in this font.TUI elements

Terminal sessions and information that the system displays appear in thisfont.

System output

CLI command keywords appear in this font.

Variables in a CLI command appear in this font.

CLI commands

Elements in square brackets are optional.[ ]

Required alternative keywords are grouped in braces and separated by verticalbars.

{x | y | z}

Optional alternative keywords are grouped in brackets and separated by verticalbars.

[x | y | z]

Cisco FXOS MIB Reference Guide v

IndicationText Type

A nonquoted set of characters. Do not use quotation marks around the string orthe string will include the quotation marks.

string

Nonprinting characters such as passwords are in angle brackets.< >

Default responses to system prompts are in square brackets.[ ]

An exclamation point (!) or a pound sign (#) at the beginning of a line of codeindicates a comment line.

!, #

Means reader take note. Notes contain helpful suggestions or references to material not covered in thedocument.

Note

Means the following information will help you solve a problem. The tips information might not betroubleshooting or even an action, but could be useful information, similar to a Timesaver.

Tip

Means the described action saves time. You can save time by performing the action described in theparagraph.

Timesaver

Means reader be careful. In this situation, you might perform an action that could result in equipmentdamage or loss of data.

Caution

IMPORTANT SAFETY INSTRUCTIONS

This warning symbol means danger. You are in a situation that could cause bodily injury. Before youwork on any equipment, be aware of the hazards involved with electrical circuitry and be familiar withstandard practices for preventing accidents. Use the statement number provided at the end of each warningto locate its translation in the translated safety warnings that accompanied this device.

SAVE THESE INSTRUCTIONS

Warning

Related DocumentationFor more information, see Navigating the Cisco FXOS Documentation at www.cisco.com/c/en/us/td/docs/security/firepower/fxos/roadmap/fxos-roadmap.html.

Cisco FXOS MIB Reference Guidevi

About This GuideRelated Documentation

www.cisco.com/c/en/us/td/docs/security/firepower/fxos/roadmap/fxos-roadmap.html

www.cisco.com/c/en/us/td/docs/security/firepower/fxos/roadmap/fxos-roadmap.html

Obtaining Documentation and Submitting a Service RequestFor information on obtaining documentation, using the Cisco Bug Search Tool (BST), submitting a servicerequest, and gathering additional information, see What's New in Cisco Product Documentation.

To receive new and revised Cisco technical content directly to your desktop, you can subscribe to the What'sNew in Cisco Product Documentation RSS feed. RSS feeds are a free service.

Cisco FXOS MIB Reference Guide vii

About This GuideObtaining Documentation and Submitting a Service Request

http://www.cisco.com/c/en/us/td/docs/general/whatsnew/whatsnew.html

http://www.cisco.com/assets/cdc_content_elements/rss/whats_new/whatsnew_rss_feed.xml

http://www.cisco.com/assets/cdc_content_elements/rss/whats_new/whatsnew_rss_feed.xml

Cisco FXOS MIB Reference Guideviii

About This GuideObtaining Documentation and Submitting a Service Request

C H A P T E R 1About Cisco FXOS MIB Files

This chapter includes the following sections:

• Cisco FXOS MIB Files, page 1

• Downloading Cisco FXOS MIB Files from Cisco.com, page 2

• Cisco FXOS Faults, page 2

• Use Cases for Cisco FXOS MIBs, page 4

• Types of MIBs, page 7

• Cisco Extensions to the IF-MIB, page 7

Cisco FXOS MIB FilesFXOS MIB files are a set of objects that are private extensions to the IETF standard MIB II. MIB II isdocumented in RFC 1213,Management Information Base for NetworkManagement of TCP/IP-based Internets:MIB-II. Portions of MIB-II have been updated since RFC 1213. See the IETF website http://www.ietf.org forthe latest updates to this MIB.

If your NMS cannot get requested information from FXOS, then the MIB that allows that specific datacollection might be missing. Typically, if an NMS cannot retrieve a particular MIB variable, either the NMSdoes not recognize that MIB variable, or the agent does not support the MIB variable. If the NMS does notrecognize a specificMIB variable, youmight need to load theMIB into the NMS, usually with aMIB compiler.For example, you might need to load the Cisco FXOS private MIB or the supported RFC MIB into the NMSto execute the required data collection. If the agent does not support a specific MIB variable, you must findout what version of system software you are running. Different software releases support different MIBs.

Cisco and IETF MIBs are updated frequently. You should download and install the latest FXOS MIBsfrom Cisco.com whenever you upgrade the FXOS software. Unique versions of the FXOS MIBs aregenerated for each software release and are posted with the release.

Note

Cisco FXOS MIB Reference Guide 1

http://www.ietf.org

Downloading Cisco FXOS MIB Files from Cisco.comBefore You Begin

Cisco FXOS MIBs are generated for each software release and are posted with the release.

Procedure

Step 1 Open a browser and go to the following URL:https://software.cisco.com/download/navigator.html?mdfid=286291275&flowid=79503

Step 2 In the lower-right list, select your Firepower Security Appliance series: Firepower 9000 Series or Firepower4100 Series.The lower-right list changes to show the available models for the selected series.

Step 3 Select your Firepower Security Appliance model from the list.The Download Software page lists available categories of software for your security appliance.

Step 4 In the Select a Software Type list, select Firepower Extensible Operating System.Step 5 Select your FXOS version from the menu on the left and then clickDownload for theMIBS zip for Firepower

FX-OS image item.

Cisco FXOS FaultsA fault is a mutable object that is managed by the Firepower eXtensible Operating System. Each fault representsa failure or an alarm threshold that has been raised. During the life cycle of a fault, it can change from onestate or severity to another.

Each fault includes information about the operational state of the affected object at the time the fault wasraised. If the fault is transitional and the failure is resolved, then the object transitions to a functional state.

A fault remains in FXOS until the fault is cleared and deleted according to the settings in the fault collectionpolicy.

The following table lists the FXOS traps included in the CISCO-FIREPOWER-NOTIF-MIB.

Table 1: CISCO-FIREPOWER-NOTIF-MIB Traps

DescriptionTrap

This notification is generated by FXOS whenever afault is raised.

cfprFaultActiveNotif

The OID for this SNMP trap is.1.3.6.1.4.1.9.9.826.0.1.

This notification is generated by FXOS whenever afault is cleared.

cfprFaultClearNotif

The OID for this SNMP trap is.1.3.6.1.4.1.9.9.826.0.2.

Cisco FXOS MIB Reference Guide2

About Cisco FXOS MIB FilesDownloading Cisco FXOS MIB Files from Cisco.com

https://software.cisco.com/download/navigator.html?mdfid=286291275&flowid=79503

All FXOS faults are available with SNMP using the cfprFaultInstTable table and theCISCO-FIREPOWER-FAULT-MIB. The table contains one entry for every fault instance. Each entry hasvariables to indicate the nature of a problem, such as its severity and type. The same object is used to modelall FXOS fault types, including equipment problems, FSM failures, configuration or environmental issues,and connectivity issues. The cfprFaultInstTable table includes all active faults (those that have been raisedand need user attention), and all faults that have been cleared but not yet deleted because of the retentioninterval.

The cfprFaultInstTable table contains cfprFaultInstEntry objects that can be queried through the XML API.In Firepower Chassis Manager, faults are available from the Overview tab.

The following table describes the attributes exposed by the cfprFaultInstTable.

Table 2: cfprFaultInstEntry Attritubes

DescriptionAttribute

A unique integer that identifies the fault.Fault Instance ID (Table Index)

The distinguished name of the mutable object that has thefault.

Affected Object DN

The Object identifier (OID) of the mutable object that hasthe fault.

Affected Object OID

The time that the fault was created, depicted in UTC format.Creation Time

The time when any of the attributes were modified.Last Modification

A code that provides information specific to the nature ofthe fault.

Code

The fault type.Type

The probable cause of the fault.Cause

The severity of the fault. Fault severity transitionsthroughout the lifecyle of the fault, so several different faultseverities can be reported during the lifecyle of a fault. Theseinclude:

• Original severity reported when the fault was firstdetected

• Current severity reported for the fault

• Previous severity reported for the fault

• Highest severity reported for the fault

Severity

The number of times that a fault has occurred since it wascreated.

Occurrence


About Cisco FXOS MIB FilesCisco FXOS Faults

DescriptionAttribute

Ahuman readable string that contains all information relatedto the fault.

Description

FXOS sends a cfprFaultActiveNotif event notification whenever a fault is raised. There is one exception tothis rule: FXOS does not send event notifications for FSM faults. The trap variables indicate the nature of theproblem, including the fault type. FXOS sends a cfprFaultClearNotif event notification whenever a fault hasbeen cleared. A fault is cleared when the underlying issue has been resolved.

The cfprFaultActiveNotif and cfprFaultClearNotif traps are defined in the CISCO-FIREPOWER-NOTIFS-MIB.All faults can be polled using SNMP GET operations on the cfprFaultInstTable, which is defined in theCISCO-FIREPOWER-FAULT-MIB.

For more details about FXOS faults, see Cisco FXOS Faults and Error Messages.

Use Cases for Cisco FXOS MIBsCommon use cases for Cisco FXOS MIBs are described below.

Receiving Fault Event NotificationsIf you want to use SNMP traps for fault event notification in your NMS, you must first load the prerequisiteMIBs (see Prerequisite MIBs, on page 9), then load the MIBs listed below.

You should load the MIBs in the order listed to eliminate most of the load-order issues.Important

• CISCO-FIREPOWER-MIB.my

• CISCO-FIREPOWER-TC-MIB.my

• CISCO-FIREPOWER-FAULT-MIB.my

• CISCO-FIREPOWER-NOTIFS-MIB.my

The following table describes the traps included in the CISCO-FIREPOWER-NOTIFS-MIB.

Table 3: CISCO-FIREPOWER-NOTIFS MIB Traps

DescriptionTrap

This notification is generated by FXOS whenever afault is raised.

cfprFaultActiveNotif

The OID that corresponds to this SNMP trap is.1.3.6.1.4.1.9.9.826.0.1.


About Cisco FXOS MIB FilesUse Cases for Cisco FXOS MIBs

http://www.cisco.com/c/en/us/support/security/firepower-9000-series/products-system-message-guides-list.html

DescriptionTrap

This notification is generated by FXOS whenever afault is cleared.

cfprFaultClearNotif

The OID that corresponds to this SNMP trap is.1.3.6.1.4.1.9.9.826.0.2.

Gathering Inventory InformationFXOS MIBs can be used to gather information about the compute equipment in your Firepower 4100/9300chassis. Inventory information includes data such as security modules, serial numbers, DIMMs, and otherintelligence related to system equipment.

See Purpose of the Cisco FXOS MIBs, on page 13, to learn more about which MIBs you need to add to yourNMS to collect the inventory data that interests you.

Gathering StatisticsIf you want to use SNMP as a way to gather statistics, use the table below as a guide to which MIBs to loadand which tables in each MIB to query.

The table lists the statistics most commonly monitored in FXOS, but it does not contain an exhaustive listof all statistics that can be monitored. To gather statistics beyond those listed below, refer to Purpose ofthe Cisco FXOS MIBs, on page 13, review the content of the various packages, and download theadditional MIB files necessary to meet your specific needs.

Note

Table 4: MIBs to Use for Gathering Statistics

Statistics Table Name in SNMPMIB that Gathers the StatisticStatistics Type

cfprEtherPauseStatsTable—Packetpause stats

cfprEtherLossStatsTable—Packet lossstats

cfprEtherErrStatsTable—Packet errorstats

cfprEtherTxStatsTable—Packettransmission stats

cfprEtherRxStatsTable—Packetreception stats

CISCO-FIREPOWER-ETHER-MIB

.1.3.6.1.4.1.9.9.826.1.21 is the parentOID where the key statistics reside.

Ethernet


About Cisco FXOS MIB FilesGathering Inventory Information

Statistics Table Name in SNMPMIB that Gathers the StatisticStatistics Type

cfprAdaptorEthPortBySizeLargeStatsTable

cfprAdaptorEthPortBySizeSmallStatsTable

cfprAdaptorEthPortStatsTable

cfprAdaptorEthPortOutsizedStatsTable

cfprAdaptorEthPortMcastStatsTable

CISCO-FIREPOWER-ADAPTOR-MIB


Adapter

cfprComputeMbPowerStatsTable—Providesall motherboard power statistics for everysecurity module.

cfprComputeMbTempStatsTable—Providesall motherboard temperature statistics forevery security module.

CISCO-FIREPOWER-COMPUTE-MIB


Blade and rack level

cfprProcessorEnvStatsTable—Providesall CPU power and temperature statisticsfor every CPU socket.

CISCO-FIREPOWER-PROCESSOR-MIB


Processor

cfprEquipmentFanStatsTable—Providesall statistics for every physical fan.

cfprEquipmentFanModuleStatsTable—Providesall fan module temperature statistics forevery fan module.

cfprEquipmentChassisStatsTable—Providesall chassis level temperature statistics.

cfprEquipmentPsuStatsTable—Providesall chassis level power and temperaturestatistics for every power supply.

cfprEquipmentIOCardStatsTable—Providesall chassis level power and temperaturestatistics for the fabric interconnect.

CISCO-FIREPOWER-EQUIPMENT-MIB


Equipment

cfprMemoryUnitEnvStatsTable—Providesall memory DIMM temperature statisticsfor every memory module.

CISCO-FIREPOWER-MEMORY-MIB


Memory statistics

cfprSwEnvStatsTable—Providesconfiguration and status information onthe switch configuration.

CISCO-FIREPOWER-SW-MIB


Switching statistics

cfprSmMonitorTable—Provides disk,CPU, and memory utilization statisticsfor each security module.

CISCO-FIREPOWER-SM-MIB


Security Modulestatistics


About Cisco FXOS MIB FilesGathering Statistics

Types of MIBsFirepower Chassis Management is based on the XML over HTTP model, which provides a rich data modelto configure andmonitor the system. This model includes polices, service profiles, configuration andmonitoringdata, and statistics.

To simplify the integration of FXOS with SNMP-based NMS, FXOS exposes the model through SNMP. Theentire FXOS data model is exposed through the read-only Cisco FXOSMIBs. All objects that can be retrievedthrough the FXOS XML API can also be retrieved through FXOS MIBs.

Each release maintains complete coverage of the XML API model through private MIBs.Note

Cisco Extensions to the IF-MIBThe IF-MIB supports basic management status and control of interfaces and sublayers within a network switch.Multiple standard and Cisco-specific MIBs use ifIndex from the IF-MIB to extend management for specificinterface types. Cisco MIBs also enhance the two interface notifications, linkUp and linkDown, from theIF-MIB to provide a clearer indication of the reason for these notifications. Cisco MIBs add two varbinds tolinkUp and linkDown as shown in the following table.

Table 5: Varbinds Added to IF-MIB Notifications

Varbinds AddedNotification

ifDescrlinkUp

ifDescrlinkDown

See the Cisco FXOS Firepower Chassis Manager Configuration Guide for details about enabling linknotifications that use these additional varbinds.


About Cisco FXOS MIB FilesTypes of MIBs

http://www.cisco.com/c/en/us/support/security/firepower-9000-series/products-installation-and-configuration-guides-list.html


About Cisco FXOS MIB FilesCisco Extensions to the IF-MIB

C H A P T E R 2Loading Cisco FXOS MIBs Into a NetworkManagement System

This chapter includes the following sections:

• Load Cisco FXOS MIBs, page 9

• Prerequisite MIBs, page 9

• MIB Loading Order , page 10

Load Cisco FXOS MIBsBefore loading FXOS MIBs into an NMS, you must first load the prerequisite MIBs into the NMS. Thisenables you to receive the FXOS Fault Traps in the NMS.

Prerequisite MIBsThe MIBs in this section are required for all use cases and need to be loaded before other Cisco MIBs areloaded.


The following is a list of MIBs from which many other MIBs import definitions:

• SNMPv2-SMI.my

• SNMPv2-TC.my

• SNMP-FRAMEWORK-MIB.my

• RFC1213-MIB.my

• IF-MIB.my

• CISCO-SMI.my


• ENTITY-MIB.my

• INET-ADDRESS-MIB.my

• CISCO-TC.my

The CISCO-SMI MIB defines the iso.org.dod.internet.private.enterprise.cisco.ciscoMgmt object(1.3.6.1.4.9.9), which is the parent node of all Cisco FXOSMIBs. SeveralMIBs, including the CISCO-SMIMIB, must be loaded before other Cisco FXOSMIBs. Attempting to load other Cisco FXOSMIBs beforethe CISCO-SMI MIB generally results in a MIB compiler error stating that a MIB node has no parentnode.

Note

MIB Loading OrderMost of the MIB use definitions are defined in other MIBs. These definitions are listed in the IMPORTSsection near the top of the MIB.

For example, if MIB B imports a definition from MIB A, some MIB compilers require you to load MIB Abefore loading MIB B. If you get the MIB loading order wrong, you might get an error message that a MIBis undefined or not listed in IMPORTS. If you receive an error message, look at the loading order of MIBsdefined in the IMPORTS section. Ensure that you have the appropriate load order.

Order for Loading MIBs in Cisco FXOSFXOS supports networkMIBs and a series ofMIBs to access all of the objects stored in the FXOSManagementInformation Tree.

All managed objects that can be accessed through the FXOSXMLAPI can also be retrieved through read-onlySNMP GET operations.


If you want to receive Cisco FXOS traps in your NMS, first load the prerequisite MIBs (see PrerequisiteMIBs, on page 9), then load the following Cisco MIBs:

• CISCO-FIREPOWER-MIB.my

• CISCO-FIREPOWER-TC-MIB.my

• CISCO-FIREPOWER-FAULT-MIB.my

• CISCO-FIREPOWER-NOTIFS-MIB.my

If you want to retrieve FXOS managed objects using read-only SNMP GET operations, you need to load alladditional Cisco FXOS MIBs. The additional FXOS MIBs are generally used to retrieve inventory andconfiguration information using SNMP GET operations. To learn more about all of the FXOS MIBs, seePurpose of the Cisco FXOS MIBs, on page 13.


Loading Cisco FXOS MIBs Into a Network Management SystemMIB Loading Order

In environments running multiple versions of FXOS, load the latest FXOSMIBs in the NMS, because allFXOS MIBs are developed to be backward-compatible with previous versions.

Note


Loading Cisco FXOS MIBs Into a Network Management SystemOrder for Loading MIBs in Cisco FXOS


Loading Cisco FXOS MIBs Into a Network Management SystemOrder for Loading MIBs in Cisco FXOS

C H A P T E R 3Purpose of the Cisco FXOS MIBs

This chapter describes the purpose of the Cisco FXOS MIBs.

• Purpose of the Cisco FXOS MIBs, page 13

Purpose of the Cisco FXOS MIBsThe following table describes the purpose of each Cisco FXOS MIB.

Table 6: MIB Purposes

PurposeMIB

This package contains data about configuring and monitoringthe AAA operation within FXOS.

It includes the following information:

• Identities of external AAA servers such as LDAP,TACACS, and RADIUS. These servers are used asauthoritative repositories to authenticate FXOS users.

• Local users

• User roles and locales

• Mappings between users, roles, and locales

• Prelogin banner configuration

• Audit logs

• AAA policies, such as password policies

CISCO-FIREPOWER-AAA-MIB


PurposeMIB

This package contains configuration and statistics informationthat reflect the state of physical network adapters within anFirepower 4100/9300 chassis.


• Ethernet and Ethernet port channel Interfaces

• Network statistics per adapter

CISCO-FIREPOWER-ADAPTOR-MIB

This package contains configuration objects for BIOS settings.


• Boot order parameters for the Firepower 4100/9300chassis

• Policy-based BIOS parameters that can be applied toservice profiles

CISCO-FIREPOWER-BIOS-MIB

This package reports Power-On Self Test (POST) statistics.CISCO-FIREPOWER-BMC-MIB

This package contains configuration objects for the Call Homefeature.


• Contact information

• Customer ID and contract ID

• Email address

• SMTP servers

• Call Home profiles and policies

• System inventory

CISCO-FIREPOWER-CALLHOME-MIB

This package contains configuration objects for the capabilitycatalog. This catalog contains the characteristics of variousphysical components in the Firepower 4100/9300 chassis,including fabric interconnect (supervisor), network adapters,security modules, chassis, network modules, CPUs, memoryunits, fan modules, local disks, power supply modules, andstorage controllers.

FXOS is designed to support new hardware by uploading anew capability catalog that includes the following information:

• Capability catalog objects

• Objects to manage the capability catalog, such asuploading a new catalog to an existing system

CISCO-FIREPOWER-CAPABILITY-MIB


Purpose of the Cisco FXOS MIBsPurpose of the Cisco FXOS MIBs

PurposeMIB

This package contains configuration objects that control globalconfigurations, such as DNS, HTTP, and SNMP.


• Date and time management

• DNS management

• Configuration of REST API over HTTP and HTTPS

• NTP management

• Shell access configuration

• SNMP management

• Telnet management

CISCO-FIREPOWER-COMM-MIB

This package contains configuration, inventory, and statisticsobjects for computing resources.


• Inventory objects for security modules and components

• Chassis connectivity policies

• Security module discovery and autoconfigurationpolicies

• Pool objects

CISCO-FIREPOWER-COMPUTE-MIB

This package contains operational information about virtualinterfaces and circuits.


• Virtual interfaces configured for each security modulenetwork adapter

• Virtual circuits configured for each security moduleadapter, chassis, or network module

CISCO-FIREPOWER-DCX-MIB

This package contains DHCP subsystem details.

It includes information on DHCP leases obtained by theFirepower 4100/9300 chassis subcomponents.

CISCO-FIREPOWER-DHCP-MIB

This package contains diagnostics information aboutFirepower 4100/9300 chassis subcomponents.

• Diagnostic policies

• Network test objects

• Diagnostic results

CISCO-FIREPOWER-DIAG-MIB



PurposeMIB

This package contains details about the Firepower 4100/9300chassis and security module storage media.

CISCO-FIREPOWER-DOMAIN-MIB

This package contains details about network Quality ofService (QoS).


• Egress QoS policy

• Internal object to manage the network QoS

CISCO-FIREPOWER-EPQOS-MIB

This package contains details about the Firepower 4100/9300chassis inventory. Objects in this package are defined tomodelthe physical components.


• Network adapters

• Beacon LEDs

• Board controllers

• Fabric Interconnect fixed and extension modules

• Firepower 4100/9300 chassis

• Fan

• SSD

• IO card

• Memory unit

• Power supply module

CISCO-FIREPOWER-EQUIPMENT-MIB

This package contains details about the Ethernet portinventory and statistics about the Ethernet ports.


• Objects that represent inventoried Ethernet ports andport channels

• Statistics about Ethernet ports

CISCO-FIREPOWER-ETHER-MIB



PurposeMIB

This package contains details about the event log. An eventis any significant occurrence in FXOS that may require usersto be notified. Events can help users identify and diagnosethe source of problems.


• Object to model the event log

• Object to model an entry in the event log

• Event log policy, which specifies the number of eventsthat need to be maintained in the event log and the eventretention policy.

CISCO-FIREPOWER-EVENT-MIB

This package contains details about management interfaces.


• Management interfaces

• Gateway ping policy

• Interface monitoring policy

• ARP targets

CISCO-FIREPOWER-EXTMGMT-MIB

This package contains details about external clients that areconnected to Firepower Chassis Manager or the FXOS CLI.

CISCO-FIREPOWER-EXTPOL-MIB

This package contains information about certificate andprivate key stores.

CISCO-FIREPOWER-EXTVMM-MIB

This package contains information about the configurationand policies on the Firepower 4100/9300 chassis fabric(supervisor). The Firepower 4100/9300 chassis fabric definesEthernet, storage, port configuration, and VLANs.


• VLANs

• Required Ethernet configuration for uplink ports andport channels

• VLAN port membership

• VCON policies

CISCO-FIREPOWER-FABRIC-MIB



PurposeMIB

This package provides information about FXOS faults. Afault is an abnormal condition or defect at the component,equipment, or subsystem level, which may lead to a failureas defined in ISO/CD 10303-226.

Each managed object in the management tree may have oneor more faults that indicate a particular problem with thisobject.


• Fault objects

• Fault policy, including fault retention, flapping, andclear action

CISCO-FIREPOWER-FAULT-MIB

This package contains details about the firmwaremanagementof the Firepower 4100/9300 chassis components. This includesobjects to download firmware packages, manage firmwareimages and firmware packages, firmware packs, and to controlfirmware upgrades or downgrades.


• Downloader object to download firmware packages

• Objects to model firmware and firmware packages

• Firmware packs

• Control of firmware upgrades and downgrades

CISCO-FIREPOWER-FIRMWARE-MIB

This package contains the network flow control policy details.CISCO-FIREPOWER-FLOWCTRL-MIB

This package contains details about pools of IP addresses thatare reserved for internal use.

CISCO-FIREPOWER-IPPOOL-MIB

This package contains details about the Link Layer DiscoveryProtocol (LLDP) object.

It includes information on the objects that provide inventoryinformation about peer links through LLDP.

CISCO-FIREPOWER-LLDP-MIB

This package contains the top-level objects for FXOS serviceprofiles.


• FXOS service profile

• Binding between a service profile and a securitymodule/engine

• Requirements that a physical security module mustsatisfy to be associated with a service profile

CISCO-FIREPOWER-LS-MIB



PurposeMIB

This package contains information about the boot objects forFXOS service profiles.

It contains the following information:

• Service profile boot policy

• Boot images

• Virtual Media

CISCO-FIREPOWER-LSBOOT-MIB

This package contains details about FXOS service profilemaintenance policy.

The FXOS service profile maintenance policy specifies whatyou can do when a requested change requires a reboot.

CISCO-FIREPOWER-LSMAINT-MIB

This package contains details about pools ofMAC addresses.Pools of MAC addresses are used to assign virtual MACaddresses to service profile vNICs.


• Pools of MAC addresses

• MAC addresses that can be assigned to service profilevNICs

CISCO-FIREPOWER-MACPOOL-MIB

This package contains information about the relationshipsbetween the FXOS Managed Objects.


• The cfprMappingsMoContainmentTable providescontainment information to navigate from aparent-managed object to the child-managed objects.

• The cfprMappingsMoInverseContainmentTable providesinformation to navigate from a child-managed object tothe parent-managed object.

• The cfprMappingsDnToOidTable provides a mappingfrom the Managed Object Distinguised Name to theSNMP OID.

CISCO-FIREPOWER-MAPPINGS-MIB



PurposeMIB

This package contains details about memory units that areinstalled in security modules.


• Memory arrays

• Memory units

• Memory qualification

• Statistics

CISCO-FIREPOWER-MEMORY-MIB

This package contains FXOS provisioning details.


• Objects to perform backups and imports of FirepowerChassis Manager configuration

• Access policies

• Process Monitor entries

CISCO-FIREPOWER-MGMT-MIB

This package defines the top-level FXOS Managed Object.CISCO-FIREPOWER-MIB

This package provides information about Firepower4100/9300 chassis fabric interconnect (supervisor).It includes the following information:

• Objects to specify the IP addresses of the Firepower4100/9300 chassis fabric interconnect

• Network statistics

CISCO-FIREPOWER-NETWORK-MIB

This MIB contains the definitions of the SNMP notificationsthat are supported by FXOS.

The following notifications are defined:

• FXOS fault raised

• FXOS fault cleared

CISCO-FIREPOWER-NOTIFS-MIB

This package provides information about network controlpolicies.

CISCO-FIREPOWER-NWCTRL-MIB

This package provides information about the organizationalhierarchy in the FXOS Management Information Tree.

CISCO-FIREPOWER-ORG-MIB



PurposeMIB

This package contains guest OS agent details.


• Guest OS instance

• Guest OS agent

CISCO-FIREPOWER-OS-MIB

This package contains details about inventory PCI cards.


• Inventory PCI card

• Equipment slot

CISCO-FIREPOWER-PCI-MIB

This package contains details about Public Key Infrastructure(PKI) objects.


• Certificate requests

• Key ring

CISCO-FIREPOWER-PKI-MIB

This package provides information about physical ports onthe fabric interconnect (supervisor) and the port groups onthe fabric interconnect.


• Port groups

• Abstract objects for physical ports on the fabricinterconnect (supervisor)

• Port trust mode

CISCO-FIREPOWER-PORT-MIB

This package contains details about chassis power cappingpolicies and statistics.


• Chassis power capping

• Chassis power statistics

CISCO-FIREPOWER-POWER-MIB

This package contains details about the internal componentsof FXOS.


• Statistics about Cisco FXOS transactions

• Information about Cisco FXOS processes

CISCO-FIREPOWER-PROC-MIB



PurposeMIB

This package provides information about Central ProcessingUnits that can be installed on the Firepower 4100/9300chassis.


• CPU characteristics

• CPU statistics

CISCO-FIREPOWER-PROCESSOR-MIB

This package provides information about QoS classes.CISCO-FIREPOWER-QOSCLASS-MIB

This package contains monitoring data for the securitymodules in the system.


• Application software version

• Memory usage

• Disk usage

• CPU utilization

CISCO-FIREPOWER-SM-MIB

This package contains details about statistics.


• Objects to specify statistics collection

• Objects to specify threshold policies

CISCO-FIREPOWER-STATS-MIB

This package contains details about storage elements that canbe installed or accessed from a Firepower 4100/9300 chassis.

It includes following information:

• Local disks

• Storage controllers

• Storage enclosures

CISCO-FIREPOWER-STORAGE-MIB



PurposeMIB

This package contains details about how the system shouldbe configured. Objects in this package are created implicitlyby the system based on user-specified data from the "fabric"package. For example, the "fabric" package may specifyhigh-level fabric policies, and the "sw" package may specifyindividual VLAN membership for each physical port.


• VLANs

• VLAN membership

• Ethernet ports

CISCO-FIREPOWER-SW-MIB

This package provides information to help troubleshootFXOS.


• Objects for accessing and exporting core files

• Backup behavior

• Log policies

• Tech support file repository

CISCO-FIREPOWER-SYSDEBUG-MIB

This package provides information to manage the import orexport of system files.

It includes abstract classes that support the import and exportof FXOS files.

CISCO-FIREPOWER-SYSFILE-MIB

This MIB contains all the SNMP textual conventions that areused in other FXOS MIBs.

CISCO-FIREPOWER-TC-MIB

This package contains the definition of the root object in theFXOS management information tree.

CISCO-FIREPOWER-TOP-MIB

This package contains information to manage scheduled andtriggered activities.

It includes the following objects:

• Objects to schedule activities

• Objects to monitor activities that have been scheduled

• Objects to track activities that require useracknowledgment

CISCO-FIREPOWER-TRIG-MIB



PurposeMIB

This package contains details about the pools of UUIDidentifiers. Pools of UUID identifiers are used to assign virtualUUIDs to service profiles.


• Pools of UUID identifiers

• Block of UUID identifiers

• UUID identifiers, which can be assigned to serviceprofiles

CISCO-FIREPOWER-UUIDPOOL-MIB

This package reports the FXOS software version.CISCO-FIREPOWER-VERSION-MIB

This package contains details specific to the inventory andmonitoring of virtual machines. FXOS keeps track of virtualmachines if the VM vNIC is provided.

CISCO-FIREPOWER-VM-MIB

This package contains details about Firepower 4100/9300chassis network adapters, including Ethernet vNICs.


• Objects to model a Service Profile Ethernet vNIC

• Policies that control the behavior of vNICs

• Policies for dynamic vNICSs

• Boot targets

CISCO-FIREPOWER-VNIC-MIB



Cisco FXOS MIB Reference Guide - Cisco - Global Home … · Cisco FXOS MIB Reference Guide 3 About...

Documents

Transcript of Cisco FXOS MIB Reference Guide - Cisco - Global Home … · Cisco FXOS MIB Reference Guide 3 About...