| OID symbolic | OID numeric | Type | Access | Description |
|---|
| ciscoFlowCloneMIB | 1.3.6.1.4.1.9.9.765 | | | This MIB module defines objects that manages flow cloning
feature. A flow cloning can be described as a hardware or
software entity, that is responsible to clone (or duplicate)
flows to the specified destination port in the device. These
cloned packets will be sent to an external device for a more
fine-grained analysis of the flows. A typical application of
this MIB module will facilitate cloning media flows. However,
by no means does the definition of this MIB module prevents
other applications from using it.
CLONE PROFILE:
==============
At the top level, this MIB module describes the notion of flow
cloning. Further descriptive texts in this MIB will use clone
profile to describe flow cloning. We can think of clone profile
as a container for the traffic flows for which it will clone
packets and send out on the specified egress interface. Because
a device can support more than one clone profile, this MIB
defines cfcCloneProfileTable.
TRAFFIC FLOW:
=============
At the next level, this MIB module describes the notion of a
traffic flow associated with the clone profile. A traffic flow
is a unidirectional stream of packets conforming to a
classifier.For example, packets having a particular source
IP address, destination IP address, protocol type, source port
number, and destination port number.
CLONE TARGET:
=============
A clone target may represent an entity that the system
provisions with a clone profile.
Clone targets include, but are not necessarily limited to, the
system, nodes (i.e., an instance of an operating system),
interfaces, VRF instances, and bridge domains.
IMPLEMENTATION GUIDANCE
=======================
It might seem that the concepts presented by this MIB module
lend themselves to a profile-based approach. However, this
approach provides the most general abstraction and lends itself
to implementations that can fall under two categories: global
and per-interface.
A global level clone profile will clone the specified flows
that are monitored in the whole device. Per interface clone
profile will clone the specified flows that are monitored on
the specified interface.
This MIB module can represent the global level clone profile
using the following procedure:
o Create a row in the cfcCloneProfileTable having the following
attributes. Allocate a value for cfcCloneProfileId and a name
for cfcCloneProfileName. For sake of discussion, let's say
the value is and the name is 'XYZ'.
cfcCloneProfileId =
cfcCloneProfileName =
.
.
cfcCloneTargetType = 'system'
o Similarly per interface level clone profile implementation
can be represented as follows.
Create a row in the cfcCloneProfileTable having the following
attributes. Allocate a value for cfcCloneProfileId and a name
for cfcCloneProfileName. For sake of discussion, let's say
the value is and the name is 'ABC'.
cfcCloneProfileId =
cfcCloneProfileName =
.
.
cfcCloneTargetType = 'interface'
cfcCloneTargetIfIndex =
While this example illustrates how an implementation may
represent global and per-interface configuration data, it is
understood that an implementation may have other requirements.
In these cases, use this example as a guide in satisfying these
requirements. |
| ciscoFlowCloneMIBNotifications | 1.3.6.1.4.1.9.9.765.0 | | | |
| ciscoFlowCloneMIBObjects | 1.3.6.1.4.1.9.9.765.1 | | | |
| cfcCloneProfiles | 1.3.6.1.4.1.9.9.765.1.1 | | | |
| OID cfcCloneProfileIdNext | 1.3.6.1.4.1.9.9.765.1.1.1 | CloneProfileIdentifier | read-only | This object specifies a value which is used as an index
value for a new clone profile entry in cfcCloneProfileTable.
Whenever read, the agent will get the next available
non-conflicting value. This is to reduce the probability of
errors during creation of new clone profile table entries |
| cfcCloneProfileTable | 1.3.6.1.4.1.9.9.765.1.1.2 | | not-accessible | This table lists the clone profiles contained by the device. |
| cfcCloneProfileEntry | 1.3.6.1.4.1.9.9.765.1.1.2.1 | | not-accessible | A peer SNMP entity may create a clone profile by setting an
instance of cfcCloneProfileId to the value that is read from
cfcCloneProfileIdNext, cfcCloneProfileName to the entry name
and an instance of cfcCloneProfileStatus to 'createAndWait'
or 'createAndGo'. Observe that an implementation that does
not support these options must specify these limitations in
an agent capabilities statement.
Other management entities (e.g., the local console) may create
a clone profile. In these cases, the system must automatically
create a row in the cfcCloneProfileTable.
A peer SNMP entity may destroy a clone profile by setting the
corresponding instance of cfcCloneProfileStatus to 'destroy'.
Observe that an implementation that does not support this
option must specify this limitation in an agent capabilities
statement.
Other management entities may destroy a clone profile. In these
cases, the system must automatically destroy the corresponding
row in the cfcCloneProfileTable. |
| OID cfcCloneProfileId | 1.3.6.1.4.1.9.9.765.1.1.2.1.1 | CloneProfileIdentifier | not-accessible | This object indicates an arbitrary integer-value that uniquely
identifies a clone profile. An application using this MIB
is responsible for making sure these are unique, although the
SNMP RowStatus row creation process will help by not allowing
it to create conflicting entries. Before creating a new entry,
a value for this variable may be obtained by reading
cfcCloneProfileIdNext to reduce the probability of a value
collision. Observe that the value assigned to a clone profile
does not necessarily persist across restarts. |
| ROW cfcCloneProfileStatus | 1.3.6.1.4.1.9.9.765.1.1.2.1.2 | RowStatus | read-create | The status of this conceptual row. This object manages
creation, modification, and deletion of rows in this table.
The following columns must be valid before activating a row:
- cfcCloneProfileName
- cfcCloneProfileStorageType
- cfcCloneTargetType
- cfcCloneTargetIfIndex
cfcCloneTargetIfIndex is mandatory ONLY if cfcCloneTargetType
is specified as 'interface'. Other writable objects in this
table may be modified at any time, even while the row is
'active'.
The entry may be deleted by setting the value to 'destroy',
and if there are any associated traffic flow entries in the
corresponding flow tables (cfcFlowIpTable in case of IP flows)
they will also be deleted with this operation. |
| STO cfcCloneProfileStorageType | 1.3.6.1.4.1.9.9.765.1.1.2.1.3 | StorageType | read-create | This object specifies the memory realization of the row. |
| STR cfcCloneProfileName | 1.3.6.1.4.1.9.9.765.1.1.2.1.4 | SnmpAdminString | read-create | This object specifies an arbitrary name that uniquely
identifies the clone profile. |
| STR cfcCloneProfileDescription | 1.3.6.1.4.1.9.9.765.1.1.2.1.5 | SnmpAdminString | read-create | This object specifies a human-readable description configured
to the clone profile. This object is optional while creating a
row in this table and specifies a null string if no description
is configured. |
| TIM cfcCloneProfileCreateTime | 1.3.6.1.4.1.9.9.765.1.1.2.1.6 | TimeStamp | read-only | This object provides the value of sysUpTime when the row was
created. |
| G32 cfcCloneProfileFlowCount | 1.3.6.1.4.1.9.9.765.1.1.2.1.7 | Gauge32 | read-only | This object provides the number of traffic flows currently
associated with the clone profile. |
| INT cfcCloneProfileFlowType | 1.3.6.1.4.1.9.9.765.1.1.2.1.8 | INTEGER | read-create | Identifies the type of flows associated with the clone
profile. Based on type the corresponding flow table will
represent the traffic flows associated with the clone profile.
Note that a clone profile can clone only one type of traffic
flows. For example, if the cfcCloneProfileFlowType is set to
'ip' than all the IP flows ONLY can be associated
(using cfcFlowIpTable) and cloned by this clone profile. New
flow types can be added to this based on the requirement and
hardware or software capability. For each new
cfcCloneProfileFlowType defined in cfcCloneProfileTable a
separate table can be added to this MIB to hold the
corresponding flow entries. The following types of flows are
supported:
'ip' IP flows are associated with this clone
profile. |
| INT cfcCloneTargetType | 1.3.6.1.4.1.9.9.765.1.1.2.1.9 | INTEGER | read-create | This object specifies the clone profile target. Following
targets are supported today
'other'
The implementation of the MIB module using this textual
convention does not recognize the clone profile target.
'system'
The clone profile target is global or the entire
system.
'interface'
The clone profile target is an interface represented
by a row in the ifTable defined by the IF-MIB
[RFC2863]. |
| I32 cfcCloneTargetIfIndex | 1.3.6.1.4.1.9.9.765.1.1.2.1.10 | Integer32 | read-create | This object specifies the ifindex of an interface over which
traffic flow to be cloned is received or transmitted. The
interface may be physical or virtual.
The value of a cfcCloneTargetIfIndex object MUST BE 0 if the
value of the cfcCloneTargetType object providing the context
is 'system' or 'other'. |
| NUM cfcCloneProfileEgressIfType | 1.3.6.1.4.1.9.9.765.1.1.2.1.11 | CloneProfilePointType | read-create | This object specifies the type of port/interface configured
to the clone profile. |
| NUM cfcCloneProfileEgressIf | 1.3.6.1.4.1.9.9.765.1.1.2.1.12 | CloneProfilePointIdentifier | read-create | This object specifies the ifindex of an interface that is
configured to the corresponding clone profile. All the flows
configured within this profile set will be cloned to this
interface. |
| TIM cfcCloneProfileTableChanged | 1.3.6.1.4.1.9.9.765.1.1.3 | TimeStamp | read-only | This object provides the value of sysUpTime the last time the
device created or destroyed a row in cfcCloneProfileTable. |
| cfcFlows | 1.3.6.1.4.1.9.9.765.1.2 | | | |
| cfcFlowIpTable | 1.3.6.1.4.1.9.9.765.1.2.1 | | not-accessible | This table lists the IP traffic flows that are cloned by
corresponding clone profile supported by the device.
This table has an expansion dependent relationship on the
cfcCloneProfileTable, containing zero or more rows for each
clone profile. Below is an example, where multiple IP flows
are associated with the single clone profile.
+----------------------------+
| cfcFlowIpTable |
| |
+----------------------+ +--------------------------------+
| cfcCloneProfileId = 3----->| +-------------------------+ |
+----------------------+ | | cfcCloneProfileId = 3 | |
| | cfcFlowIndex = 3 | |
| +-------------------------+ |
| +-------------------------+ |
| | cfcCloneProfileId = 3 | |
| | cfcFlowIndex = 5 | |
| +-------------------------+ |
| : |
| : |
| +-------------------------+ |
| | cfcCloneProfileId = 3 | |
| | cfcFlowIndex = 10 | |
| +-------------------------+ |
+--------------------------------+
| |
+----------------------+ +--------------------------------+
| cfcCloneProfileId = 4----->| +-------------------------+ |
+----------------------+ | | cfcCloneProfileId = 4 | |
| | cfcFlowIndex = 2 | |
| +-------------------------+ |
| +-------------------------+ |
| | cfcCloneProfileId = 4 | |
| | cfcFlowIndex = 6 | |
| +-------------------------+ |
| : |
| : |
| +-------------------------+ |
| | cfcCloneProfileId = 4 | |
| | cfcFlowIndex = 7 | |
| +-------------------------+ |
+--------------------------------+ |
| cfcFlowIpEntry | 1.3.6.1.4.1.9.9.765.1.2.1.1 | | not-accessible | An entry describes a IP traffic flow that are cloned by the
corresponding clone profile.
The device creates a row in the cfcFlowIpTable when a IP flow
is associated with a clone profile to clone the monitored flows
and send it to the configured egress interface. Likewise, the
device destroys a row in the cfcFlowIpTable when a traffic flow
disassociated with a clone profile.
Note that the corresponding clone profile must make sure
cfcCloneProfileFlowType is set to 'IP' before creating an entry
in this table else the creation will fail. |
| OID cfcFlowIndex | 1.3.6.1.4.1.9.9.765.1.2.1.1.1 | CloneFlowIdentifier | not-accessible | This object indicates an arbitrary integer-value that uniquely
identifies a configured traffic flow within a clone profile.
While adding an entry in this table, application is responsible
for making sure these are unique, although the SNMP RowStatus
row creation process will help by not allowing it to create
conflicting entries. Observe that the value assigned to a
traffic flow does not necessarily persist across restarts or
the removal-insertion of a physical entity supporting clone
profile(s). |
| ROW cfcFlowIpStatus | 1.3.6.1.4.1.9.9.765.1.2.1.1.2 | RowStatus | read-create | The status of this conceptual row. This object manages
creation, and deletion of rows in this table.
The following columns must be valid before activating a row:
- cfcFlowIpStorageType
- cfcFlowIpAddrSrcType
- cfcFlowIpAddrSrc
- cfcFlowIpAddrDstType
- cfcFlowIpAddrDst
Once the row is active, object in this table can not be modified
at any time.
The entry may be deleted by setting the value to 'destroy'. |
| STO cfcFlowIpStorageType | 1.3.6.1.4.1.9.9.765.1.2.1.1.3 | StorageType | read-create | This object specifies the memory realization of the row. |
| IPt cfcFlowIpAddrSrcType | 1.3.6.1.4.1.9.9.765.1.2.1.1.4 | InetAddressType | read-create | This object specifies the type of IP address indicated by the
corresponding instances of cfcFlowIpAddrSrc. |
| IP cfcFlowIpAddrSrc | 1.3.6.1.4.1.9.9.765.1.2.1.1.5 | InetAddress | read-create | This object specifies the source IP address of the
corresponding traffic flow. This address will be of the type
specified in cfcFlowIpAddrSrcType. |
| IPt cfcFlowIpAddrDstType | 1.3.6.1.4.1.9.9.765.1.2.1.1.6 | InetAddressType | read-create | This object specifies the type of IP address indicated by the
corresponding instances of cfcFlowIpAddrDst. |
| IP cfcFlowIpAddrDst | 1.3.6.1.4.1.9.9.765.1.2.1.1.7 | InetAddress | read-create | This object specifies the destination IP address of the
corresponding traffic flow. This address will be of the type
specified in cfcFlowIpAddrDstType. |
| TIM cfcFlowIpCreateTime | 1.3.6.1.4.1.9.9.765.1.2.1.1.8 | TimeStamp | read-only | This object provides the value of sysUpTime when the row was
created. |
| cfcFlowStats | 1.3.6.1.4.1.9.9.765.1.3 | | | |
| cfcFlowStatsTable | 1.3.6.1.4.1.9.9.765.1.3.1 | | not-accessible | This table contains data relating to the collection of
statistics for the flows cloned by the corresponding clone
profiles supported by the device.
This table has a sparse dependent relationship on the flow
tables, containing a row for each row in the flow table
(cfcFlowIpTable in case of IP flows) for which the device is
actively cloning the packets. |
| cfcFlowStatsEntry | 1.3.6.1.4.1.9.9.765.1.3.1.1 | | not-accessible | An entry contains collection of statistics for a corresponding
traffic flow.
The device creates a row in the cfcFlowStatsTable when a
clone profile is configured with a traffic flow and actively
cloning the packets of that flow to the specified egress
interface. Likewise, the device destroys a row in the
cfcFlowStatsTable when the corresponding flow is removed
from the clone profile. |
| C64 cfcFlowPktsEx | 1.3.6.1.4.1.9.9.765.1.3.1.1.1 | Counter64 | read-only | This object provides the total number of packets that are
cloned for a traffic flow by the corresponding clone profile. |
| C64 cfcFlowOctets | 1.3.6.1.4.1.9.9.765.1.3.1.1.2 | Counter64 | read-only | This object provides the total number of octets contained by
the packets that are cloned for a traffic flow by the
corresponding clone profile. |
| ciscoFlowCloneMIBConformance | 1.3.6.1.4.1.9.9.765.2 | | | |
| ciscoFlowCloneMIBCompliances | 1.3.6.1.4.1.9.9.765.2.1 | | | |
| ciscoCloneFlowCompliance01 | 1.3.6.1.4.1.9.9.765.2.1.1 | | | This compliance statement specifies the minimal requirements
an implementation must meet in order to claim full compliance
with the definition of the CISCO-FLOW-CLONE-MIB. |
| ciscoFlowCloneMIBGroups | 1.3.6.1.4.1.9.9.765.2.2 | | | |
| cfcCloneProfileGroup | 1.3.6.1.4.1.9.9.765.2.2.1 | | | This group contains objects describing clone profiles. |
| cfcFlowGroup | 1.3.6.1.4.1.9.9.765.2.2.2 | | | This group contains objects describing traffic flows. |
| cfcFlowStatsGroup | 1.3.6.1.4.1.9.9.765.2.2.3 | | | This group contains objects describing traffic flow metrics. |
