CISCO-FICON-MIB: View SNMP OID List / Download MIB

This is the FICON (FIber CONnection) MIB module. FICON is an IBM standard of transport mechanism for communication between the mainframes and devices and is a major consideration for enterprise data centers. The Cisco MDS Storage Area Network (SAN) switches provide the functionality of a FICON Director to the customers.

A FICON Port Change notification is generated whenever the unit type of the port changes.

A table to issue the port swap command. In FICON, lots of configuration in the host is associated with a port-address. If the FICON port connecting the host to the switch has some problem and the user wants to connect the host to a different port in the switch, one needs to swap the configuration of the two ports. This command transparently swaps the configuration of two ports without affecting the host.

A cficonPortSwapTable entry. A management station wishing to create an entry should first generate a pseudo-random serial number to be used as the index to this sparse table. The station should then create the associated instance of the row status object. It must also, in the same PDU create the associated instance of the cficonSwapPortNumberFirst and cficonSwapPortNumberSecond objects. Note that when creating a row in this table, the cficonSwapPortEntryStatus, cficonSwapPortNumberFirst and cficonSwapPortNumberSecond are all required. Once the operation completes, the management station should delete the entry.

An arbitrary index for the swap command.

The first port number that needs to be swapped .

The second port number that needs to be swapped.

If this object is set to 'createAndGo(4)' then the port configurations of the ports specified by objects cficonSwapPortNumberFirst and cficonSwapPortNumberSecond will be swapped.

A table containing the objects to manage FICON functionality in a VSAN.

A cficonVsanTable entry. Each entry, identified by vsanIndex, provides the objects to manage FICON functionality in this VSAN, identified by vsanIndex. To create a vsan, only the cficonVsanEntryStatus needs to be set in the PDU. A vsan will be created with default values for all the objects in the entry. Once the vsan is created, the values of all the writable objects within a row can be modified.

The object indicates whether the host is allowed to alter FICON Director connectivity parameters. If 'true' the host is allowed to alter the parameters, else it cannot.

The object specifying whether the host can put the VSAN offline. If 'true' it allows the host to put the VSAN offline, else it cannot.

The object indicates whether director clock alert mode is enabled or disabled. If 'true', the mode is enabled, else it is disabled.

The object indicates whether network management system is allowed to alter FICON director connectivity parameters. If 'true', the network management system is allowed to alter FICON director connectivity parameters, else, it cannot.

The object indicating whether the configuration will be saved in the configuration file for this VSAN. When an operator modifies a configuration, the running configuration is modified. If this object is 'true', then the configuration is saved in the configuration file as well. If this object is 'false', then the running configuration is not saved in the configuration file.

The object indicating Control Unit Port (CUP) is enabled. If 'true', CUP is enabled, else it is disabled.

The EBCDIC Code page used for the exchange of information with the host in this VSAN. Enumeration: 'brazil': 275, 'italy': 280, 'usa': 37, 'france': 297, 'germany': 273, 'uk': 285, 'interNational': 500, 'japan': 281, 'spain': 284.

The Character Set used for the exchange of of information with the host in this VSAN. Enumeration: 'charSet697': 1.

A counter that is incremented every time there is a configuration change. This counter is used by the Host to keep track of the number of configuration changes that have taken place.

The object indicating whether director user alert mode is enabled or disabled. If 'true', the mode is enabled. else it is disabled.

The object indicating whether CUP is in a allegiance state. If it is in allegiance state with a channel, it cannot accept any commands from any logical paths. A CUP goes in an allegiance state when it accepts command from a channel and forms 'an allegiance' with it until the successful completion of the channel program, at which point the CUP goes in a an 'unlocked' mode. Enumeration: 'lockedByCLI': 1, 'unlocked': 4, 'lockedBySnmp': 2, 'lockedByHost': 3.

The system time in the VSAN. This could be set either by the host or be the default global time in the FICON Director. The default global time is the local time in the FICON Director. The format is as follows - Wed Nov 5 18:53:52.172485 2003

The object indicating whether VSAN time is set by the host or the time is global time within a FICON Director. If 'true', the time was set by the host, else it is same as the FICON Director's global time.

The name of CUP.

The object indicating whether VSAN time can be set by the host. If 'true', the host can set the time, else it can not.

The object used to clear a CUP allegiance. If this object is set with value, 'clear(1)' the CUP goes in a 'non-allegiance' or 'unlocked' mode as described in the description of cficonVsanDeviceAllegience object above. Enumeration: 'clear': 1.

