CISCO-WAN-VISM-TONE-PLAN-MIB

Integer32 (1..1000)

Serves as index to this table. However, the maximum entry allowed is specify in tonePlanCurrentSize.

INTEGER1 = unused2 = configured3 = reloading4 = lostFile · Integer32

This attribute specifies the status of this entry as to whether this entry (row) contains usable Tone Plan configuration information (object is set to 'configured'), or if it is empty (object is set to 'unused'), or if is temporarily (object is set to 'reloading') or permanently (object is set to 'lostFile') unusable. This tone plan information for this row can be used by a DS-1 line only if this object has a value of 'configured (2)'. To add a configured entry in the vismTonePlanTable table, there must be an existing empty row with its entry status set to 'unused(1)'. Then before this empty row in the vismTonePlanTable table can be changed to 'configured', it must, in one single operation, be given all the usable values necessary to be stored in the tonePlanRegionName, tonePlanVersionNumber and tonePlanFileName MIB objects for this row. In addition, those values for the tonePlanRegionName and tonePlanVersionNumber MIB objects pair must be unique with respect to every other row of the vismTonePlanTable. Then, as this existing empty row is set with all three valid entries for the tonePlanRegionName, tonePlanVersionNumber, and tonePlanFileName MIB objects, the Entry Status MIB object for this row will be finally, internally, set to 'configured(2)'. This final 'configured' status is the direct result of correctly setting these three MIB objects with valid data. In no case will an external manager be able to directly set this MIB object to 'configured(2)' by a SNMP set command, for such a single stand alone command will be rejected. Once a table entry is set to 'configured(2)' with valid tonePlanRegionName, tonePlanVersionNumber, and tonePlanFileName MIB objects for this row, then these MIB objects may not be modified by any subsequent SNMP set command. In the case where a row needs to have these objects changed, this entry must be cleared from the table (paragraph below) and a new entry added by the add process above. Once an entry exists in the vismTonePlanTable table it may be cleared and set to unused by setting this MIB object to 'unused(1)'. But before the entry status of any entry in this table can be set to 'unused(1)', there is a check to make sure there is no vismDsx1TonePlanRegion MIB object and vismDsx1TonePlanVersion MIB object pair in the dsx1VismCnfGrpTable MIB table that may point to or refer to this table entry (row) with its unique tonePlanRegionName and tonePlanVersionNumber. Once the entry status of an entry in this table is set to 'unused(1)', all the other MIB objects for this table row are set to defaults or to NULL. Once an entry is 'configured', if a subsequent card reset occurs the VISM card will attempt to restore all of the configuration information by doing the normal download of the latest MIB database, set all 'configured (2)' MIB objects to 'reloading (3)', and then do an automatic background process to retrieve all of the tone plan files from the server since they were not downloaded by the PXM. If this retrieval of the tone plan files succeeds then this MIB object will be set back to 'configured (2)'. If this file retrieval does not succeed, then this MIB object will be set to 'lostFile (4)'. In no way will an external manager be able to directly set this MIB object to 'reloading (3)' or 'lostFile (4)' by a SNMP set command.

INTEGER1 = builtIn2 = provisionable · Integer32

This attribute specifies whether this entry contains predefined Tone Plan configuration information from internal firmware code (object is set to 'builtIn') or if it has been configured with tone plan configuration information that has been downloaded from the PXM (object is set to unused). Only entries that are provisionable may have their tonePlanEntryStatus MIB object marked as unused in this table. BuiltIn entries may not be marked as unused.

DisplayStringRepresents textual information taken from the NVT ASCII character set, as defined in pages 4, 10-11 of RFC 854. To summarize RFC 854, the NVT ASCII repertoire specifies: - the use of character codes 0-127 (decimal) - the graphics characters (32-126) are interpreted as US ASCII - NUL, LF, CR, BEL, BS, HT, VT and FF have the special meanings specified in RFC 854 - the other 25 codes have no standard interpretation - the sequence 'CR LF' means newline - the sequence 'CR NUL' means carriage-return - an 'LF' not preceded by a 'CR' means moving to the same column on the next line. - the sequence 'CR x' for any x other than LF or NUL is illegal. (Note that this also means that a string may end with either 'CR LF' or 'CR NUL', but not with CR.) Any object defined using this syntax may not exceed 255 characters in length. SIZE (1..64) · OCTET STRING · hint 255a

The region (or country) for which this tone plan is defined. Any other entry in this table may have an identical name, but the combination of tonePlanRegionName and tonePlanVersionNumber must be unique. This field may be from 1 to 64 alphabetic, numeric, or underscore characters long, with no embedded spaces. A NULL entry will consist of a single space character of length one.

Integer32 (0..65535)

