CISCO-SCSI-MIB

ScsiIndexValueA number greater than zero for administrative indices in a table. (1..4294967295) · Unsigned32

An arbitrary integer used to uniquely identify a particular SCSI instance.

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..79) · OCTET STRING · hint 255t

An administrative string, configured by the administrator to the usage of the administrator. Can be a zero-length string.

HrSWInstalledIndexOrZeroThe index value for a software module's row in the Host Resources MIB's hrSWInstalledTable. A zero value indicates that no row in the hrSWInstalledTable is applicable.Reference: hrSWInstalledTable is defined in the Host Resources MIB, RFC 2790. (0..2147483647) · Integer32

The index in the hrSWInstalledTable of RFC 2790 corresponding to this software entity. It is equal to zero if there is no reference in the hrSWInstalledTable.

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..79) · OCTET STRING · hint 255t

A text string set by the manufacturer describing the version of this instance. The format of this string is determined solely by the manufacturer, and is for informational purposes only. It is unrelated to the SCSI specification version numbers.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

This object allows to enable/disable sending notifications.

ScsiIndexValueA number greater than zero for administrative indices in a table. (1..4294967295) · Unsigned32

An arbitrary integer used to uniquely identify a particular device.

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..79) · OCTET STRING · hint 255t

An admistrative name for this device. May be empty.

BITS

Is this device acting as an initiator, or as a target or as both.

Unsigned32

The number of ports contained in this device.

Counter32

This object represents the number of times that this device has reset.

ScsiIndexValueA number greater than zero for administrative indices in a table. (1..4294967295) · Unsigned32

An arbitrary integer used to uniquely identify a particular port.

BITS

This object indicated whther this port is acting as an initiator, or as a target or as both.

RowPointerRepresents a pointer to a conceptual row. The value is the name of the instance of the first accessible columnar object in the conceptual row. For example, ifIndex.3 would point to the 3rd row in the ifTable (note that if ifIndex were not-accessible, then ifDescr.3 would be used instead). · OBJECT IDENTIFIER

This object is the index of the corresponding transport definition in the ciscoScsiTrnsptTable

Counter32

This object represents the number of port busy status sent or received by this port. Note: Initiator ports only receive busy status and target ports only send busy status.

ScsiIndexValueA number greater than zero for administrative indices in a table. (1..4294967295) · Unsigned32

An administrative integer used to uniquely identify a particular transport.

AutonomousTypeRepresents an independently extensible type identification value. It may, for example, indicate a particular sub-tree with further MIB definitions, or define a particular type of protocol or hardware. · OBJECT IDENTIFIER

The type of transport for this particular transport.

RowPointerRepresents a pointer to a conceptual row. The value is the name of the instance of the first accessible columnar object in the conceptual row. For example, ifIndex.3 would point to the 3rd row in the ifTable (note that if ifIndex were not-accessible, then ifDescr.3 would be used instead). · OBJECT IDENTIFIER

A pointer to a conceptual row in a 'transport' MIB allowing a manager to get useful information for the transport described by this entry. For example, if the transport of this device is iSCSI, this object will point to the iSCSI Instance of the iSCSI MIB. If there is no MIB for this transport, this object has the value 0.0.

ScsiNameDenotes a generic SCSI device or port name. The format depends on the transport used: - SPI: name of a device or a port is a null-length octet string. - FCP: 8 bytes for a port name. - FCP: name of a device is a null-length octet string. - SRP: 16 bytes name for a port. - SRP: name of a device is a null-length octet string. - iSCSI: 256 bytes for a device name. - iSCSI: 258 bytes for a target port. - iSCSI: 262 bytes for an initiator port. - SBP: name of a device is a null-length octet string. - SBP: 8 bytes for an initiator port name. - SBP: 11 bytes for a target port name. SIZE (0 | 8 | 11 | 16 | 256 | 258 | 262) · OCTET STRING

The name of this device in one of the format(s) appropriate for this type of transport.

INTEGER1 = unknown2 = autoEnable3 = manualEnable · Integer32

This object controls whether a discovered target is immediately authorized or not: - autoEnable(2) means that when an initiator discovers a target, it can use it immediately, - manualEnable(3) means that the initiator must wait for an operator to set ciscoScsiIntrDscTgtDiscovered = true before it is authorized.

