CISCO-ITP-MLR-MIB

TimeStampThe value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be defined in the description of any object defined using this type. If sysUpTime is reset to zero as a result of a re- initialization of the network management (sub)system, then the values of all TimeStamp objects are also reset. However, after approximately 497 days without a re- initialization, the sysUpTime object will reach 2^^32-1 and then increment around to zero; in this case, existing values of TimeStamp objects do not change. This can lead to ambiguities in the value of TimeStamp objects. · TimeTicks

The value of sysUpTime at the time of the last creation or deletion of an entry in the Multi-Layer routing table defined for this signalling point. If the local network management subsystem is re-initialized, then this object contains the sysUpTime at the time when this occurred. This value can be used to prevent unnecessary walks of the various take supporting multi-layer routing.

TimeStampThe value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be defined in the description of any object defined using this type. If sysUpTime is reset to zero as a result of a re- initialization of the network management (sub)system, then the values of all TimeStamp objects are also reset. However, after approximately 497 days without a re- initialization, the sysUpTime object will reach 2^^32-1 and then increment around to zero; in this case, existing values of TimeStamp objects do not change. This can lead to ambiguities in the value of TimeStamp objects. · TimeTicks

The value of sysUpTime at the time of the last load of the Multi-Layer Routing table using file format for this signalling point.

CItpTcTableLoadStatus1 = loadNotRequested2 = loadInProgress3 = loadComplete4 = loadCompleteWithErrors5 = loadFailedThe status of the current or prior load operation. 'loadNotRequested' : load operations have not been requested. 'loadInProgress' : load request is active. 'loadComplete' : load request complete without errors. 'loadCompleteWithErrors' : Load request completed with some type of errors that prevented the adding of one or more entries. 'loadFailed' : Load request failed. · Integer32

The status of the current load or status from the prior load operation. This object will have a value of loadInProgress while the load operation is in progress. The cmlrInstLastLoadTime contains a timestamp indicating when the load operation is completed.

CItpTcURLThe URL used to load a configuration file. An octet string specified by an administrator that must be in human-readable form. The names must conform to the allowed characters that can be specified via Command Line Interface(CLI). The names cannot contain control character and should not contain leading or trailing white space. SIZE (0..255) · OCTET STRING

The last URL used to load MLR table.

Counter32 · packets

Count of the number of times a packet was routed by MLR. This value is incremented when packet is routed with result type of 'asname', 'gt', 'pc' or 'pcSsn'.

Counter32 · packets

Count of message signal units that could not be processed because of invalid data or were explicitly blocked as a result of MLR processing. The message signalling units will be discarded.

Counter32 · packets

Count of message signal units that were passed back to normal SCCP processing.

Counter32 · packets

Count of message signal units with operation type GSM-MAP SMS-MO.

Counter32 · packets

Count of message signal units with operation type GSM-MAP SMS-MT.

Counter32 · packets

Count of message signal units with operation type GSM-MAP SRI-SM.

Counter32 · packets

Count of message signal units with operation type ANSI-41 SMD-PP.

Counter32 · packets

Count of message signal units with operation type GSM-MAP AlertSC.

Counter32 · packets

Count of message signal units with operation type ANSI-41 SMSRequest.

Counter32 · packets

Count of message signal units with operation type ANSI-41 SMSNotification.

Counter32 · packets

Count of message signal units received with unsupported SCCP message type. This object counts are also included in the cmlrInstContinueCounts object.

Counter32 · packets

Count of message signal units received with unsupported segmented SCCP message. This object counts are also included in the cmlrInstContinueCounts object.

Counter32 · packets

Count of message signal units received that could not be processed because the messages contained an unsupported command type or contents of messages was unsupported. This object counts are also included in the cmlrInstContinueCounts object.

Counter32 · packets

Count of message signal units received that could not be processed because of a parsing error. This object counts are also included in the cmlrInstContinueCounts object.

Counter32 · packets

Count of message signal units received that matched a trigger or rule that did not specify a result. This object counts are also included in the cmlrInstContinueCounts object.

Counter32 · packets

Count of message signal units received that matched a trigger or rule that specified continue for the result. This object counts are also included in the cmlrInstContinueCounts object.

Counter32 · packets

Count of message signal units received that matched a trigger or rule that specified a result or result group directing MSU to application server. However, the application server was unavailable. This object counts are also included in the cmlrInstAbortCounts object.

Counter32 · packets

Count of message signal units received that matched a trigger or rule that specified GTT for the result. This object counts are also included in the cmlrInstContinueCounts object.

Counter32 · packets

Count of message signal units received that could not be parsed due to some type of resource shortage. This object counts are also included in the cmlrInstAbortCounts object.

Counter32 · packets

Count of message signal units received that matched a trigger or rule that specified a result of block. This object counts are also included in the cmlrInstAbortCounts object.

Counter32 · packets

Count of message signal units received that could not be routed because of mis-match between GTI values. This object counts are also included in the cmlrInstAbortCounts object.

Counter32 · packets

Count of message signal units received that could not be routed because GTT address failed to convert. This object counts are also included in the cmlrInstAbortCounts object.

Counter32 · packets

Count of message signal units received that specified a result PC or PC and SSN and the destination point-code was unavailable. This object counts are also included in the cmlrInstAbortCounts object.

Counter32 · packets

Count of message signal units received that was processed and failed to mathc any trigger. This can occur when a primary trigger specifies secondary triggers and they fail to match. This object counts are also included in the cmlrInstContinueCounts object.

TimeStampThe value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be defined in the description of any object defined using this type. If sysUpTime is reset to zero as a result of a re- initialization of the network management (sub)system, then the values of all TimeStamp objects are also reset. However, after approximately 497 days without a re- initialization, the sysUpTime object will reach 2^^32-1 and then increment around to zero; in this case, existing values of TimeStamp objects do not change. This can lead to ambiguities in the value of TimeStamp objects. · TimeTicks

The value of sysUpTime on the most recent occasion at which the configuration was modified in such a way to force a discontinuity. All counters under this instance in the following tables will be reset when configuration is replaced. - cmlrTriggerTable - cmlrSubTriggerTable - cmlrAddressTable - cmlrRuleTable If no such discontinuities have occurred since the last re-initialization of the local management subsystem, then this object contains a zero value.

Counter32 · packets

Count of message signal units received that matched a trigger or rule that specified a result or result group directing MSU to application server. However, the application server was unavailable. This object counts are also included in the cmlrInstContinueCounts object.

Counter32 · packets

Count of message signal units received that matched a trigger or rule that specified result type of Application server. This object counts are also included in the cmlrInstRoutedCounts object.

Counter32 · packets

Count of message signal units received that matched a trigger or rule that specified result type Pointcode. This object counts are also included in the cmlrInstRoutedCounts object.

Counter32 · packets

Count of message signal units received that matched a trigger or rule that specified pointcode and subsystem number. This object counts are also included in the cmlrInstRoutedCounts object.

CmlrNameThe configured name used to identify various tables used by MLR. An octet string specified by an administrator that must be in human-readable form. The names must conform to the allowed characters that can be specified via Command Line Interface(CLI). The names cannot contain control character and should not contain leading or trailing white space. SIZE (0..20) · OCTET STRING

A name used to define a collection of multi-layer routing statements.

CmlrIdA numeric identifier used to specify an entry in a list. Zero is a special value used to indicate no entry. (0..65535) · Unsigned32

This object specifies the index for a list of triggers specified per routing table.

BITS

The following options define the source and processing of triggers. 'block' : Indicates that message signal units will be dropped when they match the specified trigger. When sub-trigger(secondary triggers) exist the option will be ignored. 'continue' : Indicates that message signal units will be processed by the normal SCCP routing. The continue, block and ruleset are mutually exclusive. 'matchAll': Indicates the trigger will match all message signal unit. 'cdpa' : Indicates that the trigger is found within the SCCP called party address field(cdpa). 'cgpa' : Indicates that the trigger is found within the SCCP calling party address field(cgpa). 'pc' : Indicates that the trigger will be matched if it contains the specified point-code. The point-code within the SCCP Cdpa or CgPa will be inspected first. If the point code is not present, then the DPC in the routing label is used if CdPA, and the OPC is used for CgPA. 'gt' : Indicates that the Cgpa or CdPA trigger is to be applied to packet when routing indicator specifies global title translation(RI=GT). 'tt' : Indicates that the translation type has been specified in the cmlrTriggerTransType object. 'gti' : Indicates that the global title indicator has been specified in the cmlrTriggerGti object. 'np' : Indicates that the numbering plan has been specified in the cmlrTriggerNp object. 'nai : Indicates that the nature of specified address has been specified in the cmlrTriggerNai object. 'ssn' : Indicates that the subsystem number has been in the cmlrTriggerSsn object. 'network' : Indicates the network name has been specified in the cmlrTriggerNetwork object. 'ruleset' : Indicates the set of rules to be processed as specified in the cmlrTriggerRuleset object. 'dpc' : Indicates that the destination point-code is one of MTP3 trigger parameters. The DPC is specified in the cmlrTriggerDpc object. 'opc' : Indicates that the origination point-code is one of MTP3 trigger parameters. The OPC is specified in the cmlrTriggerOpc object. 'opcMask': Indicates that the origination point-code is qualified with a mask. one of MTP3 trigger parameters. The OPC is specified in the cmlrTriggerOpc object. 'si': Indicates that the service indicator has been specified in the cmlrTriggerSi object

CItpTcGtaLongDisplayThe configured digits in the SCCP GTT Global Title Address. It consists of ASCII representation of GTA hex digits. SIZE (0..64) · OCTET STRING

The global title address to be matched when either the 'cdpa' or 'cgpa' bits are set in the cmlrTriggerParameters object. This object will return a string of zero length when the cmlrTriggerParameters 'pc' bit is set.

CgsccpGttTransTypeThe SCCP GTT Translation Type (TT). (0..255) · Unsigned32

The translation type specified within the address in the message signal unit. This object will default to value based on variant unless the 'tt' bit is set in cmlrTriggerParameters object.

CgsccpGttGlobalTitleIndThe SCCP GTT Global Title Indicator (GTI). The following values are generally used: No global title included (0), For ITU, GT includes NAI only (1), For ANSI, GT includes TT, NP and encoding scheme (1), GT includes only TT (2), GT includes TT, NP and encoding scheme (3), GT includes TT, NP, encoding scheme, NAI (4), Maximum GTI (15), Invalid GTI (253), Wild GTI (254).Reference: The Global Title Indicator is defined in the International Telecommunication Union standard Q.713: Specifications of Signalling System No. 7 - Signalling Connection Control Part (SCCP) section 3.4.1 Address Indicator. (0..255) · Unsigned32

The global title indicator value for the global tile address specified within the message signal unit. This object will default to value based on variant unless the 'gti' bit is set in cmlrTriggerParameters object.

CItpTcNumberingPlanThe SCCP GTT Numbering Plan (NP). The following values are generally used: Unknown NP (0), ISDN/Telephony NP (1), Spare (2), Data NP (3), Telex NP (4), Maritime Mobile NP (5), Land Mobile NP (6), ISDN/Mobile NP (7), Private NP (8). Max NP (15), Invalid NP (253), Wild NP (254). (0..255) · Integer32

The numbering plan of the specified global title address. This object will default to value based on variant unless the 'np' bit is set in cmlrTriggerParameters object.

CItpTcNAIThe SCCP GTT Network Address Indicator (NAI). The following values are generally used: Unknown Nature of Address (0), Subscriber Number (1), Reserved for national use (2), National Significant Number (3), International Number (4), Maximum NAI (127), Invalid NAI (253), Wild NAI (254). (0..255) · Integer32

Nature of Address Indicator (NAI) for GTT Selector. This object will default to value based on variant unless the 'nai' bit is set in cmlrTriggerParameters object.

CItpTcPointCodeThe SS7 network node address as specified in the following references. The format of the Point code depends on the variant defined in the CgspSS7Variant object as follows. 33222222222211111111110000000000 10987654321098765432109876543210 ANSI: nnnnnnnn - Network cccccccc - Cluster mmmmmmmm - Member ITU: zzz - Zone aaaaaaaa - Area/Network iii - Identifier NTT: zzzzz - Zone aaaa - Area/Network iiiiiii - Identifier TTC: zzzzz - Zone aaaa - Area/Network iiiiiii - Identifier Note: The China variant has the same format as ANSI. This form of the point-code is not intended for for presentation.Reference: The SS7 network node address as specified in the International Telecommunication Union standard Q.708: Specifications of Signalling System No. 7 - Numbering of International Signalling Point Codes, and by ANSI T1.111.8 Numbering of Signalling Point Codes. GF 001-9001 - Technical Specifications of Signalling System No. 7 for National Telephone Network of China. (0..16777216) · Unsigned32

The point-code in variant-specific format. This object only has meaning when the 'pc' bit is set in the cmlrTriggerParameters object.

CItpTcSubSystemNumberThe SCCP Subsystem Number . A value of zero indicates that a subsystem is not specified. (0 | 2..255) · Unsigned32

