EZ5 MIB Catalog

CISCO-RMON-CONFIG-MIB

2010-08-03

This module defines configuration extensions for some of the IETF RMON MIBs. The following terms are used throughout this MIB: A SPAN session is an association of one or more destination(s) with a set of source(s), along with other parameters, to specify the network traffic to be monitored. Each SPAN session is denoted by an unique number. The term 'remote SPAN', also called 'RSPAN', refers to the analysis of network traffic remotely, from destination port(s) for one or more source ports, distributed in one or more switches in a switched network, through a RSPAN VLAN.

Download CISCO-RMON-CONFIG-MIB.txt Open CISCO-RMON-CONFIG-MIB.txt in a new tab

SCALARS (11) · TABLES (8)

Scalars (11)

NameOID
rmonTimeFilterMode1.3.6.1.4.1.9.9.103.1.1.1
portCopyMaxIngressSessions1.3.6.1.4.1.9.9.103.1.2.2
portCopyMaxEgressSessions1.3.6.1.4.1.9.9.103.1.2.3
crcSpanDstPermitListEnabled1.3.6.1.4.1.9.9.103.1.2.7
rmonMaxAlarms1.3.6.1.4.1.9.9.103.1.4.1
rmonAlarmEnable1.3.6.1.4.1.9.9.103.1.4.2
rmonConfiguredAlarms1.3.6.1.4.1.9.9.103.1.4.3
rmonConfiguredHcAlarms1.3.6.1.4.1.9.9.103.1.4.4
crcSpanEgressReplicationMode1.3.6.1.4.1.9.9.103.1.5.1
crcSpanSharedSource1.3.6.1.4.1.9.9.103.1.6.2
crcSpanSharedDestination1.3.6.1.4.1.9.9.103.1.6.3

Tables (8)

NameOID
portCopyXTableaugments portCopyTable (SMON-MIB)1.3.6.1.4.1.9.9.103.1.2.1
crcSpanSessionTable1.3.6.1.4.1.9.9.103.1.2.4
crcERSpanSessionTable1.3.6.1.4.1.9.9.103.1.2.5
crcERSpanIFTable1.3.6.1.4.1.9.9.103.1.2.6
crcSpanDstPermitListTable1.3.6.1.4.1.9.9.103.1.2.8
rmonSampleConfigTable1.3.6.1.4.1.9.9.103.1.3.1
crcSpanSessionEgressModeTable1.3.6.1.4.1.9.9.103.1.5.2
crcSpanCapacityTable1.3.6.1.4.1.9.9.103.1.6.1

END OF TOC

Scalar details

rmonTimeFilterMode

1.3.6.1.4.1.9.9.103.1.1.1

INTEGER1 = stopAfterOne2 = stopAfterAll · Integer32

This object controls the way the SNMP agent implements the getnext operation for tables with a TimeFilter index, such as those found in the RMON2-MIB module. If this object has the value `stopAfterOne(1)', then a GetNext or GetBulk operation will provide one pass through a given table, i.e., the agent will continue to the next object or table, instead of incrementing a TimeMark INDEX value, even if there exists higher TimeMark values which are valid for the same conceptual row. This mode is not strictly compliant with the TimeFilter textual convention definition, because potentially many conceptual rows will be skipped instead of returned in a GetNext or GetBulk operation. Such rows are identical to each other, except for the returned TimeMark INDEX value. This mode is intended only for testing purposes, however it may also be useful if an NMS wishes to utilize the GetBulk PDU. This mode will prevent the GetBulk responses from containing duplicate rows due to the TimeFilter mechanism. If this object has the value `stopAfterAll(2)', then a getNext or getBulk MIB walk will repeat through the same MIB table until the TimeMark for the most-recently changed entry is reached. Note that as long as traffic occurs on the monitored interface, it is possible a highest value of the TimeFilter INDEX may never be reached. This mode is strictly compliant with the TimeFilter textual convention definition. Note that GetBulk PDU responses in this mode will likely contain multiple copies of the same MIB instances, differing only in the TimeMark INDEX value. As an example, consider row 'fooEntry' which was last updated at 'time 1000'. An NMS may use any TimeMark INDEX value in the range '0' to '1000', and the current (i.e., time of get request) counter values for the 'fooEntry' will be returned by agent. In the 'stopAfterOne' mode, the agent will not increment the fooEntry TimeMark index under any conditions. In the 'stopAfterAll' mode, the agent will increment any fooEntry TimeMark INDEX value in the range '0' to '999', up until the TimeMark value of '1000' is reached.

portCopyMaxIngressSessions

1.3.6.1.4.1.9.9.103.1.2.2

Integer32 (0..65535)

The maximum number of local ingress (rx or both) SPAN session that can be configured on this agent.

portCopyMaxEgressSessions

1.3.6.1.4.1.9.9.103.1.2.3

Integer32 (0..65535)

The maximum number of local egress SPAN sessions that can be configured on this agent.

crcSpanDstPermitListEnabled

1.3.6.1.4.1.9.9.103.1.2.7

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

Indicates whether the SPAN destination permit list feature is enabled. When crcSpanDstPermitListEnabled is 'true', only ports that have an entry in crcSpanDstPermitListTable are allowed to set as SPAN destination. There is no such restriction when crcSpanDstPermitListEnabled is 'false'.

rmonMaxAlarms

1.3.6.1.4.1.9.9.103.1.4.1