Counter32

Number of resets sent by this initiator device since the local agent's last re-initialization.

ScsiNameDenotes a generic SCSI device or port name. The format depends on the transport used: - SPI: name of a device or a port is a null-length octet string. - FCP: 8 bytes for a port name. - FCP: name of a device is a null-length octet string. - SRP: 16 bytes name for a port. - SRP: name of a device is a null-length octet string. - iSCSI: 256 bytes for a device name. - iSCSI: 258 bytes for a target port. - iSCSI: 262 bytes for an initiator port. - SBP: name of a device is a null-length octet string. - SBP: 8 bytes for an initiator port name. - SBP: 11 bytes for a target port name. SIZE (0 | 8 | 11 | 16 | 256 | 258 | 262) · OCTET STRING

The name of the port assigned for use by the SCSI protocol. The format will depend of the type of transport this port is using.

ScsiIdentifierDenotes a generic SCSI device or port identifier. The format depends on the transport used: - SPI: only bits:0-3 for a port identifier (LSB is 0 and MSB is 3) - SPI: identifier of a device is a null-length octet string. - FCP: 3 bytes for a port identifier - FCP: identifier of a device is a null-length octet string. - SRP: 16 bytes identifier for a port. - SRP: identifier of a device is a null-length octet string. - iSCSI: 256 bytes for a device identifier. - iSCSI: 258 bytes for a target port. - iSCSI: 262 bytes for an initiator port. - SBP: identifier of a device is a null-length octet string. - SBP: 2 bytes for an initiator port identifier. - SBP: 11 bytes for a target port identifier. SIZE (0 | 1 | 2 | 3 | 11 | 16 | 256 | 258 | 262) · OCTET STRING

The identifier of the port in one of the format(s) appropriate for the type of transport in use.

Counter32 · commands

This object represents the number of commands sent by this initiator.

Counter32 · Megabytes

This object represents the amount of data in Megabytes sent by this initiator.

Counter32 · Megabytes

This object represents the amount of data in Megabytes received by this initiator.

Counter64 (0..18446744073709551615) · commands

This object represents the number of commands sent by this initiator device. This object provides support for systems which can quickly generate lots of commands because they run at high speed.

ScsiPortIndexValueOrZeroThis textual convention is an extension of the ScsiIndexValue convention. The latter defines a greater than zero value used to identify an index. This extension permits the additional value of zero and is applicable only to indices of SCSI port. The value zero is object-specific and must therefore be defined as part of the description of any object, which uses this syntax. Examples of the usage of zero might include situations where index was unknown, or when none or all indices need to be referenced. · Unsigned32

This object is: - the index of the local scsi initiator port, - or zero, if this entry refers to the local device and therefore refers to all the local initiator ports.

ScsiIndexValueA number greater than zero for administrative indices in a table. (1..4294967295) · Unsigned32

This object is an administrative integer used to uniquely identify a particular authorized target. (Authorized to attach to this initiator device or port.)

ScsiDeviceOrPort1 = device2 = port3 = otherThis type allows to decide if some configuration is applicable to a port or to a device. · Integer32

This object specifies if this entry refers to a remote target port or remote target device.

ScsiNameDenotes a generic SCSI device or port name. The format depends on the transport used: - SPI: name of a device or a port is a null-length octet string. - FCP: 8 bytes for a port name. - FCP: name of a device is a null-length octet string. - SRP: 16 bytes name for a port. - SRP: name of a device is a null-length octet string. - iSCSI: 256 bytes for a device name. - iSCSI: 258 bytes for a target port. - iSCSI: 262 bytes for an initiator port. - SBP: name of a device is a null-length octet string. - SBP: 8 bytes for an initiator port name. - SBP: 11 bytes for a target port name. SIZE (0 | 8 | 11 | 16 | 256 | 258 | 262) · OCTET STRING

The name of this authorized/discovered target device or port.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

This object means: true(1): this entry has been configured by an administrator false(2): this entry has been added from other source. An administrator can switch this value from false to true.

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

This object means: true(1): this entry has been discovered by the SCSI instance. false(2): this entry has been added from other source. This entry is read-only because an administrator cannot change it. Note that it is an implementation issue to decide how long to retain a row with configured=false, as and when the target is no longer visible/accessible to the local initiator.