The subsystem number to be matched when the when the 'pc' bit is set in the cmlrTriggerParameters object.

CItpTcPointCodeThe SS7 network node address as specified in the following references. The format of the Point code depends on the variant defined in the CgspSS7Variant object as follows. 33222222222211111111110000000000 10987654321098765432109876543210 ANSI: nnnnnnnn - Network cccccccc - Cluster mmmmmmmm - Member ITU: zzz - Zone aaaaaaaa - Area/Network iii - Identifier NTT: zzzzz - Zone aaaa - Area/Network iiiiiii - Identifier TTC: zzzzz - Zone aaaa - Area/Network iiiiiii - Identifier Note: The China variant has the same format as ANSI. This form of the point-code is not intended for for presentation.Reference: The SS7 network node address as specified in the International Telecommunication Union standard Q.708: Specifications of Signalling System No. 7 - Numbering of International Signalling Point Codes, and by ANSI T1.111.8 Numbering of Signalling Point Codes. GF 001-9001 - Technical Specifications of Signalling System No. 7 for National Telephone Network of China. (0..16777216) · Unsigned32

The destination MTP3 point-code to be matched when the when the 'dpc' bit is set in the cmlrTriggerParameters object.

CItpTcPointCodeThe SS7 network node address as specified in the following references. The format of the Point code depends on the variant defined in the CgspSS7Variant object as follows. 33222222222211111111110000000000 10987654321098765432109876543210 ANSI: nnnnnnnn - Network cccccccc - Cluster mmmmmmmm - Member ITU: zzz - Zone aaaaaaaa - Area/Network iii - Identifier NTT: zzzzz - Zone aaaa - Area/Network iiiiiii - Identifier TTC: zzzzz - Zone aaaa - Area/Network iiiiiii - Identifier Note: The China variant has the same format as ANSI. This form of the point-code is not intended for for presentation.Reference: The SS7 network node address as specified in the International Telecommunication Union standard Q.708: Specifications of Signalling System No. 7 - Numbering of International Signalling Point Codes, and by ANSI T1.111.8 Numbering of Signalling Point Codes. GF 001-9001 - Technical Specifications of Signalling System No. 7 for National Telephone Network of China. (0..16777216) · Unsigned32

The origination MTP3 point-code to be matched when the when the 'opc' bit is set in the cmlrTriggerParameters object.

CItpTcPointCodeMaskA mask used to perform different operations on pointcodes.Reference: The SS7 network node address as specified in the International Telecommunication Union standard Q.708: Specifications of Signalling System No. 7 - Numbering of International Signalling Point Codes, and by ANSI T1.111.8 Numbering of Signalling Point Codes. (0..16777216) · Unsigned32

The origination MTP3 point-code mask to be applied in combination with cmlrTriggerOpc object. The mask will be applied when 'opcMask' bit is set in the cmlrTriggerParameters object.

CItpTcServiceIndicator0 = snmm1 = sntm2 = spare23 = sccp4 = tup5 = isup6 = dupc7 = dupf8 = mtup9 = bisup10 = sisup11 = spare1112 = spare1213 = spare1314 = spare1415 = spare15The list of possible Service Indicator values. This identifies the type of SS7 packet. The service indicator codes for the international Signalling network are allocated as follows: 'SNMM' : Signalling network management messages (SNMM) 'SNTM' : Signalling network testing and maintenance messages (SNTM) 'Spare2' : Spare 2 'SCCP' : SCCP 'TUP' : Telephone User Part (TUP) 'ISUP' : ISDN User Part (ISUP) 'DUPC' : Data User Part, call and circuit-related messages (DUPC) 'DUPF' : Data User Part, facility registration and cancellation messages (DUPF) 'MTUP' : Reserved for MTP Testing User Part (MTUP) 'BISUP' : Broadband ISDN User Part (BISUP) 'SISUP' : Satellite ISDN User Part (SISUP) 'Spare11' : Spare 11 'Spare12' : Spare 12 'Spare13' : Spare 13 'Spare14' : Spare 14 'Spare15' : Spare 15Reference: ITU Q.704 Signalling network functions and messages section 14.2.1 Service indicator. · Integer32

The Service Indicator to be matched when the when the 'si' bit is set in the cmlrTriggerParameters object.

CItpTcNetworkNameThe network name is used to indicate the network in which this signalling point is participating. One or more instances of signalling points can exist in the same physical device. This identifier will be used to correlate instances of signalling points by network. When multiple instance support is not enable the network name will default to the null string. An octet string specified by an administrator that must be in human-readable form. The names must conform to the allowed characters that can be specified via Command Line Interface(CLI). The names cannot contain control character and should not contain leading or trailing white space. SIZE (0..19) · OCTET STRING

The network name is used to indicate the network in which the ruleset will be invoked. This object only has meaning when the 'network' bit is set in the cmlrTriggerParameters object.

CmlrRuleSetNameThe configured name used to identify a set of rules within an specified network. An octet string specified by an administrator that must be in human-readable form. The names must conform to the allowed characters that can be specified via Command Line Interface(CLI). The names cannot contain control character and should not contain leading or trailing white space. SIZE (0..20) · OCTET STRING

Specifies the ruleset table that should be used if the trigger is matched and not overruled by a secondary trigger ruleset. This object only has meaning when the 'ruleset' bit is set in the cmlrTriggerParameters object.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

This object indicates whether this trigger is active. The trigger will be active when the corresponding GTA entry exists and has been linked to trigger. 'true' - Trigger is active and will be processed. 'false' - Trigger is inactive and will not be processed.

DateAndTimeA date-time specification. field octets contents range ----- ------ -------- ----- 1 1-2 year* 0..65536 2 3 month 1..12 3 4 day 1..31 4 5 hour 0..23 5 6 minutes 0..59 6 7 seconds 0..60 (use 60 for leap-second) 7 8 deci-seconds 0..9 8 9 direction from UTC '+' / '-' 9 10 hours from UTC* 0..13 10 11 minutes from UTC 0..59 * Notes: - the value of year is in network-byte order - daylight saving time in New Zealand is +13 For example, Tuesday May 26, 1992 at 1:30:15 PM EDT would be displayed as: 1992-5-26,13:30:15.0,-4:0 Note that if only local time is known, then timezone information (fields 8-10) is not present. SIZE (8 | 11) · OCTET STRING · hint 2d-1d-1d,1d:1d:1d.1d,1a1d:1d

The local date and time when this trigger and sub-triggers will become active. When all bytes of octet string are set to zero then cmlrInstStartDateAndTime does not apply.

DateAndTimeA date-time specification. field octets contents range ----- ------ -------- ----- 1 1-2 year* 0..65536 2 3 month 1..12 3 4 day 1..31 4 5 hour 0..23 5 6 minutes 0..59 6 7 seconds 0..60 (use 60 for leap-second) 7 8 deci-seconds 0..9 8 9 direction from UTC '+' / '-' 9 10 hours from UTC* 0..13 10 11 minutes from UTC 0..59 * Notes: - the value of year is in network-byte order - daylight saving time in New Zealand is +13 For example, Tuesday May 26, 1992 at 1:30:15 PM EDT would be displayed as: 1992-5-26,13:30:15.0,-4:0 Note that if only local time is known, then timezone information (fields 8-10) is not present. SIZE (8 | 11) · OCTET STRING · hint 2d-1d-1d,1d:1d:1d.1d,1a1d:1d

The local date and time this trigger and sub-triggers will become inactive. When all bytes of octet string are set to zero then cmlrInstEndDateAndTime does not apply.

Counter32

This counter indicates that a packet has matched the contents of the primary trigger. This counter indicates which triggers are causing packets to be processed by multi-layer routing. Whether the trigger is fully matched will be indicated by the cmlrTriggerMatchCounts object. It is important to note that in the case where secondary triggers do not exist the cmlTriggerPreliminaryMatchCounts and cmlrTriggerMatchCounts will be the same.

Counter32

This counter indicates that a packet has matched the trigger and the result action was performed. When a primary trigger has secondary triggers this counter indicates that the primary matched and at least one of the secondary triggers matched.

RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of [2].) The status column has six defined values: - `active', which indicates that the conceptual row is available for use by the managed device; - `notInService', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device; - `notReady', which indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instanciated); - `createAndGo', which is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device; - `createAndWait', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device); and, - `destroy', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row. Whereas five of the six values (all except `notReady') may be specified in a management protocol set operation, only three values will be returned in response to a management protocol retrieval operation: `notReady', `notInService' or `active'. That is, when queried, an existing conceptual row has only three states: it is either available for use by the managed device (the status column has value `active'); it is not available for use by the managed device, though the agent has sufficient information to attempt to make it so (the status column has value `notInService'); or, it is not available for use by the managed device, and an attempt to make it so would fail because the agent has insufficient information (the state column has value `notReady'). NOTE WELL This textual convention may be used for a MIB table, irrespective of whether the values of that table's conceptual rows are able to be modified while it is active, or whether its conceptual rows must be taken out of service in order to be modified. That is, it is the responsibility of the DESCRIPTION clause of the status column to specify whether the status column must not be `active' in order for the value of some other column of the same conceptual row to be modified. If such a specification is made, affected columns may be changed by an SNMP set PDU if the RowStatus would not be equal to `active' either immediately before or after processing the PDU. In other words, if the PDU also contained a varbind that would change the RowStatus value, the column in question may be changed if the RowStatus was not equal to `active' as the PDU was received, or if the varbind sets the status to a value other than 'active'. Also note that whenever any elements of a row exist, the RowStatus column must also exist. To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram: STATE +--------------+-----------+-------------+------------- | A | B | C | D | |status col.|status column| |status column | is | is |status column ACTION |does not exist| notReady | notInService| is active --------------+--------------+-----------+-------------+------------- set status |noError ->D|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndGo |inconsistent- | | | | Value| | | --------------+--------------+-----------+-------------+------------- set status |noError see 1|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndWait |wrongValue | | | --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError column to | Value| entValue| | active | | | | | | or | | | | | | | |see 2 ->D|see 8 ->D| ->D --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError ->C column to | Value| entValue| | notInService | | | | | | or | | or | | | | | |see 3 ->C| ->C|see 6 --------------+--------------+-----------+-------------+------------- set status |noError |noError |noError |noError ->A column to | | | | or destroy | ->A| ->A| ->A|see 7 --------------+--------------+-----------+-------------+------------- set any other |see 4 |noError |noError |see 5 column to some| | | | value | | see 1| ->C| ->D --------------+--------------+-----------+-------------+------------- (1) goto B or C, depending on information available to the agent. (2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D. (3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C. (4) at the discretion of the agent, the return value may be either: inconsistentName: because the agent does not choose to create such an instance when the corresponding RowStatus instance does not exist, or inconsistentValue: if the supplied value is inconsistent with the state of some other MIB object's value, or noError: because the agent chooses to create the instance. If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A. (5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned. (6) the return value can indicate one of the following errors: wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated. (7) the return value can indicate the following error: inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated. (8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue. NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc. Conceptual Row Creation There are four potential interactions when creating a conceptual row: selecting an instance-identifier which is not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device. Interaction 1: Selecting an Instance-Identifier The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics. In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.) Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different. Finally, the management station could select a pseudo-random number to use as the index. In the event that this index was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation. A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used. Interaction 2: Creating the Conceptual Row Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions. Interaction 2a: Creating and Activating the Conceptual Row The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes: - a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'. When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information available to the agent is provided by two sources: the management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row. NOTE WELL Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm. Interaction 2b: Negotiating the Creation of the Conceptual Row The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the columns indicated by its column requirements.) Otherwise, the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3. Interaction 3: Initializing non-defaulted Objects The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes: - a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4. Interaction 4: Making the Conceptual Row Available Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'. NOTE WELL A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device. If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row. Conceptual Row Suspension When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified). Conceptual Row Deletion For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady', `notInService' or `active'.) If the operation succeeds, then all instances associated with the conceptual row are immediately removed. · Integer32

The object is used by a management station to create or delete the row entry in cmlrTriggerTable following the RowStatus textual convention.

CmlrIdA numeric identifier used to specify an entry in a list. Zero is a special value used to indicate no entry. (0..65535) · Unsigned32

This object specifies the index for a list of secondary triggers specified per primary trigger.

BITS

The following options define the source and processing of sub-triggers(secondary trigger). 'block' : Indicates that message signal units will be dropped when they match the specified secondary trigger. 'continue' : Indicates that message signal units will be processed by the normal SCCP routing. The continue, block and ruleset are mutually exclusive. 'matchAll': Indicates the secondary trigger will match all message signal unit. 'cdpa' : Indicates that the secondary trigger is found within the SCCP called party address field(cdpa). 'cgpa' : Indicates that the secondary trigger is found within the SCCP calling party address field(cgpa). 'pc' : Indicates that the secondary trigger will be matched if it contains the specified point-code. The point-code within the SCCP Cdpa or CgPa will be inspected first. If the point code is not present, then the DPC in the routing label is used if CdPA, and the OPC is used for CgPA. 'gt' : Indicates that the Cgpa or CdPA secondary trigger is to be applied to packet when routing indicator specifies global title translation(RI=GT). 'tt' : Indicates that the translation type has been specified in the cmlrSubTriggerTransType object. 'gti' : Indicates that the global title indicator has been specified in the cmlrSubTriggerGti object. 'np' : Indicates that the numbering plan has been specified in the cmlrSubTriggerNp object. 'nai' : Indicates that the nature of specified address has been specified in the cmlrSubTriggerNai object. 'ssn' : Indicates that the subsystem number has been in the cmlrSubTriggerSsn object. 'network' : Indicates the network name has been specified in the cmlrSubTriggerNetwork object. 'ruleset' : Indicates the set of rules to be processed as specified in the cmlrSubTriggerRuleset object.