Unsigned32 (0..65535)

The maximum number of entries allowed in the alarmTable.

rmonAlarmEnable

1.3.6.1.4.1.9.9.103.1.4.2

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

This object determines if the RMON alarm feature is enabled/disabled on this device. If this object is set to 'true', the RMON alarm feature enabled. If this object is 'false', RMON alarm feature is disabled. If the RMON feature is disabled, all the RMON alarm related polling are stopped. Note that this object is only intended for temporary disabling of RMON alarm feature to ensure that the CPU usage by RMON alarms is not detrimental. For permanent disabling on this feature, it suggested that all the entries in the alarmTable are removed.

rmonConfiguredAlarms

1.3.6.1.4.1.9.9.103.1.4.3

Unsigned32

Total number of entries configured in the alarmTable.

rmonConfiguredHcAlarms

1.3.6.1.4.1.9.9.103.1.4.4

Unsigned32

Total number of entries configured in the hcAlarmTable.

crcSpanEgressReplicationMode

1.3.6.1.4.1.9.9.103.1.5.1

SpanTxReplicationMode1 = centralized2 = distributedDescribes whether egress SPAN packets replication is centralized in the device or distributed to where traffic is sourced. · Integer32

Describes where SPAN egress packets get replicated, centralized in the device or distributed to where traffic is sourced

crcSpanSharedSource

1.3.6.1.4.1.9.9.103.1.6.2

Unsigned32

The number of maximum shared span source sessions.

crcSpanSharedDestination

1.3.6.1.4.1.9.9.103.1.6.3

Unsigned32

The number of maximum shared span destination sessions.

Table details

portCopyXTable

1.3.6.1.4.1.9.9.103.1.2.1

augments portCopyTable (SMON-MIB)

Index: portCopySource · portCopyDest

This table extends the port copy capability found in the SMON MIB portCopyTable. This table is intended to augment every portCopyEntry, but not all features provided may be available on all RMON platforms. In such a case, a particular MIB object will be implemented with read-only access.

from SMON-MIB

portCopySource

InterfaceIndexA unique value, greater than zero, for each interface or interface sub-layer in the managed system. It is recommended that values are assigned contiguously starting from 1. The value for each interface sub-layer must remain constant at least from one re-initialization of the entity's network management system to the next re-initialization. (1..2147483647) · Integer32 · hint d

The ifIndex of the source which will have all packets redirected to the destination as defined by portCopyDest.

portCopyDest

InterfaceIndexA unique value, greater than zero, for each interface or interface sub-layer in the managed system. It is recommended that values are assigned contiguously starting from 1. The value for each interface sub-layer must remain constant at least from one re-initialization of the entity's network management system to the next re-initialization. (1..2147483647) · Integer32 · hint d

Defines the ifIndex destination for the copy operation.

portCopyLoVlanMask

1.3.6.1.4.1.9.9.103.1.2.1.1.1

OCTET STRING SIZE (0..256)

This object affects the way VLAN-based traffic is copied from a switch source port, for the indicated port copy operation. It is used in tandem with the portCopyHiVlanMask to identify all possible 4096 IEEE 802.1Q VLAN ID values. This object is used to select or deselect VLAN IDs 0 though 2047. If this object contains a zero-length string, or none of the octets contain a non-zero value, and the associated portCopyHiVlanMask is not instantiated, contains a zero-length string, or contains only zero-valued octets, then network traffic will not be filtered, based on IEEE 802.1Q or ISL VLAN ID, before it is copied to the indicated destination port. If this object has a non-zero length, and at least one octet contains a non-zero value, or the portCopyHiVlanMask contains at least one non-zero octet, then traffic will be filtered, based on the indicated IEEE 802.1Q or ISL VLAN ID, before it is copied to the indicated destination port. Only frames (tagged or untagged) which match the indicated VLAN ID(s) will be copied to the indicated destination port. VLAN IDs are encoded as a string of octets containing one bit per VLAN to be included in the port copy operation. The first octet corresponds to VLANs with VlanIndex values of 0 through 7; the second octet to VLANs 8 through 15; etc. The most significant bit of each octet corresponds to the lowest value VlanIndex in that octet. If the bit corresponding to a VLAN is set to '1', then the traffic associated with that VLAN will be selected for the indicated port copy operation. Note that if the length of this string is less than 256 octets, any 'missing' octets are assumed to contain the value zero. An NMS may omit any zero-valued octets from the end of this string in order to reduce SetPDU size, and the agent may also omit zero-valued trailing octets, to reduce the size of GetResponse PDUs. The creation and deletion of instances of this object is controlled by the portCopyStatus object found in the augmented portCopyEntry. It is an implementation-specific matter as to how many VLANs may be selected from a particular physical source port at any one time, or whether this object may be modified while the associated portCopyStatus object is equal to 'active'.

portCopyHiVlanMask

1.3.6.1.4.1.9.9.103.1.2.1.1.2

OCTET STRING SIZE (0..256)