Counter32 · commands

This object represents the number of commands received by this target port or device.

Counter32 · Megabytes

This object represents the amount of data in Megabytes written by this target port or device.

Counter32 · Megabytes

This object represents the amount of data in Megabytes read by this target port or device.

Counter64 (0..18446744073709551615) · commands

This object represents the number of commands received by this target port or device. This object provides support for systems which can quickly generate lots of commands because they run at high speed.

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

This object represents the value of sysUpTime when this row was created.

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

This object allows to configure dynamically a new entry in this table via SNMP or eventually delete it. An administrator is not allowed to delete an entry where the object ciscoScsiIntrDscTgtDiscovered is equal to true.

ScsiIndexValueA number greater than zero for administrative indices in a table. (1..4294967295) · Unsigned32

This object is an administrative integer used to uniquely identify a particular LUN discovered by a particular scsi initiator port or device. This index will point to an entry for this LUN in the ciscoScsiDscLunIdTable.

ScsiLUNOrZeroThis Textual Convention represents either a SCSI Logical Unit Number (LUN) or a zero-length string. Objects defined with this syntax must specify the meaning of the zero-length string. The format of a LUN is: - a zero-length octet string or - a string of two octets if the underlying transport protocol is SBP-3 or SPI-4 using data group transfers or - a string of eight octets for all other cases. SIZE (0 | 2 | 8) · OCTET STRING

This object is the actual value of the LUN of the discovered logical unit.

ScsiIndexValueA number greater than zero for administrative indices in a table. (1..4294967295) · Unsigned32

This object is an administrative integer used to uniquely identify a particular LUN Identifier discovered by each scsi initiator device or port.

ScsiIdCodeSetThis Textual Convention specifies the code set in use with this identifier. The format is the same as contained in the identifier's Identification Descriptor within the Logical Unit's Device Identification Page.Reference: ANSI - SCSI Primary Commands - 2 (SPC-2), Revision 20, 18 July 2001 Chapter 8: section 8.4.4, page 210 Vital Product Data Parameters [16] (0..15) · Unsigned32

Reference: ANSI - SCSI Primary Commands - 2 (SPC-2),Revision 20, Chapter 8: section 8.4.4, page 210 Vital Product Data Parameters [16]

This object determines the code set in use for this identifier as specified by the ANSI-SCSI Primary Commands -2 document; the code set can be binary or ascii.

ScsiIdAssociationThis Textual Convention specifies what the identifier is associated with (e.g, with the addressed physical/logical device or with a particular port). The format is the same as contained in the identifier's Identification Descriptor within the Logical Unit's Device Identification Page.Reference: ANSI - SCSI Primary Commands - 2 (SPC-2), Revision 20, 18 July 2001 - Chapter 8: section 8.4.4, page 210 Vital Product Data Parameters [16] (0..3) · Unsigned32

Reference: ANSI - SCSI Primary Commands - 2 (SPC-2), Revision 20, Chapter 8: section 8.4.4, page 210 Vital Product Data Parameters [16]

This value means that the identifier is associated with the addressed physical or logical device or that the identifier is associated with the port that received the request.

ScsiIdTypeThis Textual Convention specifies the type of the identifier. The format is the same as contained in the identifier's Identification Descriptor within the Logical Unit's Device Identification Page.Reference: ANSI - SCSI Primary Commands - 2 (SPC-2), Revision 20, Chapter 8: section 8.4.4, page 210 Vital Product Data Parameters [16] (0..15) · Unsigned32

Reference: ANSI - SCSI Primary Commands - 2 (SPC-2), Revision 20, Chapter 8: section 8.4.4, page 210 Vital Product Data Parameters [16]

This object defines the type of LU Identifier used for this identifier and indicates the format of scsiLUIdValue.

ScsiIdValueThis Textual Convention represents an identifier. The objects of type ScsiIdCodeSet, ScsIdAssociation, ScsiIdType, define together the format. The format is the same as contained in the identifier's Identification Descriptor within the Logical Unit's Device Identification Page.Reference: ANSI - SCSI Primary Commands - 2 (SPC-2), Revision 20, 18 July 2001 - Chapter 8: section 8.4.4, page 210 Vital Product Data Parameters [16] SIZE (0..255) · OCTET STRING

