CISCO-FCTRACEROUTE-MIB

File: CISCO-FCTRACEROUTE-MIB.mib (22605 bytes)

Imported modules

SNMPv2-SMI SNMPv2-CONF SNMPv2-TC
CISCO-SMI CISCO-ST-TC CISCO-FCPING-MIB

Imported symbols

MODULE-IDENTITY OBJECT-TYPE NOTIFICATION-TYPE
Unsigned32 MODULE-COMPLIANCE OBJECT-GROUP
NOTIFICATION-GROUP RowStatus TruthValue
ciscoMgmt FcNameId VsanIndex
FcAddress FcAddressType FcStartOper

Defined Types

FcTraceRouteEntry  
SEQUENCE    
  fcTraceRouteIndex Unsigned32
  fcTraceRouteVsanIndex VsanIndex
  fcTraceRouteTargetAddrType FcAddressType
  fcTraceRouteTargetAddr FcAddress
  fcTraceRouteTimeout Unsigned32
  fcTraceRouteAdminStatus FcStartOper
  fcTraceRouteOperStatus INTEGER
  fcTraceRouteAgeInterval Unsigned32
  fcTraceRouteTrapOnCompletion TruthValue
  fcTraceRouteRowStatus RowStatus

FcTraceRouteHopsEntry  
SEQUENCE    
  fcTraceRouteHopsHopIndex Unsigned32
  fcTraceRouteHopsHopAddr FcNameId
  fcTraceRouteHopsHopLatencyValid TruthValue
  fcTraceRouteHopsHopLatency Unsigned32

Defined Values

ciscoFcTraceRouteMIB 1.3.6.1.4.1.9.9.296
The MIB module for the management of the Fibre Channel Trace Route functionality.
MODULE-IDENTITY    

ciscoFcTraceRouteMIBObjects 1.3.6.1.4.1.9.9.296.1
OBJECT IDENTIFIER    

fcTraceRouteMIBConformance 1.3.6.1.4.1.9.9.296.2
OBJECT IDENTIFIER    

fcTraceRouteConfiguration 1.3.6.1.4.1.9.9.296.1.1
OBJECT IDENTIFIER    

fcTraceRouteResults 1.3.6.1.4.1.9.9.296.1.2
OBJECT IDENTIFIER    

fcTraceRouteNotification 1.3.6.1.4.1.9.9.296.1.3
OBJECT IDENTIFIER    

fcTraceRouteNotifications 1.3.6.1.4.1.9.9.296.1.3.0
OBJECT IDENTIFIER    

fcTraceRouteTable 1.3.6.1.4.1.9.9.296.1.1.1
A table of trace route request entries. The fcTraceRouteTable will contain a set of trace route requests that need to be executed at the agent.
OBJECT-TYPE    
  SEQUENCE OF  
    FcTraceRouteEntry

fcTraceRouteEntry 1.3.6.1.4.1.9.9.296.1.1.1.1
A trace route request entry. A management station wishing to create an entry should generate a pseudo-random number to be used as an index into this table and create an instance of the fcTraceRouteRowStatus object. After that, the management station should set the corresponding instance of fcTraceRouteTargetAddr object with the address of the destination for which the route needs to be determined and fcTraceRouteVsanIndex with the desired VSAN number. 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 and the corresponding instance of fcTraceRouteAdminStatus should be set to 'enable' to initiate the trace route sequence. Note that this entire procedure may be initiated via a single set request which specifies a row status of createAndGo as well as specifies valid values for the non-defaulted configuration objects. The results of the trace route operation are made available in the fcTraceRouteHopsTable. For an entry uniquely identified by fcTraceRouteIndex, the value of the corresponding instance of fcTraceRouteOperStatus object will specify whether test was a success or a failure. The fcTraceRouteHopsTable will contain the actual hops that were determined by the test. For an entry uniquely identified by fcTraceRouteIndex, entries will be created automatically in the fcTraceRouteHopsTable which contain the different hops of the trace route path. Once the trace route test is complete, the management station should retrieve the information from the fcTraceRouteHopsTable and delete the entry from this table. When an entry is deleted from this table, related entries in the fcTraceRouteHopsTable will be automatically deleted by the agent. In order to prevent old entries from clogging the table, entries will be aged out. But an entry will never be deleted within fcTraceRouteAgeInterval milliseconds of completing. If the management station wishes to repeat the trace route test for a particular destination, then it will need to set the corresponding instance of fcTraceRouteAdminStatus to 'enable' again.
OBJECT-TYPE    
  FcTraceRouteEntry  