This object affects the way VLAN-based traffic is copied from a switch source port, for the indicated port copy operation. It is used in tandem with the portCopyLoVlanMask to identify all possible 4096 IEEE 802.1Q VLAN ID values. This object is used to select or deselect VLAN IDs 2048 though 4095. If this object contains a zero-length string, or none of the octets contain a non-zero value, and the associated portCopyLoVlanMask is not instantiated, contains a zero-length string, or contains only zero-valued octets, then network traffic will not be filtered, based on IEEE 802.1Q or ISL VLAN ID, before it is copied to the indicated destination port. If this object has a non-zero length, and at least one octet contains a non-zero value, or the portCopyLoVlanMask contains at least one non-zero octet, then traffic will be filtered, based on the indicated IEEE 802.1Q or ISL VLAN ID, before it is copied to the indicated destination port. Only frames (tagged or untagged) which match the indicated VLAN ID(s) will be copied to the indicated destination port. VLAN IDs are encoded as a string of octets containing one bit per VLAN to be included in the port copy operation. The first octet corresponds to VLANs with VlanIndex values of 2048 through 2055; the second octet to VLANs 2056 through 2063; etc. The most significant bit of each octet corresponds to the lowest value VlanIndex in that octet. If the bit corresponding to a VLAN is set to '1', then the traffic associated with that VLAN will be selected for the indicated port copy operation. Note that if the length of this string is less than 256 octets, any 'missing' octets are assumed to contain the value zero. An NMS may omit any zero-valued octets from the end of this string in order to reduce SetPDU size, and the agent may also omit zero-valued trailing octets, to reduce the size of GetResponse PDUs. The creation and deletion of instances of this object is controlled by the portCopyStatus object found in the augmented portCopyEntry. It is an implementation-specific matter as to how many VLANs may be selected from a particular physical source port at any one time, or whether this object may be modified while the associated portCopyStatus object is equal to 'active'.

portCopyDestLoVlanMask

1.3.6.1.4.1.9.9.103.1.2.1.1.3

OCTET STRING SIZE (0..256)

This object affects the way VLAN-based traffic to a switch destination port is filtered for the indicated port copy operation. It is used in tandem with the portCopyDestHiVlanMask to identify all possible 4096 IEEE 802.1Q VLAN ID values. This object is used to select or deselect VLAN IDs 0 though 2047. If this object contains a zero-length string, or none of the octets contain a non-zero value, and the associated portCopyDestHiVlanMask is not instantiated, contains a zero-length string, or contains only zero-valued octets, then network traffic will not be filtered, based on IEEE 802.1Q or ISL VLAN ID, before it is copied to the indicated destination port. If this object has a non-zero length, and at least one octet contains a non-zero value, or the portCopyDestHiVlanMask contains at least one non-zero octet, then traffic will be filtered, based on the indicated IEEE 802.1Q or ISL VLAN ID, before it is copied to the indicated destination port. Only frames (tagged or untagged) which match the indicated VLAN ID(s) will be copied to the indicated destination port. If a VLAN is included in the portCopyDestLoVlanMask object, it should also be included in the portCopyLoVlanMask object and vice versa. VLAN IDs are encoded as a string of octets containing one bit per VLAN to be included in the port copy operation. The first octet corresponds to VLANs with VlanIndex values of 0 through 7; the second octet to VLANs 8 through 15; etc. The most significant bit of each octet corresponds to the lowest value VlanIndex in that octet. If the bit corresponding to a VLAN is set to '1', then the traffic associated with that VLAN will be selected for the indicated port copy operation. Note that if the length of this string is less than 256 octets, any 'missing' octets are assumed to contain the value zero. An NMS may omit any zero-valued octets from the end of this string in order to reduce SetPDU size, and the agent may also omit zero-valued trailing octets, to reduce the size of GetResponse PDUs. The creation and deletion of instances of this object is controlled by the portCopyStatus object found in the augmented portCopyEntry. It is an implementation-specific matter as to how many VLANs may be selected from a particular physical source port at any one time, or whether this object may be modified while the associated portCopyStatus object is equal to 'active'.

portCopyDestHiVlanMask

1.3.6.1.4.1.9.9.103.1.2.1.1.4

OCTET STRING SIZE (0..256)

This object affects the way VLAN-based traffic to a switch destination port is filtered for the indicated port copy operation. It is used in tandem with the portCopyDestLoVlanMask to identify all possible 4096 IEEE 802.1Q VLAN ID values. This object is used to select or deselect VLAN IDs 2048 though 4095. If this object contains a zero-length string, or none of the octets contain a non-zero value, and the associated portCopyDestLoVlanMask is not instantiated, contains a zero-length string, or contains only zero-valued octets, then network traffic will not be filtered, based on IEEE 802.1Q or ISL VLAN ID, before it is copied to the indicated destination port. If this object has a non-zero length, and at least one octet contains a non-zero value, or the portCopyDestLoVlanMask contains at least one non-zero octet, then traffic will be filtered, based on the indicated IEEE 802.1Q or ISL VLAN ID, before it is copied to the indicated destination port. Only frames (tagged or untagged) which match the indicated VLAN ID(s) will be copied to the indicated destination port. If a VLAN is included in the portCopyDestHiVlanMask object, it should also be included in the portCopyHiVlanMask object and vice versa. VLAN IDs are encoded as a string of octets containing one bit per VLAN to be included in the port copy operation. The first octet corresponds to VLANs with VlanIndex values of 2048 through 2055; the second octet to VLANs 2056 through 2063; etc. The most significant bit of each octet corresponds to the lowest value VlanIndex in that octet. If the bit corresponding to a VLAN is set to '1', then the traffic associated with that VLAN will be selected for the indicated port copy operation. Note that if the length of this string is less than 256 octets, any 'missing' octets are assumed to contain the value zero. An NMS may omit any zero-valued octets from the end of this string in order to reduce SetPDU size, and the agent may also omit zero-valued trailing octets, to reduce the size of GetResponse PDUs. The creation and deletion of instances of this object is controlled by the portCopyStatus object found in the augmented portCopyEntry. It is an implementation-specific matter as to how many VLANs may be selected from a particular physical source port at any one time, or whether this object may be modified while the associated portCopyStatus object is equal to 'active'.