Reference: ANSI - SCSI Primary Commands - 2 (SPC-2), Chapter 8: section 8.4.4, page 210 Vital Product Data Parameters [16]

The actual value of this identifier. The format is defined by the objects ciscoScsiIntrDscLunIdCodeSet, ciscoScsiIntrDscLunIdAssoc, ciscoScsiIntrDscLunIdType.

ScsiIndexValueA number greater than zero for administrative indices in a table. (1..4294967295) · Unsigned32

An administrative integer used to uniquely identify a particular currently attached target.

ScsiIndexValueOrZeroThis textual convention is an extension of the ScsiIndexValue convention. The latter defines a greater than zero value used to identify an index. This extension permits the additional value of zero. The value zero is object-specific and must therefore be defined as part of the description of any object, which uses this syntax. Examples of the usage of zero might include situations where index was unknown, or when none or all indices need to be referenced. · Unsigned32

The corresponding index in the ciscoScsiIntrDiscTgtTable for this current attached target port or zero if this attached target port is not in the table.

ScsiNameDenotes a generic SCSI device or port name. The format depends on the transport used: - SPI: name of a device or a port is a null-length octet string. - FCP: 8 bytes for a port name. - FCP: name of a device is a null-length octet string. - SRP: 16 bytes name for a port. - SRP: name of a device is a null-length octet string. - iSCSI: 256 bytes for a device name. - iSCSI: 258 bytes for a target port. - iSCSI: 262 bytes for an initiator port. - SBP: name of a device is a null-length octet string. - SBP: 8 bytes for an initiator port name. - SBP: 11 bytes for a target port name. SIZE (0 | 8 | 11 | 16 | 256 | 258 | 262) · OCTET STRING

The name of the remote target port attached to this initiator port.

ScsiIdentifierDenotes a generic SCSI device or port identifier. The format depends on the transport used: - SPI: only bits:0-3 for a port identifier (LSB is 0 and MSB is 3) - SPI: identifier of a device is a null-length octet string. - FCP: 3 bytes for a port identifier - FCP: identifier of a device is a null-length octet string. - SRP: 16 bytes identifier for a port. - SRP: identifier of a device is a null-length octet string. - iSCSI: 256 bytes for a device identifier. - iSCSI: 258 bytes for a target port. - iSCSI: 262 bytes for an initiator port. - SBP: identifier of a device is a null-length octet string. - SBP: 2 bytes for an initiator port identifier. - SBP: 11 bytes for a target port identifier. SIZE (0 | 1 | 2 | 3 | 11 | 16 | 256 | 258 | 262) · OCTET STRING

The identifier of the remote target port attached to this local initiator port.

Gauge32

This object is the number of Logical Units accessible via this local target device.

INTEGER1 = unknown2 = available3 = broken4 = readying5 = abnormal6 = nonAddrFailure7 = nonAddrFailReadying8 = nonAddrFailAbnormal · Integer32

Reference: SCSI Controller Commands-2 (SCC-2) standard NCITS.318-1998 6.3.1.8 REPORT STATES service action

This object represents the status of this SCSI device, summarizing the state of both the addressable devices (i.e., the logical units) and the non-addressable devices within this SCSI device: - unknown(1): This value is used when the status cannot be determined - available(2): All addressable and non-addressable devices within the SCSI device are fully operational (i.e., no logical units have an abnormal status). - broken(3): The SCSI device is not operational and cannot be made operational without external intervention. - readying(4): One or more logical units within the SCSI device are being initialized and access to the SCSI device is temporarily limited (i.e., one or more of the logical unit have a readying status). - abnormal(5): One or more addressable devices within the SCSI device are indicating a status other than available; nevertheless, the SCSI device is operational (i.e., one or more of the logical units have an abnormal status). - nonAddrFailure(6): One or more non-addressable devices within the SCSI device have failed; nevertheless, the SCSI device is operational (i.e., no logical units have an abnormal or readying status). - nonAddrFailReadying(7): One or more non-addressable devices within the SCSI device have failed; nevertheless,one or more logical units within the SCSI device are being initialized and access to the SCSI device is temporarily limited. - nonAddrFailAbnormal(8): One or more non-addressable devices within the SCSI device have failed and one or more addressable devices within the SCSI device are indicating a status other than available however the SCSI device is operational.