CItpTcGtaLongDisplayThe configured digits in the SCCP GTT Global Title Address. It consists of ASCII representation of GTA hex digits. SIZE (0..64) · OCTET STRING

The global title address to be matched when either the 'cdpa' or 'cgpa' bits are set in the cmlrSubTriggerParameters object. This object will return a string of zero length when the cmlrSubTriggerParameters 'pc' bit is set.

CgsccpGttTransTypeThe SCCP GTT Translation Type (TT). (0..255) · Unsigned32

The translation type specified within the address in the message signal unit. This object will default to value based on variant unless the 'tt' bit is set in cmlrSubTriggerParameters object.

CgsccpGttGlobalTitleIndThe SCCP GTT Global Title Indicator (GTI). The following values are generally used: No global title included (0), For ITU, GT includes NAI only (1), For ANSI, GT includes TT, NP and encoding scheme (1), GT includes only TT (2), GT includes TT, NP and encoding scheme (3), GT includes TT, NP, encoding scheme, NAI (4), Maximum GTI (15), Invalid GTI (253), Wild GTI (254).Reference: The Global Title Indicator is defined in the International Telecommunication Union standard Q.713: Specifications of Signalling System No. 7 - Signalling Connection Control Part (SCCP) section 3.4.1 Address Indicator. (0..255) · Unsigned32

The global title indicator value for the global tile address specified within the message signal unit. This object will default to value based on variant unless the 'gti' bit is set in cmlrSubTriggerParameters object.

CItpTcNumberingPlanThe SCCP GTT Numbering Plan (NP). The following values are generally used: Unknown NP (0), ISDN/Telephony NP (1), Spare (2), Data NP (3), Telex NP (4), Maritime Mobile NP (5), Land Mobile NP (6), ISDN/Mobile NP (7), Private NP (8). Max NP (15), Invalid NP (253), Wild NP (254). (0..255) · Integer32

The numbering plan of the specified global title address. This object will default to value based on variant unless the 'np' bit is set in cmlrSubTriggerParameters object.

CItpTcNAIThe SCCP GTT Network Address Indicator (NAI). The following values are generally used: Unknown Nature of Address (0), Subscriber Number (1), Reserved for national use (2), National Significant Number (3), International Number (4), Maximum NAI (127), Invalid NAI (253), Wild NAI (254). (0..255) · Integer32

The nature of specified address. This object will default to value based on variant unless the 'nai' bit is set in cmlrSubTriggerParameters object.

CItpTcPointCodeThe SS7 network node address as specified in the following references. The format of the Point code depends on the variant defined in the CgspSS7Variant object as follows. 33222222222211111111110000000000 10987654321098765432109876543210 ANSI: nnnnnnnn - Network cccccccc - Cluster mmmmmmmm - Member ITU: zzz - Zone aaaaaaaa - Area/Network iii - Identifier NTT: zzzzz - Zone aaaa - Area/Network iiiiiii - Identifier TTC: zzzzz - Zone aaaa - Area/Network iiiiiii - Identifier Note: The China variant has the same format as ANSI. This form of the point-code is not intended for for presentation.Reference: The SS7 network node address as specified in the International Telecommunication Union standard Q.708: Specifications of Signalling System No. 7 - Numbering of International Signalling Point Codes, and by ANSI T1.111.8 Numbering of Signalling Point Codes. GF 001-9001 - Technical Specifications of Signalling System No. 7 for National Telephone Network of China. (0..16777216) · Unsigned32

The point-code in variant-specific format. This object only has meaning when the 'pc' bit is set in the cmlrSubTriggerParameters object.

CItpTcSubSystemNumberThe SCCP Subsystem Number . A value of zero indicates that a subsystem is not specified. (0 | 2..255) · Unsigned32

The subsystem number to be matched when the when the 'pc' bit is set in the cmlrSubTriggerParameters object.

CItpTcNetworkNameThe network name is used to indicate the network in which this signalling point is participating. One or more instances of signalling points can exist in the same physical device. This identifier will be used to correlate instances of signalling points by network. When multiple instance support is not enable the network name will default to the null string. An octet string specified by an administrator that must be in human-readable form. The names must conform to the allowed characters that can be specified via Command Line Interface(CLI). The names cannot contain control character and should not contain leading or trailing white space. SIZE (0..19) · OCTET STRING

The network name is used to indicate the network in which the ruleset will be invoked. This object only has meaning when the 'network' bit is set in the cmlrSubTriggerParameters object.

CmlrRuleSetNameThe configured name used to identify a set of rules within an specified network. An octet string specified by an administrator that must be in human-readable form. The names must conform to the allowed characters that can be specified via Command Line Interface(CLI). The names cannot contain control character and should not contain leading or trailing white space. SIZE (0..20) · OCTET STRING

Specifies the ruleset table that should be used if the trigger is matched and not overruled by a secondary trigger ruleset. This object only has meaning when the 'ruleset' bit is set in the cmlrSubTriggerParameters object.

Counter32

Count of the number of times secondary trigger was matched.

RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of [2].) The status column has six defined values: - `active', which indicates that the conceptual row is available for use by the managed device; - `notInService', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device; - `notReady', which indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instanciated); - `createAndGo', which is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device; - `createAndWait', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device); and, - `destroy', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row. Whereas five of the six values (all except `notReady') may be specified in a management protocol set operation, only three values will be returned in response to a management protocol retrieval operation: `notReady', `notInService' or `active'. That is, when queried, an existing conceptual row has only three states: it is either available for use by the managed device (the status column has value `active'); it is not available for use by the managed device, though the agent has sufficient information to attempt to make it so (the status column has value `notInService'); or, it is not available for use by the managed device, and an attempt to make it so would fail because the agent has insufficient information (the state column has value `notReady'). NOTE WELL This textual convention may be used for a MIB table, irrespective of whether the values of that table's conceptual rows are able to be modified while it is active, or whether its conceptual rows must be taken out of service in order to be modified. That is, it is the responsibility of the DESCRIPTION clause of the status column to specify whether the status column must not be `active' in order for the value of some other column of the same conceptual row to be modified. If such a specification is made, affected columns may be changed by an SNMP set PDU if the RowStatus would not be equal to `active' either immediately before or after processing the PDU. In other words, if the PDU also contained a varbind that would change the RowStatus value, the column in question may be changed if the RowStatus was not equal to `active' as the PDU was received, or if the varbind sets the status to a value other than 'active'. Also note that whenever any elements of a row exist, the RowStatus column must also exist. To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram: STATE +--------------+-----------+-------------+------------- | A | B | C | D | |status col.|status column| |status column | is | is |status column ACTION |does not exist| notReady | notInService| is active --------------+--------------+-----------+-------------+------------- set status |noError ->D|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndGo |inconsistent- | | | | Value| | | --------------+--------------+-----------+-------------+------------- set status |noError see 1|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndWait |wrongValue | | | --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError column to | Value| entValue| | active | | | | | | or | | | | | | | |see 2 ->D|see 8 ->D| ->D --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError ->C column to | Value| entValue| | notInService | | | | | | or | | or | | | | | |see 3 ->C| ->C|see 6 --------------+--------------+-----------+-------------+------------- set status |noError |noError |noError |noError ->A column to | | | | or destroy | ->A| ->A| ->A|see 7 --------------+--------------+-----------+-------------+------------- set any other |see 4 |noError |noError |see 5 column to some| | | | value | | see 1| ->C| ->D --------------+--------------+-----------+-------------+------------- (1) goto B or C, depending on information available to the agent. (2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D. (3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C. (4) at the discretion of the agent, the return value may be either: inconsistentName: because the agent does not choose to create such an instance when the corresponding RowStatus instance does not exist, or inconsistentValue: if the supplied value is inconsistent with the state of some other MIB object's value, or noError: because the agent chooses to create the instance. If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A. (5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned. (6) the return value can indicate one of the following errors: wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated. (7) the return value can indicate the following error: inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated. (8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue. NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc. Conceptual Row Creation There are four potential interactions when creating a conceptual row: selecting an instance-identifier which is not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device. Interaction 1: Selecting an Instance-Identifier The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics. In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.) Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different. Finally, the management station could select a pseudo-random number to use as the index. In the event that this index was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation. A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used. Interaction 2: Creating the Conceptual Row Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions. Interaction 2a: Creating and Activating the Conceptual Row The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes: - a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'. When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information available to the agent is provided by two sources: the management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row. NOTE WELL Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm. Interaction 2b: Negotiating the Creation of the Conceptual Row The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the columns indicated by its column requirements.) Otherwise, the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3. Interaction 3: Initializing non-defaulted Objects The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes: - a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4. Interaction 4: Making the Conceptual Row Available Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'. NOTE WELL A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device. If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row. Conceptual Row Suspension When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified). Conceptual Row Deletion For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady', `notInService' or `active'.) If the operation succeeds, then all instances associated with the conceptual row are immediately removed. · Integer32

The object is used by a management station to create or delete the row entry in cmlrSubTriggerTable following the RowStatus textual convention.

CmlrNameThe configured name used to identify various tables used by MLR. An octet string specified by an administrator that must be in human-readable form. The names must conform to the allowed characters that can be specified via Command Line Interface(CLI). The names cannot contain control character and should not contain leading or trailing white space. SIZE (0..20) · OCTET STRING

A name used to define a collection of addresses used to route and modify messages signalling units.

CmlrAddressType1 = bch2 = gsmDaList of possible table types. 'bch' : Binary Coded Hexadecimal 'gsmDa' : GSM 7 bit Default Alphabet · Integer32

The type of addresses in the address tables. The different types will be used to determine how to format and convert cmlrAddressDigits.

CmlrAddressDigitsThe configured digits of A-address or B-address specified in the format indicated by CmlrAddressType. All values are entered in binary and represent digits All values are encoded as hexidecimal values and represent the following characters by address type are as follows. CmlrAddressType: 'bch' GSM: Encoding Character 0000-1001 0-9 1010 * 1011 # 1100 a 1101 b 1110 c 1111 filler ANSI-41 0000-1001 0-9 1010 Spare 1011 Code 11 1100 Code 12 1101 * 1110 # 1111 ST (or filler) CmlrAddressType: 'gmsDa' |0 0 0 0 1 1 1 1 b7 b b b b |0 0 1 1 0 0 1 1 b6 4 3 2 1 |0 1 0 1 0 1 0 1 b5 ----------------------------------- 0 0 0 0 |@ . SP 0 � P � p 0 0 0 1 |� _ ! 1 A Q a q 0 0 1 0 |$ F DQ 2 B R b r 0 0 1 1 |� G # 3 C S c s 0 1 0 0 |� . � 4 D T d t 0 1 0 1 |� . % 5 E U e u 0 1 1 0 |� . & 6 F V f v 0 1 1 1 |� . ' 7 G W g w 1 0 0 0 |� S ( 8 H X h x 1 0 0 1 |� T ) 9 I Y i y 1 0 1 0 |LF . * : J Z j z 1 0 1 1 |� 1) + ; K � k � 1 1 0 0 |� � , < L � l � 1 1 0 1 |CR � - = M � m � 1 1 1 0 |� � . > N � n . 1 1 1 1 |� � / ? O � o � 'SP' - Space 'LF' - Line Feed 'DQ' - Double quote '.' = Special characters outside standard ASCII See 6.2.1 GSM 7 bit Default Alphabet Table. The string will consists of N Octets were the first n-1 octets represent the hexadecimal address. The last Octet specifies the number of bits used to match the calling address. For example, when CmlrAddressType is Binary Coded Hexadecimal the following entries illustrate why the trailing number of match bits is required. '081000000000000000000C' match '081' '0810000000000000000010' match '0810'Reference: GSM 04.08 Table 10.5.118,ANSI T1.114.5 Figure 8 and ETSI TS 123 038 V5.0.0 (2002-03) SIZE (0..32) · OCTET STRING

The digits of the address in following formats as indicated by cmlrAddressType object. 'hexadecimal' - The digits are hexadecimal digits specified in ASCII as follows. '0123456789ABCDEF'

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

This object indicates that the address specified by cmlrAddressDigits object must exactly match value in message signalling unit. 'true' - Exact match is specified. 'false' - Best match is specified.