portCopyOption

1.3.6.1.4.1.9.9.103.1.2.1.1.5

BITS

Indicates the additional SPAN configuration on destination port. Instances of same portCopyDest index must have same values in portCopyOption. Changes on portCopyOption of one instance will be applied to all other instances of same portCopyDest index. - inpkts(0) This bit is set to enable the destination port to receive normal incoming traffic. - learningDisable(1) This bit is set to suppress MAC learning for incoming traffic at the destination port. - dot1q(2) This bit is set for dot1q trunking encapsulation of forwarded traffic at the destination port. This bit can not be set when isl(3) bit is 1. - isl(3) This bit is set for isl trunking encapsulation of forwarded traffic at the destination port. This bit can not be set when dot1q(2) bit is 1. - multicast(4) This bit is set to enable the destination port to receive multicast traffic. - unicastDisable(5) This bit is set to disable the destination port to receive unicast traffic. - broadcastDisable(6) This bit is set to disable the destination port to receive broadcast traffic. - goodDisable(7) This bit is set to disable the destination port to receive good packets. - badDisable(8) This bit is set to disable the destination port to receive bad packets.

portCopySessionNo

1.3.6.1.4.1.9.9.103.1.2.1.1.6

Integer32 (0..2147483647)

Indicates the arbitrary unique identifier for this SPAN session. If a non zero value is specified, the agent will check if a SPAN session that has the same session number exists. If so, the agent will use this session number when this entry is activated. This entry will be added to the existing SPAN session (identified by all entries with the same portCopySessionNo value). If no such session exists, a new SPAN session is created and assigned the specified value. Otherwise, the agent will check if the destination port belongs to an existing SPAN session. If so, the agent will assign that session number when this entry is activated. This entry will be added to the existing SPAN session (identified by all entries with the same portCopySessionNo value). If no such session exists, a new SPAN session is created and assigned an arbitrary, locally unique value. If the associated portCopyStatus object is equal to 'active', then this object may not be modified.

portCopySessionType

1.3.6.1.4.1.9.9.103.1.2.1.1.7

INTEGER1 = notSpecified2 = local3 = remoteSource4 = remoteDestination5 = localTx · Integer32

Indicates the SPAN session type. 'remoteSource' refers to session where traffic is copied from source port to RSPAN VLAN as its destination port. 'remoteDestination' refers to session where traffic is copied from RSPAN VLAN to the destination port. For 'local' SPAN session, both source and destination ports reside in the same switch. 'localTx' refers to session where only traffic transmitted out the indicated source port will be copied to the destination port, i.e. the corresponding portCopyDirection can only have the value of 'copyTxOnly'. In a set operation, agent will decide the actual SPAN type for the session if this MIB object is 'notSpecified' based on type of source and destination ports. A read operation will return one of the other three types. Changes on portCopySessionType of one entry will be applied to all existing active entries having the same value of portCopySessionNo if such change is allowed by the implementation. If the associated portCopyStatus object is equal to 'active', then this object may not be modified.

portCopyRemoveSrc

1.3.6.1.4.1.9.9.103.1.2.1.1.8

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

Indicates how the agent will modify a SPAN session when an entry belonging to this session is deleted. The value 'true' specifies source port based entry deletion. In source port based deletion, all entries of same index portCopySource from the session are to be deleted. The value 'false' specifies destination based entry deletion. In destination port based deletion, all entries of same index portCopyDest from the session are to be deleted.

portCopyReflectorPort

1.3.6.1.4.1.9.9.103.1.2.1.1.9

InterfaceIndexA unique value, greater than zero, for each interface or interface sub-layer in the managed system. It is recommended that values are assigned contiguously starting from 1. The value for each interface sub-layer must remain constant at least from one re-initialization of the entity's network management system to the next re-initialization. (1..2147483647) · Integer32 · hint d

Indicates the reflector port of this SPAN session. The value of this object is ignored whenever the value of portCopySessionType is not remoteSource(3).

portCopyInpktVlan

1.3.6.1.4.1.9.9.103.1.2.1.1.10

Unsigned32 (0..4095)

This object indicates the default VLAN that is used for the untagged incoming traffic from the portCopyDest when portCopyOption's inpkts bit is set. The range is defined to identify all possible 4096 IEEE 802.1Q VLAN ID values although only 1 - 4094 are valid VLAN IDs that could be configured as the default VLAN for the untagged incoming traffic. If this object contains a value of zero and portCopyOption's inpkts bit is set, then the switch is free to use its default VLAN for untagged incoming packets. On platforms that do not have a dedicated default VLAN for this purpose, error is returned. If portCopyOption's inpkts bit is not set or isl bit is set, the value in this object is ignored by the agent.

crcSpanSessionTable

1.3.6.1.4.1.9.9.103.1.2.4

Index: crcSpanSessionNo