Gauge32

This object is the number of Logical Units existing but not currently accessible via this local target device.

ScsiNameDenotes a generic SCSI device or port name. The format depends on the transport used: - SPI: name of a device or a port is a null-length octet string. - FCP: 8 bytes for a port name. - FCP: name of a device is a null-length octet string. - SRP: 16 bytes name for a port. - SRP: name of a device is a null-length octet string. - iSCSI: 256 bytes for a device name. - iSCSI: 258 bytes for a target port. - iSCSI: 262 bytes for an initiator port. - SBP: name of a device is a null-length octet string. - SBP: 8 bytes for an initiator port name. - SBP: 11 bytes for a target port name. SIZE (0 | 8 | 11 | 16 | 256 | 258 | 262) · OCTET STRING

The name of the port assigned for use in the SCSI protocol.

ScsiIdentifierDenotes a generic SCSI device or port identifier. The format depends on the transport used: - SPI: only bits:0-3 for a port identifier (LSB is 0 and MSB is 3) - SPI: identifier of a device is a null-length octet string. - FCP: 3 bytes for a port identifier - FCP: identifier of a device is a null-length octet string. - SRP: 16 bytes identifier for a port. - SRP: identifier of a device is a null-length octet string. - iSCSI: 256 bytes for a device identifier. - iSCSI: 258 bytes for a target port. - iSCSI: 262 bytes for an initiator port. - SBP: identifier of a device is a null-length octet string. - SBP: 2 bytes for an initiator port identifier. - SBP: 11 bytes for a target port identifier. SIZE (0 | 1 | 2 | 3 | 11 | 16 | 256 | 258 | 262) · OCTET STRING

The identifier of the port in one of the format(s) appropriate for the type of transport.

Counter32 · commands

This object represents the number of commands received by this target port.

Counter32 · Megabytes

This object represents the amount of data written in Megabytes by this target port.

Counter32 · Megabytes

This object represents the amount of data read in Megabytes by this target port.

Counter64 (0..18446744073709551615) · commands

This object represents the number of commands received. This object provides support for systems that can quickly generate lots of commands because they run at high speed.

ScsiPortIndexValueOrZeroThis textual convention is an extension of the ScsiIndexValue convention. The latter defines a greater than zero value used to identify an index. This extension permits the additional value of zero and is applicable only to indices of SCSI port. The value zero is object-specific and must therefore be defined as part of the description of any object, which uses this syntax. Examples of the usage of zero might include situations where index was unknown, or when none or all indices need to be referenced. · Unsigned32

This object is: - the index of the local scsi target port, - or zero, if this entry refers to a local target device.

ScsiIndexValueA number greater than zero for administrative indices in a table. (1..4294967295) · Unsigned32

This object is an administrative integer used to uniquely identify a particular authorized initiator. (Authorized to attach to this target device or port.)

ScsiDeviceOrPort1 = device2 = port3 = otherThis type allows to decide if some configuration is applicable to a port or to a device. · Integer32

This object specifies if this entry refers to a remote initiator port or a device.

ScsiNameDenotes a generic SCSI device or port name. The format depends on the transport used: - SPI: name of a device or a port is a null-length octet string. - FCP: 8 bytes for a port name. - FCP: name of a device is a null-length octet string. - SRP: 16 bytes name for a port. - SRP: name of a device is a null-length octet string. - iSCSI: 256 bytes for a device name. - iSCSI: 258 bytes for a target port. - iSCSI: 262 bytes for an initiator port. - SBP: name of a device is a null-length octet string. - SBP: 8 bytes for an initiator port name. - SBP: 11 bytes for a target port name. SIZE (0 | 8 | 11 | 16 | 256 | 258 | 262) · OCTET STRING

The name of the remote initiator device or port authorized to attach this local target device or port.

ScsiIndexValueOrZeroThis textual convention is an extension of the ScsiIndexValue convention. The latter defines a greater than zero value used to identify an index. This extension permits the additional value of zero. The value zero is object-specific and must therefore be defined as part of the description of any object, which uses this syntax. Examples of the usage of zero might include situations where index was unknown, or when none or all indices need to be referenced. · Unsigned32

