-- ===================================================================== -- Copyright (c) 2009-2023 FS.COM Inc. All Rights Reserved. -- -- Description: -- This MIB module is for the management of the Fibre Channel -- Trace Route functionality. -- Reference: -- Version: V1.0 -- History: -- V1.0 Initial version created by liuyanchao 2013-02-27 -- ===================================================================== FS-FC-TRACE-ROUTE-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE, Unsigned32 FROM SNMPv2-SMI RowStatus, TruthValue FROM SNMPv2-TC FsFcVsanIndex, FsFcAddressType, FsFcAddress, FsFcNameId, FsFcStartOper FROM FS-FC-TC-MIB fsSan FROM FS-VSAN-MIB; fsFcTraceRoute MODULE-IDENTITY LAST-UPDATED "201302270000Z" ORGANIZATION "Fiberstore Co.,Limited" CONTACT-INFO "" DESCRIPTION "This MIB module is for the management of the Fibre Channel Trace Route functionality." REVISION "201302270000Z" DESCRIPTION "Initial version of this MIB module." ::= { fsSan 4 } fsFcTraceRouteObjects OBJECT IDENTIFIER ::= { fsFcTraceRoute 1 } fsFcTraceRouteConfigurations OBJECT IDENTIFIER ::= { fsFcTraceRouteObjects 1 } fsFcTraceRouteResults OBJECT IDENTIFIER ::= { fsFcTraceRouteObjects 2 } fsFcTraceRouteNotifications OBJECT IDENTIFIER ::= { fsFcTraceRouteObjects 3 } fsFcTraceRouteNotifyPrefix OBJECT IDENTIFIER ::= { fsFcTraceRouteNotifications 0 } -- Trace Route table. fsFcTraceRouteTable OBJECT-TYPE SYNTAX SEQUENCE OF FsFcTraceRouteEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A table of trace route entries containing a group of trace route requests that need to be executed at the agent." ::= { fsFcTraceRouteConfigurations 1 } fsFcTraceRouteEntry OBJECT-TYPE SYNTAX FsFcTraceRouteEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A trace route request entry that needs to be executed at the agent." INDEX { fsFcTraceRouteIndex } ::= { fsFcTraceRouteTable 1 } FsFcTraceRouteEntry ::= SEQUENCE { fsFcTraceRouteIndex Unsigned32, fsFcTraceRouteVsan FsFcVsanIndex, fsFcTraceRouteAddressType FsFcAddressType, fsFcTraceRouteAddress FsFcAddress, fsFcTraceRouteTimeout Unsigned32, fsFcTraceRouteAdminStatus FsFcStartOper, fsFcTraceRouteOperStatus INTEGER, fsFcTraceRouteAgeInterval Unsigned32, fsFcTraceRouteTrapOnCompletion TruthValue, fsFcTraceRouteRowStatus RowStatus } fsFcTraceRouteIndex OBJECT-TYPE SYNTAX Unsigned32 (1..65535) MAX-ACCESS accessible-for-notify STATUS current DESCRIPTION "The index of the current trace route entry. This object uniquely identifies a trace route request entry in a specified VSAN (Virtual Storage Area Network)." ::= { fsFcTraceRouteEntry 1 } fsFcTraceRouteVsan OBJECT-TYPE SYNTAX FsFcVsanIndex MAX-ACCESS read-create STATUS current DESCRIPTION "The VSAN on which the trace route request will be executed. If the corresponding instance value of fsFcTraceRouteOperStatus is 'inProgress', the object cannot be modified." ::= { fsFcTraceRouteEntry 2 } fsFcTraceRouteAddressType OBJECT-TYPE SYNTAX FsFcAddressType MAX-ACCESS read-create STATUS current DESCRIPTION "The type of the corresponding instance of fsFcTraceRouteAddress object." DEFVAL { fcid } ::= { fsFcTraceRouteEntry 3 } fsFcTraceRouteAddress OBJECT-TYPE SYNTAX FsFcAddress MAX-ACCESS read-create STATUS current DESCRIPTION "The address to which the route will be traced. This object will contain an 8-octet WWN (World Wide Name), if the value of the associated instance of fsFcTraceRouteAddressType object is 'wwn'. This object will contain a 3-octet Fibre Channel ID, if the value of the associated instance of fsFcTraceRouteAddressType object is 'fcid'." ::= { fsFcTraceRouteEntry 4 } fsFcTraceRouteTimeout OBJECT-TYPE SYNTAX Unsigned32 (1..10) UNITS "seconds" MAX-ACCESS read-create STATUS current DESCRIPTION "The value of timeout for this trace route request. If the corresponding instance value of fsFcTraceRouteOperStatus object is 'inProgress', this object cannot be modified." DEFVAL { 5 } ::= { fsFcTraceRouteEntry 5 } fsFcTraceRouteAdminStatus OBJECT-TYPE SYNTAX FsFcStartOper MAX-ACCESS read-create STATUS current DESCRIPTION "The administrative status of each fsFcTraceRouteEntry. The object has two values: enable - Activate the entry. disable - Deactivate the entry. When the trace route entry is being executed, this object cannot be modified. If this object is being read, a value of 'enable' will be returned. When the execution finishes, the value of this object will be set to 'disable'." DEFVAL { disable } ::= { fsFcTraceRouteEntry 6 } fsFcTraceRouteOperStatus OBJECT-TYPE SYNTAX INTEGER { inProgress(1), -- trace route in progress success(2), -- trace route success partialSuccess(3), -- trace route partial success failure(4), -- trace route failure disabled(5) -- trace route is disabled } MAX-ACCESS read-only STATUS current DESCRIPTION "This object indicates the operational status of this fsFcTraceRouteEntry. The value specifications are listed as follows: inProgress - Trace route is in progress. success - Trace route has succeeded. partialSuccess - Trace route has partially succeeded. failure - Trace route has failed due to resource limitations. disabled - Trace route is disabled." ::= { fsFcTraceRouteEntry 7 } fsFcTraceRouteAgeInterval OBJECT-TYPE SYNTAX Unsigned32 (500..900) UNITS "seconds" MAX-ACCESS read-create STATUS current DESCRIPTION "The interval time for an entry to age out after a trace route test is completed." DEFVAL { 500 } ::= { fsFcTraceRouteEntry 8 } fsFcTraceRouteTrapOnCompletion OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-create STATUS current DESCRIPTION "This object indicates whether a fsFcTraceRouteCompletionNotify notification should be generated when this trace route test completes." DEFVAL { false } ::= { fsFcTraceRouteEntry 9 } fsFcTraceRouteRowStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "The status of this conceptual row." ::= { fsFcTraceRouteEntry 10 } -- Trace Route Hops Table -- The fsFcTraceRouteHopsTable contains the hop-by-hop result -- of a trace route test performed for an entry in the -- fsFcTraceRouteTable. fsFcTraceRouteHopsTable OBJECT-TYPE SYNTAX SEQUENCE OF FsFcTraceRouteHopsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A table of trace route hop results. This table indicates the hop-by-hop result of a trace route test associated with an entry in the fsFcTraceRouteTable." ::= { fsFcTraceRouteResults 1 } fsFcTraceRouteHopsEntry OBJECT-TYPE SYNTAX FsFcTraceRouteHopsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A trace route hop entry. The first index member specifies the fsFcTraceRouteEntry that an fsFcTraceRouteHopsEntry is associated with. The second index element identifies a hop in a trace route path. In the case of a complete path being traced, entries corresponding to an fsFcTraceRouteEntry are created automatically in this table. Each hop in the complete path will be listed in this table. When an fsFcTraceRouteEntry is deleted or aged out, the entries corresponding to the fsFcTraceRouteEntry in this table are also deleted." INDEX { fsFcTraceRouteIndex, fsFcTraceRouteHopsIndex } ::= { fsFcTraceRouteHopsTable 1 } FsFcTraceRouteHopsEntry ::= SEQUENCE { fsFcTraceRouteHopsIndex Unsigned32, fsFcTraceRouteHopsAddr FsFcNameId } fsFcTraceRouteHopsIndex OBJECT-TYPE SYNTAX Unsigned32 (1..65535) MAX-ACCESS not-accessible STATUS current DESCRIPTION "This object indicates the hop index for a trace route hop. Values for this object associated with the same fsFcTraceRouteIndex MUST begin with 1 and automatically increase by 1." ::= { fsFcTraceRouteHopsEntry 1 } fsFcTraceRouteHopsAddr OBJECT-TYPE SYNTAX FsFcNameId MAX-ACCESS read-only STATUS current DESCRIPTION "This object specifies the WWN of the device associated with this hop." ::= { fsFcTraceRouteHopsEntry 2 } -- Notifications fsFcTraceRouteCompletionNotify NOTIFICATION-TYPE OBJECTS { fsFcTraceRouteIndex, fsFcTraceRouteVsan, fsFcTraceRouteAddressType, fsFcTraceRouteAddress, fsFcTraceRouteOperStatus } STATUS current DESCRIPTION "When a trace route test is finished and the instance of fsFcTraceRouteTrapOnCompletion associated with the test is set to 'true', this notification occurred." ::= { fsFcTraceRouteNotifyPrefix 1 } END