Contains SPAN session entries. A row is created for each SPAN session configured in a device.

crcSpanSessionNo

1.3.6.1.4.1.9.9.103.1.2.4.1.1

Unsigned32

Defines a SPAN session number.

crcSpanSessionType

1.3.6.1.4.1.9.9.103.1.2.4.1.2

INTEGER1 = local2 = remote3 = erspan4 = service5 = other · Integer32

Defines the SPAN session type. 'local' refers to SPAN session where both source and destination ports reside in the same switch. This type of SPAN is manageable via portCopyTable and portCopyXTable. 'remote' refers to session where traffic is copied from source port to RSPAN VLAN as its destination port or vise versa. This type of SPAN is manageable via portCopyTable and portCopyXTable. 'erspan' refers to a session where traffic is copied from crcERSpanIFIndex of crcERSpanIFTable as source to crcERSpanIp as destination or vise versa. This type of SPAN is manageable via crcERSpanSessionTable and crcERSpanIFTable. 'service' refers to special SPAN service session. 'other' refers to any other SPAN session type not enumerated for the MIB object.

crcSpanSessionEnabled

1.3.6.1.4.1.9.9.103.1.2.4.1.3

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

Indicates whether the SPAN session is enabled. Modifying the value of crcSpanSessionEnabled to 'false' stops the SPAN monitoring but does not remove this SPAN configuration from the system.

crcSpanSessionDescr

1.3.6.1.4.1.9.9.103.1.2.4.1.4

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

Provides description of this SPAN session.

crcERSpanSessionTable

1.3.6.1.4.1.9.9.103.1.2.5

Index: crcERSpanSessionNo

Contains ERSPAN session entries. A row is created for each SPAN session configured in a device. A row can only be created if an instance of the same session number is not present in crcSpanSessionEntry. ERSPAN, or Encapsulated Remote SPAN, provides the ability to copy all frames from a specified source to a specified destination across a layer 3 network, allowing source and destination to be from different devices. Depending on type of ERSPAN, the source can be an interface from crcERSpanIFIndex of crcERSpanIFTable, the destination be a layer 3 internet address defined by crcERSpanIp of this table, or vise versa.

crcERSpanSessionNo

1.3.6.1.4.1.9.9.103.1.2.5.1.1

Unsigned32

Defines an ERSPAN session number.

crcERSpanSessionType

1.3.6.1.4.1.9.9.103.1.2.5.1.2

INTEGER1 = eRSpanSource2 = eRSpanDestination · Integer32

Defines the ERSPAN session type. This object may not be modified if the value of the corresponding instance of crcERSpanSessionRowStatus is active. 'eRSpanSource' refers to a session where traffic is copied from crcERSpanIFIndex of crcERSpanIFTable as source to crcERSpanIp as destination. 'eRSpanDestination' refers to a session where traffic is copied from crcERSpanIp as source to crcERSpanIFIndex of crcERSpanIFTable as destination.

crcERSpanSessionDescr

1.3.6.1.4.1.9.9.103.1.2.5.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

Provides description of this ERSPAN session. This object may be modified when the row is active.

crcERSpanEncapID

1.3.6.1.4.1.9.9.103.1.2.5.1.4

Unsigned32

Defines ERSPAN's encapsulation id for this entry. This object may be modified when the row is active.

crcERSpanIpType

1.3.6.1.4.1.9.9.103.1.2.5.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

Defines the type of Internet address for crcERSpanIp used by this entry. This object may be modified when the row is active.

crcERSpanIp

1.3.6.1.4.1.9.9.103.1.2.5.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

Defines Internet address of copy source or destination. If crcERSanSessionType has value of eRSpanSource(1), crcERSpanIp is a copy destination. If crcERSpanSessionType has value of eRSpanDestination(2), crcERSpanIp is a copy source. This object may be modified when the row is active.

crcSrcERSpanIpTTL

1.3.6.1.4.1.9.9.103.1.2.5.1.7

Unsigned32 (1..255)

The IP TTL value for this traffic type. This object is only significant when object crcERSpanSessionType is eRSpanSource(1). This object may be modified when the row is active.

crcSrcERSpanDscpOrPrec

1.3.6.1.4.1.9.9.103.1.2.5.1.8

INTEGER1 = dscp2 = precedence · Integer32

The QOS classification used - precedence or DSCP based. This object is only significant when object crcERSpanSessionType is eRSpanSource(1). This object may be modified when the row is active.

crcSrcERSpanIpPrec

1.3.6.1.4.1.9.9.103.1.2.5.1.9

Unsigned32 (0..7)

The IP precedence value for this traffic type. This object is only significant when object crcERSpanSessionType is eRSpanSource(1) and object crcSrcERSpanDscpOrPrec is precedence(1). This object may be modified when the row is active.

crcSrcERSpanIpDscp

1.3.6.1.4.1.9.9.103.1.2.5.1.10

DscpAn integer that is in the range of the DiffServ codepoint values. (0..63) · Integer32

The IP DSCP value for this traffic type. This object is only significant when object crcERSpanSessionType is eRSpanSource(1) and object crcSrcERSpanDscpOrPrec is dscp(1). This object may be modified when the row is active.

crcERSpanIpVRF

1.3.6.1.4.1.9.9.103.1.2.5.1.11

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

Specifies VRF used for the traffic type. This object may be modified when the row is active.

crcSrcERSpanLoVlanMask