This object identifies the set of entries in the ciscoScsiLunMapTable for which ciscoScsiLunMapIndex has the same value as the value of this object. The identified set of entries constitute the LUN map to be used for accessing logical units when the remote initiator corresponding to this entry is attached to any local target corresponding to this entry. Note that this object has a value of zero if this entry should use the default LUN map.

Counter32 · Times

This object indicates the number of times that this remote initiator has transitioned from unattached to attached to this local target device or port.

Counter32 · commands

This object indicates the number of commands that the remote initiator corresponding to this entry has sent to the local target device or port corresponding to this entry.

Counter32 · Megabytes

This object indicates the amount of data in Megabytes that the remote initiator corresponding to this entry has read from the local target device or port corresponding to this entry.

Counter32 · Megabytes

This object indicates the amount of data in Megabytes that the remote initiator corresponding to this entry has written from the local target device or port corresponding to this entry.

Counter64 (0..18446744073709551615) · commands

This object represents the number of commands sent by the remote initiator corresponding to this entry to the local target device or port corresponding to this entry. This object provides support for systems which can quickly generate lots of commands because they run at high speed.

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

This object indicates the value of sysUpTime when this row was last created.

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

This object allows an administrator to create or delete this entry.

ScsiIndexValueA number greater than zero for administrative indices in a table. (1..4294967295) · Unsigned32

An administrative integer used to uniquely identify a particular attached remote initiator port.

ScsiIndexValueOrZeroThis textual convention is an extension of the ScsiIndexValue convention. The latter defines a greater than zero value used to identify an index. This extension permits the additional value of zero. The value zero is object-specific and must therefore be defined as part of the description of any object, which uses this syntax. Examples of the usage of zero might include situations where index was unknown, or when none or all indices need to be referenced. · Unsigned32

This object is the corresponding index in the ciscoScsiAuthorizedIntrTable for this current attached remote initiator or zero if this remote attached initiator is not configured in that table.

ScsiNameDenotes a generic SCSI device or port name. The format depends on the transport used: - SPI: name of a device or a port is a null-length octet string. - FCP: 8 bytes for a port name. - FCP: name of a device is a null-length octet string. - SRP: 16 bytes name for a port. - SRP: name of a device is a null-length octet string. - iSCSI: 256 bytes for a device name. - iSCSI: 258 bytes for a target port. - iSCSI: 262 bytes for an initiator port. - SBP: name of a device is a null-length octet string. - SBP: 8 bytes for an initiator port name. - SBP: 11 bytes for a target port name. SIZE (0 | 8 | 11 | 16 | 256 | 258 | 262) · OCTET STRING

The name of the remote initiator attached to this local target port.

ScsiIdentifierDenotes a generic SCSI device or port identifier. The format depends on the transport used: - SPI: only bits:0-3 for a port identifier (LSB is 0 and MSB is 3) - SPI: identifier of a device is a null-length octet string. - FCP: 3 bytes for a port identifier - FCP: identifier of a device is a null-length octet string. - SRP: 16 bytes identifier for a port. - SRP: identifier of a device is a null-length octet string. - iSCSI: 256 bytes for a device identifier. - iSCSI: 258 bytes for a target port. - iSCSI: 262 bytes for an initiator port. - SBP: identifier of a device is a null-length octet string. - SBP: 2 bytes for an initiator port identifier. - SBP: 11 bytes for a target port identifier. SIZE (0 | 1 | 2 | 3 | 11 | 16 | 256 | 258 | 262) · OCTET STRING

The identifier of the remote initiator attached to this local target port.

ScsiIndexValueA number greater than zero for administrative indices in a table. (1..4294967295) · Unsigned32

An administrative integer used to uniquely identify a particular logical unit.

ScsiLUNOrZeroThis Textual Convention represents either a SCSI Logical Unit Number (LUN) or a zero-length string. Objects defined with this syntax must specify the meaning of the zero-length string. The format of a LUN is: - a zero-length octet string or - a string of two octets if the underlying transport protocol is SBP-3 or SPI-4 using data group transfers or - a string of eight octets for all other cases. SIZE (0 | 2 | 8) · OCTET STRING