fcTraceRouteIndex 1.3.6.1.4.1.9.9.296.1.1.1.1.1
The index of a trace route entry. This object uniquely identifies a trace route request entry on a particular VSAN.
OBJECT-TYPE    
  Unsigned32 1..2147483647  

fcTraceRouteVsanIndex 1.3.6.1.4.1.9.9.296.1.1.1.1.2
This object identifies the VSAN on which this trace route request is to be performed. This object cannot be modified if the corresponding instance of fcTraceRouteOperStatus object has a value of 'inProgress'.
OBJECT-TYPE    
  VsanIndex  

fcTraceRouteTargetAddrType 1.3.6.1.4.1.9.9.296.1.1.1.1.3
The format of the corresponding instance of fcTraceRouteTargetAddr object.
OBJECT-TYPE    
  FcAddressType  

fcTraceRouteTargetAddr 1.3.6.1.4.1.9.9.296.1.1.1.1.4
The address of the device to which the route is to be traced. If the value of the corresponding instance of fcTraceRouteTargetAddrType object is 'wwn', then this object will contain an 8 octet long WWN. If the value of the corresponding instance of fcTraceRouteTargetAddrType object is 'fcid', then this object will contain a 3 octet long FCID. This object MUST be set to a valid value before or concurrently with setting the corresponding instance of fcTraceRouteRowStatus to 'active'.
OBJECT-TYPE    
  FcAddress  

fcTraceRouteTimeout 1.3.6.1.4.1.9.9.296.1.1.1.1.5
The timeout value for this trace route request. This object cannot be modified if the corresponding instance of fcTraceRouteOperStatus object has a value of 'inProgress'.
OBJECT-TYPE    
  Unsigned32 5..25  

fcTraceRouteAdminStatus 1.3.6.1.4.1.9.9.296.1.1.1.1.6
This object specifies the desired state that a fcTraceRouteEntry should be in: enable(1) - Attempt to activate the test as defined by this entry. disable(2) - Deactivate the test as defined by this entry. The actual operational state of this test is indicated by the corresponding instance of fcTraceRouteOperStatus. When the trace route test corresponding to this entry is executing, this object cannot be modified. If this object is read at such a time, a value of 'enable' will be returned. When the test completes, the value of this object will be made 'disable' automatically by the agent.
OBJECT-TYPE    
  FcStartOper  

fcTraceRouteOperStatus 1.3.6.1.4.1.9.9.296.1.1.1.1.7
This object indicates the operational status of this fcTraceRouteEntry. inProgress(1) - Indicates that the trace route test as defined by this instance of fcTraceRouteEntry is currently running. success(2) - Indicates that the trace route test as defined by this instance of fcTraceRouteEntry is currently complete and the whole path to the destination has been traced. partialSuccess(3) - Indicates that the trace route test as defined by this instance of fcTraceRouteEntry is currently partially successful. failure(4) - Indicates that the trace route test as defined by this instance of fcTraceRouteEntry has currently failed due to resource limitations. disabled(5) - Indicates that the trace route test as defined by this instance of fcTraceRouteEntry is currently disabled. Initially the value of this object will be 'inProgress' when the test is being executed. Once the test completes, the value of this object will be 'success' or 'partialSuccess' depending on the outcome of the test. If the value of this object is 'success', then the route to the target as determined by this test will be available in the fcTraceRouteHopsTable. If the value of this object is 'partialSuccess', then the fcTraceRouteHopsTable will contain that portion of the route that was traced by the test. If the value of this object is 'failure', then the test was not carried out and the fcTraceRouteHopsTable will not have any entries corresponding to this test. If the value of the corresponding instance of fcTraceRouteAdminStatus is 'disable', then this object will have a value of 'disabled'.
OBJECT-TYPE    
  INTEGER inProgress(1), success(2), partialSuccess(3), failure(4), disabled(5)  

fcTraceRouteAgeInterval 1.3.6.1.4.1.9.9.296.1.1.1.1.8
The amount of time to wait after a trace route test completes before the entry is aged out. This object cannot be modified if the corresponding instance of fcTraceRouteOperStatus object has a value of 'inProgress'.
OBJECT-TYPE    
  Unsigned32 500000..900000  

fcTraceRouteTrapOnCompletion 1.3.6.1.4.1.9.9.296.1.1.1.1.9
This object specifies if fcTraceRouteCompletionNotify notification should be generated or not when this trace route test completes. If this object is set to 'true', then the notification is generated. If this object is set to 'false', then the notification is not generated. This object cannot be modified if the corresponding instance of fcTraceRouteOperStatus object is having a value of 'inProgress'.
OBJECT-TYPE    
  TruthValue  