1.3.6.1.4.1.9.9.103.1.2.5.1.12

OCTET STRING SIZE (0..256)

This object affects the way VLAN-based traffic is copied from a switch source port, for the indicated port copy operation. It is used in tandem with the crcSrcERSpanHiVlanMask to identify all possible 4096 IEEE 802.1Q VLAN ID values. This object is used to select or deselect VLAN IDs 0 though 2047. If this object contains a zero-length string, or none of the octets contain a non-zero value, and the associated crcSrcERSpanHiVlanMask is not instantiated, contains a zero-length string, or contains only zero-valued octets, then network traffic will not be filtered, based on IEEE 802.1Q or ISL VLAN ID, before it is copied to the indicated destination. If this object has a non-zero length, and at least one octet contains a non-zero value, or the crcSrcERSpanHiVlanMask contains at least one non-zero octet, then traffic will be filtered, based on the indicated IEEE 802.1Q or ISL VLAN ID, before it is copied to the indicated destination. Only frames (tagged or untagged) which match the indicated VLAN ID(s) will be copied to the indicated destination. VLAN IDs are encoded as a string of octets containing one bit per VLAN to be included in the port copy operation. The first octet corresponds to VLANs with VlanIndex values of 0 through 7; the second octet to VLANs 8 through 15; etc. The most significant bit of each octet corresponds to the lowest value VlanIndex in that octet. If the bit corresponding to a VLAN is set to '1', then the traffic associated with that VLAN will be selected for the indicated port copy operation. Note that if the length of this string is less than 256 octets, any 'missing' octets are assumed to contain the value zero. An NMS may omit any zero-valued octets from the end of this string in order to reduce SetPDU size, and the agent may also omit zero-valued trailing octets, to reduce the size of GetResponse PDUs. This object is only significant when object crcERSpanSessionType is eRSpanSource(1). This object may be modified when the row is active.

crcSrcERSpanHiVlanMask

1.3.6.1.4.1.9.9.103.1.2.5.1.13

OCTET STRING SIZE (0..256)

This object affects the way VLAN-based traffic is copied from a switch source port, for the indicated port copy operation. It is used in tandem with the crcSrcERSpanLoVlanMask to identify all possible 4096 IEEE 802.1Q VLAN ID values. This object is used to select or deselect VLAN IDs 2048 though 4095. If this object contains a zero-length string, or none of the octets contain a non-zero value, and the associated crcSrcERSpanLoVlanMask is not instantiated, contains a zero-length string, or contains only zero-valued octets, then network traffic will not be filtered, based on IEEE 802.1Q or ISL VLAN ID, before it is copied to the indicated destination. If this object has a non-zero length, and at least one octet contains a non-zero value, or the crcSrcERSpanLoVlanMask contains at least one non-zero octet, then traffic will be filtered, based on the indicated IEEE 802.1Q or ISL VLAN ID, before it is copied to the indicated destination. Only frames (tagged or untagged) which match the indicated VLAN ID(s) will be copied to the indicated destination. VLAN IDs are encoded as a string of octets containing one bit per VLAN to be included in the port copy operation. The first octet corresponds to VLANs with VlanIndex values of 2048 through 2055; the second octet to VLANs 2056 through 2063; etc. The most significant bit of each octet corresponds to the lowest value VlanIndex in that octet. If the bit corresponding to a VLAN is set to '1', then the traffic associated with that VLAN will be selected for the indicated port copy operation. Note that if the length of this string is less than 256 octets, any 'missing' octets are assumed to contain the value zero. An NMS may omit any zero-valued octets from the end of this string in order to reduce SetPDU size, and the agent may also omit zero-valued trailing octets, to reduce the size of GetResponse PDUs. This object is only significant when object crcERSpanSessionType is eRSpanSource(1). This object may be modified when the row is active.

crcSrcERSpanOrigIpType

1.3.6.1.4.1.9.9.103.1.2.5.1.14

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

Defines the type of Internet address for crcSrcERSpanOrigIp used by this entry. This object is only significant when object crcERSpanSessionType is eRSpanSource(1). This object may be modified when the row is active.

crcSrcERSpanOrigIp

1.3.6.1.4.1.9.9.103.1.2.5.1.15

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

Defines the Internet address of copy source. This object is only significant when object crcERSpanSessionType is eRSpanSource(1). This object may be modified when the row is active.

crcDstERSpanOption

1.3.6.1.4.1.9.9.103.1.2.5.1.16

BITS

Indicates the additional ERSPAN configuration on destination port. - inpkts(0) This bit is set to enable the destination port to receive incoming traffic. - learningDisable(1) This bit is set to suppress MAC learning for incoming traffic at the destination port. This object only takes effect when object crcERSpanSessionType is eRSpanDestination(2) and crcERSpanIfIndex of same ERSPAN session from crcERSpanIFTable points to a physical port. This object may be modified when the row is active. This object is deprecated and replaced by crcERSpanIFOption.

crcERSpanSessionRowStatus

1.3.6.1.4.1.9.9.103.1.2.5.1.17

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

Defines the status of this entry.

crcERSpanIFTable

1.3.6.1.4.1.9.9.103.1.2.6

Index: crcERSpanSessionNo · crcERSpanIFIndex