The default Logical Unit Number (LUN) for this logical unit; it is the LUN that will appear to an initiator that was not configured to see another LUN. Note that this object will have a zero-length string if this Logical Unit does not have a default LUN.

ScsiNameIdOrZeroThis Textual Convention represents either the SCSI name of a logical unit or a zero-length string. Objects defined with this syntax must specify the meaning of the zero-length string. The format of the name of a LU is: - a zero-length octet string or - a string of eight octets. SIZE (0 | 8) · OCTET STRING

The World-Wide Name of this LU.

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..79) · OCTET STRING · hint 255t

A string identifying the vendor of this LU according to the value in SCSI device page.

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..79) · OCTET STRING · hint 255t

A string identifying the product for this LU according to the value in SCSI device page.

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..79) · OCTET STRING · hint 255t

A string defining the product revision of this LU according to the value in SCSI device page.

Unsigned32

Reference: ANSI - SCSI Primary Commands - 2 (SPC-2), T10 Project 1236- D, Revision 20, 18 July 2001 [16]

This object is the value returned to SCSI query VPD page 83. It can be: direct-access device, sequential-access device, printer, communication device and so on. The values that can be returned here are defined in SCSI Primary Commands -2 .

INTEGER1 = unknown2 = available3 = notAvailable4 = broken5 = readying6 = abnormal · Integer32

Reference: SCSI Controller Commands-2 (SCC-2) standard NCITS.318-1998 6.3.1.8 REPORT STATES service action

The status of this logical unit: - unknown(1): The status of this logical unit cannot be determined. - available(2): The logical unit is fully operational (i.e., accepts media access SCSI commands and has no state information to report). - notAvailable(3): The logical unit is capable of being supported but not available (i.e., no logical unit is currently present or the logical unit is present but not configured for use). - broken(4): The logical unit has failed and cannot respond to SCSI commands. - readying(5): The logical unit is being initialized and access is temporarily limited. - abnormal(6): The logical unit has state information available that indicates it is operating with limits. The ciscoScsiLuState indicates what those limits are.

BITS

Reference: SCSI Controller Commands-2 (SCC-2) standard NCITS.318-1998 6.3.1.8 REPORT STATES service action

According the bit position: 0 Data lost: Within the logical unit data has been lost. 1 Dynamic reconfiguration in progress: The logical unit is being reconfigured. In this state all data is still protected. 2 Exposed: Within the logical unit data is not protected. In this state all data is still valid, however, loss of data/data-availability is unavoidable in the event of a failure. 3 Fractionally exposed: Within the logical unit part of the data is not protected. In this state all data is still valid, however, a failure may cause a loss of data or a loss of data availability. 4 Partially exposed: Within the logical unit one or more underlying storage devices have failed. In this state all data is still protected. 5 Protected rebuild: The logical unit is in the process of a rebuild operation. In this state all data is protected. 6 Protection disabled: Within the logical unit the data protection method has been disabled. In this state all data is still valid, however, however, loss of data/data-availability is unavoidable in the event of a failure. 7 Rebuild: The data protection method is in the process of rebuilding data. In this state data is not protected. 8 Recalculate: The logical unit is in the process of a recalculate operation. 9 Spare in use: Within the logical unit a storage device in full or part being used to store data. In this state all data is still protected. 10 Verify in progress: Within the logical unit data is being verified.

Counter32 · commands

This object represents the number of commands received by this logical unit.

Counter32 · Megabytes

This object represents the amount of data in Megabytes read from this logical unit.

Counter32 · Megabytes

This object represents the amount of data in Megabytes written by this logical unit.

Counter32 · resets

This object represents the number of resets received by this logical unit.

Counter32

This object represents the number of queue full statuses received by this logical unit.

Counter64 (0..18446744073709551615) · commands

This object represents the number of commands received by this logical unit. This object provides support for systems that can quickly generate lots of commands because they run at high speed.

ScsiIndexValueA number greater than zero for administrative indices in a table. (1..4294967295) · Unsigned32

This object represents an arbitrary integer used to uniquely identify a particular LU Identifier within a particular logical unit within a particular SCSI target device within a particular SCSI instance.

