XF-SOFTWARE-MIB

MIB Reference — IPNetwork Monitor

All MIBsXF-SOFTWARE-MIB

Organization: Ericsson-Norway

Last Updated: 2008-03-06

Category: Ericsson Radio Link

Description:

Manages Ericsson Norway XF device software inventory, version tracking, and upgrade status.

Imported Objects

From ENTITY-MIB

entPhysicalIndexOBJECT-TYPE

From SNMP-FRAMEWORK-MIB

SnmpAdminString

From SNMPv2-CONF

MODULE-COMPLIANCE
OBJECT-GROUP

From SNMPv2-SMI

Integer32
MODULE-IDENTITY
OBJECT-IDENTITY
OBJECT-TYPE

From SNMPv2-TC

DateAndTime
TEXTUAL-CONVENTION

From XF-TOP-MIB

XfProductRevision
XfProductnumber
xfPlatformOBJECT-IDENTITY

What Is XF-SOFTWARE-MIB?

XF-SOFTWARE-MIB is an Ericsson Norway enterprise MIB dedicated to software inventory management on XF-branded devices, part of Ericsson's access/transport product line. It exposes objects describing installed software components, their version identifiers, and upgrade/activation status rather than interface or environmental data. This makes it a software-status-focused MIB: administrators use it to confirm which firmware/software image is currently active on a device, track pending or in-progress upgrades, and detect version mismatches across a fleet of XF units. As a vendor-specific software-inventory MIB it typically works alongside Ericsson's broader XF hardware and system MIBs rather than any IETF standard. It is deployed in telecom access/transport networks running Ericsson XF equipment where firmware version compliance and upgrade tracking are operational requirements. Engineers can download the XF-SOFTWARE-MIB file directly to load it into their MIB browser.

IPNetwork Monitor allows you to monitor SNMP objects defined in XF-SOFTWARE-MIB. Use the built-in SNMP Monitoring Browser to explore available variables, view their current values and descriptions, and select the objects you want to monitor. You can then create SNMP monitors, configure thresholds, and receive alerts when monitored values change.

What Can Be Monitored

  • active software/firmware version
  • software upgrade status
  • installed software component inventory
  • version compliance across devices

Supported Devices

  • Ericsson XF access/transport equipment

Monitoring Examples

An operator would poll the software inventory table to read the currently active version identifier for a given XF unit and compare it against the fleet-wide target version to flag units still pending an upgrade. If the reported upgrade status stays in a pending or in-progress state longer than expected, that signals a stalled or failed firmware upgrade needing investigation. Because the module description confirms this MIB exists specifically to support software inventory information, its primary value is confirming version compliance rather than performance monitoring.