This table in conjunction with crcERSpanSessionTable, provides the ability to copy all frames from a specified source to a specified destination across a layer 3 network. A row is created for each interface from ifEntries that is configured as ERSPAN source or destination while crcERSpanSessionRowStatus is active(1) for the corresponding session.

crcERSpanIFIndex

1.3.6.1.4.1.9.9.103.1.2.6.1.1

InterfaceIndexA unique value, greater than zero, for each interface or interface sub-layer in the managed system. It is recommended that values are assigned contiguously starting from 1. The value for each interface sub-layer must remain constant at least from one re-initialization of the entity's network management system to the next re-initialization. (1..2147483647) · Integer32 · hint d

Defines the device interface's ifIndex. Mapped via crcERSpanSessionNo, if crcERSanSessionType from crcERSpanSessionTable has value of eRSpanSource(1), crcRSpanIFIndex is a copy source. If crcERSpanSessionType has value of eRSpanDestination(2), crcRSpanIFIndex is a copy destination.

crcERSpanIFDirection

1.3.6.1.4.1.9.9.103.1.2.6.1.2

INTEGER1 = copyRxOnly2 = copyTxOnly3 = copyBoth · Integer32

This object affects the way traffic is copied from a device's source. If this object has the value 'copyRxOnly(1)', then only traffic received on crcERSpanIFIndex will be copied to the destination. If this object has the value 'copyTxOnly(2)', then only traffic transmitted out the crcERSpanIFIndex will be copied to the destination. If this object has the value 'copyBoth(3)', then all traffic received or transmitted on crcERSpanIFIndex will be copied to the destination. This object is only significant when object crcERSpanSessionType of the corresponding crcERSpanSessionTable, mapped via crcERSpanSessionNo, is eRSpanSource(1). This object may be modified when the row is active.

crcERSpanIFRowStatus

1.3.6.1.4.1.9.9.103.1.2.6.1.3

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

Defines the status of this entry. For this object to be active(1), the crcERSpanSessionRowStatus from crcERSpanSessionTable, mapped via crcERSpanSessionNo, must be active(1). If the said crcERSpanSessionRowStatus transistions to notInService(2) or destroy(6), all corresponding entries from crcERSpanIFTable will be deleted. In order to configure a source to destination traffic copy relationship, crcERSpanIFIndex MUST be present as an ifEntry in the ifTable and its respective ifAdminStatus and ifOperStatus values MUST be equal to 'up(1)'. If the value of any of those two objects changes after the crcERSpanSessionEntry is activated, crcERSpanSessionRowStatus will transition to 'notReady(3)'. The capability of crcERSpanIFIndex to be source or destination of a port copy operation is described by the 'copySourcePort(0)' and 'copyDestPort(1)' bits in dataSourceCopyCaps. Those bits SHOULD be appropriately set by the agent, in order to allow for a crcERSpanIFEntry to be created.

crcERSpanIFOption

1.3.6.1.4.1.9.9.103.1.2.6.1.4

BITS

Indicates the additional ERSPAN configuration on destination port. - inpkts This bit is set to enable the destination port to receive incoming traffic. - learningDisable This bit is set to suppress MAC learning for incoming traffic at the destination port. This object can only be modified when object crcERSpanSessionType of the corresponding crcERSpanSessionTable, mapped via crcERSpanSessionNo, is eRSpanDestination and the crcERSpanIfIndex points to a physical port. This object may be modified when the row is active.

crcSpanDstPermitListTable

1.3.6.1.4.1.9.9.103.1.2.8

Index: ifIndex

Contains a list of ports that are configured as allowed SPAN destination ports. Entry of portCopyTable with its portCopyDest can not be created if crcSpanDstPermitListEnabled is 'true' and a corresponding entry does not exist in the crcSpanDstPermitListTable table. In other words the InterfaceIndex specified by portCopyDest object from SMON-MIB must match ifIndex of entries in this table.

from IF-MIB

ifIndex

InterfaceIndexA unique value, greater than zero, for each interface or interface sub-layer in the managed system. It is recommended that values are assigned contiguously starting from 1. The value for each interface sub-layer must remain constant at least from one re-initialization of the entity's network management system to the next re-initialization. (1..2147483647) · Integer32 · hint d

A unique value, greater than zero, for each interface. It is recommended that values are assigned contiguously starting from 1. The value for each interface sub-layer must remain constant at least from one re-initialization of the entity's network management system to the next re- initialization.

crcSpanDstPermitListRowStatus

1.3.6.1.4.1.9.9.103.1.2.8.1.1

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

Defines the status of this entry. An active entry means that the port of this ifIndex can be set as SPAN destination port. The valid values are active(1), createAndGo(4) and destroy(6).

rmonSampleConfigTable

1.3.6.1.4.1.9.9.103.1.3.1

Index: ifIndex

This table controls the configuration of RMON collection based on statistical sampling techniques, for each monitored interface on the RMON probe. It is a SPARSE-AUGMENTS of the ifEntry found in the IF-MIB module. An entry is created in this table at the same time the augmented ifEntry is created (usually at system startup time), for each interface which can be monitored by the RMON agent. An associated entry in the SMON MIB dataSourceCapsTable is also created for each RMON-capable interface at the same time. An RMON collection is associated with a particular interface if the control table dataSource OBJECT IDENTIFIER is of the form 'ifIndex.I', and 'I' is the same value as the ifIndex value for the ifEntry and rmonSampleConfigEntry.

from IF-MIB

ifIndex

