This module defines management information specific to the iSCSI protocol.
Copyright (c) 2014 IETF Trust and the persons identified as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info).
An arbitrary integer used to uniquely identify a particular iSCSI instance. This index value must not be modified or reused by an agent unless a reboot has occurred. An agent should attempt to keep this value persistent across reboots.
iscsiInstDescr
1.3.6.1.2.1.142.1.1.1.1.2
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..255) · OCTET STRING · hint 255t
A UTF-8 string, determined by the implementation to describe the iSCSI instance. When only a single instance is present, this object may be set to the zero-length string; with multiple iSCSI instances, it may be used in an implementation-dependent manner to describe the purpose of the respective instance.
iscsiInstVersionMin
1.3.6.1.2.1.142.1.1.1.1.3
Unsigned32 (0..255)
The minimum version number of the iSCSI specification such that this iSCSI instance supports this minimum value, the maximum value indicated by the corresponding instance in iscsiInstVersionMax, and all versions in between. Reference: RFC 7143, Section 11.12, Login Request
iscsiInstVersionMax
1.3.6.1.2.1.142.1.1.1.1.4
Unsigned32 (0..255)
The maximum version number of the iSCSI specification such that this iSCSI instance supports this maximum value, the minimum value indicated by the corresponding instance in iscsiInstVersionMin, and all versions in between. Reference: RFC 7143, Section 11.12, Login Request
iscsiInstVendorID
1.3.6.1.2.1.142.1.1.1.1.5
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..255) · OCTET STRING · hint 255t
A UTF-8 string describing the manufacturer of the implementation of this instance.
iscsiInstVendorVersion
1.3.6.1.2.1.142.1.1.1.1.6
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..255) · OCTET STRING · hint 255t
A UTF-8 string set by the manufacturer describing the version of the implementation of this instance. The format of this string is determined solely by the manufacturer; the string is for informational purposes only. It is unrelated to the iSCSI specification version numbers.
iscsiInstPortalNumber
1.3.6.1.2.1.142.1.1.1.1.7
Unsigned32 · transport endpoints
The number of rows in the iscsiPortalAttributesTable that are currently associated with this iSCSI instance.
iscsiInstNodeNumber
1.3.6.1.2.1.142.1.1.1.1.8
Unsigned32 · iSCSI nodes
The number of rows in the iscsiNodeAttributesTable that are currently associated with this iSCSI instance.
iscsiInstSessionNumber
1.3.6.1.2.1.142.1.1.1.1.9
Unsigned32 · sessions
The number of rows in the iscsiSessionAttributesTable that are currently associated with this iSCSI instance.
iscsiInstSsnFailures
1.3.6.1.2.1.142.1.1.1.1.10
Counter32 · sessions
This object counts the number of times a session belonging to this instance has failed. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiInstDiscontinuityTime. Reference: RFC 7143, Section 13.1, HeaderDigest and DataDigest
iscsiInstLastSsnFailureType
1.3.6.1.2.1.142.1.1.1.1.11
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 counter object in the iscsiInstanceSsnErrorStatsTable that was incremented when the last session failure occurred.
If the reason for failure is not found in the iscsiInstanceSsnErrorStatsTable, the value { 0.0 } is used instead.
iscsiInstLastSsnRmtNodeName
1.3.6.1.2.1.142.1.1.1.1.12
IscsiNameThis data type is used for objects whose value is an iSCSI name with the properties described in RFC 7143, Section 4.2.7.1, and encoded as specified in RFC 7143, Section 4.2.7.2. A zero-length string indicates the absence of an iSCSI name.Reference: RFC 7143, Section 4.2.7, iSCSI Names. SIZE (0 | 16..223) · OCTET STRING · hint 223t
The iSCSI name of the remote node from the failed session.
iscsiInstDiscontinuityTime
1.3.6.1.2.1.142.1.1.1.1.13
TimeStampThe value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be
defined in the description of any object defined using this type.
If sysUpTime is reset to zero as a result of a re- initialization of the network management (sub)system, then the values of all TimeStamp objects are also reset. However, after approximately 497 days without a re- initialization, the sysUpTime object will reach 2^^32-1 and then increment around to zero; in this case, existing values of TimeStamp objects do not change. This can lead to ambiguities in the value of TimeStamp objects. · TimeTicks
The value of SysUpTime on the most recent occasion at which any one or more of this instance's counters suffered a discontinuity.
If no such discontinuities have occurred since the last re-initialization of the local management subsystem, then this object contains a zero value.
iscsiInstXNodeArchitecture
1.3.6.1.2.1.142.1.1.1.1.14
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..255) · OCTET STRING · hint 255t
A UTF-8 string set by the manufacturer declaring the details of its iSCSI node architecture to the remote endpoint. These details may include, but are not limited to, iSCSI vendor software, firmware, or hardware versions, the OS version, or hardware architecture. The format of this string is determined solely by the manufacturer; the string is for informational purposes only. It is unrelated to the iSCSI specification version numbers. Reference: RFC 7143, Section 13.26, X#NodeArchitecture
Statistics regarding the occurrences of error types that result in a session failure.
iscsiInstSsnDigestErrors
1.3.6.1.2.1.142.1.1.2.1.1
Counter32 · sessions
The count of sessions that failed due to receipt of a PDU containing header or data digest errors. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiInstDiscontinuityTime. Reference: RFC 7143, Section 7.8, Digest Errors
iscsiInstSsnCxnTimeoutErrors
1.3.6.1.2.1.142.1.1.2.1.2
Counter32 · sessions
The count of sessions that failed due to a sequence exceeding a time limit. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiInstDiscontinuityTime. Reference: RFC 7143, Section 7.5, Connection Timeout Management
iscsiInstSsnFormatErrors
1.3.6.1.2.1.142.1.1.2.1.3
Counter32 · sessions
The count of sessions that failed due to receipt of a PDU that contained a format error. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiInstDiscontinuityTime. Reference: RFC 7143 Section 7.7, Format Errors
iscsiInstSsnTgtUnmappedErrors
1.3.6.1.2.1.142.1.1.2.1.4
Counter32 · sessions
The count of sessions that failed due to the target becoming unmapped. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiInstDiscontinuityTime.
iscsiPortalAttributesTable
1.3.6.1.2.1.142.1.2.1
Index: iscsiInstIndex · iscsiPortalIndex
A list of transport endpoints (using TCP or another transport protocol) used by this iSCSI instance. An iSCSI instance may use a portal to listen for incoming connections to its targets, to initiate connections to other targets, or both.
iscsiPortalIndex
1.3.6.1.2.1.142.1.2.1.1.1
Unsigned32 (1..4294967295)
An arbitrary integer used to uniquely identify a particular transport endpoint within this iSCSI instance. This index value must not be modified or reused by an agent unless a reboot has occurred. An agent should attempt to keep this value persistent across reboots.
iscsiPortalRowStatus
1.3.6.1.2.1.142.1.2.1.1.2
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 field allows entries to be dynamically added and removed from this table via SNMP. When adding a row to this table, all non-Index/RowStatus objects must be set. When the value of this object is 'active', the values of the other objects in this table cannot be changed. Rows may be discarded using RowStatus.
Note that creating a row in this table will typically cause the agent to create one or more rows in the iscsiTgtPortalAttributesTable and/or the iscsiIntrPortalAttributesTable.
iscsiPortalRoles
1.3.6.1.2.1.142.1.2.1.1.3
BITS
A portal can operate in one or both of two roles: as a target portal and/or an initiator portal. If the portal will operate in both roles, both bits must be set.
This object will define a corresponding row that will exist or must be created in the iscsiTgtPortalAttributesTable, the iscsiIntrPortalAttributesTable, or both. If the targetTypePortal bit is set, one or more corresponding iscsiTgtPortalAttributesEntry rows will be found or created. If the initiatorTypePortal bit is set, one or more corresponding iscsiIntrPortalAttributesEntry rows will be found or created. If both bits are set, one or more corresponding rows will be found or created in one of the above tables.
iscsiPortalAddrType
1.3.6.1.2.1.142.1.2.1.1.4
InetAddressType0 = unknown1 = ipv42 = ipv63 = ipv4z4 = ipv6z16 = dnsA value that represents a type of Internet address.
unknown(0) An unknown address type. This value MUST
be used if the value of the corresponding InetAddress object is a zero-length string. It may also be used to indicate an IP address that is not in one of the formats defined below.
ipv4(1) An IPv4 address as defined by the
InetAddressIPv4 textual convention.
ipv6(2) An IPv6 address as defined by the
InetAddressIPv6 textual convention.
ipv4z(3) A non-global IPv4 address including a zone
index as defined by the InetAddressIPv4z textual convention.
ipv6z(4) A non-global IPv6 address including a zone
index as defined by the InetAddressIPv6z textual convention.
dns(16) A DNS domain name as defined by the
InetAddressDNS textual convention.
Each definition of a concrete InetAddressType value must be accompanied by a definition of a textual convention for use with that InetAddressType.
To support future extensions, the InetAddressType textual convention SHOULD NOT be sub-typed in object type definitions. It MAY be sub-typed in compliance statements in order to require only a subset of these address types for a compliant implementation.
Implementations must ensure that InetAddressType objects and any dependent objects (e.g., InetAddress objects) are consistent. An inconsistentValue error must be generated if an attempt to change an InetAddressType object would, for example, lead to an undefined InetAddress value. In particular, InetAddressType/InetAddress pairs must be changed together if the address type changes (e.g., from ipv6(2) to ipv4(1)). · Integer32
The type of Internet Network Address contained in the corresponding instance of the iscsiPortalAddr.
iscsiPortalAddr
1.3.6.1.2.1.142.1.2.1.1.5
InetAddressDenotes a generic Internet address.
An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row.
The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error.
When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate. SIZE (0..255) · OCTET STRING
The portal's Internet Network Address, of the type specified by the object iscsiPortalAddrType. If iscsiPortalAddrType has the value 'dns', this address gets resolved to an IP address whenever a new iSCSI connection is established using this portal.
iscsiPortalProtocol
1.3.6.1.2.1.142.1.2.1.1.6
IscsiTransportProtocolThis data type is used to define the transport protocols that will carry iSCSI PDUs. Protocol numbers are assigned by IANA. A current list of all assignments is available from <http://www.iana.org/assignments/protocol-numbers/>. (0..255) · Unsigned32 · hint d
The portal's transport protocol.
iscsiPortalMaxRecvDataSegLength
1.3.6.1.2.1.142.1.2.1.1.7
Unsigned32 (512..16777215) · bytes
The maximum PDU length this portal can receive. This may be constrained by hardware characteristics, and individual implementations may choose not to allow this object to be changed. Reference: RFC 7143, Section 13.12, MaxRecvDataSegmentLength
iscsiPortalPrimaryHdrDigest
1.3.6.1.2.1.142.1.2.1.1.8
IscsiDigestMethod1 = none2 = other3 = noDigest4 = crc32cThis data type represents the methods possible for digest negotiation.
none - a placeholder for a secondary digest method
that means only the primary method can be used.
other - a digest method other than those defined below.
noDigest - does not support digests (will operate without a digest (Note: implementations must support digests to be compliant with RFC 7143).
CRC32c - require a CRC32C digest.Reference: RFC 7143, Section 13.1, HeaderDigest and DataDigest · Integer32
The preferred header digest for this portal.
iscsiPortalPrimaryDataDigest
1.3.6.1.2.1.142.1.2.1.1.9
IscsiDigestMethod1 = none2 = other3 = noDigest4 = crc32cThis data type represents the methods possible for digest negotiation.
none - a placeholder for a secondary digest method
that means only the primary method can be used.
other - a digest method other than those defined below.
noDigest - does not support digests (will operate without a digest (Note: implementations must support digests to be compliant with RFC 7143).
CRC32c - require a CRC32C digest.Reference: RFC 7143, Section 13.1, HeaderDigest and DataDigest · Integer32
The preferred data digest method for this portal.
iscsiPortalSecondaryHdrDigest
1.3.6.1.2.1.142.1.2.1.1.10
IscsiDigestMethod1 = none2 = other3 = noDigest4 = crc32cThis data type represents the methods possible for digest negotiation.
none - a placeholder for a secondary digest method
that means only the primary method can be used.
other - a digest method other than those defined below.
noDigest - does not support digests (will operate without a digest (Note: implementations must support digests to be compliant with RFC 7143).
CRC32c - require a CRC32C digest.Reference: RFC 7143, Section 13.1, HeaderDigest and DataDigest · Integer32
An alternate header digest preference for this portal.
iscsiPortalSecondaryDataDigest
1.3.6.1.2.1.142.1.2.1.1.11
IscsiDigestMethod1 = none2 = other3 = noDigest4 = crc32cThis data type represents the methods possible for digest negotiation.
none - a placeholder for a secondary digest method
that means only the primary method can be used.
other - a digest method other than those defined below.
noDigest - does not support digests (will operate without a digest (Note: implementations must support digests to be compliant with RFC 7143).
CRC32c - require a CRC32C digest.Reference: RFC 7143, Section 13.1, HeaderDigest and DataDigest · Integer32
An alternate data digest preference for this portal.
iscsiPortalRecvMarker
1.3.6.1.2.1.142.1.2.1.1.12
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
This object indicates whether or not this portal will request markers in its incoming data stream. Reference: RFC 7143, Section 13.25, Obsoleted Keys.
iscsiPortalStorageType
1.3.6.1.2.1.142.1.2.1.1.13
StorageType1 = other2 = volatile3 = nonVolatile4 = permanent5 = readOnlyDescribes the memory realization of a conceptual row. A row which is volatile(2) is lost upon reboot. A row which is either nonVolatile(3), permanent(4) or readOnly(5), is backed up by stable storage. A row which is permanent(4) can be changed but not deleted. A row which is readOnly(5) cannot be changed nor deleted.
If the value of an object with this syntax is either permanent(4) or readOnly(5), it cannot be written. Conversely, if the value is either other(1), volatile(2) or nonVolatile(3), it cannot be modified to be permanent(4) or readOnly(5). (All illegal modifications result in a 'wrongValue' error.)
Every usage of this textual convention is required to specify the columnar objects which a permanent(4) row must at a minimum allow to be writable. · Integer32
The storage type for this row. Rows in this table that were created through an external process (e.g., not created via this MIB) may have a storage type of readOnly or permanent.
Conceptual rows having the value 'permanent' need not allow write access to any columnar objects in the row.
iscsiPortalDescr
1.3.6.1.2.1.142.1.2.1.1.14
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..255) · OCTET STRING · hint 255t
A UTF-8 string, determined by the implementation to describe the iSCSI portal. When only a single instance is present, this object may be set to the zero-length string; with multiple iSCSI portals, it may be used in an implementation-dependent manner to describe the respective portal, and could include information such as Host Bus Adapter (HBA) model, description, and version, or software driver and version.
A list of transport endpoints (using TCP or another transport protocol) on which this iSCSI instance listens for incoming connections to its targets.
iscsiTgtPortalNodeIndexOrZero
1.3.6.1.2.1.142.1.3.1.1.1
Unsigned32
An arbitrary integer used to uniquely identify a particular node within an iSCSI instance present on the local system. For implementations where each {portal, node} tuple can have a different portal tag, this value will map to the iscsiNodeIndex.
For implementations where the portal tag is the same for a given portal regardless of which node is using the portal, the value 0 (zero) is used.
iscsiTgtPortalPort
1.3.6.1.2.1.142.1.3.1.1.2
InetPortNumberRepresents a 16 bit port number of an Internet transport layer protocol. Port numbers are assigned by IANA. A current list of all assignments is available from <http://www.iana.org/>.
The value zero is object-specific and must be defined as part of the description of any object that uses this syntax. Examples of the usage of zero might include situations where a port number is unknown, or when the value zero is used as a wildcard in a filter.Reference: STD 6 (RFC 768), STD 7 (RFC 793) and RFC 2960 (1..65535) · Unsigned32 · hint d
The portal's transport protocol port number on which the portal listens for incoming iSCSI connections when the portal is used as a target portal. This object's storage type is specified in iscsiPortalStorageType.
iscsiTgtPortalTag
1.3.6.1.2.1.142.1.3.1.1.3
Unsigned32 (1..65535)
The portal's aggregation tag when the portal is used as a target portal. Multiple-connection sessions may be aggregated over portals sharing an identical aggregation tag. This object's storage type is specified in iscsiPortalStorageType. Reference: RFC 7143, Section 4.4.1, iSCSI Architecture Model
A list of Internet Network Addresses (using TCP or another transport protocol) from which this iSCSI instance may initiate connections to other targets.
iscsiIntrPortalNodeIndexOrZero
1.3.6.1.2.1.142.1.4.1.1.1
Unsigned32
An arbitrary integer used to uniquely identify a particular node within an iSCSI instance present on the local system.
For implementations where each {portal, node} tuple can have a different portal tag, this value will map to the iscsiNodeIndex.
For implementations where the portal tag is the same for a given portal regardless of which node is using the portal, the value 0 (zero) is used.
iscsiIntrPortalTag
1.3.6.1.2.1.142.1.4.1.1.2
Unsigned32 (1..65535)
The portal's aggregation tag when the portal is used as an initiator portal. Multiple-connection sessions may be aggregated over portals sharing an identical aggregation tag. This object's storage type is specified in iscsiPortalStorageType. Reference: RFC 7143, Section 4.4.1, iSCSI Architecture Model
iscsiNodeAttributesTable
1.3.6.1.2.1.142.1.5.1
Index: iscsiInstIndex · iscsiNodeIndex
A list of iSCSI nodes belonging to each iSCSI instance present on the local system. An iSCSI node can act as an initiator, a target, or both.
iscsiNodeIndex
1.3.6.1.2.1.142.1.5.1.1.1
Unsigned32 (1..4294967295)
An arbitrary integer used to uniquely identify a particular node within an iSCSI instance. This index value must not be modified or reused by an agent unless a reboot has occurred. An agent should attempt to keep this value persistent across reboots.
iscsiNodeName
1.3.6.1.2.1.142.1.5.1.1.2
IscsiNameThis data type is used for objects whose value is an iSCSI name with the properties described in RFC 7143, Section 4.2.7.1, and encoded as specified in RFC 7143, Section 4.2.7.2. A zero-length string indicates the absence of an iSCSI name.Reference: RFC 7143, Section 4.2.7, iSCSI Names. SIZE (0 | 16..223) · OCTET STRING · hint 223t
This node's iSCSI name, which is independent of the location of the node, and can be resolved into a set of addresses through various discovery services.
iscsiNodeAlias
1.3.6.1.2.1.142.1.5.1.1.3
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..255) · OCTET STRING · hint 255t
A character string that is a human-readable name or description of the iSCSI node. If configured, this alias may be communicated to the initiator or target node at the remote end of the connection during a Login Request or Response message. This string is not used as an identifier, but it can be displayed by the system's user interface in a list of initiators and/or targets to which it is connected.
If no alias exists, the value is a zero-length string. Reference: RFC 7143, Sections 13.6 (TargetAlias) and 13.7 (InitiatorAlias)
iscsiNodeRoles
1.3.6.1.2.1.142.1.5.1.1.4
BITS
A node can operate in one or both of two roles: a target role and/or an initiator role. If the node will operate in both roles, both bits must be set.
This object will also define the corresponding rows that will exist in the iscsiTargetAttributesTable, the iscsiInitiatorAttributesTable, or both. If the targetTypeNode bit is set, there will be a corresponding iscsiTargetAttributesEntry. If the initiatorTypeNode bit is set, there will be a corresponding iscsiInitiatorAttributesEntry. If both bits are set, there will be a corresponding iscsiTgtPortalAttributesEntry and iscsiPortalAttributesEntry.
iscsiNodeTransportType
1.3.6.1.2.1.142.1.5.1.1.5
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 the corresponding row in the appropriate table for this SCSI transport, thereby allowing management stations to locate the SCSI-level device that is represented by this iscsiNode. For example, it will usually point to the corresponding scsiTrnspt object in the SCSI MIB module. If no corresponding row exists, the value 0.0 must be used to indicate this. Reference: SCSI-MIB, RFC 4455, Section 9, Object Definitions, scsiTransportTypes
iscsiNodeInitialR2T
1.3.6.1.2.1.142.1.5.1.1.6
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
This object indicates the InitialR2T preference for this node: true = YES, false = will try to negotiate NO, will accept YES Reference: RFC 7143, Section 13.10, InitialR2T
iscsiNodeImmediateData
1.3.6.1.2.1.142.1.5.1.1.7
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
This object indicates ImmediateData preference for this node: true = YES (but will accept NO), false = NO Reference: RFC 7143, Section 13.11, ImmediateData
iscsiNodeMaxOutstandingR2T
1.3.6.1.2.1.142.1.5.1.1.8
Unsigned32 (1..65535) · R2Ts
Maximum number of outstanding requests-to-transmit (R2Ts) allowed per iSCSI task. Reference: RFC 7143, Section 13.17, MaxOutstandingR2T
iscsiNodeFirstBurstLength
1.3.6.1.2.1.142.1.5.1.1.9
Unsigned32 (512..16777215) · bytes
The maximum length (bytes) supported for unsolicited data to/from this node. Reference: RFC 7143, Section 13.14, FirstBurstLength
iscsiNodeMaxBurstLength
1.3.6.1.2.1.142.1.5.1.1.10
Unsigned32 (512..16777215) · bytes
The maximum number of bytes that can be sent within a single sequence of Data-In or Data-Out PDUs. Reference: RFC 7143, Section 13.13, MaxBurstLength
iscsiNodeMaxConnections
1.3.6.1.2.1.142.1.5.1.1.11
Unsigned32 (1..65535) · connections
The maximum number of connections allowed in each session to and/or from this node. Reference: RFC 7143, Section 13.2, MaxConnections
iscsiNodeDataSequenceInOrder
1.3.6.1.2.1.142.1.5.1.1.12
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
The DataSequenceInOrder preference of this node. False (=No) indicates that iSCSI data PDU sequences may be transferred in any order. True (=Yes) indicates that data PDU sequences must be transferred using continuously increasing offsets, except during error recovery. Reference: RFC 7143, Section 13.19, DataSequenceInOrder
iscsiNodeDataPDUInOrder
1.3.6.1.2.1.142.1.5.1.1.13
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
The DataPDUInOrder preference of this node. False (=No) indicates that iSCSI data PDUs within sequences may be in any order. True (=Yes) indicates that data PDUs within sequences must be at continuously increasing addresses, with no gaps or overlay between PDUs. Reference: RFC 7143, Section 13.18, DataPDUInOrder
iscsiNodeDefaultTime2Wait
1.3.6.1.2.1.142.1.5.1.1.14
Unsigned32 (0..3600) · seconds
The DefaultTime2Wait preference of this node. This is the minimum time, in seconds, to wait before attempting an explicit/implicit logout or active iSCSI task reassignment after an unexpected connection termination or a connection reset. Reference: RFC 7143, Section 13.15, DefaultTime2Wait
iscsiNodeDefaultTime2Retain
1.3.6.1.2.1.142.1.5.1.1.15
Unsigned32 (0..3600) · seconds
The DefaultTime2Retain preference of this node. This is the maximum time, in seconds after an initial wait (Time2Wait), before which an active iSCSI task reassignment is still possible after an unexpected connection termination or a connection reset. Reference: RFC 7143, Section 13.16, DefaultTime2Retain
iscsiNodeErrorRecoveryLevel
1.3.6.1.2.1.142.1.5.1.1.16
Unsigned32 (0..255)
The ErrorRecoveryLevel preference of this node. Currently, only 0-2 are valid.
This object is designed to accommodate future error-recovery levels. Higher error-recovery levels imply support in addition to support for the lower error level functions. In other words, error level 2 implies support for levels 0-1, since those functions are subsets of error level 2. Reference: RFC 7143, Section 13.20, ErrorRecoveryLevel
iscsiNodeDiscontinuityTime
1.3.6.1.2.1.142.1.5.1.1.17
TimeStampThe value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be
defined in the description of any object defined using this type.
If sysUpTime is reset to zero as a result of a re- initialization of the network management (sub)system, then the values of all TimeStamp objects are also reset. However, after approximately 497 days without a re- initialization, the sysUpTime object will reach 2^^32-1 and then increment around to zero; in this case, existing values of TimeStamp objects do not change. This can lead to ambiguities in the value of TimeStamp objects. · TimeTicks
The value of SysUpTime on the most recent occasion at which any one or more of this node's counters suffered a discontinuity.
If no such discontinuities have occurred since the last re-initialization of the local management subsystem, then this object contains a zero value.
iscsiNodeStorageType
1.3.6.1.2.1.142.1.5.1.1.18
StorageType1 = other2 = volatile3 = nonVolatile4 = permanent5 = readOnlyDescribes the memory realization of a conceptual row. A row which is volatile(2) is lost upon reboot. A row which is either nonVolatile(3), permanent(4) or readOnly(5), is backed up by stable storage. A row which is permanent(4) can be changed but not deleted. A row which is readOnly(5) cannot be changed nor deleted.
If the value of an object with this syntax is either permanent(4) or readOnly(5), it cannot be written. Conversely, if the value is either other(1), volatile(2) or nonVolatile(3), it cannot be modified to be permanent(4) or readOnly(5). (All illegal modifications result in a 'wrongValue' error.)
Every usage of this textual convention is required to specify the columnar objects which a permanent(4) row must at a minimum allow to be writable. · Integer32
The storage type for all read-write objects within this row. Rows in this table are always created via an external process (e.g., not created via this MIB module). Conceptual rows having the value 'permanent' need not allow Write access to any columnar objects in the row.
If this object has the value 'volatile', modifications to read-write objects in this row are not persistent across reboots. If this object has the value 'nonVolatile', modifications to objects in this row are persistent.
An implementation may choose to allow this object to be set to either 'nonVolatile' or 'volatile', allowing the management application to choose this behavior.
iscsiTargetAttributesTable
1.3.6.1.2.1.142.1.6.1
Index: iscsiInstIndex · iscsiNodeIndex
A list of iSCSI nodes that can take on a target role, belonging to each iSCSI instance present on the local system.
iscsiTgtLoginFailures
1.3.6.1.2.1.142.1.6.1.1.1
Counter32 · failed login attempts
This object counts the number of times a login attempt to this local target has failed. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime. Reference: RFC 7143, Section 11.13.5, Status-Class and Status-Detail
iscsiTgtLastFailureTime
1.3.6.1.2.1.142.1.6.1.1.2
TimeStampThe value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be
defined in the description of any object defined using this type.
If sysUpTime is reset to zero as a result of a re- initialization of the network management (sub)system, then the values of all TimeStamp objects are also reset. However, after approximately 497 days without a re- initialization, the sysUpTime object will reach 2^^32-1 and then increment around to zero; in this case, existing values of TimeStamp objects do not change. This can lead to ambiguities in the value of TimeStamp objects. · TimeTicks
The timestamp of the most recent failure of a login attempt to this target. A value of zero indicates that no such failures have occurred since the last system boot.
iscsiTgtLastFailureType
1.3.6.1.2.1.142.1.6.1.1.3
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 the most recent failure of a login attempt to this target, represented as the OID of the counter object in iscsiTargetLoginStatsTable for which the relevant instance was incremented. If no such failures have occurred since the last system boot, this attribute will have the value 0.0. A value of 0.0 may also be used to indicate a type that is not represented by any of the counters in iscsiTargetLoginStatsTable.
iscsiTgtLastIntrFailureName
1.3.6.1.2.1.142.1.6.1.1.4
IscsiNameThis data type is used for objects whose value is an iSCSI name with the properties described in RFC 7143, Section 4.2.7.1, and encoded as specified in RFC 7143, Section 4.2.7.2. A zero-length string indicates the absence of an iSCSI name.Reference: RFC 7143, Section 4.2.7, iSCSI Names. SIZE (0 | 16..223) · OCTET STRING · hint 223t
The iSCSI name of the initiator that failed the last login attempt. If no such failures have occurred since the last system boot, this value is a zero-length string.
iscsiTgtLastIntrFailureAddrType
1.3.6.1.2.1.142.1.6.1.1.5
InetAddressType0 = unknown1 = ipv42 = ipv63 = ipv4z4 = ipv6z16 = dnsA value that represents a type of Internet address.
unknown(0) An unknown address type. This value MUST
be used if the value of the corresponding InetAddress object is a zero-length string. It may also be used to indicate an IP address that is not in one of the formats defined below.
ipv4(1) An IPv4 address as defined by the
InetAddressIPv4 textual convention.
ipv6(2) An IPv6 address as defined by the
InetAddressIPv6 textual convention.
ipv4z(3) A non-global IPv4 address including a zone
index as defined by the InetAddressIPv4z textual convention.
ipv6z(4) A non-global IPv6 address including a zone
index as defined by the InetAddressIPv6z textual convention.
dns(16) A DNS domain name as defined by the
InetAddressDNS textual convention.
Each definition of a concrete InetAddressType value must be accompanied by a definition of a textual convention for use with that InetAddressType.
To support future extensions, the InetAddressType textual convention SHOULD NOT be sub-typed in object type definitions. It MAY be sub-typed in compliance statements in order to require only a subset of these address types for a compliant implementation.
Implementations must ensure that InetAddressType objects and any dependent objects (e.g., InetAddress objects) are consistent. An inconsistentValue error must be generated if an attempt to change an InetAddressType object would, for example, lead to an undefined InetAddress value. In particular, InetAddressType/InetAddress pairs must be changed together if the address type changes (e.g., from ipv6(2) to ipv4(1)). · Integer32
The type of Internet Network Address contained in the corresponding instance of the iscsiTgtLastIntrFailureAddr. The value 'dns' is not allowed. If no such failures have occurred since the last system boot, this value is zero.
iscsiTgtLastIntrFailureAddr
1.3.6.1.2.1.142.1.6.1.1.6
InetAddressDenotes a generic Internet address.
An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row.
The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error.
When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate. SIZE (0..255) · OCTET STRING
An Internet Network Address, of the type specified by the object iscsiTgtLastIntrFailureAddrType, giving the host address of the initiator that failed the last login attempt. If no such failures have occurred since the last system boot, this value is a zero-length string.
iscsiTgtLastIntrFailurePort
1.3.6.1.2.1.142.1.6.1.1.7
InetPortNumberRepresents a 16 bit port number of an Internet transport layer protocol. Port numbers are assigned by IANA. A current list of all assignments is available from <http://www.iana.org/>.
The value zero is object-specific and must be defined as part of the description of any object that uses this syntax. Examples of the usage of zero might include situations where a port number is unknown, or when the value zero is used as a wildcard in a filter.Reference: STD 6 (RFC 768), STD 7 (RFC 793) and RFC 2960 (0..65535) · Unsigned32 · hint d
The transport protocol port number used by the initiator that failed the last login attempt. If no such failures have occurred since the last system boot, this value is a zero-length string.
A table of counters that keep a record of the results of initiators' login attempts to this target.
iscsiTgtLoginAccepts
1.3.6.1.2.1.142.1.6.2.1.1
Counter32 · successful logins
The count of Login Response PDUs with status 0x0000, Accept Login, transmitted by this target. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime. Reference: RFC 7143, Section 11.13.5, Status-Class and Status-Detail
iscsiTgtLoginOtherFails
1.3.6.1.2.1.142.1.6.2.1.2
Counter32 · failed logins
The number of Login Response PDUs that were transmitted by this target and that were not counted by any other object in the row. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime. Reference: RFC 7143, Section 11.13.5, Status-Class and Status-Detail
iscsiTgtLoginRedirects
1.3.6.1.2.1.142.1.6.2.1.3
Counter32 · redirected logins
The count of Login Response PDUs with status class 0x01, Redirection, transmitted by this target. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime. Reference: RFC 7143, Section 11.13.5, Status-Class and Status-Detail
iscsiTgtLoginAuthorizeFails
1.3.6.1.2.1.142.1.6.2.1.4
Counter32 · failed logins
The count of Login Response PDUs with status 0x0202, Forbidden Target, transmitted by this target.
If this counter is incremented, an iscsiTgtLoginFailure notification should be generated. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime. Reference: RFC 7143, Section 11.13.5, Status-Class and Status-Detail
iscsiTgtLoginAuthenticateFails
1.3.6.1.2.1.142.1.6.2.1.5
Counter32 · failed logins
The count of Login Response PDUs with status 0x0201, Authentication Failed, transmitted by this target.
If this counter is incremented, an iscsiTgtLoginFailure notification should be generated.
If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime. Reference: RFC 7143, Section 11.13.5, Status-Class and Status-Detail
iscsiTgtLoginNegotiateFails
1.3.6.1.2.1.142.1.6.2.1.6
Counter32 · failed logins
The number of times a target has effectively refused a login because the parameter negotiation failed. If this counter is incremented, an iscsiTgtLoginFailure notification should be generated. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime.
When a target receives a Logout command, it responds with a Logout Response that carries a status code. This table contains counters for both normal and abnormal Logout Requests received by this target.
iscsiTgtLogoutNormals
1.3.6.1.2.1.142.1.6.3.1.1
Counter32 · normal logouts
The count of Logout Command PDUs received by this target, with reason code 0 (closes the session). If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime. Reference: RFC 7143, Section 11.14.1, Reason Code
iscsiTgtLogoutOthers
1.3.6.1.2.1.142.1.6.3.1.2
Counter32 · abnormal logouts
The count of Logout Command PDUs received by this target, with any reason code other than 0. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime. Reference: RFC 7143, Section 11.14.1, Reason Code
iscsiTgtLogoutCxnClosed
1.3.6.1.2.1.142.1.6.3.1.3
Counter32 · abnormal logouts
The count of Logout Command PDUs received by this target, with reason code 1 (closes the connection). If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime. Reference: RFC 7143, Section 11.14.1, Reason Code
iscsiTgtLogoutCxnRemoved
1.3.6.1.2.1.142.1.6.3.1.4
Counter32 · abnormal logouts
The count of Logout Command PDUs received by this target, with reason code 2 (removes the connection). If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime. Reference: RFC 7143, Section 11.14.1, Reason Code
A list of initiator identities that are authorized to access each target node within each iSCSI instance present on the local system.
iscsiTgtAuthIndex
1.3.6.1.2.1.142.1.7.1.1.1
Unsigned32 (1..4294967295)
An arbitrary integer used to uniquely identify a particular target's authorized initiator identity within an iSCSI instance present on the local system. This index value must not be modified or reused by an agent unless a reboot has occurred. An agent should attempt to keep this value persistent across reboots.
iscsiTgtAuthRowStatus
1.3.6.1.2.1.142.1.7.1.1.2
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 field allows entries to be dynamically added and removed from this table via SNMP. When adding a row to this table, all non-Index/RowStatus objects must be set. When the value of this object is 'active', the values of the other objects in this table cannot be changed. Rows may be discarded using RowStatus.
iscsiTgtAuthIdentity
1.3.6.1.2.1.142.1.7.1.1.3
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 the corresponding user entry in the IPS-AUTH MIB module that will be allowed to access this iSCSI target. Reference: IPS-AUTH MIB, RFC 4545, Section 7.3, ipsAuthIdentity
iscsiTgtAuthStorageType
1.3.6.1.2.1.142.1.7.1.1.4
StorageType1 = other2 = volatile3 = nonVolatile4 = permanent5 = readOnlyDescribes the memory realization of a conceptual row. A row which is volatile(2) is lost upon reboot. A row which is either nonVolatile(3), permanent(4) or readOnly(5), is backed up by stable storage. A row which is permanent(4) can be changed but not deleted. A row which is readOnly(5) cannot be changed nor deleted.
If the value of an object with this syntax is either permanent(4) or readOnly(5), it cannot be written. Conversely, if the value is either other(1), volatile(2) or nonVolatile(3), it cannot be modified to be permanent(4) or readOnly(5). (All illegal modifications result in a 'wrongValue' error.)
Every usage of this textual convention is required to specify the columnar objects which a permanent(4) row must at a minimum allow to be writable. · Integer32
The storage type for this row. Rows in this table that were created through an external process (e.g., not created via this MIB) may have a storage type of readOnly or permanent.
Conceptual rows having the value 'permanent' need not allow write access to any columnar objects in the row.
iscsiInitiatorAttributesTable
1.3.6.1.2.1.142.1.8.1
Index: iscsiInstIndex · iscsiNodeIndex
A list of iSCSI nodes that can take on an initiator role, belonging to each iSCSI instance present on the local system.
iscsiIntrLoginFailures
1.3.6.1.2.1.142.1.8.1.1.1
Counter32 · failed logins
This object counts the number of times a login attempt from this local initiator has failed. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime. Reference: RFC 7143, Section 11.13.5, Status-Class and Status-Detail
iscsiIntrLastFailureTime
1.3.6.1.2.1.142.1.8.1.1.2
TimeStampThe value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be
defined in the description of any object defined using this type.
If sysUpTime is reset to zero as a result of a re- initialization of the network management (sub)system, then the values of all TimeStamp objects are also reset. However, after approximately 497 days without a re- initialization, the sysUpTime object will reach 2^^32-1 and then increment around to zero; in this case, existing values of TimeStamp objects do not change. This can lead to ambiguities in the value of TimeStamp objects. · TimeTicks
The timestamp of the most recent failure of a login attempt from this initiator. A value of zero indicates that no such failures have occurred since the last system boot.
iscsiIntrLastFailureType
1.3.6.1.2.1.142.1.8.1.1.3
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 the most recent failure of a login attempt from this initiator, represented as the OID of the counter object in iscsiInitiatorLoginStatsTable for which the relevant instance was incremented. If no such failures have occurred since the last system boot, this attribute will have the value 0.0. A value of 0.0 may also be used to indicate a type that is not represented by any of the counters in iscsiInitiatorLoginStatsTable.
iscsiIntrLastTgtFailureName
1.3.6.1.2.1.142.1.8.1.1.4
IscsiNameThis data type is used for objects whose value is an iSCSI name with the properties described in RFC 7143, Section 4.2.7.1, and encoded as specified in RFC 7143, Section 4.2.7.2. A zero-length string indicates the absence of an iSCSI name.Reference: RFC 7143, Section 4.2.7, iSCSI Names. SIZE (0 | 16..223) · OCTET STRING · hint 223t
A UTF-8 string giving the name of the target that failed the last login attempt. If no such failures have occurred since the last system boot, this value is a zero-length string.
iscsiIntrLastTgtFailureAddrType
1.3.6.1.2.1.142.1.8.1.1.5
InetAddressType0 = unknown1 = ipv42 = ipv63 = ipv4z4 = ipv6z16 = dnsA value that represents a type of Internet address.
unknown(0) An unknown address type. This value MUST
be used if the value of the corresponding InetAddress object is a zero-length string. It may also be used to indicate an IP address that is not in one of the formats defined below.
ipv4(1) An IPv4 address as defined by the
InetAddressIPv4 textual convention.
ipv6(2) An IPv6 address as defined by the
InetAddressIPv6 textual convention.
ipv4z(3) A non-global IPv4 address including a zone
index as defined by the InetAddressIPv4z textual convention.
ipv6z(4) A non-global IPv6 address including a zone
index as defined by the InetAddressIPv6z textual convention.
dns(16) A DNS domain name as defined by the
InetAddressDNS textual convention.
Each definition of a concrete InetAddressType value must be accompanied by a definition of a textual convention for use with that InetAddressType.
To support future extensions, the InetAddressType textual convention SHOULD NOT be sub-typed in object type definitions. It MAY be sub-typed in compliance statements in order to require only a subset of these address types for a compliant implementation.
Implementations must ensure that InetAddressType objects and any dependent objects (e.g., InetAddress objects) are consistent. An inconsistentValue error must be generated if an attempt to change an InetAddressType object would, for example, lead to an undefined InetAddress value. In particular, InetAddressType/InetAddress pairs must be changed together if the address type changes (e.g., from ipv6(2) to ipv4(1)). · Integer32
The type of Internet Network Address contained in the corresponding instance of the iscsiIntrLastTgtFailureAddr. The value 'dns' is not allowed. If no such failures have occurred since the last system boot, this value is zero.
iscsiIntrLastTgtFailureAddr
1.3.6.1.2.1.142.1.8.1.1.6
InetAddressDenotes a generic Internet address.
An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row.
The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error.
When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate. SIZE (0..255) · OCTET STRING
An Internet Network Address, of the type specified by the object iscsiIntrLastTgtFailureAddrType, giving the host address of the target that failed the last login attempt. If no such failures have occurred since the last system boot, this value is a zero-length string.
iscsiIntrLastTgtFailurePort
1.3.6.1.2.1.142.1.8.1.1.7
InetPortNumberRepresents a 16 bit port number of an Internet transport layer protocol. Port numbers are assigned by IANA. A current list of all assignments is available from <http://www.iana.org/>.
The value zero is object-specific and must be defined as part of the description of any object that uses this syntax. Examples of the usage of zero might include situations where a port number is unknown, or when the value zero is used as a wildcard in a filter.Reference: STD 6 (RFC 768), STD 7 (RFC 793) and RFC 2960 (0..65535) · Unsigned32 · hint d
The transport protocol port number used by the target that failed the last login attempt. If no such failures have occurred since the last system boot, this value is a zero-length string.
A table of counters that keep track of the results of this initiator's login attempts.
iscsiIntrLoginAcceptRsps
1.3.6.1.2.1.142.1.8.2.1.1
Counter32 · successful logins
The count of Login Response PDUs with status 0x0000, Accept Login, received by this initiator. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime. Reference: RFC 7143, Section 11.13.5, Status-Class and Status-Detail
iscsiIntrLoginOtherFailRsps
1.3.6.1.2.1.142.1.8.2.1.2
Counter32 · failed logins
The count of Login Response PDUs received by this initiator with any status code not counted in the objects below. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime. Reference: RFC 7143, Section 11.13.5, Status-Class and Status-Detail
iscsiIntrLoginRedirectRsps
1.3.6.1.2.1.142.1.8.2.1.3
Counter32 · failed logins
The count of Login Response PDUs with status class 0x01, Redirection, received by this initiator. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime. Reference: RFC 7143, Section 11.13.5, Status-Class and Status-Detail
iscsiIntrLoginAuthFailRsps
1.3.6.1.2.1.142.1.8.2.1.4
Counter32 · failed logins
The count of Login Response PDUs with status class 0x201, Authentication Failed, received by this initiator. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime. Reference: RFC 7143, Section 11.13.5, Status-Class and Status-Detail
iscsiIntrLoginAuthenticateFails
1.3.6.1.2.1.142.1.8.2.1.5
Counter32 · failed logins
The number of times the initiator has aborted a login because the target could not be authenticated.
No response is generated.
If this counter is incremented, an iscsiIntrLoginFailure notification should be generated. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime. Reference: RFC 7143, Section 11.13.5, Status-Class and Status-Detail
iscsiIntrLoginNegotiateFails
1.3.6.1.2.1.142.1.8.2.1.6
Counter32 · failed logins
The number of times the initiator has aborted a login because parameter negotiation with the target failed.
No response is generated.
If this counter is incremented, an iscsiIntrLoginFailure notification should be generated. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime. Reference: RFC 7143, Section 7.12, Negotiation Failures
iscsiIntrLoginAuthorizeFails
1.3.6.1.2.1.142.1.8.2.1.7
Counter32 · failed logins
The count of Login Response PDUs with status 0x0202, Forbidden Target, received by this initiator.
If this counter is incremented, an iscsiIntrLoginFailure notification should be generated. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime. Reference: RFC 7143, Section 11.13.5, Status-Class and Status-Detail
When an initiator attempts to send a Logout command, the target responds with a Logout Response that carries a status code. This table contains a list of counters of Logout Response PDUs of each status code that was received by each initiator belonging to this iSCSI instance present on this system.
iscsiIntrLogoutNormals
1.3.6.1.2.1.142.1.8.3.1.1
Counter32 · normal logouts
The count of Logout Command PDUs generated by this initiator with reason code 0 (closes the session). If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime. Reference: RFC 7143, Section 11.14.1, Reason Code
iscsiIntrLogoutOthers
1.3.6.1.2.1.142.1.8.3.1.2
Counter32 · abnormal logouts
The count of Logout Command PDUs generated by this initiator with any status code other than 0. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime. Reference: RFC 7143, Section 11.14.1, Reason Code
A list of target identities that each initiator on the local system may access.
iscsiIntrAuthIndex
1.3.6.1.2.1.142.1.9.1.1.1
Unsigned32 (1..4294967295)
An arbitrary integer used to uniquely identify a particular initiator node's authorized target identity within an iSCSI instance present on the local system. This index value must not be modified or reused by an agent unless a reboot has occurred. An agent should attempt to keep this value persistent across reboots.
iscsiIntrAuthRowStatus
1.3.6.1.2.1.142.1.9.1.1.2
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 field allows entries to be dynamically added and removed from this table via SNMP. When adding a row to this table, all non-Index/RowStatus objects must be set. When the value of this object is 'active', the values of the other objects in this table cannot be changed. Rows may be discarded using RowStatus.
iscsiIntrAuthIdentity
1.3.6.1.2.1.142.1.9.1.1.3
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 the corresponding user entry in the IPS-AUTH MIB module to which this initiator node should attempt to establish an iSCSI session. Reference: IPS-AUTH MIB, RFC 4545, Section 7.3, ipsAuthIdentity
iscsiIntrAuthStorageType
1.3.6.1.2.1.142.1.9.1.1.4
StorageType1 = other2 = volatile3 = nonVolatile4 = permanent5 = readOnlyDescribes the memory realization of a conceptual row. A row which is volatile(2) is lost upon reboot. A row which is either nonVolatile(3), permanent(4) or readOnly(5), is backed up by stable storage. A row which is permanent(4) can be changed but not deleted. A row which is readOnly(5) cannot be changed nor deleted.
If the value of an object with this syntax is either permanent(4) or readOnly(5), it cannot be written. Conversely, if the value is either other(1), volatile(2) or nonVolatile(3), it cannot be modified to be permanent(4) or readOnly(5). (All illegal modifications result in a 'wrongValue' error.)
Every usage of this textual convention is required to specify the columnar objects which a permanent(4) row must at a minimum allow to be writable. · Integer32
The storage type for this row. Rows in this table that were created through an external process (e.g., not created via this MIB) may have a storage type of readOnly or permanent.
Conceptual rows having the value 'permanent' need not allow write access to any columnar objects in the row.
A list of sessions belonging to each iSCSI instance present on the system.
iscsiSsnNodeIndex
1.3.6.1.2.1.142.1.10.1.1.1
Unsigned32
An arbitrary integer used to uniquely identify a particular node within an iSCSI instance present on the local system. For normal, non-discovery sessions, this value will map to the iscsiNodeIndex. For discovery sessions that do not have a node associated, the value 0 (zero) is used.
iscsiSsnIndex
1.3.6.1.2.1.142.1.10.1.1.2
Unsigned32 (1..4294967295)
An arbitrary integer used to uniquely identify a particular session within an iSCSI instance present on the local system. An agent should attempt to not reuse index values unless a reboot has occurred. iSCSI sessions are destroyed during a reboot; rows in this table are not persistent across reboots.
Direction of iSCSI session:
inboundSession - session is established from an external
initiator to a target within this iSCSI instance. outboundSession - session is established from an initiator within this iSCSI instance to an external target.
iscsiSsnInitiatorName
1.3.6.1.2.1.142.1.10.1.1.4
IscsiNameThis data type is used for objects whose value is an iSCSI name with the properties described in RFC 7143, Section 4.2.7.1, and encoded as specified in RFC 7143, Section 4.2.7.2. A zero-length string indicates the absence of an iSCSI name.Reference: RFC 7143, Section 4.2.7, iSCSI Names. SIZE (0 | 16..223) · OCTET STRING · hint 223t
If iscsiSsnDirection is Inbound, this object is a UTF-8 string that will contain the name of the remote initiator. If this session is a discovery session that does not specify a particular initiator, this object will contain a zero-length string.
If iscsiSsnDirection is Outbound, this object will contain a zero-length string.
iscsiSsnTargetName
1.3.6.1.2.1.142.1.10.1.1.5
IscsiNameThis data type is used for objects whose value is an iSCSI name with the properties described in RFC 7143, Section 4.2.7.1, and encoded as specified in RFC 7143, Section 4.2.7.2. A zero-length string indicates the absence of an iSCSI name.Reference: RFC 7143, Section 4.2.7, iSCSI Names. SIZE (0 | 16..223) · OCTET STRING · hint 223t
If iscsiSsnDirection is Outbound, this object is a UTF-8 string that will contain the name of the remote target. If this session is a discovery session that does not specify a particular target, this object will contain a zero-length string.
If iscsiSsnDirection is Inbound, this object will contain a zero-length string.
iscsiSsnTSIH
1.3.6.1.2.1.142.1.10.1.1.6
Unsigned32 (1..65535)
The target-defined identification handle for this session. Reference: RFC 7143, Section 11.12.6, TSIH
iscsiSsnISID
1.3.6.1.2.1.142.1.10.1.1.7
OCTET STRING SIZE (6)
The initiator-defined portion of the iSCSI Session ID. Reference: RFC 7143, Section 11.12.5, ISID
iscsiSsnInitiatorAlias
1.3.6.1.2.1.142.1.10.1.1.8
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..255) · OCTET STRING · hint 255t
A UTF-8 string that gives the alias communicated by the initiator end of the session during the login phase.
If no alias exists, the value is a zero-length string. Reference: RFC 7143, Section 13.7, InitiatorAlias
iscsiSsnTargetAlias
1.3.6.1.2.1.142.1.10.1.1.9
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..255) · OCTET STRING · hint 255t
A UTF-8 string that gives the alias communicated by the target end of the session during the login phase.
If no alias exists, the value is a zero-length string. Reference: RFC 7143, Section 13.6, TargetAlias
iscsiSsnInitialR2T
1.3.6.1.2.1.142.1.10.1.1.10
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
If set to true, indicates that the initiator must wait for an R2T before sending to the target. If set to false, the initiator may send data immediately, within limits set by iscsiSsnFirstBurstLength and the expected data transfer length of the request. Reference: RFC 7143, Section 13.10, InitialR2T
iscsiSsnImmediateData
1.3.6.1.2.1.142.1.10.1.1.11
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
Indicates whether the initiator and target have agreed to support immediate data on this session. Reference: RFC 7143, Section 13.11, ImmediateData
Type of iSCSI session:
normalSession - session is a normal iSCSI session
discoverySession - session is being used only for discovery. Reference: RFC 7143, Section 13.21, SessionType
iscsiSsnMaxOutstandingR2T
1.3.6.1.2.1.142.1.10.1.1.13
Unsigned32 (1..65535) · R2Ts
The maximum number of outstanding requests-to-transmit (R2Ts) per iSCSI task within this session. Reference: RFC 7143, Section 13.17, MaxOutstandingR2T
iscsiSsnFirstBurstLength
1.3.6.1.2.1.142.1.10.1.1.14
Unsigned32 (512..16777215) · bytes
The maximum length supported for unsolicited data sent within this session. Reference: RFC 7143, Section 13.14, FirstBurstLength
iscsiSsnMaxBurstLength
1.3.6.1.2.1.142.1.10.1.1.15
Unsigned32 (512..16777215) · bytes
The maximum number of bytes that can be sent within a single sequence of Data-In or Data-Out PDUs. Reference: RFC 7143, Section 13.13, MaxBurstLength
iscsiSsnConnectionNumber
1.3.6.1.2.1.142.1.10.1.1.16
Gauge32 (1..65535) · connections
The number of transport protocol connections that currently belong to this session.
iscsiSsnAuthIdentity
1.3.6.1.2.1.142.1.10.1.1.17
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 contains a pointer to a row in the IPS-AUTH MIB module that identifies the authentication identity being used on this session, as communicated during the login phase. Reference: IPS-AUTH MIB, RFC 4545, Section 7.3, ipsAuthIdentity
iscsiSsnDataSequenceInOrder
1.3.6.1.2.1.142.1.10.1.1.18
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
False indicates that iSCSI data PDU sequences may be transferred in any order. True indicates that data PDU sequences must be transferred using continuously increasing offsets, except during error recovery. Reference: RFC 7143, Section 13.19, DataSequenceInOrder
iscsiSsnDataPDUInOrder
1.3.6.1.2.1.142.1.10.1.1.19
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
False indicates that iSCSI data PDUs within sequences may be in any order. True indicates that data PDUs within sequences must be at continuously increasing addresses, with no gaps or overlay between PDUs. Default is true. Reference: RFC 7143, Section 13.18, DataPDUInOrder
iscsiSsnErrorRecoveryLevel
1.3.6.1.2.1.142.1.10.1.1.20
Unsigned32 (0..255)
The level of error recovery negotiated between the initiator and the target. Higher numbers represent more detailed recovery schemes. Reference: RFC 7143, Section 13.20, ErrorRecoveryLevel
iscsiSsnDiscontinuityTime
1.3.6.1.2.1.142.1.10.1.1.21
TimeStampThe value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be
defined in the description of any object defined using this type.
If sysUpTime is reset to zero as a result of a re- initialization of the network management (sub)system, then the values of all TimeStamp objects are also reset. However, after approximately 497 days without a re- initialization, the sysUpTime object will reach 2^^32-1 and then increment around to zero; in this case, existing values of TimeStamp objects do not change. This can lead to ambiguities in the value of TimeStamp objects. · TimeTicks
The value of SysUpTime on the most recent occasion at which any one or more of this session's counters suffered a discontinuity. When a session is established, and this object is created, it is initialized to the current value of SysUpTime.
iscsiSsnProtocolLevel
1.3.6.1.2.1.142.1.10.1.1.22
Unsigned32 (0..31)
The iSCSI protocol level negotiated for this session. Reference: RFC 7144, Section 7.1.1, iSCSIProtocolLevel
iscsiSsnTaskReporting
1.3.6.1.2.1.142.1.10.1.1.23
BITS
This key is used to negotiate the task completion reporting semantics from the SCSI target.
Default value is taskReportingRfc3720. Reference: RFC 7143, Section 13.23, TaskReporting
A list of general iSCSI traffic counters for each of the sessions present on the system.
iscsiSsnCmdPDUs
1.3.6.1.2.1.142.1.10.2.1.1
Counter32 · PDUs
The count of Command PDUs transferred on this session. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiSsnDiscontinuityTime.
iscsiSsnRspPDUs
1.3.6.1.2.1.142.1.10.2.1.2
Counter32 · PDUs
The count of Response PDUs transferred on this session. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiSsnDiscontinuityTime.
iscsiSsnTxDataOctets
1.3.6.1.2.1.142.1.10.2.1.3
Counter64 (0..18446744073709551615) · octets
The count of data octets that were transmitted by the local iSCSI node on this session. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiSsnDiscontinuityTime.
iscsiSsnRxDataOctets
1.3.6.1.2.1.142.1.10.2.1.4
Counter64 (0..18446744073709551615) · octets
The count of data octets that were received by the local iSCSI node on this session. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiSsnDiscontinuityTime.
iscsiSsnLCTxDataOctets
1.3.6.1.2.1.142.1.10.2.1.5
Counter32 · octets
A Low-Capacity shadow object of iscsiSsnTxDataOctets for those systems that are accessible via SNMPv1 only. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiSsnDiscontinuityTime.
iscsiSsnLCRxDataOctets
1.3.6.1.2.1.142.1.10.2.1.6
Counter32 · octets
A Low-Capacity shadow object of iscsiSsnRxDataOctets for those systems which are accessible via SNMPv1 only. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiSsnDiscontinuityTime.
iscsiSsnNopReceivedPDUs
1.3.6.1.2.1.142.1.10.2.1.7
Counter32 · PDUs
The count of NOP-In or NOP-Out PDUs received on this session. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiSsnDiscontinuityTime.
iscsiSsnNopSentPDUs
1.3.6.1.2.1.142.1.10.2.1.8
Counter32 · PDUs
The count of NOP-In or NOP-Out PDUs sent on this session. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiSsnDiscontinuityTime.
A list of error counters for each of the sessions present on this system.
iscsiSsnCxnDigestErrors
1.3.6.1.2.1.142.1.10.3.1.1
Counter32 · PDUs
The count of PDUs that were received on the session and contained header or data digest errors. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiSsnDiscontinuityTime. This counter is most likely provided when the error-recovery level is 1 or 2 Reference: RFC 7143, Section 7.8, Digest Errors
iscsiSsnCxnTimeoutErrors
1.3.6.1.2.1.142.1.10.3.1.2
Counter32 · connections
The count of connections within this session that have been terminated due to timeout. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiSsnDiscontinuityTime. This counter is most likely provided when the error-recovery level is 2 Reference: RFC 7143, Section 7.5, Connection Timeout Management
A list of connections belonging to each iSCSI instance present on the system.
iscsiCxnIndex
1.3.6.1.2.1.142.1.11.1.1.1
Unsigned32 (1..4294967295)
An arbitrary integer used to uniquely identify a particular connection of a particular session within an iSCSI instance present on the local system. An agent should attempt to not reuse index values unless a reboot has occurred. iSCSI connections are destroyed during a reboot; rows in this table are not persistent across reboots.
iscsiCxnCid
1.3.6.1.2.1.142.1.11.1.1.2
Unsigned32 (1..65535)
The iSCSI Connection ID for this connection.
iscsiCxnState
1.3.6.1.2.1.142.1.11.1.1.3
INTEGER1 = login2 = full3 = logout · Integer32
The current state of this connection, from an iSCSI negotiation point of view. Here are the states:
login - The transport protocol connection has been established,
but a valid iSCSI login response with the final bit set has not been sent or received.
full - A valid iSCSI login response with the final bit set
has been sent or received. logout - A valid iSCSI logout command has been sent or received, but the transport protocol connection has not yet been closed.
iscsiCxnAddrType
1.3.6.1.2.1.142.1.11.1.1.4
InetAddressType0 = unknown1 = ipv42 = ipv63 = ipv4z4 = ipv6z16 = dnsA value that represents a type of Internet address.
unknown(0) An unknown address type. This value MUST
be used if the value of the corresponding InetAddress object is a zero-length string. It may also be used to indicate an IP address that is not in one of the formats defined below.
ipv4(1) An IPv4 address as defined by the
InetAddressIPv4 textual convention.
ipv6(2) An IPv6 address as defined by the
InetAddressIPv6 textual convention.
ipv4z(3) A non-global IPv4 address including a zone
index as defined by the InetAddressIPv4z textual convention.
ipv6z(4) A non-global IPv6 address including a zone
index as defined by the InetAddressIPv6z textual convention.
dns(16) A DNS domain name as defined by the
InetAddressDNS textual convention.
Each definition of a concrete InetAddressType value must be accompanied by a definition of a textual convention for use with that InetAddressType.
To support future extensions, the InetAddressType textual convention SHOULD NOT be sub-typed in object type definitions. It MAY be sub-typed in compliance statements in order to require only a subset of these address types for a compliant implementation.
Implementations must ensure that InetAddressType objects and any dependent objects (e.g., InetAddress objects) are consistent. An inconsistentValue error must be generated if an attempt to change an InetAddressType object would, for example, lead to an undefined InetAddress value. In particular, InetAddressType/InetAddress pairs must be changed together if the address type changes (e.g., from ipv6(2) to ipv4(1)). · Integer32
The type of Internet Network Addresses contained in the corresponding instances of iscsiCxnLocalAddr and iscsiCxnRemoteAddr. The value 'dns' is not allowed.
iscsiCxnLocalAddr
1.3.6.1.2.1.142.1.11.1.1.5
InetAddressDenotes a generic Internet address.
An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row.
The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error.
When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate. SIZE (0..255) · OCTET STRING
The local Internet Network Address, of the type specified by iscsiCxnAddrType, used by this connection.
iscsiCxnProtocol
1.3.6.1.2.1.142.1.11.1.1.6
IscsiTransportProtocolThis data type is used to define the transport protocols that will carry iSCSI PDUs. Protocol numbers are assigned by IANA. A current list of all assignments is available from <http://www.iana.org/assignments/protocol-numbers/>. (0..255) · Unsigned32 · hint d
The transport protocol over which this connection is running.
iscsiCxnLocalPort
1.3.6.1.2.1.142.1.11.1.1.7
InetPortNumberRepresents a 16 bit port number of an Internet transport layer protocol. Port numbers are assigned by IANA. A current list of all assignments is available from <http://www.iana.org/>.
The value zero is object-specific and must be defined as part of the description of any object that uses this syntax. Examples of the usage of zero might include situations where a port number is unknown, or when the value zero is used as a wildcard in a filter.Reference: STD 6 (RFC 768), STD 7 (RFC 793) and RFC 2960 (0..65535) · Unsigned32 · hint d
The local transport protocol port used by this connection. This object cannot have the value zero, since it represents an established connection.
iscsiCxnRemoteAddr
1.3.6.1.2.1.142.1.11.1.1.8
InetAddressDenotes a generic Internet address.
An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row.
The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error.
When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate. SIZE (0..255) · OCTET STRING
The remote Internet Network Address, of the type specified by iscsiCxnAddrType, used by this connection.
iscsiCxnRemotePort
1.3.6.1.2.1.142.1.11.1.1.9
InetPortNumberRepresents a 16 bit port number of an Internet transport layer protocol. Port numbers are assigned by IANA. A current list of all assignments is available from <http://www.iana.org/>.
The value zero is object-specific and must be defined as part of the description of any object that uses this syntax. Examples of the usage of zero might include situations where a port number is unknown, or when the value zero is used as a wildcard in a filter.Reference: STD 6 (RFC 768), STD 7 (RFC 793) and RFC 2960 (0..65535) · Unsigned32 · hint d
The remote transport protocol port used by this connection. This object cannot have the value zero, since it represents an established connection.
iscsiCxnMaxRecvDataSegLength
1.3.6.1.2.1.142.1.11.1.1.10
Unsigned32 (512..16777215) · bytes
The maximum data payload size supported for command or data PDUs able to be received on this connection. Reference: RFC 7143, Section 13.12, MaxRecvDataSegmentLength
iscsiCxnMaxXmitDataSegLength
1.3.6.1.2.1.142.1.11.1.1.11
Unsigned32 (512..16777215) · bytes
The maximum data payload size supported for command or data PDUs to be sent on this connection. Reference: RFC 7143, Section 13.12, MaxRecvDataSegmentLength
iscsiCxnHeaderIntegrity
1.3.6.1.2.1.142.1.11.1.1.12
IscsiDigestMethod1 = none2 = other3 = noDigest4 = crc32cThis data type represents the methods possible for digest negotiation.
none - a placeholder for a secondary digest method
that means only the primary method can be used.
other - a digest method other than those defined below.
noDigest - does not support digests (will operate without a digest (Note: implementations must support digests to be compliant with RFC 7143).
CRC32c - require a CRC32C digest.Reference: RFC 7143, Section 13.1, HeaderDigest and DataDigest · Integer32
This object identifies the iSCSI header digest scheme in use within this connection.
iscsiCxnDataIntegrity
1.3.6.1.2.1.142.1.11.1.1.13
IscsiDigestMethod1 = none2 = other3 = noDigest4 = crc32cThis data type represents the methods possible for digest negotiation.
none - a placeholder for a secondary digest method
that means only the primary method can be used.
other - a digest method other than those defined below.
noDigest - does not support digests (will operate without a digest (Note: implementations must support digests to be compliant with RFC 7143).
CRC32c - require a CRC32C digest.Reference: RFC 7143, Section 13.1, HeaderDigest and DataDigest · Integer32
This object identifies the iSCSI data digest scheme in use within this connection.
iscsiCxnRecvMarker
1.3.6.1.2.1.142.1.11.1.1.14
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
This object indicates whether or not this connection is receiving markers in its incoming data stream. Reference: RFC 7143, Section 13.25, Obsoleted Keys.
iscsiCxnSendMarker
1.3.6.1.2.1.142.1.11.1.1.15
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
This object indicates whether or not this connection is inserting markers in its outgoing data stream. Reference: RFC 7143, Section 13.25, Obsoleted Keys.
iscsiCxnVersionActive
1.3.6.1.2.1.142.1.11.1.1.16
Unsigned32 (0..255)
Active version number of the iSCSI specification negotiated on this connection. Reference: RFC 7143, Section 11.12, Login Request
Trap details
iscsiTgtLoginFailure
1.3.6.1.2.1.142.0.1
Sent when a login is failed by a target.
To avoid sending an excessive number of notifications due to multiple errors counted, an SNMP agent implementing this notification SHOULD NOT send more than 3 notifications of this type in any 10-second time period.
iscsiTgtLoginFailures
1.3.6.1.2.1.142.1.6.1.1.1
Counter32 · failed login attempts
This object counts the number of times a login attempt to this local target has failed. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime. Reference: RFC 7143, Section 11.13.5, Status-Class and Status-Detail
iscsiTgtLastFailureType
1.3.6.1.2.1.142.1.6.1.1.3
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 the most recent failure of a login attempt to this target, represented as the OID of the counter object in iscsiTargetLoginStatsTable for which the relevant instance was incremented. If no such failures have occurred since the last system boot, this attribute will have the value 0.0. A value of 0.0 may also be used to indicate a type that is not represented by any of the counters in iscsiTargetLoginStatsTable.
iscsiTgtLastIntrFailureName
1.3.6.1.2.1.142.1.6.1.1.4
IscsiNameThis data type is used for objects whose value is an iSCSI name with the properties described in RFC 7143, Section 4.2.7.1, and encoded as specified in RFC 7143, Section 4.2.7.2. A zero-length string indicates the absence of an iSCSI name.Reference: RFC 7143, Section 4.2.7, iSCSI Names. SIZE (0 | 16..223) · OCTET STRING · hint 223t
The iSCSI name of the initiator that failed the last login attempt. If no such failures have occurred since the last system boot, this value is a zero-length string.
iscsiTgtLastIntrFailureAddrType
1.3.6.1.2.1.142.1.6.1.1.5
InetAddressType0 = unknown1 = ipv42 = ipv63 = ipv4z4 = ipv6z16 = dnsA value that represents a type of Internet address.
unknown(0) An unknown address type. This value MUST
be used if the value of the corresponding InetAddress object is a zero-length string. It may also be used to indicate an IP address that is not in one of the formats defined below.
ipv4(1) An IPv4 address as defined by the
InetAddressIPv4 textual convention.
ipv6(2) An IPv6 address as defined by the
InetAddressIPv6 textual convention.
ipv4z(3) A non-global IPv4 address including a zone
index as defined by the InetAddressIPv4z textual convention.
ipv6z(4) A non-global IPv6 address including a zone
index as defined by the InetAddressIPv6z textual convention.
dns(16) A DNS domain name as defined by the
InetAddressDNS textual convention.
Each definition of a concrete InetAddressType value must be accompanied by a definition of a textual convention for use with that InetAddressType.
To support future extensions, the InetAddressType textual convention SHOULD NOT be sub-typed in object type definitions. It MAY be sub-typed in compliance statements in order to require only a subset of these address types for a compliant implementation.
Implementations must ensure that InetAddressType objects and any dependent objects (e.g., InetAddress objects) are consistent. An inconsistentValue error must be generated if an attempt to change an InetAddressType object would, for example, lead to an undefined InetAddress value. In particular, InetAddressType/InetAddress pairs must be changed together if the address type changes (e.g., from ipv6(2) to ipv4(1)). · Integer32
The type of Internet Network Address contained in the corresponding instance of the iscsiTgtLastIntrFailureAddr. The value 'dns' is not allowed. If no such failures have occurred since the last system boot, this value is zero.
iscsiTgtLastIntrFailureAddr
1.3.6.1.2.1.142.1.6.1.1.6
InetAddressDenotes a generic Internet address.
An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row.
The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error.
When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate. SIZE (0..255) · OCTET STRING
An Internet Network Address, of the type specified by the object iscsiTgtLastIntrFailureAddrType, giving the host address of the initiator that failed the last login attempt. If no such failures have occurred since the last system boot, this value is a zero-length string.
iscsiTgtLastIntrFailurePort
1.3.6.1.2.1.142.1.6.1.1.7
InetPortNumberRepresents a 16 bit port number of an Internet transport layer protocol. Port numbers are assigned by IANA. A current list of all assignments is available from <http://www.iana.org/>.
The value zero is object-specific and must be defined as part of the description of any object that uses this syntax. Examples of the usage of zero might include situations where a port number is unknown, or when the value zero is used as a wildcard in a filter.Reference: STD 6 (RFC 768), STD 7 (RFC 793) and RFC 2960 (0..65535) · Unsigned32 · hint d
The transport protocol port number used by the initiator that failed the last login attempt. If no such failures have occurred since the last system boot, this value is a zero-length string.
iscsiIntrLoginFailure
1.3.6.1.2.1.142.0.2
Sent when a login is failed by an initiator.
To avoid sending an excessive number of notifications due to multiple errors counted, an SNMP agent implementing this notification SHOULD NOT send more than 3 notifications of this type in any 10-second time period.
iscsiIntrLoginFailures
1.3.6.1.2.1.142.1.8.1.1.1
Counter32 · failed logins
This object counts the number of times a login attempt from this local initiator has failed. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiNodeDiscontinuityTime. Reference: RFC 7143, Section 11.13.5, Status-Class and Status-Detail
iscsiIntrLastFailureType
1.3.6.1.2.1.142.1.8.1.1.3
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 the most recent failure of a login attempt from this initiator, represented as the OID of the counter object in iscsiInitiatorLoginStatsTable for which the relevant instance was incremented. If no such failures have occurred since the last system boot, this attribute will have the value 0.0. A value of 0.0 may also be used to indicate a type that is not represented by any of the counters in iscsiInitiatorLoginStatsTable.
iscsiIntrLastTgtFailureName
1.3.6.1.2.1.142.1.8.1.1.4
IscsiNameThis data type is used for objects whose value is an iSCSI name with the properties described in RFC 7143, Section 4.2.7.1, and encoded as specified in RFC 7143, Section 4.2.7.2. A zero-length string indicates the absence of an iSCSI name.Reference: RFC 7143, Section 4.2.7, iSCSI Names. SIZE (0 | 16..223) · OCTET STRING · hint 223t
A UTF-8 string giving the name of the target that failed the last login attempt. If no such failures have occurred since the last system boot, this value is a zero-length string.
iscsiIntrLastTgtFailureAddrType
1.3.6.1.2.1.142.1.8.1.1.5
InetAddressType0 = unknown1 = ipv42 = ipv63 = ipv4z4 = ipv6z16 = dnsA value that represents a type of Internet address.
unknown(0) An unknown address type. This value MUST
be used if the value of the corresponding InetAddress object is a zero-length string. It may also be used to indicate an IP address that is not in one of the formats defined below.
ipv4(1) An IPv4 address as defined by the
InetAddressIPv4 textual convention.
ipv6(2) An IPv6 address as defined by the
InetAddressIPv6 textual convention.
ipv4z(3) A non-global IPv4 address including a zone
index as defined by the InetAddressIPv4z textual convention.
ipv6z(4) A non-global IPv6 address including a zone
index as defined by the InetAddressIPv6z textual convention.
dns(16) A DNS domain name as defined by the
InetAddressDNS textual convention.
Each definition of a concrete InetAddressType value must be accompanied by a definition of a textual convention for use with that InetAddressType.
To support future extensions, the InetAddressType textual convention SHOULD NOT be sub-typed in object type definitions. It MAY be sub-typed in compliance statements in order to require only a subset of these address types for a compliant implementation.
Implementations must ensure that InetAddressType objects and any dependent objects (e.g., InetAddress objects) are consistent. An inconsistentValue error must be generated if an attempt to change an InetAddressType object would, for example, lead to an undefined InetAddress value. In particular, InetAddressType/InetAddress pairs must be changed together if the address type changes (e.g., from ipv6(2) to ipv4(1)). · Integer32
The type of Internet Network Address contained in the corresponding instance of the iscsiIntrLastTgtFailureAddr. The value 'dns' is not allowed. If no such failures have occurred since the last system boot, this value is zero.
iscsiIntrLastTgtFailureAddr
1.3.6.1.2.1.142.1.8.1.1.6
InetAddressDenotes a generic Internet address.
An InetAddress value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddress textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddress textual convention, if they appear in the same logical row.
The value of an InetAddress object must always be consistent with the value of the associated InetAddressType object. Attempts to set an InetAddress object to a value inconsistent with the associated InetAddressType must fail with an inconsistentValue error.
When this textual convention is used as the syntax of an index object, there may be issues with the limit of 128 sub-identifiers specified in SMIv2, STD 58. In this case, the object definition MUST include a 'SIZE' clause to limit the number of potential instance sub-identifiers; otherwise the applicable constraints MUST be stated in the appropriate conceptual row DESCRIPTION clauses, or in the surrounding documentation if there is no single DESCRIPTION clause that is appropriate. SIZE (0..255) · OCTET STRING
An Internet Network Address, of the type specified by the object iscsiIntrLastTgtFailureAddrType, giving the host address of the target that failed the last login attempt. If no such failures have occurred since the last system boot, this value is a zero-length string.
iscsiIntrLastTgtFailurePort
1.3.6.1.2.1.142.1.8.1.1.7
InetPortNumberRepresents a 16 bit port number of an Internet transport layer protocol. Port numbers are assigned by IANA. A current list of all assignments is available from <http://www.iana.org/>.
The value zero is object-specific and must be defined as part of the description of any object that uses this syntax. Examples of the usage of zero might include situations where a port number is unknown, or when the value zero is used as a wildcard in a filter.Reference: STD 6 (RFC 768), STD 7 (RFC 793) and RFC 2960 (0..65535) · Unsigned32 · hint d
The transport protocol port number used by the target that failed the last login attempt. If no such failures have occurred since the last system boot, this value is a zero-length string.
iscsiInstSessionFailure
1.3.6.1.2.1.142.0.3
Sent when an active session is failed by either the initiator or the target. To avoid sending an excessive number of notifications due to multiple errors counted, an SNMP agent implementing this notification SHOULD NOT send more than 3 notifications of this type in any 10-second time period.
iscsiInstSsnFailures
1.3.6.1.2.1.142.1.1.1.1.10
Counter32 · sessions
This object counts the number of times a session belonging to this instance has failed. If this counter has suffered a discontinuity, the time of the last discontinuity is indicated in iscsiInstDiscontinuityTime. Reference: RFC 7143, Section 13.1, HeaderDigest and DataDigest
iscsiInstLastSsnFailureType
1.3.6.1.2.1.142.1.1.1.1.11
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 counter object in the iscsiInstanceSsnErrorStatsTable that was incremented when the last session failure occurred.
If the reason for failure is not found in the iscsiInstanceSsnErrorStatsTable, the value { 0.0 } is used instead.
iscsiInstLastSsnRmtNodeName
1.3.6.1.2.1.142.1.1.1.1.12
IscsiNameThis data type is used for objects whose value is an iSCSI name with the properties described in RFC 7143, Section 4.2.7.1, and encoded as specified in RFC 7143, Section 4.2.7.2. A zero-length string indicates the absence of an iSCSI name.Reference: RFC 7143, Section 4.2.7, iSCSI Names. SIZE (0 | 16..223) · OCTET STRING · hint 223t
The iSCSI name of the remote node from the failed session.