CmlrResultParametersIn order to specify the results of MLR statements different values in the packet can be modified. These values are determined by a combination of variant and operation type. This object indicates which objects will be used to form a result action as follows. 'network' : specifies network 'octet' : specifies octet string 'tranType' : specifies translation type 'gti' : specifies global title indicator 'np' : specifies numbering plan 'nai' : specifies nature of address 'pc' : specifies point-code 'ssn' : specifies subsystem number · BITS

Many of the result parameter used in the processing of address table have default values. These values are determined by a combination of variant and operation type. This object will be provide information which parameter used in setting results have been specified as follows. 'network' : cmlrAddressSetResultNetwork 'octet' : cmlrAddressSetResultOctet 'tranType' : cmlrAddressResultTransType 'gti' : cmlrAddressResultGti 'np' : cmlrAddressResultNp 'nai' : cmlrAddressResultNai 'pc' : cmlrAddressResultPc 'ssn' : cmlrAddressResultSsn

CItpTcNetworkNameThe network name is used to indicate the network in which this signalling point is participating. One or more instances of signalling points can exist in the same physical device. This identifier will be used to correlate instances of signalling points by network. When multiple instance support is not enable the network name will default to the null string. An octet string specified by an administrator that must be in human-readable form. The names must conform to the allowed characters that can be specified via Command Line Interface(CLI). The names cannot contain control character and should not contain leading or trailing white space. SIZE (0..19) · OCTET STRING

The network name is used to indicate the network in which the result operation will be performed.

CmlrResultType1 = none2 = asname3 = group4 = gt5 = pc6 = pcSsn7 = block8 = continue9 = address10 = rulesetList of possible result types. 'none' : Result not specified. 'asname' : Message will be routed to a particular destination M3UA or SUA Application Server(AS). 'group' : Message will be routed using information specified in result group. 'gt' : Message will be routed using SCCP global title. 'pc' : Message will be routed using the specified destination point code. 'pcSsn' : Message will be routed using the specified destination point code and subsystem number. 'block' : Message will be discarded. 'continue': Message signal units will be processed by the normal SCCP routing. 'address' : Address table will be search to allow MSU to be routed or modified based on address information. 'ruleset' : Message processed by ruleset to allow MSU to be routed or modified based on information specified in MSU. · Integer32

Specified the type of information to be placed into the message signal unit or how the it will be processed.

CmlrResultOctetAn octet string that contains various types of output from a rule set. The information in this object will be formatted as follows. CmlrResultType: None : Octet string with length of zero. asname : Application Server name formatted as CItpTcXuaName. group : Result group formatted as CmlrName. gt : The global title address formatted as CItpTcGtaLongDisplay pc : Not applicable. block : Octet string with length of zero. continue: Octet string with length of zero. address : The address table name specified by the cmlrAddressTableName object. ruleset : The ruleset table name specified by the cmlrRuleSetName object. An octet string specified by an administrator that must be in human-readable form. The names must conform to the allowed characters that can be specified via Command Line Interface(CLI). The names cannot contain control character and should not contain leading or trailing white space. SIZE (0..64 | 255) · OCTET STRING

Information to be placed in the message signal unit based on the value specified by the cmlrAddressSetResultType object. When the cmlrAddressSetResultType object is set to 'pc' or 'none' this object will not be used in the result processing and will have a length of zero.

CgsccpGttTransTypeThe SCCP GTT Translation Type (TT). (0..255) · Unsigned32

The translation type specified within the address in the message signal unit. This object only applies when the cmlrAddressSetResultType is set to 'gt' value.

CgsccpGttGlobalTitleIndThe SCCP GTT Global Title Indicator (GTI). The following values are generally used: No global title included (0), For ITU, GT includes NAI only (1), For ANSI, GT includes TT, NP and encoding scheme (1), GT includes only TT (2), GT includes TT, NP and encoding scheme (3), GT includes TT, NP, encoding scheme, NAI (4), Maximum GTI (15), Invalid GTI (253), Wild GTI (254).Reference: The Global Title Indicator is defined in the International Telecommunication Union standard Q.713: Specifications of Signalling System No. 7 - Signalling Connection Control Part (SCCP) section 3.4.1 Address Indicator. (0..255) · Unsigned32

The global title indicator value for the global tile address specified within the message signal unit. This object only applies when the cmlrAddressSetResultType is set to 'gt' value.

CItpTcNumberingPlanThe SCCP GTT Numbering Plan (NP). The following values are generally used: Unknown NP (0), ISDN/Telephony NP (1), Spare (2), Data NP (3), Telex NP (4), Maritime Mobile NP (5), Land Mobile NP (6), ISDN/Mobile NP (7), Private NP (8). Max NP (15), Invalid NP (253), Wild NP (254). (0..255) · Integer32

The numbering plan for the global tile address specified within the message signal unit. This object only applies when the cmlrAddressSetResultType is set to 'gt' value.

CItpTcNAIThe SCCP GTT Network Address Indicator (NAI). The following values are generally used: Unknown Nature of Address (0), Subscriber Number (1), Reserved for national use (2), National Significant Number (3), International Number (4), Maximum NAI (127), Invalid NAI (253), Wild NAI (254). (0..255) · Integer32

The nature of specified address for the global tile address specified within the message signal unit. This object only applies when the cmlrAddressSetResultType is set to 'gt' value.

CItpTcPointCodeThe SS7 network node address as specified in the following references. The format of the Point code depends on the variant defined in the CgspSS7Variant object as follows. 33222222222211111111110000000000 10987654321098765432109876543210 ANSI: nnnnnnnn - Network cccccccc - Cluster mmmmmmmm - Member ITU: zzz - Zone aaaaaaaa - Area/Network iii - Identifier NTT: zzzzz - Zone aaaa - Area/Network iiiiiii - Identifier TTC: zzzzz - Zone aaaa - Area/Network iiiiiii - Identifier Note: The China variant has the same format as ANSI. This form of the point-code is not intended for for presentation.Reference: The SS7 network node address as specified in the International Telecommunication Union standard Q.708: Specifications of Signalling System No. 7 - Numbering of International Signalling Point Codes, and by ANSI T1.111.8 Numbering of Signalling Point Codes. GF 001-9001 - Technical Specifications of Signalling System No. 7 for National Telephone Network of China. (0..16777216) · Unsigned32

The point-code to be place in the message signal unit. This object only applies when the cmlrAddressResultType is set to 'pc' value.

CItpTcSubSystemNumberThe SCCP Subsystem Number . A value of zero indicates that a subsystem is not specified. (0 | 2..255) · Unsigned32

The subsystem number to be place in the message signal unit. This object only applies when the cmlrAddressResultType is set to 'ssn' value.

Counter32

Count of the number of times address was matched. This counter is only incremented when rule matches.

RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of [2].) The status column has six defined values: - `active', which indicates that the conceptual row is available for use by the managed device; - `notInService', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device; - `notReady', which indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instanciated); - `createAndGo', which is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device; - `createAndWait', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device); and, - `destroy', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row. Whereas five of the six values (all except `notReady') may be specified in a management protocol set operation, only three values will be returned in response to a management protocol retrieval operation: `notReady', `notInService' or `active'. That is, when queried, an existing conceptual row has only three states: it is either available for use by the managed device (the status column has value `active'); it is not available for use by the managed device, though the agent has sufficient information to attempt to make it so (the status column has value `notInService'); or, it is not available for use by the managed device, and an attempt to make it so would fail because the agent has insufficient information (the state column has value `notReady'). NOTE WELL This textual convention may be used for a MIB table, irrespective of whether the values of that table's conceptual rows are able to be modified while it is active, or whether its conceptual rows must be taken out of service in order to be modified. That is, it is the responsibility of the DESCRIPTION clause of the status column to specify whether the status column must not be `active' in order for the value of some other column of the same conceptual row to be modified. If such a specification is made, affected columns may be changed by an SNMP set PDU if the RowStatus would not be equal to `active' either immediately before or after processing the PDU. In other words, if the PDU also contained a varbind that would change the RowStatus value, the column in question may be changed if the RowStatus was not equal to `active' as the PDU was received, or if the varbind sets the status to a value other than 'active'. Also note that whenever any elements of a row exist, the RowStatus column must also exist. To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram: STATE +--------------+-----------+-------------+------------- | A | B | C | D | |status col.|status column| |status column | is | is |status column ACTION |does not exist| notReady | notInService| is active --------------+--------------+-----------+-------------+------------- set status |noError ->D|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndGo |inconsistent- | | | | Value| | | --------------+--------------+-----------+-------------+------------- set status |noError see 1|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndWait |wrongValue | | | --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError column to | Value| entValue| | active | | | | | | or | | | | | | | |see 2 ->D|see 8 ->D| ->D --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError ->C column to | Value| entValue| | notInService | | | | | | or | | or | | | | | |see 3 ->C| ->C|see 6 --------------+--------------+-----------+-------------+------------- set status |noError |noError |noError |noError ->A column to | | | | or destroy | ->A| ->A| ->A|see 7 --------------+--------------+-----------+-------------+------------- set any other |see 4 |noError |noError |see 5 column to some| | | | value | | see 1| ->C| ->D --------------+--------------+-----------+-------------+------------- (1) goto B or C, depending on information available to the agent. (2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D. (3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C. (4) at the discretion of the agent, the return value may be either: inconsistentName: because the agent does not choose to create such an instance when the corresponding RowStatus instance does not exist, or inconsistentValue: if the supplied value is inconsistent with the state of some other MIB object's value, or noError: because the agent chooses to create the instance. If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A. (5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned. (6) the return value can indicate one of the following errors: wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated. (7) the return value can indicate the following error: inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated. (8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue. NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc. Conceptual Row Creation There are four potential interactions when creating a conceptual row: selecting an instance-identifier which is not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device. Interaction 1: Selecting an Instance-Identifier The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics. In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.) Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different. Finally, the management station could select a pseudo-random number to use as the index. In the event that this index was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation. A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used. Interaction 2: Creating the Conceptual Row Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions. Interaction 2a: Creating and Activating the Conceptual Row The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes: - a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'. When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information available to the agent is provided by two sources: the management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row. NOTE WELL Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm. Interaction 2b: Negotiating the Creation of the Conceptual Row The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the columns indicated by its column requirements.) Otherwise, the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3. Interaction 3: Initializing non-defaulted Objects The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes: - a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4. Interaction 4: Making the Conceptual Row Available Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'. NOTE WELL A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device. If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row. Conceptual Row Suspension When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified). Conceptual Row Deletion For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady', `notInService' or `active'.) If the operation succeeds, then all instances associated with the conceptual row are immediately removed. · Integer32

The object is used by a management station to create or delete the row entry in cmlrAddressTable following the RowStatus textual convention.

CmlrRuleSetNameThe configured name used to identify a set of rules within an specified network. An octet string specified by an administrator that must be in human-readable form. The names must conform to the allowed characters that can be specified via Command Line Interface(CLI). The names cannot contain control character and should not contain leading or trailing white space. SIZE (0..20) · OCTET STRING

A name used to define a set rules used to transform traffic.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

This object indicates whether segmented messages will be processed by rules contained in this ruleset. 'true' - Segmented messages will be processed. 'false' - Segmented messages will not be processed.

CmlrRuleProtocol1 = none2 = gsmMap3 = ansi41The list of possible protocol types. 'none' : Protocol not specified and will default to value based on variant or other configuration information. 'gsmMap' : Global system for mobile communications Mobile Application Part operations should be matched by this rule. 'ansi41' : Indicates that only ANSI-41 operations should be matched by this rule. · Integer32

The object is used to establish a default protocol type for all rules within the rule set. If this object is set to 'none' will default to protocol specified by variant.

INTEGER1 = seq2 = bestMatch · Integer32

Defines how the rules with the ruleset will be search as follows. 'seq' : Rules will be processed in ascending order based on the value of the cmlrRuleNumber object 'bestMatch' : Rules will be processed using a combination of operation and order number to reduce cost of locating rule providing best match.

DateAndTimeA date-time specification. field octets contents range ----- ------ -------- ----- 1 1-2 year* 0..65536 2 3 month 1..12 3 4 day 1..31 4 5 hour 0..23 5 6 minutes 0..59 6 7 seconds 0..60 (use 60 for leap-second) 7 8 deci-seconds 0..9 8 9 direction from UTC '+' / '-' 9 10 hours from UTC* 0..13 10 11 minutes from UTC 0..59 * Notes: - the value of year is in network-byte order - daylight saving time in New Zealand is +13 For example, Tuesday May 26, 1992 at 1:30:15 PM EDT would be displayed as: 1992-5-26,13:30:15.0,-4:0 Note that if only local time is known, then timezone information (fields 8-10) is not present. SIZE (8 | 11) · OCTET STRING · hint 2d-1d-1d,1d:1d:1d.1d,1a1d:1d

The local date and time when this trigger and sub-triggers will become active. When the value is null then the cmlrInstStartDateAndTime does not apply.