InterfaceIndexA unique value, greater than zero, for each interface or interface sub-layer in the managed system. It is recommended that values are assigned contiguously starting from 1. The value for each interface sub-layer must remain constant at least from one re-initialization of the entity's network management system to the next re-initialization. (1..2147483647) · Integer32 · hint d

A unique value, greater than zero, for each interface. It is recommended that values are assigned contiguously starting from 1. The value for each interface sub-layer must remain constant at least from one re-initialization of the entity's network management system to the next re- initialization.

rmonSamplingEnabled

1.3.6.1.4.1.9.9.103.1.3.1.1.1

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

This object affects the way the RMON probe uses statistical sampling to collect packets from the indicated interface. If this object has the value 'false', then the probe will attempt to monitor all packets detected on the indicated interface, in the event any RMON collections are actually configured. The data returned in all RMON collection tables associated with this interface will represent non-sampled monitored counter values. If this object has the value 'true', then the probe will use adaptive statistical sampling techniques to monitor the indicated interface, in the event any RMON collections are actually configured. The data returned in RMON collection tables associated with this interface may be based on statistical approximations. In this mode, the RMON agent will also maintain additional MIB objects to provide the confidence interval information for each sampled counter. These objects can be found in the CISCO-RMON-SAMPLING-MIB. When this object transitions from 'false' to 'true', all active packet capture functions will be suspended, without affecting the contents of any associated filterEntry, filter2Entry, channelEntry, channel2Entry, bufferControlEntry, captureBufferEntry, or captureBufferHighCapacityEntry. Only the low-level packet capture processing is deactivated. When this object transitions from 'true' to 'false', all suspended packet capture functions associated with the interface will be reactivated. Note that an NMS application which is unaware of this MIB object will not be able to detect suspended packet capture operations or sampled collections, however multi-manager mis-configuration issues are beyond the scope of this MIB. The packet capture function Get and Set operations are not affected by this object. If an interface cannot be sampled, or the sampling configuration cannot be modified, then such an instance of this object will be implemented with read-only access.

crcSpanSessionEgressModeTable

1.3.6.1.4.1.9.9.103.1.5.2

Index: crcSpanSessionNo

A table containing operational SPAN egress packet replication mode for each SPAN session. A row is created for each SPAN session that is capable of monitoring egress traffic in a device.

crcSpanEgressReplicationOperMode

1.3.6.1.4.1.9.9.103.1.5.2.1.1

SpanTxReplicationMode1 = centralized2 = distributedDescribes whether egress SPAN packets replication is centralized in the device or distributed to where traffic is sourced. · Integer32

The current egress replication mode in operation.

crcSpanCapacityTable

1.3.6.1.4.1.9.9.103.1.6.1

Index: crcSpanCapacityType

This table lists the resource capacity for each SPAN session type that is capable of providing such information.

crcSpanCapacityType

1.3.6.1.4.1.9.9.103.1.6.1.1.1

INTEGER1 = allSrc2 = allDst3 = localSrc4 = localTx5 = rspanSrc6 = rspanDst7 = erspanSrc8 = erspanDst9 = serviceModule10 = oamLoopback11 = capture12 = reflector · Integer32

Indicating the SPAN resource capacity session type. 'allSrc' refers to all SPAN source sessions. 'allDst' refers to all SPAN destination sessions. 'localSrc' refers to local SPAN session where both source and destination ports reside in the same switch. 'localTx' refers to local Tx only SPAN session. 'rspanSrc' refers to remote span source in a RSPAN session where traffic is copied from source port to RSPAN VLAN as its destination port. 'rspanDst' refers to remote span destination in a RSPAN session where traffic is copied from RSPAN VLAN as its source to its destination port. 'erspanSrc' refers to a session where traffic is copied from crcERSpanIFIndex of crcERSpanIFTable as source to crcERSpanIp as destination. 'erspanDst' refers to a session where traffic is copied from crcERSpanIp as source to crcERSpanIFIndex of crcERSpanIFTable as destination. 'serviceModule' refers to special SPAN service module session. 'oamLoopback' refers to special SPAN service for OAM (Operations, Administration and Maintenance) loopback. 'capture' refers to Packet Capture Span Session. 'reflector' refers to Reflector Span Session.

crcSpanCapacityShared

1.3.6.1.4.1.9.9.103.1.6.1.1.2

INTEGER1 = none2 = source3 = destination · Integer32

Indicating the shared SPAN capacity type. 'none' means the capacity is not shared out of crcSpanSharedSource or crcSpanSharedDestination. 'source' means the capacity is counted against crcSpanSharedSource. The sum of crcSpanUsedSession for all entries with crcSpanCapacityShared being 'source' shall not exceed crcSpanSharedSource. 'destination' means the capacity is counted against crcSpanSharedDestination. The sum of crcSpanUsedSession for all entries with crcSpanCapacityShared being 'destination' shall not exceed crcSpanSharedDestination.

crcSpanMaxSession

1.3.6.1.4.1.9.9.103.1.6.1.1.3

Unsigned32

The maximum number of sessions allowed for the SPAN type defined by crcSpanCapacityType. A value of zero indicates no specific limit for this SPAN capacity session type.

crcSpanUsedSession

1.3.6.1.4.1.9.9.103.1.6.1.1.4

Unsigned32

The number of sessions currently used for the SPAN capacity session type defined.

↑ To TOC