The status of this table entry.

The object used to control the state of the ports belonging to a vsan in the context of the FICON functionality. If this object is set to 'offline(1)' all the ports belonging to the vsan, specified by the vsanIndex are put in the suspended state. If this object is set to 'online(2)' all the ports belonging to the vsan, specified by the vsanIndex are put in the operational state. Enumeration: 'offline': 1, 'online': 2.

The serial number of the FICON director.

A table listing the port information as stored in the configuration file.

A cficonPortTable entry. Each entry provides the information about a port, identified by cficonPortAddr, in the configuration file, identified by cficonPortFilename, on this VSAN, identified by vsanIndex.

The Port Address of this port.

The object indicates whether to block or unblock this port. This is one of the port-connectivity parameters. If 'true' this port is blocked, else it is unblocked.

The name of this port.

The list of ports that will be prohibited from communication. Each octet within the value of an object of this type, specifies a set of eight ports, with the first octet specifying ports 1 through 8, the second octet specifying ports 9 through 16, etc. Within each octet, the most significant bit represents the lowest numbered port and the least significant bit represents the highest numbered port.

A table listing the port information as stored in the running configuration. Each port is identified by the port address in the context of its vsan Index.

A cficonPortRunCfgTable entry. Each entry provides the information about a port (identified by cficonPortAddr), on this VSAN (identified by vsanIndex), for the running configuration.

The address of this port.

The object indicating whether to block or unblock this port. If 'true' this port is blocked, else it is unblocked.

The port name of this port.

The list of ports that will be prohibited. Each octet within the value of an object of this type specifies a set of eight ports, with the first octet specifying ports 1 through 8, the second octet specifying ports 9 through 16, etc. Within each octet, the most significant bit represents the lowest numbered port and the least significant bit represents the highest numbered port.

The type number for this FICON Director.

The model number for this FICON Director. It is in the form of ASCII characters.

The name of the the company that manufactured this FICON Director.

The plant code that identifies the plant of manufacture of this FICON Director.

The sequence number assigned to this FICON Director during manufacturing.

The peer type of the port that this port is communicating. channel - Host controlUnit - Disk fabric - Another SAN switch Enumeration: 'unknown': 4, 'controlUnit': 2, 'channel': 1, 'fabric': 3.

This is the identifier of the peer port. If the peer port is channel, as described by the instance of cficonRunCfgUnitType, then cficonRunCfgPortId will be the CHPID (Channel Path Identifier) of the channel path that contains this peer port. If the peer port is controlUnit, then cficonRunCfgPortId will be 0. If the peer port is fabric, then cficonRunCfgPortId will be port address of the interface on the peer switch.