This attribute specifies this entry's version number for a tone plan for a region. Multiple tone plans may be defined for each region, but each of these tone plans must have a unique tonePlanRegionName and tonePlanVersionNumber. When a new tone plan is added for a region, it should be added with a newer(larger) version number. Allowed values are in range (1..65535) but a value of zero being set in this object means that this object is a NULL entry.

DisplayStringRepresents textual information taken from the NVT ASCII character set, as defined in pages 4, 10-11 of RFC 854. To summarize RFC 854, the NVT ASCII repertoire specifies: - the use of character codes 0-127 (decimal) - the graphics characters (32-126) are interpreted as US ASCII - NUL, LF, CR, BEL, BS, HT, VT and FF have the special meanings specified in RFC 854 - the other 25 codes have no standard interpretation - the sequence 'CR LF' means newline - the sequence 'CR NUL' means carriage-return - an 'LF' not preceded by a 'CR' means moving to the same column on the next line. - the sequence 'CR x' for any x other than LF or NUL is illegal. (Note that this also means that a string may end with either 'CR LF' or 'CR NUL', but not with CR.) Any object defined using this syntax may not exceed 255 characters in length. SIZE (1..32) · OCTET STRING · hint 255a

This is the name of a valid file stored on the TFTP server which contains the tone definitions. A missing or invalid file name will cause a failure in the configuration of this entry. If this entry points to a build-in tone plan predefined in firmware, then this name will be: 'BUILTIN'. Provisionable file names are not allowed to have the string 'BUILTIN' as their names. This field may be from 1 to 32 alphabetic, numeric, or underscore characters (no embedded spaces) long for a valid entry. A NULL entry will consist of a single space character of length one.

Integer32 (1..10)

This is the index of this table. Currently only tones 1 to 10 are used and call agent can request up to ten tones to be detected on different endpoints at any point in time.

Integer32 (0..255)

This is the secondary index of this table. Call agent can request supervision tone detection indexed by this field. The values of event code are mapped from the subscriber line event codes defined in RFC2833. Currently VISM supports detection of only a handful of supervision tones like Ringing, Busy, Dial-Tone and SIT tones.

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

Controls the creation and deletion of a Config Tone. An entry may be created using the 'createAndGo' option. When the row is successfully created, the vismConfigToneDetectRowStatus would be set to 'active' by the agent. An entry may be deleted by setting the vismConfigToneDetectRowStatus to 'destroy'.

Integer32 (10..125) · Hz

Specifies the maximum frequency deviation to be used by VISM when detecting a specific dual frequency tone. Please refer the VISM configuration guide for standard values to be used for this field.

Integer32 (0..30) · dB

Specifies the maximum frequency power to be used by VISM when detecting a specific dual frequency tone. Please refer the VISM configuration guide for standard values to be used for this field.

Integer32 (10..35) · dB

Specifies the minimum frequency power to be used by VISM when detecting a specific dual frequency tone. Please refer the VISM configuration guide for standard values to be used for this field.

Integer32 (0..15) · dB

Specifies the maximum frequency power twist permitted between the two frequencies used by VISM when detecting a dual frequency tone. Please refer the VISM configuration guide for standard values to be used for this field.

Integer32 (0..100) · milliseconds

Specifies the maximum frequency delay to be used by VISM when detecting a dual frequency tone. Please refer the VISM configuration guide for standard values to be used for this field. It is measured in units of 10ms.

Integer32 (3..100) · milliseconds

Specifies the minimum tone cycle ON time that is necessary for the VISM to detect the dual frequency tone. The vismMinOnCadence has to be less than vismFreqOnCadence value. Please refer the VISM configuration guide for standard values to be used for this field.

Integer32 (5..5000)

Specifies the maximum tone cycle OFF time that is necessary for the VISM to detect the dual frequency tone. The vismMaxOffCadence should be greater than vismFreqOffCadence value. Please refer the VISM configuration guide for standard values to be used for this field.

Integer32 (0..6)

Specifies the number of pairs of the dual frequency that needs to be detected. Currently ten pairs of frequency can be detected by the DSP.

Integer32 (280..3800) · Hz

Specifies the 1st frequency component of the dual frequency to be detected by the VISM.

Integer32 (0..3800) · Hz

Specifies the 2nd frequency component of the dual frequency to be detected by the DSP. A value of 0 means this is a single frequency. The range of 1 to 279 is not a valid range in the DSP.

Integer32 (3..5000) · milliseconds

The On time in each cycle of the dual frequency to be detected by the DSP. The vismFreqOnCadence has to be less than vismMinOnCadence value. It is measured in units of 10ms.

Integer32 (5..5000) · milliseconds

The Off time in each cycle of the dual frequency to be detected by the DSP. The vismFreqOffCadence should be lesser than the vismMaxOffCadence value. It is measured in units of 10ms.