DateAndTimeA date-time specification. field octets contents range ----- ------ -------- ----- 1 1-2 year* 0..65536 2 3 month 1..12 3 4 day 1..31 4 5 hour 0..23 5 6 minutes 0..59 6 7 seconds 0..60 (use 60 for leap-second) 7 8 deci-seconds 0..9 8 9 direction from UTC '+' / '-' 9 10 hours from UTC* 0..13 10 11 minutes from UTC 0..59 * Notes: - the value of year is in network-byte order - daylight saving time in New Zealand is +13 For example, Tuesday May 26, 1992 at 1:30:15 PM EDT would be displayed as: 1992-5-26,13:30:15.0,-4:0 Note that if only local time is known, then timezone information (fields 8-10) is not present. SIZE (8 | 11) · OCTET STRING · hint 2d-1d-1d,1d:1d:1d.1d,1a1d:1d

The local date and time this trigger and sub-triggers will become inactive. When the value is null then the cmlrInstEndDateAndTime does not apply.

RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of [2].) The status column has six defined values: - `active', which indicates that the conceptual row is available for use by the managed device; - `notInService', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device; - `notReady', which indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instanciated); - `createAndGo', which is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device; - `createAndWait', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device); and, - `destroy', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row. Whereas five of the six values (all except `notReady') may be specified in a management protocol set operation, only three values will be returned in response to a management protocol retrieval operation: `notReady', `notInService' or `active'. That is, when queried, an existing conceptual row has only three states: it is either available for use by the managed device (the status column has value `active'); it is not available for use by the managed device, though the agent has sufficient information to attempt to make it so (the status column has value `notInService'); or, it is not available for use by the managed device, and an attempt to make it so would fail because the agent has insufficient information (the state column has value `notReady'). NOTE WELL This textual convention may be used for a MIB table, irrespective of whether the values of that table's conceptual rows are able to be modified while it is active, or whether its conceptual rows must be taken out of service in order to be modified. That is, it is the responsibility of the DESCRIPTION clause of the status column to specify whether the status column must not be `active' in order for the value of some other column of the same conceptual row to be modified. If such a specification is made, affected columns may be changed by an SNMP set PDU if the RowStatus would not be equal to `active' either immediately before or after processing the PDU. In other words, if the PDU also contained a varbind that would change the RowStatus value, the column in question may be changed if the RowStatus was not equal to `active' as the PDU was received, or if the varbind sets the status to a value other than 'active'. Also note that whenever any elements of a row exist, the RowStatus column must also exist. To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram: STATE +--------------+-----------+-------------+------------- | A | B | C | D | |status col.|status column| |status column | is | is |status column ACTION |does not exist| notReady | notInService| is active --------------+--------------+-----------+-------------+------------- set status |noError ->D|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndGo |inconsistent- | | | | Value| | | --------------+--------------+-----------+-------------+------------- set status |noError see 1|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndWait |wrongValue | | | --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError column to | Value| entValue| | active | | | | | | or | | | | | | | |see 2 ->D|see 8 ->D| ->D --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError ->C column to | Value| entValue| | notInService | | | | | | or | | or | | | | | |see 3 ->C| ->C|see 6 --------------+--------------+-----------+-------------+------------- set status |noError |noError |noError |noError ->A column to | | | | or destroy | ->A| ->A| ->A|see 7 --------------+--------------+-----------+-------------+------------- set any other |see 4 |noError |noError |see 5 column to some| | | | value | | see 1| ->C| ->D --------------+--------------+-----------+-------------+------------- (1) goto B or C, depending on information available to the agent. (2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D. (3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C. (4) at the discretion of the agent, the return value may be either: inconsistentName: because the agent does not choose to create such an instance when the corresponding RowStatus instance does not exist, or inconsistentValue: if the supplied value is inconsistent with the state of some other MIB object's value, or noError: because the agent chooses to create the instance. If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A. (5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned. (6) the return value can indicate one of the following errors: wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated. (7) the return value can indicate the following error: inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated. (8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue. NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc. Conceptual Row Creation There are four potential interactions when creating a conceptual row: selecting an instance-identifier which is not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device. Interaction 1: Selecting an Instance-Identifier The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics. In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.) Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different. Finally, the management station could select a pseudo-random number to use as the index. In the event that this index was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation. A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used. Interaction 2: Creating the Conceptual Row Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions. Interaction 2a: Creating and Activating the Conceptual Row The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes: - a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'. When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information available to the agent is provided by two sources: the management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row. NOTE WELL Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm. Interaction 2b: Negotiating the Creation of the Conceptual Row The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the columns indicated by its column requirements.) Otherwise, the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3. Interaction 3: Initializing non-defaulted Objects The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes: - a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4. Interaction 4: Making the Conceptual Row Available Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'. NOTE WELL A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device. If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row. Conceptual Row Suspension When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified). Conceptual Row Deletion For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady', `notInService' or `active'.) If the operation succeeds, then all instances associated with the conceptual row are immediately removed. · Integer32

The object is used by a management station to create or delete the row entry in cmlrRuleSetTable following the RowStatus textual convention.

CmlrIdA numeric identifier used to specify an entry in a list. Zero is a special value used to indicate no entry. (0..65535) · Unsigned32

This object specifies the index for a list of secondary triggers specified per routing table. The trigger will be processed in ascending order.

INTEGER0 = unknown1 = alertSc2 = smdPp3 = smsMo4 = smsMt5 = smsReg6 = sriSm7 = smsNotify255 = all · Integer32

The list of possible operation types. 'unknown' : undefined operation type. 'alertSc' : Used to identify AlertServiceCenter request messages in GSM MAP. 'smdPp' : Used to identify SMS DeliveryPointToPoint request messages for the GSM MAP and ANSI-41. 'smsMo' : Used to identify SMS MO request messages for the GSM MAP and ANSI-41. 'smsMt' : Used to identify SMS MT request messages for the GSM MAP and ANSI-41. 'smsReq' : Used to identify the SMSRequest request messages within ANSI-41. 'sriSm' : Used to identify SRI SM request messages in GSM MAP and SMSRequest messages in ANSI-41. 'smsNotify' : Used to identify Alert Service Center messages in GSM MAP and SMSNotification messages in ANSI-41. 'all' : Used to identify a match of any valid operation code.

CmlrRuleProtocol1 = none2 = gsmMap3 = ansi41The list of possible protocol types. 'none' : Protocol not specified and will default to value based on variant or other configuration information. 'gsmMap' : Global system for mobile communications Mobile Application Part operations should be matched by this rule. 'ansi41' : Indicates that only ANSI-41 operations should be matched by this rule. · Integer32

Protocol used to examine message. 'none' : Will use protocol specified in cmlrRuleSetProtocol object. 'gsmMap' : Global system for mobile communications Mobile Application Part operations should be matched by this rule. 'is41' : Indicates that only ANSI-41 operations should be matched by this rule.

BITS

Many of the parameter used in the processing of rules have default values. These values are determined by a combination of variant and operation type. This object will be provide information which parameter has been specified as follows. 'destPort' : Indicates that the destination Port number is specified in the cmlrRuleDestPort object. 'destSmeGta' : Indicates that a global title address is specified in the cmlrRuleDestSmeGta object. 'destSmeExact': Indicates that the cmlrRuleDestSmeGta address must be an exact match. 'destSmeNai' : Indicates that the nature of specified address is specified in the cmlrRuleDestSmeNai object. 'destSmeNp' : Indicates that the numbering plan is specified in the cmlrRuleDestSmeNp object. 'destSmeImsi' : Indicates that the address specified in the International Mobile Subscriber Identification address. This indicator applies to the cmlrRuleDestSmeGta object. 'destSmeMin' : Indicates that the address specified in the Mobile Identification Number. This indicator applies to the cmlrRuleDestSmeGta object. 'destSmscGta' : Indicates that a global title address is specified in the cmlrRuleDestSmscGta object. 'destSmscExact':Indicates that the cmlrRuleDestSmscGta address must be an exact match. 'destSmscNai' : Indicates that the nature of specified address is specified in the cmlrRuleDestSmscNai object. 'destSmscNp' : Indicates that the numbering plan is specified in the cmlrRuleDestSmscNp object. 'origSmeGta' : Indicates that a global title address is specified in the cmlrRuleOrigSmeGta object. 'origSmeExact': Indicates that the cmlrRuleOrigSmeGta address must be an exact match. 'origSmeNai' : Indicates that the nature of specified address is specified in the cmlrRuleOrigSmeNai object. 'origSmeNp' : Indicates that the numbering plan is specified in the cmlrRuleOrigSmeNp object. 'origSmscGta' : Indicates that a global title address is specified in the cmlrRuleOrigSmscGta object. 'origSmscExact':Indicates that the cmlrRuleOrigSmeGta address must be an exact match. 'origSmscNai' : Indicates that the nature of specified address is specified in the cmlrRuleOrigSmscNai object. 'origSmscNp' : Indicates that the numbering plan is specified in the cmlrRuleOrigSmscNp object. 'pid' : Indicates that the Protocol Identifier has been specified in the cmlrRuleProtocolId object. 'tid' : Indicates that the Teleservice Identifier has been specified in the cmlrRuleTeleserviceId object. 'default' : Indicates the processing of messages that match the specified operation_name only. 'destSmeTable': A table of destination short message entity addresses. The name of the table is specified in the cmlrRuleAddressTable object. 'origSmeTable': A table of origination short message entity addresses. The name of the table is specified in the cmlrRuleOrigAddressTable object. 'destSmeMinDigits' : Minimum number global title address digits specified in the cmlrRuleDestSmeGta object using the cmlrRuleDestSmeMinDigits object. 'destSmeMaxDigits' : Maximum number global title address digits specified in the cmlrRuleDestSmeGta object using the cmlrRuleDestSmeMaxDigits object. 'destSmeTableImsi' : Indicates that the addresses specified in the cmlrRuleAddressTable are International Mobile Subscriber Identification addresses. 'destSmeTableNai' : Indicates that the all nature of specified address is specified in the cmlrRuleDestSmeTableNai object. 'destSmeTableNp' : Indicates that the numbering plan is specified in the cmlrRuleDestSmeTableNp object. 'destSmscMinDigits' : Minimum number global title address digits specified in the cmlrRuleDestSmscGta object using the cmlrRuleDestSmscMinDigits object. 'destSmscMaxDigits' : Maximum number global title address digits specified in the cmlrRuleDestSmscGta object using the cmlrRuleDestSmscMaxDigits object. 'origSmeMinDigits' : Minimum number global title address digits specified in the cmlrRuleOrigSmeGta object using the cmlrRuleOrigSmeMinDigits object. 'origSmeMaxDigits' : Maximum number global title address digits specified in the cmlrRuleOrigSmeGta object using the cmlrRuleOrigSmeMaxDigits object. 'origSmeTableNai' : Indicates that the all nature of specified address is specified in the cmlrRuleOrigSmeTableNai object. 'origSmeTableNp' : Indicates that the numbering plan is specified in the cmlrRuleOrigSmeTableNp object. 'origImsiGta' : Indicates that a global title address is specified in the cmlrRuleDestSmeGta object. 'origImsiExact' : Indicates that the cmlrRuleDestSmeGta address must be an exact match. 'origImsiNai' : Indicates that the nature of specified address is specified in the cmlrRuleDestSmeNai object. 'origImsiNp' : Indicates that the numbering plan is specified in the cmlrRuleDestSmeNp object. 'origImsiMinDigits' : Minimum number global title address digits specified in the cmlrRuleOrigImsiGta object using the cmlrRuleOrigImsiMinDigits object. 'origImsiMaxDigits' : Maximum number global title address digits specified in the cmlrRuleOrigImsiGta object using the cmlrRuleOrigImsiMaxDigits object. 'origImsiUnknown' : Indicates that the rule can match when packets do not contain the origination IMSI address. That is, when the address is unknown or unspecified. The IMSI address is only specified in map version 3. Therefore, the packets using version 1 or 2 when match when this parameter is specified. 'origImsiTable' : A table of origination IMSI addresses. The name of the table is specified in the cmlrRuleOrigImsiTable object. 'origSmscMinDigits' : Minimum number global title address digits specified in the cmlrRuleOrigSmscGta object using the cmlrRuleOrigSmscMinDigits object. 'origSmscMaxDigits' : Maximum number global title address digits specified in the cmlrRuleOrigSmscGta object using the cmlrRuleOrigSmscMaxDigits object. 'multiMessageDialog' : Indicates that this rules applies to packet that are part of multiple message dialogs.

Unsigned32 (0..65535)

A destination application port number. The value of the port number maps to the values specified in the User Data Header (UDH) of the SMS message. This object only applies when the 'destPort' bit is set in the cmlrRuleInputParameters object.

CItpTcGtaLongDisplayThe configured digits in the SCCP GTT Global Title Address. It consists of ASCII representation of GTA hex digits. SIZE (0..64) · OCTET STRING

The destination short message entity global title address. When the length of the global title address is zero it specified a wildcard match and all global title will match GTA clause of rule. This object only applies when the 'destSmeGta' bit is set in the cmlrRuleInputParameters object.