OIDs
OID symbolicOID numericTypeAccessDescription
xfSoftwareMIB1.3.6.1.4.1.193.81.2.7This MIB contains the objects which support software inventory information.
xfSwObjects1.3.6.1.4.1.193.81.2.7.1
xfSwLoadModuleTable1.3.6.1.4.1.193.81.2.7.1.1not-accessibleThis table contains information about the load modules that are part of the system releases as described by the xfSwReleaseTable.
xfSwLoadModuleEntry1.3.6.1.4.1.193.81.2.7.1.1.1not-accessibleInformation about 1 software load module.
XFS xfSwRelease1.3.6.1.4.1.193.81.2.7.1.1.1.1XfSwReleaseread-onlyThere are two software releases present on the node: - an active release, normally the most recent release and the one that is running - a passive release, that is the previous release or the one that is currently being download to upgrade the active release. xfSwRelease is an index into the active or passive release. xfSwActiveRelease indicates which release is active.
I32 xfSwLoadModuleIndex1.3.6.1.4.1.193.81.2.7.1.1.1.2Integer32read-onlyUnique value within one release for each load module.
XFP xfSwLoadModuleProductNumber1.3.6.1.4.1.193.81.2.7.1.1.1.3XfProductnumberread-onlyProduct number of the load module. Normally something like 'CAXR102_012/1'.
XFP xfSwLoadModuleRevision1.3.6.1.4.1.193.81.2.7.1.1.1.4XfProductRevisionread-onlyRevision of the load module. Normally something like 'R1A'.
INT xfSwLoadModuleOperStatus1.3.6.1.4.1.193.81.2.7.1.1.1.5INTEGERread-onlyIndicates the status of the software upgrade process for this load module. passive(1) the load module is not involved in a upgrade process and is not active. I.e.it is part of the previous software release. upgradeStarted(2) a load module will have this status directly after the SBDF info for this module is loaded and the xfSwLoadModuleAdminStatus of the release was set to upgradeStarted. upgradeFinished(3) indicates that this load modules has been retrieved and burned into the flash memories. This is the state of load modules that are part of an active release. upgradeFailed(4) upgraded has failed for a reason, e.g. file transfer checksum was wrong, see xfSwLoadModuleFailure. upgradeAborted(5) when the manager has aborted the upgrade of the complete release whilst this load module wasn't upgradedFinished yet this will be its status.
INT xfSwLoadModuleFailure1.3.6.1.4.1.193.81.2.7.1.1.1.6INTEGERread-onlyThe objects specifies the cause of a software upgrade failure for this load module.
I32 xfSwLoadModuleProgress1.3.6.1.4.1.193.81.2.7.1.1.1.8Integer32read-onlyThis object indicates the progress in downloading the respective load module when part of an upgrade of an NE to a software baseline.
STR xfSwLoadModuleDescription1.3.6.1.4.1.193.81.2.7.1.1.1.9SnmpAdminStringread-onlyThis object indicates a textual description of the load module, indicating PIU type as stated by the entPhysicalDescription MO.
xfSwReleaseTable1.3.6.1.4.1.193.81.2.7.1.2not-accessibleThis contains the information on the active and passive software releases.
xfSwReleaseEntry1.3.6.1.4.1.193.81.2.7.1.2.1not-accessibleInformation about a software release. There are always only two releases. For the active release write is possible but will have no impact and will result in a inconsistentValue error response.
XFS xfSwReleaseIndex1.3.6.1.4.1.193.81.2.7.1.2.1.1XfSwReleaseread-onlyIndicates the Release the info for which this row is applicable.
XFP xfSwReleaseProductNumber1.3.6.1.4.1.193.81.2.7.1.2.1.2XfProductnumberread-writeProduct number of the installed software package in this release. Normally something like 'CAXR102 012/1'. For the active release this is a read-only object.
XFP xfSwReleaseRevision1.3.6.1.4.1.193.81.2.7.1.2.1.3XfProductRevisionread-writeRevision of the installed software package in this Release. Normally something like 'R1A'. For the active release this is a read-only object.
INT xfSwReleaseAdminStatus1.3.6.1.4.1.193.81.2.7.1.2.1.4INTEGERread-writeIndicates the desired status for this release. To start a software upgrade the manager has to set xfSwReleaseProductNumber and xfSwReleaseRevision. After that it will set this object to upgradeStarted. Which will lead to downloading the SBDF-file from the FTP Server. For the active release this is a read-only object.
INT xfSwReleaseOperStatus1.3.6.1.4.1.193.81.2.7.1.2.1.5INTEGERread-onlyIndicates the status of this release. passive(1) release not involved in upgrade and currently not running. upgradeStarted(2) the release is in the process of being upgraded upgradeFinished(3) All load modules of the release are downloaded and burned in the respective flash memories. testing(4) This release is running as test and not committed yet. upgradeFailed(5) The upgrade to this release failed, e.g. due to FTP server failure. upgradeAborted(6) The manager has order to abort the upgrade to this release. running(7) This is the release that is running now and all new boards should upgrade to. testingFromManual(8) Same as value testing(4) but indicating that this a test phase after a SBL from Manual mode. As such a fall-back will result in manual mode, i.e. no SBL. The 50 series errors are reported by the FTP client on the node. errorInternalError(50) An internal error detected before FTP operation. errorFileStorage(51) Error when erasing flash to store the downloaded file at the node. ftpPingFailed(52) FTP ping failed. ftpNoAccess(53) Not able to send the FTP commands. ftpConnectionDetailsMissing(54) FTP connection details are missing. ftpConnectionDetailsInvalid(55) FTP connection details are invalid. ftpConnectionTimeout(56) FTP connection timeout is detected. ftpNoSuchRemoteFile(57) No such remote file exists. ftpNoSuchRemoteDir(58) No such remote directory exists. The 400 series errors occur when the command was not accepted and the requested action did not take place, but the error condition is temporary and the action may be requested again. ftpServiceNotAvailable(421) Service not available, closing control connection. This may be a reply to any command if the service knows it must shut down. Possible causes are transfer timeouts and/or FTP server resets. ftpUnableToOpenDataConnection(425) Can't open data connection. Try changing from PASV to PORT mode. ftpConnectionClosed(426) Connection closed and file transfer is aborted. Possible causes are out of local diskspace and loss of connection. ftpFileBusy(450) Requested file action not taken. File unavailable (e.g file busy). ftpLocalError(451) Requested action aborted due to local error in processing. ftpInsufficienStorageSpace(452) Requested action not taken due to insufficient storage space on the server. The 500 series errors occur when the command was not accepted and the requested action did not take place. ftpSyntaxError(501) FTP Syntax error in parameters or arguments. ftpCommandNotImplemented(502) FTP Command not implemented. ftpBadSequenceCommands(503) Bad sequence of the FTP commands. ftpParameterNotImplemented(504) FTP command not implemented for that parameter. ftpNotLoggedIn(530) Not logged in. Your username and/or password is being rejected, contact the server adminstrator. ftpNeedAccount(532) Need account for storing files. ftpFileUnavailable(550) Requested action not taken. File unavailable (e.g.file not found, no access). Contact the server adminstrator. ftpExceededStorageAllocation(552) Requested file action aborted.Exceeded storage allocation (for current directory or data set). Contact the server adminstrator. ftpFileNameNotAllowed(553) Requested action not taken. File name not allowed. Try changing the file name or getting rid of spaces in the file name.
INT xfSwReleaseSBLType1.3.6.1.4.1.193.81.2.7.1.2.1.6INTEGERread-onlyThis object indicates whether the SBL information in the SBDF is generated by Ericsson or by an operator. This is based on a check of the SBDF. Of course this will only be a reliable object when the software can distinguish between Ericsson and operator defined SBDFs, i.e. upgrading from R2A.
XFS xfSwActiveRelease1.3.6.1.4.1.193.81.2.7.1.3XfSwReleaseread-onlyIndicates which of the two Releases is active at the moment, i.e. active is the software actually running.
DAT xfSwBootTime1.3.6.1.4.1.193.81.2.7.1.4DateAndTimeread-writeIndicates when the XF NE will warm restart to test the new software release. If all fields have value 0 an immediate boot will be performed.
INT xfSwCommitType1.3.6.1.4.1.193.81.2.7.1.5INTEGERread-writeIn case of a scheduled restart, i.e. valid date and time in xfSwBootTime, two different commit procedures can be followed: operatorCommit(1) The manager commits the software release under test by setting the xfSwRelease- AdminState to activeAndRunning. nodeCommit(2) The release under test is accepted when the node is able to establish contact through the DCN with an external IP-address. Default values is operatorCommit(1).
xfSwBoardTable1.3.6.1.4.1.193.81.2.7.1.6not-accessibleThis table holds the information about software present on the boards in the XF-NE. Boards without software will not be in this table.
xfSwBoardEntry1.3.6.1.4.1.193.81.2.7.1.6.1not-accessibleEntry in the table.
I32 xfSwBoardLoadModuleIndex1.3.6.1.4.1.193.81.2.7.1.6.1.1Integer32read-onlyIndex to the load module on the board. A board may contain more than one load module.
OID xfSwBoardLoadModuleType1.3.6.1.4.1.193.81.2.7.1.6.1.2OBJECT IDENTIFIERread-onlyThis object indicates of what type the software is, like DP (Device Processor) or FPGA (Field Programmable Gate Array) or another type. New type can be defined by defining a new OID in a other MIB.
XFP xfSwBoardProductNumber1.3.6.1.4.1.193.81.2.7.1.6.1.3XfProductnumberread-onlyThis is a string indicating the product number of the software in the active flash memory.
XFP xfSwBoardRevision1.3.6.1.4.1.193.81.2.7.1.6.1.4XfProductRevisionread-onlyThis is a string indicating the revision of the software in the active flash memory.
INT xfSwBoardStatus1.3.6.1.4.1.193.81.2.7.1.6.1.5INTEGERread-onlyIndicates the status of the software on the board: Unknown(1) The status of the software is unknown for example at startup. Active(2) Software on the board is OK and running Upgrading(3) Software is in the process of being upgraded WrongSoftware(4) Wrong software on the board and for some reason not being upgraded yet. MinSoftware revision(5) The board was tried to downgrade to a software revision that is not compatible with the hardware. The xfSwBoardStatus is only of use in case version control is enabled. If version control is not enabled the unit will always runs its software.
I32 xfSwBoardSuProgress1.3.6.1.4.1.193.81.2.7.1.6.1.6Integer32read-onlyThis object indicates the progress of the software upgrade process for each individual PIU. This indicates both flash erasing and programming. This object indicates this for both upgrade to a baseline as well as for inserted PIUs. In case the software upgrade of the board takes less than 10 seconds this objects will directly go to 100%.
XFP xfSwBoardMinProductNumber1.3.6.1.4.1.193.81.2.7.1.6.1.7XfProductnumberread-onlyThis is a string indicating the product number of the minimally acceptable software revision for this unit type/variant.
XFP xfSwBoardMinRevision1.3.6.1.4.1.193.81.2.7.1.6.1.8XfProductRevisionread-onlyThis is a string indicating the revision of the minimally acceptable software revision for this unit type/variant.
INT xfSwBoardTrafficDisturbance1.3.6.1.4.1.193.81.2.7.1.6.1.9INTEGERread-onlyThis object indicates that software upgrade of this load module on this unit might lead to traffic disturbance. This could for example happen in the exceptional case where the load module includes FPGA code for the traffic system.
xfSwNpuObjects1.3.6.1.4.1.193.81.2.7.1.7
XFP xfSwNpuPassiveProductNumber1.3.6.1.4.1.193.81.2.7.1.7.1XfProductnumberread-onlyProduct number of NPU software in passive bank.
XFP xfSwNpuPassiveRevision1.3.6.1.4.1.193.81.2.7.1.7.2XfProductRevisionread-onlyRevision of software in passive bank on NPU.
INT xfSwNpuPassiveSwitch1.3.6.1.4.1.193.81.2.7.1.7.3INTEGERread-writeThis object can be used to switch the NPU passive software. As a safety precaution this object is only available when the node is in installation mode or when the node is accessed through the USB port (if present). A warm restart is required to activate the fallback. A switch leads to all xfSwUpgradePreferences being set to their default values, i.e. no version control.
xfSwLoadModuleTypes1.3.6.1.4.1.193.81.2.7.1.8
xfDeviceProcessorSoftware1.3.6.1.4.1.193.81.2.7.1.8.1Used for DP software load modules.
xfPciFpgaCode1.3.6.1.4.1.193.81.2.7.1.8.2Used for PCI FPGA load modules.
xfSwUpgradePreferences1.3.6.1.4.1.193.81.2.7.1.9
XFS xfSwVersionControl1.3.6.1.4.1.193.81.2.7.1.9.1XfSwEnableDisableread-writeUsed to enable/disable version control. Default: disable.
XFS xfSwAutoUpgrade1.3.6.1.4.1.193.81.2.7.1.9.2XfSwEnableDisableread-writeUsed to enable/disable automatic software upgrade. In case xfSwVersionControl is enabled a change of the value will cause all PIUs to be checked again. Default: disable.
XFS xfSwAutoDowngrade1.3.6.1.4.1.193.81.2.7.1.9.3XfSwEnableDisableread-writeUsed to enable/disable automatic software downgrade. In case xfSwVersionControl is enabled a change of the value will cause all PIUs to be checked again. Default: disable.
XFS xfSwAcceptFailure1.3.6.1.4.1.193.81.2.7.1.9.4XfSwEnableDisableread-writeUsed to enable/disable setting of new PIUs, that fail to up/downgrade, in 'out of service'. PIUs that are out of service will not be taken into service on the disable/enable transistion. Default: enable.
xfSwLmUpgradeTable1.3.6.1.4.1.193.81.2.7.1.10not-accessibleThis table is used to upgrade a single load module. For each known load module an entry is present.
xfSwLmUpgradeEntry1.3.6.1.4.1.193.81.2.7.1.10.1not-accessibleEntry in the table.
I32 xfSwLmUpgradeIndex1.3.6.1.4.1.193.81.2.7.1.10.1.1Integer32read-onlyObjects used to index the table.
XFP xfSwLmUpgradeProductNumber1.3.6.1.4.1.193.81.2.7.1.10.1.3XfProductnumberread-onlyProduct number of the load module. Normally something like 'CAXR102_012/1'.
XFP xfSwLmUpgradeRevision1.3.6.1.4.1.193.81.2.7.1.10.1.4XfProductRevisionread-writeRevision to which the load module should be upgraded. Normally something like 'R1A'.
INT xfSwLmUpgradeAdminStatus1.3.6.1.4.1.193.81.2.7.1.10.1.6INTEGERread-writeIndicates the desired status for this release. To start a software upgrade the manager has to set xfSwLmUpgradeRevision. After that it will set this object to upgradeStarted. Which will lead to downloading the SBDF-file from the FTP Server. For the active release write is possible but will have no impact.
INT xfSwLmUpgradeOperStatus1.3.6.1.4.1.193.81.2.7.1.10.1.7INTEGERread-onlyIndicates the status of the software upgrade process for this load module. active(1) the load module is active and running on the PIU. upgradeStarted(2) a load module will have this status directly after the SRDF info for this module is loaded and the xfSwLmUpgradeAdminStatus of the release was set to upgradeStarted. upgradeFinished(3) indicates that this load modules has been retreived and burned into the flash memories.This is the state of load modules that are part of an active release. upgradeTested(4) This release is running as test and not committed yet. upgradeFailed(5) upgraded has failed for a reason, e.g. file transfer checksum was wrong, see xfSwLmUpgradeFailure. upgradeAborted(6) when the manager has aborted the upgrade of the complete release whilst this load module wasn't upgradedFinished yet this will be its status. The 50 series errors are reported by the FTP client on the node. errorInternalError(50) An internal error detected before FTP operation. errorFileStorage(51) Error when erasing flash to store the downloaded file at the node. ftpPingFailed(52) FTP ping failed. ftpNoAccess(53) Not able to send the FTP commands. ftpConnectionDetailsMissing(54) FTP connection details are missing. ftpConnectionDetailsInvalid(55) FTP connection details are invalid. ftpConnectionTimeout(56) FTP connection timeout is detected. ftpNoSuchRemoteFile(57) No such remote file exists. ftpNoSuchRemoteDir(58) No such remote directory exists. The 400 series errors occur when the command was not accepted and the requested action did not take place, but the error condition is temporary and the action may be requested again. ftpServiceNotAvailable(421) Service not available, closing control connection. This may be a reply to any command if the service knows it must shut down. Possible causes are transfer timeouts and/or FTP server resets. ftpUnableToOpenDataConnection(425) Can't open data connection. Try changing from PASV to PORT mode. ftpConnectionClosed(426) Connection closed and file transfer is aborted. Possible causes are out of local diskspace and loss of connection. ftpFileBusy(450) Requested file action not taken. File unavailable (e.g file busy). ftpLocalError(451) Requested action aborted due to local error in processing. ftpInsufficienStorageSpace(452) Requested action not taken due to insufficient storage space on the server. The 500 series errors occur when the command was not accepted and the requested action did not take place. ftpSyntaxError(501) FTP Syntax error in parameters or arguments. ftpCommandNotImplemented(502) FTP Command not implemented. ftpBadSequenceCommands(503) Bad sequence of the FTP commands. ftpParameterNotImplemented(504) FTP command not implemented for that parameter. ftpNotLoggedIn(530) Not logged in. Your username and/or password is being rejected, contact the server adminstrator. ftpNeedAccount(532) Need account for storing files. ftpFileUnavailable(550) Requested action not taken. File unavailable (e.g.file not found, no access). Contact the server adminstrator. ftpExceededStorageAllocation(552) Requested file action aborted.Exceeded storage allocation (for current directory or data set). Contact the server adminstrator. ftpFileNameNotAllowed(553) Requested action not taken. File name not allowed. Try changing the file name or getting rid of spaces in the file name.
I32 xfSwLmUpgradeProgress1.3.6.1.4.1.193.81.2.7.1.10.1.8Integer32read-onlyThis object indicates the progress in downloading the respective load module when part of an upgrade of an inserted PIU.
INT xfSwLmUpgradeFailure1.3.6.1.4.1.193.81.2.7.1.10.1.9INTEGERread-onlyThis object specifies the cause of a software upgrade failure.
STR xfSwLmUpgradeDescription1.3.6.1.4.1.193.81.2.7.1.10.1.10SnmpAdminStringread-onlyThis object indicates a textual description of the load module, indicating PIU type as stated by the entPhysicalDescription MO.
BIT xfSwGlobalState1.3.6.1.4.1.193.81.2.7.1.11Bitsread-onlyThis objecty indicates the global state of the Software Upgrade process. noUpgrade(0), no Software upgrade ongoing sblStarted(1), a SBL upgrade is started and SBDF and Load Modules are downloading sblWaitForActivate(2), a SBL upgrade is finished and waiting for an activation sblWaitForCommit(3), a SBL upgrade is in test phase and waiting for commit manualStarted(4), a manual upgrade is started and Load Modules are downloading manualWaitForActivate(5), a manual upgrade is finished and waiting for an activation manualWaitForCommit(6), a manual upgrade is in test phase and waiting for commit unitUpgrade(7), an unit is inserted and in the process of upgrading cachingLoadModules(8), software upgrade is in the process of downloading the load modules for cache. preparingForTest(9), a period after a power-up/restart the node prepares to enter the test phase. During this period some units might restart and it is not possible to commit the software upgrade.
xfSwConformance1.3.6.1.4.1.193.81.2.7.2
xfSwCompliances1.3.6.1.4.1.193.81.2.7.2.1
xfSwFullCompliance1.3.6.1.4.1.193.81.2.7.2.1.1The compliance statement for SNMP entities which implement everything.
xfSwGroups1.3.6.1.4.1.193.81.2.7.2.2
xfSwGroup1.3.6.1.4.1.193.81.2.7.2.2.1Group of all software related objects.
xSwGroupR21.3.6.1.4.1.193.81.2.7.2.2.2All objects added for MINI-LINK Traffic Node R2.
xfSwObsoleteGroup1.3.6.1.4.1.193.81.2.7.2.2.3Description.

RFC description

Tracks software inventory, upgrade status, and load module management for Ericsson XF platform network devices.

Start monitoring Ericsson XF access/transport equipment (software-inventory/version/upgrade status) with a free 30-day trial of IPNetwork Monitor. Import MIBs, browse SNMP OIDs, create custom SNMP monitors, configure alerts, and monitor any SNMP-enabled network device from a single console.

Download XF-SOFTWARE-MIB