fcTraceRouteRowStatus 1.3.6.1.4.1.9.9.296.1.1.1.1.10
The status of this conceptual row. If a trace route test is being executed and if the corresponding instance of this object is set to 'destroy', then the trace route test will be stopped.
OBJECT-TYPE    
  RowStatus  

fcTraceRouteHopsTable 1.3.6.1.4.1.9.9.296.1.2.1
A table of trace route hop results. This table contains the hop-by-hop result of a trace route test performed for an entry in the fcTraceRouteTable.
OBJECT-TYPE    
  SEQUENCE OF  
    FcTraceRouteHopsEntry

fcTraceRouteHopsEntry 1.3.6.1.4.1.9.9.296.1.2.1.1
A trace route hop entry. The first index identifies the fcTraceRouteEntry that a fcTraceRouteHopsEntry belongs to. The second index element selects a hop in a trace route path. Entries are created automatically in this table corresponding to a fcTraceRouteEntry when the trace route test completes. In the case of a complete path being traced, the source and destination points along with the intermediate hops will be listed in this table. The entries in this table corresponding to a fcTraceRouteEntry are automatically deleted when the fcTraceRouteEntry is deleted or aged out.
OBJECT-TYPE    
  FcTraceRouteHopsEntry  

fcTraceRouteHopsHopIndex 1.3.6.1.4.1.9.9.296.1.2.1.1.1
This object specifies the hop index for a traceroute hop. Values for this object with respect to the same fcTraceRouteIndex MUST start at 1 and increase monotonically. All hops (traceRouteHopsTable entries) in a trace route path MUST be updated at the same time when a trace route test completes.
OBJECT-TYPE    
  Unsigned32 1..2147483647  

fcTraceRouteHopsHopAddr 1.3.6.1.4.1.9.9.296.1.2.1.1.2
This object reports the WWN of the device associated with this hop.
OBJECT-TYPE    
  FcNameId  

fcTraceRouteHopsHopLatencyValid 1.3.6.1.4.1.9.9.296.1.2.1.1.3
This object indicates whether the corresponding instance of fcTraceRouteHopsHopLatency object contains a valid value. If the value of this object is 'true', then the corresponding instance of fcTraceRouteHopsHopLatency contains a valid value. If the value of this object is 'false', then the corresponding instance of fcTraceRouteHopsHopLatency does not contain a valid value and should be ignored.
OBJECT-TYPE    
  TruthValue  

fcTraceRouteHopsHopLatency 1.3.6.1.4.1.9.9.296.1.2.1.1.4
This object reports the round trip time associated with this hop.
OBJECT-TYPE    
  Unsigned32 0..25000000  

fcTraceRouteCompletionNotify 1.3.6.1.4.1.9.9.296.1.3.0.1
This notification is generated whenever a trace route test is completed and the corresponding instance of fcTraceRouteTrapOnCompletion is set to 'true'. The agent is encouraged to append, at the end of this notification's varbindlist, one varbind for each hop of the traced route. Each such appended varbind would contain an instance of fcTraceRouteHopsHopAddr object. If the number of varbinds required would cause the notification to approach it's maximum size, the number of instances of fcTraceRouteHopsHopAddr will be truncated suitably.
NOTIFICATION-TYPE    

fcTraceRouteMIBCompliances 1.3.6.1.4.1.9.9.296.2.1
OBJECT IDENTIFIER    

fcTraceRouteMIBGroups 1.3.6.1.4.1.9.9.296.2.2
OBJECT IDENTIFIER    

fcTraceRouteMIBCompliance 1.3.6.1.4.1.9.9.296.2.1.1
Only three values 'createAndGo', 'destroy' and 'active' out of the six enumerated values need to be supported.
MODULE-COMPLIANCE    
  fcTraceRouteRowStatus INTEGER active(1), createAndGo(4), destroy(6)

fcTraceRouteConfigGroup 1.3.6.1.4.1.9.9.296.2.2.1
A collection of objects for configuring Fibre Channel Trace route functionality.
OBJECT-GROUP    

fcTraceRouteResultsGroup 1.3.6.1.4.1.9.9.296.2.2.2
A collection of objects for displaying Fibre Channel Trace route results.
OBJECT-GROUP    

fcTraceRouteNotifyGroup 1.3.6.1.4.1.9.9.296.2.2.3
A collection of notification(s) for monitoring Fibre Channel Trace route test completion.
NOTIFICATION-GROUP