CItpTcNAIThe SCCP GTT Network Address Indicator (NAI). The following values are generally used: Unknown Nature of Address (0), Subscriber Number (1), Reserved for national use (2), National Significant Number (3), International Number (4), Maximum NAI (127), Invalid NAI (253), Wild NAI (254). (0..255) · Integer32

The nature of specified address for the destination short message entity global title address specified within the message signal unit. This object only applies when the 'destSmeNai' bit is set in the cmlrRuleInputParameters object.

CItpTcNumberingPlanThe SCCP GTT Numbering Plan (NP). The following values are generally used: Unknown NP (0), ISDN/Telephony NP (1), Spare (2), Data NP (3), Telex NP (4), Maritime Mobile NP (5), Land Mobile NP (6), ISDN/Mobile NP (7), Private NP (8). Max NP (15), Invalid NP (253), Wild NP (254). (0..255) · Integer32

The numbering plan for the destination short message entity global title address specified within the message signal unit. This object only applies when the 'destSmeNp' bit is set in the cmlrRuleInputParameters object.

CItpTcGtaLongDisplayThe configured digits in the SCCP GTT Global Title Address. It consists of ASCII representation of GTA hex digits. SIZE (0..64) · OCTET STRING

The destination short message service center global title address. When the length of the global title address is zero it specified a wildcard match and all global title will match GTA clause of rule. This object only applies when the 'destSmscGta' bit is set in the cmlrRuleInputParameters object.

CItpTcNAIThe SCCP GTT Network Address Indicator (NAI). The following values are generally used: Unknown Nature of Address (0), Subscriber Number (1), Reserved for national use (2), National Significant Number (3), International Number (4), Maximum NAI (127), Invalid NAI (253), Wild NAI (254). (0..255) · Integer32

The nature of specified address for the destination short message service center global title address specified within the message signal unit. This object only applies when the 'destSmscNai' bit is set in the cmlrRuleInputParameters object.

CItpTcNumberingPlanThe SCCP GTT Numbering Plan (NP). The following values are generally used: Unknown NP (0), ISDN/Telephony NP (1), Spare (2), Data NP (3), Telex NP (4), Maritime Mobile NP (5), Land Mobile NP (6), ISDN/Mobile NP (7), Private NP (8). Max NP (15), Invalid NP (253), Wild NP (254). (0..255) · Integer32

The numbering plan for the destination short message service center global title address specified within the message signal unit. This object only applies when the 'destSmscNp' bit is set in the cmlrRuleInputParameters object.

CItpTcGtaLongDisplayThe configured digits in the SCCP GTT Global Title Address. It consists of ASCII representation of GTA hex digits. SIZE (0..64) · OCTET STRING

The origination short message entity global title address. When the length of the global title address is zero it specified a wildcard match and all global title will match GTA clause of rule. This object only applies when the 'origSmeGta' bit is set in the cmlrRuleInputParameters object.

CItpTcNAIThe SCCP GTT Network Address Indicator (NAI). The following values are generally used: Unknown Nature of Address (0), Subscriber Number (1), Reserved for national use (2), National Significant Number (3), International Number (4), Maximum NAI (127), Invalid NAI (253), Wild NAI (254). (0..255) · Integer32

The nature of specified address for the origination short message entity global title address specified within the message signal unit. This object only applies when the 'origSmeNai' bit is set in the cmlrRuleInputParameters object.

CItpTcNumberingPlanThe SCCP GTT Numbering Plan (NP). The following values are generally used: Unknown NP (0), ISDN/Telephony NP (1), Spare (2), Data NP (3), Telex NP (4), Maritime Mobile NP (5), Land Mobile NP (6), ISDN/Mobile NP (7), Private NP (8). Max NP (15), Invalid NP (253), Wild NP (254). (0..255) · Integer32

The numbering plan for the origination short message entity global title address specified within the message signal unit. This object only applies when the 'origSmeNp' bit is set in the cmlrRuleInputParameters object.

CItpTcGtaLongDisplayThe configured digits in the SCCP GTT Global Title Address. It consists of ASCII representation of GTA hex digits. SIZE (0..64) · OCTET STRING

The origination short message service center global title address. When the length of the global title address is zero it specified a wildcard match and all global title will match GTA clause of rule. This object only applies when the 'origSmscGta' bit is set in the cmlrRuleInputParameters object.

CItpTcNAIThe SCCP GTT Network Address Indicator (NAI). The following values are generally used: Unknown Nature of Address (0), Subscriber Number (1), Reserved for national use (2), National Significant Number (3), International Number (4), Maximum NAI (127), Invalid NAI (253), Wild NAI (254). (0..255) · Integer32

The nature of specified address for the origination short message service center global title address specified within the message signal unit. This object only applies when the 'origSmscNai' bit is set in the cmlrRuleInputParameters object.

CItpTcNumberingPlanThe SCCP GTT Numbering Plan (NP). The following values are generally used: Unknown NP (0), ISDN/Telephony NP (1), Spare (2), Data NP (3), Telex NP (4), Maritime Mobile NP (5), Land Mobile NP (6), ISDN/Mobile NP (7), Private NP (8). Max NP (15), Invalid NP (253), Wild NP (254). (0..255) · Integer32

The numbering plan for the origination short message service center global title address specified within the message signal unit. This object only applies when the 'origSmscNp' bit is set in the cmlrRuleInputParameters object.

Unsigned32 (0..255)

The protocol identifier value used for the 'smsMo and 'smsMt' operations specified by the cmlrRuleParmsOperationType object. The value of the cmlrRuleParmsMatchPid object maps to the values specified for the TP-PID SMS parameter. This object only applies when the 'pid' bit is set in the cmlrRuleInputParameters object.

Unsigned32 (0..65535)

The Teleservice identifier value for the following types of operations specified by the cmlrRuleParmsOperationType object. 'smdPp' 'smsMo' 'smsMt' 'smsNotify' The value of the cmlrRuleParmsMatchTid object maps to the values specified for the SMS_TeleserviceIdentifier parameter in ANSI-41. This object only applies when the 'tid' bit is set in the cmlrRuleInputParameters object.

CmlrNameThe configured name used to identify various tables used by MLR. An octet string specified by an administrator that must be in human-readable form. The names must conform to the allowed characters that can be specified via Command Line Interface(CLI). The names cannot contain control character and should not contain leading or trailing white space. SIZE (0..20) · OCTET STRING

The name of the entry in the cmlrAddressTable that will be searched for matches. The table will be search for the following types of addresses based on values set in the cmlrRuleInputParameters object. This object only applies when the 'destSmeTable' bit is set in the cmlrRuleInputParameters object.

CmlrResultParametersIn order to specify the results of MLR statements different values in the packet can be modified. These values are determined by a combination of variant and operation type. This object indicates which objects will be used to form a result action as follows. 'network' : specifies network 'octet' : specifies octet string 'tranType' : specifies translation type 'gti' : specifies global title indicator 'np' : specifies numbering plan 'nai' : specifies nature of address 'pc' : specifies point-code 'ssn' : specifies subsystem number · BITS

Many of the parameter used in the processing of rules have default values. These values are determined by a combination of variant and operation type. This object will be provide information on which parameter have been specified as follows. 'network' : cmlrRuleSetResultNetwork 'octet' : cmlrRuleSetResultOctet 'tranType' : cmlrRuleResultTransType 'gti' : cmlrRuleResultGti 'np' : cmlrRuleResultNp 'nai' : cmlrRuleResultNai 'pc' : cmlrRuleResultPc 'ssn' : cmlrRuleResultSsn

CItpTcNetworkNameThe network name is used to indicate the network in which this signalling point is participating. One or more instances of signalling points can exist in the same physical device. This identifier will be used to correlate instances of signalling points by network. When multiple instance support is not enable the network name will default to the null string. An octet string specified by an administrator that must be in human-readable form. The names must conform to the allowed characters that can be specified via Command Line Interface(CLI). The names cannot contain control character and should not contain leading or trailing white space. SIZE (0..19) · OCTET STRING

The network name is used to indicate the network in which the result operation will be performed.

CmlrResultType1 = none2 = asname3 = group4 = gt5 = pc6 = pcSsn7 = block8 = continue9 = address10 = rulesetList of possible result types. 'none' : Result not specified. 'asname' : Message will be routed to a particular destination M3UA or SUA Application Server(AS). 'group' : Message will be routed using information specified in result group. 'gt' : Message will be routed using SCCP global title. 'pc' : Message will be routed using the specified destination point code. 'pcSsn' : Message will be routed using the specified destination point code and subsystem number. 'block' : Message will be discarded. 'continue': Message signal units will be processed by the normal SCCP routing. 'address' : Address table will be search to allow MSU to be routed or modified based on address information. 'ruleset' : Message processed by ruleset to allow MSU to be routed or modified based on information specified in MSU. · Integer32

Specified the type of information to be placed into the message signal unit or how the it will be processed.

CmlrResultOctetAn octet string that contains various types of output from a rule set. The information in this object will be formatted as follows. CmlrResultType: None : Octet string with length of zero. asname : Application Server name formatted as CItpTcXuaName. group : Result group formatted as CmlrName. gt : The global title address formatted as CItpTcGtaLongDisplay pc : Not applicable. block : Octet string with length of zero. continue: Octet string with length of zero. address : The address table name specified by the cmlrAddressTableName object. ruleset : The ruleset table name specified by the cmlrRuleSetName object. An octet string specified by an administrator that must be in human-readable form. The names must conform to the allowed characters that can be specified via Command Line Interface(CLI). The names cannot contain control character and should not contain leading or trailing white space. SIZE (0..64 | 255) · OCTET STRING

Information to be placed in the message signal unit based on the value specified by the cmlrRuleSetResultType object. When the cmlrRuleSetResultType object is set to 'pc' or 'none' this object will not be used in the result processing and will have a length of zero.

CgsccpGttTransTypeThe SCCP GTT Translation Type (TT). (0..255) · Unsigned32

The translation type specified within the address in the message signal unit. This object only applies when the cmlrRuleSetResultType is set to 'gt' value.

CgsccpGttGlobalTitleIndThe SCCP GTT Global Title Indicator (GTI). The following values are generally used: No global title included (0), For ITU, GT includes NAI only (1), For ANSI, GT includes TT, NP and encoding scheme (1), GT includes only TT (2), GT includes TT, NP and encoding scheme (3), GT includes TT, NP, encoding scheme, NAI (4), Maximum GTI (15), Invalid GTI (253), Wild GTI (254).Reference: The Global Title Indicator is defined in the International Telecommunication Union standard Q.713: Specifications of Signalling System No. 7 - Signalling Connection Control Part (SCCP) section 3.4.1 Address Indicator. (0..255) · Unsigned32

The global title indicator value for the global tile address specified within the message signal unit. This object only applies when the cmlrRuleSetResultType is set to 'gt' value.

CItpTcNumberingPlanThe SCCP GTT Numbering Plan (NP). The following values are generally used: Unknown NP (0), ISDN/Telephony NP (1), Spare (2), Data NP (3), Telex NP (4), Maritime Mobile NP (5), Land Mobile NP (6), ISDN/Mobile NP (7), Private NP (8). Max NP (15), Invalid NP (253), Wild NP (254). (0..255) · Integer32

The numbering plan for the global tile address specified within the message signal unit. This object only applies when the cmlrRuleSetResultType is set to 'gt' value.

CItpTcNAIThe SCCP GTT Network Address Indicator (NAI). The following values are generally used: Unknown Nature of Address (0), Subscriber Number (1), Reserved for national use (2), National Significant Number (3), International Number (4), Maximum NAI (127), Invalid NAI (253), Wild NAI (254). (0..255) · Integer32

The nature of specified address for the global tile address specified within the message signal unit. This object only applies when the cmlrRuleSetResultType is set to 'gt' value.

CItpTcPointCodeThe SS7 network node address as specified in the following references. The format of the Point code depends on the variant defined in the CgspSS7Variant object as follows. 33222222222211111111110000000000 10987654321098765432109876543210 ANSI: nnnnnnnn - Network cccccccc - Cluster mmmmmmmm - Member ITU: zzz - Zone aaaaaaaa - Area/Network iii - Identifier NTT: zzzzz - Zone aaaa - Area/Network iiiiiii - Identifier TTC: zzzzz - Zone aaaa - Area/Network iiiiiii - Identifier Note: The China variant has the same format as ANSI. This form of the point-code is not intended for for presentation.Reference: The SS7 network node address as specified in the International Telecommunication Union standard Q.708: Specifications of Signalling System No. 7 - Numbering of International Signalling Point Codes, and by ANSI T1.111.8 Numbering of Signalling Point Codes. GF 001-9001 - Technical Specifications of Signalling System No. 7 for National Telephone Network of China. (0..16777216) · Unsigned32

The point-code to be place in the message signal unit. This object only applies when the cmlrRuleResultType is set to 'pc' value.

CItpTcSubSystemNumberThe SCCP Subsystem Number . A value of zero indicates that a subsystem is not specified. (0 | 2..255) · Unsigned32

The subsytem number to be place in the message signal unit. This object only applies when the cmlrRuleResultType is set to 'ssn' value.