ScsiIdCodeSetThis Textual Convention specifies the code set in use with this identifier. The format is the same as contained in the identifier's Identification Descriptor within the Logical Unit's Device Identification Page.Reference: ANSI - SCSI Primary Commands - 2 (SPC-2), Revision 20, 18 July 2001 Chapter 8: section 8.4.4, page 210 Vital Product Data Parameters [16] (0..15) · Unsigned32

Reference: ANSI - SCSI Primary Commands - 2 ((SPC-2), Revision 20, Chapter 8: section 8.4.4, page 210 Vital Product Data Parameters [16]

This object specifies the code set in use with this identifier. The value is represented in the same format as is contained in the identifier's Identification Descriptor within the Logical Unit's Device Identification Page.

ScsiIdAssociationThis Textual Convention specifies what the identifier is associated with (e.g, with the addressed physical/logical device or with a particular port). The format is the same as contained in the identifier's Identification Descriptor within the Logical Unit's Device Identification Page.Reference: ANSI - SCSI Primary Commands - 2 (SPC-2), Revision 20, 18 July 2001 - Chapter 8: section 8.4.4, page 210 Vital Product Data Parameters [16] (0..3) · Unsigned32

Reference: ANSI - SCSI Primary Commands - 2 (SPC-2), Revision 20, Chapter 8: section 8.4.4, page 210 Vital Product Data Parameters [16]

This object specifies what the identifier is associated with (e.g, with the addressed physical/logical device or with a particular port). The value is represented in the same format as is contained in the identifier's Identification Descriptor within the Logical Unit's Device Identification Page.

ScsiIdTypeThis Textual Convention specifies the type of the identifier. The format is the same as contained in the identifier's Identification Descriptor within the Logical Unit's Device Identification Page.Reference: ANSI - SCSI Primary Commands - 2 (SPC-2), Revision 20, Chapter 8: section 8.4.4, page 210 Vital Product Data Parameters [16] (0..15) · Unsigned32

Reference: ANSI - SCSI Primary Commands - 2 (SPC-2), Revision 20, Chapter 8: section 8.4.4, page 210 Vital Product Data Parameters [16]

This object specifies the type of the identifier. The value is represented in the same format as is contained in the identifier's Identification Descriptor within the Logical Unit's Device Identification Page.

ScsiIdValueThis Textual Convention represents an identifier. The objects of type ScsiIdCodeSet, ScsIdAssociation, ScsiIdType, define together the format. The format is the same as contained in the identifier's Identification Descriptor within the Logical Unit's Device Identification Page.Reference: ANSI - SCSI Primary Commands - 2 (SPC-2), Revision 20, 18 July 2001 - Chapter 8: section 8.4.4, page 210 Vital Product Data Parameters [16] SIZE (0..255) · OCTET STRING

Reference: ANSI - SCSI Primary Commands - 2 (SPC-2), Chapter 8: section 8.4.4, page 210 Vital Product Data Parameters [16]

This object represents the actual value of this identifier. The format is defined by the objects ciscoScsiLuIdCodeSet, ciscoScsiLuIdAssociation, ciscoScsiLuIdType. The value is represented in the same format as is contained in the identifier's Identification Descriptor within the Logical Unit's Device Identification Page.

ScsiIndexValueA number greater than zero for administrative indices in a table. (1..4294967295) · Unsigned32

An administrative integer used to uniquely identify a particular LunMap.

ScsiLUNOrZeroThis Textual Convention represents either a SCSI Logical Unit Number (LUN) or a zero-length string. Objects defined with this syntax must specify the meaning of the zero-length string. The format of a LUN is: - a zero-length octet string or - a string of two octets if the underlying transport protocol is SBP-3 or SPI-4 using data group transfers or - a string of eight octets for all other cases. SIZE (0 | 2 | 8) · OCTET STRING

This object specifies the Logical Unit Number, to which a logical unit is mapped by this row.

ScsiIndexValueA number greater than zero for administrative indices in a table. (1..4294967295) · Unsigned32

This object identifies the logical unit for which the value of ciscoScsiLuIndex is the same as the value of this object. The identified logical unit is the one mapped to a LUN by this row.

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

This object allows an administrator to create and delete this entry.