This object specifies the status of the row, whether some specific columns in this row are valid, invalid or old. These specific columns are - cficonRunCfgProhibitPrtNums, cficonRunCfgTypeNumber, cficonRunCfgModelNumber, cficonRunCfgManufacturer, cficonRunCfgPlantOfMfg, cficonRunCfgSerialNumber and cficonRunCfgUnitType. The only value that can be assigned by the Network Management System(NMS) is 'invalid'. The NMS cannot set this object to any other value (i.e 'valid' or 'old'). valid - The information ( values of the other columns) is guaranteed to be correct. old - The information was valid before the port went down. Although the information has not vanished, it cannot be guaranteed. invalid - When the port does not have the information at all. (i.e. when the port comes up for the first time or the NMS clears the information. Enumeration: 'valid': 1, 'old': 3, 'invalid': 2.

A table listing the configuration files for each vsan.

A cficonCfgFileTable entry. Each entry provides the configuration file for a vsan (identified by vsanIndex) and a file (identified by cficonCfgFilename). Each entry lists the file status, the time the file was last updated etc. The cficonCfgFileRowStatus object is used to create or delete a configuration file. For creation or deletion, only the cficonCfgFileRowStatus object needs to be set in the PDU. cficonCfgFileCmd object is used to apply this configuration file to the vsan specified by the vsanIndex. For example, To create a configuration file 'cfg' for vsan 1, the management application must do the following - cficonCfgFileRowStatus.1.cfg = createAndGo; To delete the configuration file, cficonCfgFileRowStatus.1.cfg = destroy; To apply this configuration file, cficonCfgFileCmd.1.cfg = apply;

The name of the configuration file.

The description of the configuration file.

The status of filename containing these ports. Network Management station must check this object before it can read the contents of the configuration file. If it is 'locked', it means that the host or the CLI or the network management station is in the process of writing the contents of this file. If it is 'locked' the the file cannot be read. If it is 'unlocked', then the file is ready to be read. Enumeration: 'locked': 1, 'unlocked': 2.

The time this file was last updated. The format is as follows - Wed Nov 5 18:53:52.172485 2003

The object to apply this configuration file to the VSAN identified by the vsanIndex. When reading this object, a noOp(2) is returned. open(3) opens this file for modifying. close(4) closes this file. Enumeration: 'apply': 1, 'noOp': 2, 'open': 3, 'close': 4.

The rowStatus of this row.

The object to describe the status of the last 'apply' command. success - The last apply command was successful. inProgress - The last apply command is still in the process of execution. failed - The last apply command failed. notApplicable - The last apply command status is not available. Enumeration: 'failed': 3, 'inProgress': 2, 'success': 1, 'notApplicable': 4.

The string describing the reason the the last 'apply' command failed. This string needs to be polled only in the case when the value of the cficonCfgFileCmdStatus is 'failed'.

A table listing the association of Port number to its interface index.

A cficonPortNumIfTable entry. Each entry provides a mapping between the port number and its interface index.

The port number of this port.

The interface index of this port. For ports that are not installed, this object would be zero.

A table listing the association of Port address to port number.

A cficonPortAddrNumTable entry. Each entry provides the port address to port number mapping.

The port address of this port.

The port number of this port.

A table listing the association of Port number to its port number.

A cficonPortNumAddrTable entry. Each entry provides a mapping between the port number and its port number.

The port number of this port.

The port address of this port.

A table listing the director history buffer. Director History Buffer is a mechanism to determine those ports that have changed their configuration for a particular value of a key counter. The FICON Director maintains a change vector of 256 bits (32 bytes) and an associated key counter. This table lists this vector for a given key counter.

A row in the cficonDirHistTable, identified by the vsanIndex and the key counter.

The key counter.

The list of ports that have configuration change for a value of cficonDirHistKeyCounter. If a port has configuration change, its bit position will be 1. Each octet within the value of an object of this type, specifies a set of eight ports, with the first octet specifying ports 1 through 8, the second octet specifying ports 9 through 16, etc. Within each octet, the most significant bit represents the lowest numbered port and the least significant bit represents the highest numbered port.

A table listing the FICON Statistics .

An entry listing the FICON statistics for FICON port.

Number of 2.5 microsecond units that frame transmission is blocked due to zero credit.

Number of frames with disparity errors.

Number of frames with EOF errors.

Number of frames with OOF errors.

Number of invalid or unrecognizable Order Sets outside of frames.

This counter contains a sum of the errors counted by a set of the other defined error counters.

An object to control which ports are displayed. If set to all(1), all the ports, regardless whether they are installed or not are displayed in the cficonPortTable and cificonPortRunCfgTable. If set to 'installed', only the ports that are installed ports are displayed in the cficonPortTable and cificonPortRunCfgTable. Enumeration: 'all': 1, 'installed': 2.

A table listing the link incidents in a FICON interface. A Link incident is an event when the interface experiences the conditions described in the cficonLinkIncident object.

An entry listing the cficonLinkIncidentTable.

The type of link incident that occurred on an interface. bitErrThreshExceeded - Bit Error Threshold exceeded. lossOfSignalOrSync - Loss of Signal or Sync message. nosReceived - NOS msg Received NOS - Non Operational State primitiveSeqTimeOut - Primitive Timeout invalidPrimitiveSeq - Invalid Primitive sequence Enumeration: 'none': 1, 'primitiveSeqTimeOut': 5, 'nosReceived': 4, 'lossOfSignalOrSync': 3, 'invalidPrimitiveSeq': 6, 'bitErrThreshExceeded': 2.

The time at which the link incident happened. The format is as follows - Wed Nov 5 18:53:52.172485 2003

The object used to clear the link incident for an interface. Enumeration: 'clear': 1.

A table listing the CUP names for each vsan in a configuration file.

A cficonCfgFileCupNameTable entry. Each entry provides the CUP name for a VSAN (identified by vsanIndex) and a file (identified by cficonCfgFilename).

The name of CUP.

A table of config-copy requests.

A config-copy request. A management station wishing to create an entry should first generate a random serial number to be used as the index to this sparse table. The station should then create the associated instance of the row status object. This config-copy operation is only to copy the running configuration to startup configuration for FICON. Once the appropriate instance of all the configuration objects have been created, either by an explicit SNMP set request or by default, the row status should be set to active to initiate the request. Note that this entire procedure may be initiated via a single set request which specifies a row status of createAndGo. Once the config-copy request has been created (i.e. the cfCopyEntryRowStatus has been made active), the entry cannot be modified - the only operation possible after this is to delete the row. Once the request completes, the management station should retrieve the value of the status object and should then delete the entry. In order to prevent old entries from clogging the table, entries will be aged out, but an entry will never be deleted within 5 minutes of completing.

Object which specifies a unique entry in the cficonConfigCopyTable. A management station wishing to initiate a config-copy operation should use a random value for this object when creating an instance of a cficonConfigCopyEntry.

Specifies the result of this config-copy request. This value of this object is instantiated only after the row has been instantiated, i.e. after the cficonCopyEntryRowStatus has been made active. Enumeration: 'failed': 3, 'inProgress': 1, 'success': 2.

An error string describing the reason the copy failed.

The status of this table entry. Once the entry status is set to active, the associated entry cannot be modified until the request completes (cficonCopyState transitions to successful or failed state).

The object indicates whether auto save state is enabled or disabled. Enabling the auto save state, saves the configuration to the configuration file whenever a configuration change is made. If the cficonAutoSaveState is disabled (false), the configuration change is not saved to the configuration file.

The port map1. This object contains information specific to third party vendor and the usage is vendor specific. Each record is 6 bytes long and there can be up to 42 records in this object. Each record consists of the following - 0-3 bytes - IfIndex byte 4 - Port Address byte 5 - Unit Type

The port map2. This object contains information specific to third party vendor and the usage is vendor specific. Each record is 6 bytes long and there can be up to 42 records in this object. Each record consists of the following - 0-3 bytes - IfIndex byte 4 - Port Address byte 5 - Unit Type

The port map3. This object contains information specific to third party vendor and the usage is vendor specific. Each record is 6 bytes long and there can be up to 42 records in this object. Each record consists of the following - 0-3 bytes - IfIndex byte 4 - Port Address byte 5 - Unit Type

The port map4. This object contains information specific to third party vendor and the usage is vendor specific. Each record is 6 bytes long and there can be up to 42 records in this object. Each record consists of the following - 0-3 bytes - IfIndex byte 4 - Port Address byte 5 - Unit Type

The port map5. This object contains information specific to third party vendor and the usage is vendor specific. Each record is 6 bytes long and there can be up to 42 records in this object. Each record consists of the following - 0-3 bytes - IfIndex byte 4 - Port Address byte 5 - Unit Type

The port map6. This object contains information specific to third party vendor and the usage is vendor specific. Each record is 6 bytes long and there can be up to 42 records in this object. Each record consists of the following - 0-3 bytes - IfIndex byte 4 - Port Address byte 5 - Unit Type

Number of port map objects.

The port map table. This table contains the list of port map objects to carry the information of IfIndex, port Address, unit Type and Port Number for all ports.

The port map entry. This entry consists of a index number indicating a set of ports and a port map object carrying certain port attributes for these ports.

The port map index. This number indicates the group of ports described by the port map object.

The port map object. This object contains information specific to third party vendor and the usage is vendor specific. Each record is 7 bytes long and there can be up to 36 records in this object. Each record consists of the following - 0-3 bytes - IfIndex byte 4 - Port Address byte 5 - Unit Type byte 6 - Port Number

Chassis slot port number table. This table contains the list of all reserved port numbers for all slots of the chassis.

Chassis slot port number entry. This entry has the slot number and reserved port numbers for this slot.

The chassis slot number.

Chassis slot port numbers. Reserved port numbers for one chassis slot. There can be up to 64 port numbers reserved for each slot in the chassis.

Reserved port numbers for logical ports. There can be up to 256 port numbers reserved for logical ports.

A table of Nx_Ports that have registered to receive RLIRs on all VSANs on the local switch.

An entry (conceptual row) containing information about an Nx_Port which has registered to receive RLIRs on the VSAN indicated by vsanIndex.

The Fibre Channel Identifier (FC-ID) of the subscribing Nx_Port.

Indicates the device type for which the Nx_Port is interested in receiving RLIR ELS.

This object indicates the type of registration desired by the subscriber. conditionalRx(1) - the Nx_Port is registered as a valid recipient of subsequent RLIRs. But such an Nx_Port is chosen as the recipient of a link incident record only if no other recipients from the ERL on this VSAN have been chosen. alwaysRx(2) - the Nx_Port is registered as a valid recipient of subsequent RLIRs. Such an Nx_Port is always chosen as a recipient of a link incident record. Enumeration: 'conditionalRx': 1, 'alwaysRx': 2.

This table provides a management application with the capability to swap the configuration of two specified interfaces. In FICON, a host associates a great deal of configuration data with a port-address. If the FICON port connecting the host to the switch has some problem and the user wants to connect the host to a different port in the switch, one needs to swap the configuration of the two ports. This command transparently swaps the configuration of two ports without affecting the host.

A cficonInterfaceSwapTable entry contains 2 interface indices to be swapped among other objects. A management station wishing to create an entry should first obtain a unique serial number, e.g. get the cficonInterfaceSwapNextIndex scalar as the index to this sparse table. The station should then create the associated instance of the row status object. Note that when creating a row in this table, the cficonSwapPortEntryStatus, cficonSwapInterfaceIndexFirst and cficonSwapInterfaceIndexSecond are all required. The values of cficonSwapInterfaceIndexFirst and cficonSwapInterfaceIndexSecond should be different. If for any reason the new row can not be created, no swap action will be performed. If the table entry creation is successful, the value of cficonSwapInterfaceActionStatus will be pending(1) first and the SNMP response will be returned as success. When the swap starts, the value will be executing(2). After the swap action is done, the value will be either success(3) or failure(4). cficonSwapInterfaceFailReason contains the failure reason to indicate where the failure is from. cficonSwapInterfaceSystemError is a user readable description given by the failure causing sub-module. The management station should delete the entry after the value of cficonSwapInterfaceActionStatus being either success(3) or failure(4).

An arbitrary index for the swap command.

The first port number that needs to be swapped .

The second port number that needs to be swapped.

The status of the port swap request. pending - the request is waiting to be processed by the device. executing - the request is currently being processed by the device. success - the request has been completed successfully by the device. failure - the request failed. Enumeration: 'executing': 2, 'success': 3, 'pending': 1, 'failure': 4.

The reason of failed port swap request other - the failure is caused by other sub-module. none - no failure. dmFailure - the failure is caused by Domain Manager. ficonFailure - the failure is caused by FICON Manager. pmFailure - the failure is caused by Port Manager. psmFailure - the failure is caused by Port Security Manager. qosFailure - the failure is caused by QOS sub-module. spanFailure - the failure is caused by SPAN sub-module. zsFailure - the failure is caused by Zone Server. Enumeration: 'psmFailure': 6, 'qosFailure': 7, 'none': 2, 'zsFailure': 9, 'pmFailure': 5, 'ficonFailure': 4, 'other': 1, 'dmFailure': 3, 'spanFailure': 8.

A system error string readable by user for the failed swap action.

If this object is set to 'active(1)' then the port configurations of the ports specified by objects cficonSwapInterfaceIndexFirst and cficonSwapInterfaceIndexSecond will be swapped.

Next unique index available for creating new entry in the FICON interface swap table.

This object indicates the default state which whether to prohibit traffic or allow traffic among all External Ports of a new FICON VSAN. If 'true' the default state is prohibit all traffic, else the default state is allow all traffic. The default values of the cficonProhibitPortNumbers and the cficonRunCfgProhibitPrtNums in a newly created FICON VSAN are consistent with the state of this object.

Compliance statement for FICON MIB.

Compliance statement for FICON MIB.

Compliance statement for FICON MIB.

Compliance statement for FICON MIB.

A collection of objects providing port swap functionality.

A group containing objects providing ficon information in a vsan.

A group containing an object providing ficon port information.

A group containing an object providing ficon port information.

A collection of objects for the per VSAN config file table.

A collection of objects giving association of a Port Number to Interface Index of the Port.

A collection of objects giving association of a port address to port number and interface index of the port.

A collection of objects for the port number to port Address translation table.

A collection of objects for the Director History table.

A collection of objects for the FICON statistics table.

A collection of objects for the FICON statistics table.

A collection of objects for the FICON incidents table.

A collection of objects for the FICON CUP name for the vsan in the configuration files.

A collection of objects for the FICON configuration copy operation.

A collection of objects for the FICON configuration copy auto save operation.

A collection of objects for the FICON port maps.

A collection of FICON notifications.

A collection of objects for the FICON port maps.

A collection of objects for the reserved FICON port numbers.

A collection of objects for displaying RLIR ERL.

A collection of objects providing port swap functionality.

A collection of objects providing default port block state.