Counter32

Count of the number of times this rule was matched.

RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of [2].) The status column has six defined values: - `active', which indicates that the conceptual row is available for use by the managed device; - `notInService', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device; - `notReady', which indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instanciated); - `createAndGo', which is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device; - `createAndWait', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device); and, - `destroy', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row. Whereas five of the six values (all except `notReady') may be specified in a management protocol set operation, only three values will be returned in response to a management protocol retrieval operation: `notReady', `notInService' or `active'. That is, when queried, an existing conceptual row has only three states: it is either available for use by the managed device (the status column has value `active'); it is not available for use by the managed device, though the agent has sufficient information to attempt to make it so (the status column has value `notInService'); or, it is not available for use by the managed device, and an attempt to make it so would fail because the agent has insufficient information (the state column has value `notReady'). NOTE WELL This textual convention may be used for a MIB table, irrespective of whether the values of that table's conceptual rows are able to be modified while it is active, or whether its conceptual rows must be taken out of service in order to be modified. That is, it is the responsibility of the DESCRIPTION clause of the status column to specify whether the status column must not be `active' in order for the value of some other column of the same conceptual row to be modified. If such a specification is made, affected columns may be changed by an SNMP set PDU if the RowStatus would not be equal to `active' either immediately before or after processing the PDU. In other words, if the PDU also contained a varbind that would change the RowStatus value, the column in question may be changed if the RowStatus was not equal to `active' as the PDU was received, or if the varbind sets the status to a value other than 'active'. Also note that whenever any elements of a row exist, the RowStatus column must also exist. To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram: STATE +--------------+-----------+-------------+------------- | A | B | C | D | |status col.|status column| |status column | is | is |status column ACTION |does not exist| notReady | notInService| is active --------------+--------------+-----------+-------------+------------- set status |noError ->D|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndGo |inconsistent- | | | | Value| | | --------------+--------------+-----------+-------------+------------- set status |noError see 1|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndWait |wrongValue | | | --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError column to | Value| entValue| | active | | | | | | or | | | | | | | |see 2 ->D|see 8 ->D| ->D --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError ->C column to | Value| entValue| | notInService | | | | | | or | | or | | | | | |see 3 ->C| ->C|see 6 --------------+--------------+-----------+-------------+------------- set status |noError |noError |noError |noError ->A column to | | | | or destroy | ->A| ->A| ->A|see 7 --------------+--------------+-----------+-------------+------------- set any other |see 4 |noError |noError |see 5 column to some| | | | value | | see 1| ->C| ->D --------------+--------------+-----------+-------------+------------- (1) goto B or C, depending on information available to the agent. (2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D. (3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C. (4) at the discretion of the agent, the return value may be either: inconsistentName: because the agent does not choose to create such an instance when the corresponding RowStatus instance does not exist, or inconsistentValue: if the supplied value is inconsistent with the state of some other MIB object's value, or noError: because the agent chooses to create the instance. If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A. (5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned. (6) the return value can indicate one of the following errors: wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated. (7) the return value can indicate the following error: inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated. (8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue. NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc. Conceptual Row Creation There are four potential interactions when creating a conceptual row: selecting an instance-identifier which is not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device. Interaction 1: Selecting an Instance-Identifier The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics. In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.) Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different. Finally, the management station could select a pseudo-random number to use as the index. In the event that this index was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation. A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used. Interaction 2: Creating the Conceptual Row Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions. Interaction 2a: Creating and Activating the Conceptual Row The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes: - a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'. When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information available to the agent is provided by two sources: the management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row. NOTE WELL Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm. Interaction 2b: Negotiating the Creation of the Conceptual Row The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the columns indicated by its column requirements.) Otherwise, the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3. Interaction 3: Initializing non-defaulted Objects The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes: - a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4. Interaction 4: Making the Conceptual Row Available Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'. NOTE WELL A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device. If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row. Conceptual Row Suspension When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified). Conceptual Row Deletion For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady', `notInService' or `active'.) If the operation succeeds, then all instances associated with the conceptual row are immediately removed. · Integer32

The object is used by a management station to create or delete the row entry in cmlrRuleTable following the RowStatus textual convention.

CmlrNameThe configured name used to identify various tables used by MLR. An octet string specified by an administrator that must be in human-readable form. The names must conform to the allowed characters that can be specified via Command Line Interface(CLI). The names cannot contain control character and should not contain leading or trailing white space. SIZE (0..20) · OCTET STRING

The name of the entry in the cmlrAddressTable that will be searched for matches. The table will be search for the following types of addresses based on values set in the cmlrRuleInputParameters object. This object only applies when the 'origSmeTable' bit is set in the cmlrRuleInputParameters object.

CmlrMinimumDigitsMinimum number of digits that global title address can contain and match rule. The minimum number of digits must be greater than or equal to the length of the specified address. This parameter does not apply when the global title address length is set to zero. (1..20) · Unsigned32

Specifies the minimum number of digits that the global title address specified by the cmlrRuleDestSmeGta object can contain for rule to match. This object only applies when the 'destSmeMinDigits' bit is set in the cmlrRuleInputParameters object.

CmlrMaximumDigitsMaximum number of digits that global title address can contain and match rule. The maximum number of digits must be greater than or equal to the length of the specified address. Also, the maximum number of digits must be greater than or equal to minimum number of digits. This parameter does not apply when the global title address length is set to zero. (1..20) · Unsigned32

Specifies the maximum number of digits that the global title address specified by the cmlrRuleDestSmeGta object can contain for rule to match. This object only applies when the 'destSmeMaxDigits' bit is set in the cmlrRuleInputParameters object.

CItpTcNAIThe SCCP GTT Network Address Indicator (NAI). The following values are generally used: Unknown Nature of Address (0), Subscriber Number (1), Reserved for national use (2), National Significant Number (3), International Number (4), Maximum NAI (127), Invalid NAI (253), Wild NAI (254). (0..255) · Integer32

The nature of specified address for the global tile address specified within the message signal unit. This object only applies when the 'destSmeTableNai' bit is set in the cmlrRuleInputParameters object. When operation type, cmlrRuleOperationType is 'smsMt' this object does not apply.

CItpTcNumberingPlanThe SCCP GTT Numbering Plan (NP). The following values are generally used: Unknown NP (0), ISDN/Telephony NP (1), Spare (2), Data NP (3), Telex NP (4), Maritime Mobile NP (5), Land Mobile NP (6), ISDN/Mobile NP (7), Private NP (8). Max NP (15), Invalid NP (253), Wild NP (254). (0..255) · Integer32

The numbering plan for the destination short message service center global title address specified within the message signal unit. This object only applies when the 'destSmeTableNp' bit is set in the cmlrRuleInputParameters object. When operation type, cmlrRuleOperationType is 'smsMt' this object does not apply.

CmlrMinimumDigitsMinimum number of digits that global title address can contain and match rule. The minimum number of digits must be greater than or equal to the length of the specified address. This parameter does not apply when the global title address length is set to zero. (1..20) · Unsigned32

Specifies the minimum number of digits that the global title address specified by the cmlrRuleDestSmscGta object can contain for rule to match. This object only applies when the 'destSmscMinDigits' bit is set in the cmlrRuleInputParameters object.

CmlrMaximumDigitsMaximum number of digits that global title address can contain and match rule. The maximum number of digits must be greater than or equal to the length of the specified address. Also, the maximum number of digits must be greater than or equal to minimum number of digits. This parameter does not apply when the global title address length is set to zero. (1..20) · Unsigned32

Specifies the maximum number of digits that the global title address specified by the cmlrRuleDestSmscGta object can contain for rule to match. This object only applies when the 'destSmscMaxDigits' bit is set in the cmlrRuleInputParameters object.

CmlrMinimumDigitsMinimum number of digits that global title address can contain and match rule. The minimum number of digits must be greater than or equal to the length of the specified address. This parameter does not apply when the global title address length is set to zero. (1..20) · Unsigned32

Specifies the minimum number of digits that the global title address specified by the cmlrRuleOrigSmeGta object can contain for rule to match. This object only applies when the 'origSmeMinDigits' bit is set in the cmlrRuleInputParameters object.

CmlrMaximumDigitsMaximum number of digits that global title address can contain and match rule. The maximum number of digits must be greater than or equal to the length of the specified address. Also, the maximum number of digits must be greater than or equal to minimum number of digits. This parameter does not apply when the global title address length is set to zero. (1..20) · Unsigned32

Specifies the maximum number of digits that the global title address specified by the cmlrRuleOrigSmeGta can contain for rule to match. This object only applies when the 'origSmeMaxDigits' bit is set in the cmlrRuleInputParameters object.

CItpTcNAIThe SCCP GTT Network Address Indicator (NAI). The following values are generally used: Unknown Nature of Address (0), Subscriber Number (1), Reserved for national use (2), National Significant Number (3), International Number (4), Maximum NAI (127), Invalid NAI (253), Wild NAI (254). (0..255) · Integer32

The nature of specified address for the global tile address specified within the message signal unit. This object only applies when the 'origSmeTableNai' bit is set in the cmlrRuleInputParameters object.

CItpTcNumberingPlanThe SCCP GTT Numbering Plan (NP). The following values are generally used: Unknown NP (0), ISDN/Telephony NP (1), Spare (2), Data NP (3), Telex NP (4), Maritime Mobile NP (5), Land Mobile NP (6), ISDN/Mobile NP (7), Private NP (8). Max NP (15), Invalid NP (253), Wild NP (254). (0..255) · Integer32

The numbering plan for the destination short message service center global title address specified within the message signal unit. This object only applies when the 'origSmeTableNp' bit is set in the cmlrRuleInputParameters object.

CItpTcGtaLongDisplayThe configured digits in the SCCP GTT Global Title Address. It consists of ASCII representation of GTA hex digits. SIZE (0..64) · OCTET STRING

The origination short message entity global title address. When the length of the global title address is zero it specified a wildcard match and all global title will match GTA clause of rule. This object only applies when the 'origImsiGta' bit is set in the cmlrRuleInputParameters object.

CItpTcNAIThe SCCP GTT Network Address Indicator (NAI). The following values are generally used: Unknown Nature of Address (0), Subscriber Number (1), Reserved for national use (2), National Significant Number (3), International Number (4), Maximum NAI (127), Invalid NAI (253), Wild NAI (254). (0..255) · Integer32

The nature of specified address for the origination short message entity global title address specified within the message signal unit. This object only applies when the 'origImsiNai' bit is set in the cmlrRuleInputParameters object.

CItpTcNumberingPlanThe SCCP GTT Numbering Plan (NP). The following values are generally used: Unknown NP (0), ISDN/Telephony NP (1), Spare (2), Data NP (3), Telex NP (4), Maritime Mobile NP (5), Land Mobile NP (6), ISDN/Mobile NP (7), Private NP (8). Max NP (15), Invalid NP (253), Wild NP (254). (0..255) · Integer32

The numbering plan for the origination short message entity global title address specified within the message signal unit. This object only applies when the 'origImsiNp' bit is set in the cmlrRuleInputParameters object.

CmlrMinimumDigitsMinimum number of digits that global title address can contain and match rule. The minimum number of digits must be greater than or equal to the length of the specified address. This parameter does not apply when the global title address length is set to zero. (1..20) · Unsigned32

Specifies the minimum number of digits that the global title address specified by the cmlrRuleOrigImsiGta object can contain for rule to match. This object only applies when the 'origImsiMinDigits' bit is set in the cmlrRuleInputParameters object.

CmlrMaximumDigitsMaximum number of digits that global title address can contain and match rule. The maximum number of digits must be greater than or equal to the length of the specified address. Also, the maximum number of digits must be greater than or equal to minimum number of digits. This parameter does not apply when the global title address length is set to zero. (1..20) · Unsigned32

Specifies the maximum number of digits that the global title address specified by the cmlrRuleOrigImsiGta object can contain for rule to match. This object only applies when the 'origImsiMaxDigits' bit is set in the cmlrRuleInputParameters object.

CmlrNameThe configured name used to identify various tables used by MLR. An octet string specified by an administrator that must be in human-readable form. The names must conform to the allowed characters that can be specified via Command Line Interface(CLI). The names cannot contain control character and should not contain leading or trailing white space. SIZE (0..20) · OCTET STRING

The name of the entry in the cmlrAddressTable that will be searched for matches. The table will be search for the following types of addresses based on values set in the cmlrRuleInputParameters object. This object only applies when the 'origImsiTable' bit is set in the cmlrRuleInputParameters object.

CmlrMinimumDigitsMinimum number of digits that global title address can contain and match rule. The minimum number of digits must be greater than or equal to the length of the specified address. This parameter does not apply when the global title address length is set to zero. (1..20) · Unsigned32

Specifies the minimum number of digits that the global title address specified by the cmlrRuleOrigSmscGta object can contain for rule to match. This object only applies when the 'origSmscMinDigits' bit is set in the cmlrRuleInputParameters object.

CmlrMaximumDigitsMaximum number of digits that global title address can contain and match rule. The maximum number of digits must be greater than or equal to the length of the specified address. Also, the maximum number of digits must be greater than or equal to minimum number of digits. This parameter does not apply when the global title address length is set to zero. (1..20) · Unsigned32

Specifies the maximum number of digits that the global title address specified by the cmlrRuleOrigSmscGta object can contain for rule to match. This object only applies when the 'origSmscMaxDigits' bit is set in the cmlrRuleInputParameters object.

CmlrNameThe configured name used to identify various tables used by MLR. An octet string specified by an administrator that must be in human-readable form. The names must conform to the allowed characters that can be specified via Command Line Interface(CLI). The names cannot contain control character and should not contain leading or trailing white space. SIZE (0..20) · OCTET STRING

A name used to define a result group.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

When all results in a group are unavailable this object defines whether to discard packet or to return packet to SCCP layer for normal processing. 'true' Packet will be discarded. 'false' Packet will be returned to SCCP layer for normal processing.

RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of [2].) The status column has six defined values: - `active', which indicates that the conceptual row is available for use by the managed device; - `notInService', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device; - `notReady', which indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instanciated); - `createAndGo', which is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device; - `createAndWait', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device); and, - `destroy', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row. Whereas five of the six values (all except `notReady') may be specified in a management protocol set operation, only three values will be returned in response to a management protocol retrieval operation: `notReady', `notInService' or `active'. That is, when queried, an existing conceptual row has only three states: it is either available for use by the managed device (the status column has value `active'); it is not available for use by the managed device, though the agent has sufficient information to attempt to make it so (the status column has value `notInService'); or, it is not available for use by the managed device, and an attempt to make it so would fail because the agent has insufficient information (the state column has value `notReady'). NOTE WELL This textual convention may be used for a MIB table, irrespective of whether the values of that table's conceptual rows are able to be modified while it is active, or whether its conceptual rows must be taken out of service in order to be modified. That is, it is the responsibility of the DESCRIPTION clause of the status column to specify whether the status column must not be `active' in order for the value of some other column of the same conceptual row to be modified. If such a specification is made, affected columns may be changed by an SNMP set PDU if the RowStatus would not be equal to `active' either immediately before or after processing the PDU. In other words, if the PDU also contained a varbind that would change the RowStatus value, the column in question may be changed if the RowStatus was not equal to `active' as the PDU was received, or if the varbind sets the status to a value other than 'active'. Also note that whenever any elements of a row exist, the RowStatus column must also exist. To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram: STATE +--------------+-----------+-------------+------------- | A | B | C | D | |status col.|status column| |status column | is | is |status column ACTION |does not exist| notReady | notInService| is active --------------+--------------+-----------+-------------+------------- set status |noError ->D|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndGo |inconsistent- | | | | Value| | | --------------+--------------+-----------+-------------+------------- set status |noError see 1|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndWait |wrongValue | | | --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError column to | Value| entValue| | active | | | | | | or | | | | | | | |see 2 ->D|see 8 ->D| ->D --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError ->C column to | Value| entValue| | notInService | | | | | | or | | or | | | | | |see 3 ->C| ->C|see 6 --------------+--------------+-----------+-------------+------------- set status |noError |noError |noError |noError ->A column to | | | | or destroy | ->A| ->A| ->A|see 7 --------------+--------------+-----------+-------------+------------- set any other |see 4 |noError |noError |see 5 column to some| | | | value | | see 1| ->C| ->D --------------+--------------+-----------+-------------+------------- (1) goto B or C, depending on information available to the agent. (2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D. (3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C. (4) at the discretion of the agent, the return value may be either: inconsistentName: because the agent does not choose to create such an instance when the corresponding RowStatus instance does not exist, or inconsistentValue: if the supplied value is inconsistent with the state of some other MIB object's value, or noError: because the agent chooses to create the instance. If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A. (5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned. (6) the return value can indicate one of the following errors: wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated. (7) the return value can indicate the following error: inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated. (8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue. NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc. Conceptual Row Creation There are four potential interactions when creating a conceptual row: selecting an instance-identifier which is not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device. Interaction 1: Selecting an Instance-Identifier The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics. In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.) Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different. Finally, the management station could select a pseudo-random number to use as the index. In the event that this index was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation. A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used. Interaction 2: Creating the Conceptual Row Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions. Interaction 2a: Creating and Activating the Conceptual Row The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes: - a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'. When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information available to the agent is provided by two sources: the management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row. NOTE WELL Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm. Interaction 2b: Negotiating the Creation of the Conceptual Row The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the columns indicated by its column requirements.) Otherwise, the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3. Interaction 3: Initializing non-defaulted Objects The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes: - a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4. Interaction 4: Making the Conceptual Row Available Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'. NOTE WELL A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device. If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row. Conceptual Row Suspension When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified). Conceptual Row Deletion For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady', `notInService' or `active'.) If the operation succeeds, then all instances associated with the conceptual row are immediately removed. · Integer32

The object is used by a management station to create or delete the row entry in cmlrResultSetTable following the RowStatus textual convention.

CmlrIdA numeric identifier used to specify an entry in a list. Zero is a special value used to indicate no entry. (0..65535) · Unsigned32

This object specifies the index for a list of results specified per result group.

CmlrResultType1 = none2 = asname3 = group4 = gt5 = pc6 = pcSsn7 = block8 = continue9 = address10 = rulesetList of possible result types. 'none' : Result not specified. 'asname' : Message will be routed to a particular destination M3UA or SUA Application Server(AS). 'group' : Message will be routed using information specified in result group. 'gt' : Message will be routed using SCCP global title. 'pc' : Message will be routed using the specified destination point code. 'pcSsn' : Message will be routed using the specified destination point code and subsystem number. 'block' : Message will be discarded. 'continue': Message signal units will be processed by the normal SCCP routing. 'address' : Address table will be search to allow MSU to be routed or modified based on address information. 'ruleset' : Message processed by ruleset to allow MSU to be routed or modified based on information specified in MSU. · Integer32

Result type used to route MSU.

CItpTcNetworkNameThe network name is used to indicate the network in which this signalling point is participating. One or more instances of signalling points can exist in the same physical device. This identifier will be used to correlate instances of signalling points by network. When multiple instance support is not enable the network name will default to the null string. An octet string specified by an administrator that must be in human-readable form. The names must conform to the allowed characters that can be specified via Command Line Interface(CLI). The names cannot contain control character and should not contain leading or trailing white space. SIZE (0..19) · OCTET STRING

The network name is used to indicate the network in which the result parameters exist.

CmlrResultOctetAn octet string that contains various types of output from a rule set. The information in this object will be formatted as follows. CmlrResultType: None : Octet string with length of zero. asname : Application Server name formatted as CItpTcXuaName. group : Result group formatted as CmlrName. gt : The global title address formatted as CItpTcGtaLongDisplay pc : Not applicable. block : Octet string with length of zero. continue: Octet string with length of zero. address : The address table name specified by the cmlrAddressTableName object. ruleset : The ruleset table name specified by the cmlrRuleSetName object. An octet string specified by an administrator that must be in human-readable form. The names must conform to the allowed characters that can be specified via Command Line Interface(CLI). The names cannot contain control character and should not contain leading or trailing white space. SIZE (0..64 | 255) · OCTET STRING

Specified the information used to route the MSU based on cmlrResultType object.

CItpTcPointCodeThe SS7 network node address as specified in the following references. The format of the Point code depends on the variant defined in the CgspSS7Variant object as follows. 33222222222211111111110000000000 10987654321098765432109876543210 ANSI: nnnnnnnn - Network cccccccc - Cluster mmmmmmmm - Member ITU: zzz - Zone aaaaaaaa - Area/Network iii - Identifier NTT: zzzzz - Zone aaaa - Area/Network iiiiiii - Identifier TTC: zzzzz - Zone aaaa - Area/Network iiiiiii - Identifier Note: The China variant has the same format as ANSI. This form of the point-code is not intended for for presentation.Reference: The SS7 network node address as specified in the International Telecommunication Union standard Q.708: Specifications of Signalling System No. 7 - Numbering of International Signalling Point Codes, and by ANSI T1.111.8 Numbering of Signalling Point Codes. GF 001-9001 - Technical Specifications of Signalling System No. 7 for National Telephone Network of China. (0..16777216) · Unsigned32

A destination point code that must exist in the MTP3 routing table, and its state is extracted from MTP3 for availability purposes. This object only has applies when the cmlrResultType has the 'pc' value. Otherwise, this object will return zero value.

CItpTcSubSystemNumberThe SCCP Subsystem Number . A value of zero indicates that a subsystem is not specified. (0 | 2..255) · Unsigned32

The subsystem number to be inserted into MSU. This object only has applies when the cmlrResultType has the 'pcSsn' value. Otherwise, this object will return zero value.

INTEGER (0..10) · Integer32

This object specifies the weight applied to the weighted round robin distribution algorithm used for multi-layer result group. An integer value in the range of 0 to 10. A value of ten indicates the resource should be selected ten times more than a resource assigned a weight of one.

Counter32

Number of times this entry was invoked.

RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of [2].) The status column has six defined values: - `active', which indicates that the conceptual row is available for use by the managed device; - `notInService', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device; - `notReady', which indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instanciated); - `createAndGo', which is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device; - `createAndWait', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device); and, - `destroy', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row. Whereas five of the six values (all except `notReady') may be specified in a management protocol set operation, only three values will be returned in response to a management protocol retrieval operation: `notReady', `notInService' or `active'. That is, when queried, an existing conceptual row has only three states: it is either available for use by the managed device (the status column has value `active'); it is not available for use by the managed device, though the agent has sufficient information to attempt to make it so (the status column has value `notInService'); or, it is not available for use by the managed device, and an attempt to make it so would fail because the agent has insufficient information (the state column has value `notReady'). NOTE WELL This textual convention may be used for a MIB table, irrespective of whether the values of that table's conceptual rows are able to be modified while it is active, or whether its conceptual rows must be taken out of service in order to be modified. That is, it is the responsibility of the DESCRIPTION clause of the status column to specify whether the status column must not be `active' in order for the value of some other column of the same conceptual row to be modified. If such a specification is made, affected columns may be changed by an SNMP set PDU if the RowStatus would not be equal to `active' either immediately before or after processing the PDU. In other words, if the PDU also contained a varbind that would change the RowStatus value, the column in question may be changed if the RowStatus was not equal to `active' as the PDU was received, or if the varbind sets the status to a value other than 'active'. Also note that whenever any elements of a row exist, the RowStatus column must also exist. To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram: STATE +--------------+-----------+-------------+------------- | A | B | C | D | |status col.|status column| |status column | is | is |status column ACTION |does not exist| notReady | notInService| is active --------------+--------------+-----------+-------------+------------- set status |noError ->D|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndGo |inconsistent- | | | | Value| | | --------------+--------------+-----------+-------------+------------- set status |noError see 1|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndWait |wrongValue | | | --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError column to | Value| entValue| | active | | | | | | or | | | | | | | |see 2 ->D|see 8 ->D| ->D --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError ->C column to | Value| entValue| | notInService | | | | | | or | | or | | | | | |see 3 ->C| ->C|see 6 --------------+--------------+-----------+-------------+------------- set status |noError |noError |noError |noError ->A column to | | | | or destroy | ->A| ->A| ->A|see 7 --------------+--------------+-----------+-------------+------------- set any other |see 4 |noError |noError |see 5 column to some| | | | value | | see 1| ->C| ->D --------------+--------------+-----------+-------------+------------- (1) goto B or C, depending on information available to the agent. (2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D. (3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C. (4) at the discretion of the agent, the return value may be either: inconsistentName: because the agent does not choose to create such an instance when the corresponding RowStatus instance does not exist, or inconsistentValue: if the supplied value is inconsistent with the state of some other MIB object's value, or noError: because the agent chooses to create the instance. If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A. (5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned. (6) the return value can indicate one of the following errors: wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated. (7) the return value can indicate the following error: inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated. (8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue. NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc. Conceptual Row Creation There are four potential interactions when creating a conceptual row: selecting an instance-identifier which is not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device. Interaction 1: Selecting an Instance-Identifier The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics. In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.) Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different. Finally, the management station could select a pseudo-random number to use as the index. In the event that this index was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation. A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used. Interaction 2: Creating the Conceptual Row Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions. Interaction 2a: Creating and Activating the Conceptual Row The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes: - a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'. When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information available to the agent is provided by two sources: the management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row. NOTE WELL Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm. Interaction 2b: Negotiating the Creation of the Conceptual Row The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the columns indicated by its column requirements.) Otherwise, the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3. Interaction 3: Initializing non-defaulted Objects The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes: - a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4. Interaction 4: Making the Conceptual Row Available Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'. NOTE WELL A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device. If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row. Conceptual Row Suspension When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified). Conceptual Row Deletion For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady', `notInService' or `active'.) If the operation succeeds, then all instances associated with the conceptual row are immediately removed. · Integer32

The object is used by a management station to create or delete the row entry in cmlrResultsTable following the RowStatus textual convention.