SNMP API and MIB Guide for
Videoscape Control Suite 3.5.2
Introduction
This document describes the Simple Network Management Protocol (SNMP)
functional specifications as they relate to the Cisco® Videoscape™ Control Suite
product.
For additional information about the Videoscape Control Suite, see the following
guides:
 Getting Started Guide for Videoscape Control Suite (OL-27702)
 Installing COP Files for the Videoscape Control Suite (part number OL-27753)
Document Version
This is the second formal release of this document. This document was updated to
support version 3.5.2 of the Videoscape Control Suite.
Net-SNMP
Net-SNMP
Net-SNMP refers to the suite of software that is used to deploy the SNMP protocol.
Net-SNMP has been modified to support the Single Entity Mode, as well as the
default behavior of a standalone network management component.
Data Persistence in the Management Console
The Videoscape Control Suite Management Console (management console) uses the
XMP persistence module to store data in the Oracle database. The management
console saves the following operational data in the database:
 All events and alarms processed by the Alarms and Events module
 Platform statistics counters
The management console receives events in the form of SNMP traps sent by the
Management Console Controller (MCC) and the SYSLOGTRAP process. The MCC is
responsible for sending traps from the managed node; the SYSLOGTRAP process is
responsible for sending traps from the management node.
The management console conducts a periodic query of each managed node to collect
the platform statistics. The statistics are also displayed on the detailed statistics page
of each managed node from the dashboard. The statistics are saved in the database
and can be purged based upon user configuration. This data will be made available
to the Cisco Prime Performance application for statistics charting via a northbound
interface (NBI).
Single Entity Mode Overview
The Single Entity Mode, also known as single OAM, refers to users querying the
SNMP information of any node in a Videoscape Control Suite cluster via the SNMP
agent of the management node. From the viewpoint of a network management
system (NMS), the whole Videoscape Control Suite cluster is considered as one
system. In this mode, the agent of the management node polls data from all
managed nodes via the XMPP interface and stores this in memory for faster access.
To minimize the XMPP traffic that can affect the operation of the cluster, there is a
refresh time for each table, typically 30 seconds, from which the management node
polls the managed nodes again for new data.
2
Net-SNMP
The data from managed nodes is then indexed by the agent in the management
node. The index scheme, defined in Supported MIBs and Tables in Single Entity
Mode, (on page 3) should be used by the users to query the data of a managed node,
or to decode the data from the “snmpwalk” action.
Example: IF-MIB
 ifIndex of the management node: no change
IF-MIB::ifIndex.1 (the 1st interface)
IF-MIB::ifIndex.2 (the 2nd interface), …
 ifIndex of a managed node that has nodeID of 1002:
IF-MIB::ifIndex.151 (the 1st interface)
because 50(1002-1000+1) = 150
IF-MIB::ifIndex.152 (the 2nd interface) …
Because the SNMP agent polls data from managed nodes via the XMPP messaging
system, there is no need to start the agents of those managed nodes. There will be a
command line interface (CLI) to start the SNMP agent individually in each node, if
necessary.
Supported MIBs and Tables in Single Entity Mode
The following MIBs, which provide the operating data of a node, are supported in
Single Entity Mode.
MIBs
Table
Entry
Index (Managed Node)
IF-MIB
ifTable
ifEntry
50*(ID-BASE+1)
ifXTable
ifXEntry
50*(ID-BASE+1)
RFC1213-MIB
atTable
atEntry
50*(ID-BASE+1)
IP-MIB
ipAddrTable
ipAddrEntry
IP Address
ipNetToMediaTable
ipNetToMediaEntr
y
50*(ID-BASE+1)
ipAddressTable
ipAddressEntry
IP Address
ipNetToPhysicalTable
ipNetToPhysicalEn
try
50*(ID-BASE+1)
tcpConnTable
ipSystemStatsEntry
50*(ID-BASE+1)
3
Net-SNMP
MIBs
Table
Entry
Index (Managed Node)
TCP-MIB
tcpConnTable
tcpConnEntry
Unique IP: No change
Duplicate IP: port +=
100000*(ID-BASE+1)
UDP-MIB
udpTable
udpEntry
Unique IP: No change
Duplicate IP: port +=
100000*(ID-BASE+1)
HOSTRESOURCESMIB
hrStorageTable
hrStorageEntry
50*(ID-BASE+1)
hrDeviceTable
hrDeviceEntry
(dev_type<<12)+50*(IDBASE+1)
hrProcTable
hrProcEntry
(3<<12)+ 50*(ID-BASE+1)
hrNetworkTable
hrNetworkEntry
(4<<12)+ 50*(ID-BASE+1)
hrDiskStorageTable
hrDiskStorageEntry
(6<<12)+ 50*(ID-BASE+1)
hrPartitionTable
hrPartitionEntry
Based on storage index
hrFSTable
hrFSEntry
50*(ID-BASE+1)
hrSWRunTable
hrSWRunEntry
100000*(ID-BASE+1)
hrSWRunPerfTable
hrSWRunPerfEntry
100000*(ID-BASE+1)
 ID — Node ID
 BASE — Base index; the value is 1000 in R2.5
 Dev_type — Device type
4
-
Processor — 3
-
Network — 4
-
Storage — 6
Net-SNMP
Scalers in Single Entity Mode
Most scalars belong to supported MIBs. Tables are aggregated with values from
individual nodes.
MIBs
Scalers
IF-MIB
IF-MIB::ifNumber.0
IP-MIB
IP-MIB::ipForwarding.0
IP-MIB::ipDefaultTTL.0
IP-MIB::ipInReceives.0
IP-MIB::ipInHdrErrors.0
IP-MIB::ipInAddrErrors.0
IP-MIB::ipForwDatagrams.0
IP-MIB::ipInUnknownProtos.0
IP-MIB::ipInDiscards.0
IP-MIB::ipInDelivers.0
IP-MIB::ipOutRequests.0
IP-MIB::ipOutDiscards.0
IP-MIB::ipOutNoRoutes.0
IP-MIB::ipReasmTimeout.0
IP-MIB::ipReasmReqds.0
IP-MIB::ipReasmOKs.0
IP-MIB::ipReasmFails.0
IP-MIB::ipFragOKs.0
IP-MIB::ipFragFails.0
IP-MIB::ipFragCreates.0
IP-MIB::icmpInMsgs.0
IP-MIB::icmpInErrors.0
IP-MIB::icmpInDestUnreachs.0
IP-MIB::icmpInTimeExcds.0
IP-MIB::icmpInParmProbs.0
IP-MIB::icmpInSrcQuenchs.0
IP-MIB::icmpInRedirects.0
IP-MIB::icmpInEchos.0
IP-MIB::icmpInEchoReps.0
IP-MIB::icmpInTimestamps.0
IP-MIB::icmpInTimestampReps.0
IP-MIB::icmpInAddrMasks.0
IP-MIB::icmpInAddrMaskReps.0
IP-MIB::icmpOutMsgs.0
IP-MIB::icmpOutErrors.0
IP-MIB::icmpOutDestUnreachs.0
IP-MIB::icmpOutTimeExcds.0
IP-MIB::icmpOutParmProbs.0
IP-MIB::icmpOutSrcQuenchs.0
IP-MIB::icmpOutRedirects.0
IP-MIB::icmpOutEchos.0
IP-MIB::icmpOutEchoReps.0
IP-MIB::icmpOutTimestamps.0
IP-MIB::icmpOutTimestampReps.0
IP-MIB::icmpOutAddrMasks.0
IP-MIB::icmpOutAddrMaskReps.0
5
Net-SNMP
TCP-MIB
TCP-MIB::tcpRtoMin.0
TCP-MIB::tcpRtoMax.0
TCP-MIB::tcpMaxConn.0
TCP-MIB::tcpActiveOpen s.0
TCP-MIB::tcpPassiveOpen s.0
TCP-MIB::tcpAttemptFail s.0
TCP-MIB::tcpEstabRese ts.0
TCP-MIB::tcpCurrEstab.0
TCP-MIB::tcpInSegs.0
TCP-MIB::tcpOutSegs.0
TCP-MIB::tcpRetransSegs.0
TCP-MIB::tcpInErrs.0
TCP-MIB::tcpOutRsts.0
UDP-MIB
UDP-MIB::udpInDatagrams.0
UDP-MIB::udpNoPor ts.0
UDP-MIB::udpInErrors.0
UDP-MIB::udpOutDatagrams.0
Standalone Mode
There are cases in which the users of Videoscape Control Suite applications are
required to have an active SNMP agent on a managed node. The standalone mode is
the option through which the SNMP agent of a managed node will be activated. This
agent provides SNMP support for the node, as requested.
The standalone mode is managed by CLI commands:
 utils service snmpd_single_mode start — Starts the SNMP agent
 utils service snmpd_single_mode stop — Stops the SNMP agent
 utils service snmpd_single_mode status — Checks if the snmpd
process is running
6
Net-SNMP
Traps
There are two new traps from the Management Health Monitor(MHM) that relate to
the high-availability (HA) feature. These MIBs are the main means for
communicating SNMP events.
 CISCO-SYSLOG-MIB
http://www.cisco.com/en/US/docs/net_mgmt/mobile_wireless_transport_ma
nager/6.1/developer/guide/appC.html
Trap Format
1)clogMessageGenerated:
Name:
clogMessageGenerated:
OID:
1.3.6.1.4.1.9.9.41.2.0.1
MIB:
CISCO-SYSLOG-MIB
Status:
current
Objects:
clogHistFacility, clogHistSeverity, clogHistMsgName,
clogHistMsgText, clogHistTimestamp
Description:
When a syslog message is generated by the device a
clogMessageGenerated notification is sent. The sending of
these notifications can be enabled/disabled via the
clogNotificationsEnabled object.
Name
OID
Syntax
clogHistFa
cility
clogHistSe
rverity
1.3.6.1.4.1.9.
9.41.1.2.3.1.2
1.3.6.1.4.1.9.
9.41.1.2.3.1.3
clogHistMs
gName
1.3.6.1.4.1.9.
9.41.1.2.3.1.4
DISPLAYSTRING(SIZE(1..20)
)
(INTEGER){emergency(1),al
ert(2),critical(3),error(
4),warning(5),notice(6),i
nfo(7),debug(8)}
DISPLAYSTRING(SIZE(1..30)
)
clogHistMs
gText
clogHistTi
mestamp
1.3.6.1.4.1.9.
9.41.1.2.3.1.5
1.3.6.1.4.1.9.
9.41.1.2.3.1.6
DISPLAYSTRING(SIZE(1..255
))
TIMESTAMP
Descr
Name of the facility that
generated this message.
The severity of the message
A textual identification for
the message type. A facility
name in conjunction with a
message
name
uniquely
identifies a message type
The text of the message.
The value of sysUpTime when
this message is generated
7
Net-SNMP
2)linkUp/linkDown
Name:
linkup/linkDown
OID:
1.3.6.1.6.3.1.1.5.3
MIB:
IF-MIB
Description: A linkUp trap signifies that the SNMP entity, acting in an
agent role, has detected that the ifOperStatus object for one of its communication
links left the down state and transitioned into some other state (but not into the
notPresent state). This other state is indicated by the included value of ifOperStatus.
Descripition: A linkDown trap signifies that the SNMP entity, acting in
an agent role, has detected that the ifOperStatus object for one of its communication
links is about to enter the down state from some other state (but not from the
notPresent state). This other state is indicated by the included value of ifOperStatus.
Name
8
OID
ifIndex
1.3.6.1.2.1.
2.2.1.1
ifAdminStatus
1.3.6.1.2.1.
2.2.1.7
ifOperStatus
1.3.6.1.2.1.
2.2.1.8
Syntax
Descr
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
reinitialization
The
desired
state
of
the
interface.
The
testing(3)
state
indicates that no operational
packets can be passed. When a
managed
system
initializes,
all interfaces start with
ifAdminStatus in the down(2)
state. As a result of either
explicit management action or
per configuration information
retained
by
the
managed
system, ifAdminStatus is then
changed to either the up(1) or
testing(3) states (or remains
in the down(2) state)."
Values:
1 : up
2 : down
3 : testing
4 : unknown
5 : dormant
6 : notPresent
7:lowerLayerDown
Net-SNMP
3)coldStart
Name:
coldStart
OID:
1.3.6.1.6.3.1.1.5.1
MIB:
SNMPv2-MIB
Description: A coldStart trap signifies that the SNMP entity, supporting a
notification originator application, is reinitializing itself and that its configuration
mayhave been altered."
4)warmStart
Name:
OID:
warmStart
1.3.6.1.6.3.1.1.5.2
MIB:
SNMPv2-MIB
Description: A warmStart trap signifies that the SNMP entity, supporting a
notification originator application, is reinitializing itself such that its configuration
is unaltered."
5)hrStorageRam
Name:
hrStorageRam
OID:
MIB:
Description:
1.3.6.1.2.1.25.2.1.2
HOST-RESOURCES-TYPES
The storage type identifier used for RAM
6)hrStorageRamDisk
Name:
hrStorageRamDisk
OID:
MIB:
Description:
RAM
1.3.6.1.2.1.25.2.1.8
HOST-RESOURCES-TYPES
The storage type identifier used for a filesysterm that is stored in
 CISCO-EPM-NOTIFICATION-MIB
http://www.cisco.com/en/US/docs/net_mgmt/mobile_wireless_transport_ma
nager/6.1/developer/guide/appD.html
Both of these MIBs define NOTIFICATION-TYPE events sent by an SNMP agent,
which should be receivable by a sufficiently modern SNMP manager (receiver).
9
Net-SNMP
There are two kinds of SNMP events in general use: the basic TRAP-TYPE, defined
by SNMP version 1 (SNMP-v1) and the NOTIFICATION-TYPE, defined by SNMP
version2c (SNMP-v2c). These have very different syntaxes, with the
NOTIFICATION-TYPE providing a more regular object identity and content model
than the TRAP-TYPE.
The SNMP-v2c manager must be aware of this distinction in order to handle both
types of events. A v1 SNMP manager cannot handle a v2c notification, although an
agent can perform a mapping transformation on the event, from NOTIFICATIONTYPE to TRAP-TYPE, to enable the manager to receive the event.
Version 3.0 of the Videoscape Control Suite supports both SNMP-v1 and SNMP-v2c
receivers.
The management console represents all TRAP-TYPE or NOTIFICATION-TYPE
objects as Alerts for direct viewing and management in the console.
All generated SNMP events will be transmitted as TRAP-TYPE or NOTIFICATIONTYPE events to receivers. This is captured graphically in the following figure.
10
Net-SNMP
An additional option allows for the configuration of an upstream EPM receiver. This
is used to forward SNMP events to a Cisco Prime Analytics server, using the
Videoscape Control Suite message infrastructure (instead of the more standard
SNMP transport), as shown in the following figure.
Trap Description
Management
Node
Managed Node
Notes
Cold start
SNMP (APi0)
PNC (syslog)
SNMP Warm start
n/a
n/a
See Note #1
SNMP Authentication
SNMP (API)
n/a
Default disable
Interface Up/Down
NetLink
NetLink
CPU Threshold
RMON (syslog)
RMON (syslog)
Memory Threshold
RMON (syslog)
RMON (syslog)
Process Restart Denied - Node
Restart
ServM (syslog)
ServM (syslog)
Process Restart
ServM (syslog)
ServM (syslog)
Process Restart Denied - Node
Restart
MHM(syslog)
n/a
Process Restart
MHM(syslog)
n/a
Msg-Infra failure - Node Restart
NC
NC
Environment traps (CPU fan,
temperature)
Kernel
Kernel
From VMware
11
Net-SNMP
Note #1: The Warm start trap is not implemented in Net-SNMP because the
requirement of the agent to make sure the configuration has not been changed since
the last restart is considered too strict by the developers of Net-SNMP.
12
For Information
If You Have Questions
If you have technical questions, call Cisco Services for assistance. Follow the menu
options to speak with a service engineer.
Americas Headquarters
http://www.cisco.com
Cisco Systems, Inc.
Tel: 408 526-4000
170 West Tasman Drive
800 553-6387
San Jose, CA 95134-1706
Fax: 408 527-0883
USA
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates
in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL:
www.cisco.com/go/trademarks.
Third party trademarks mentioned are the property of their respective owners.
The use of the word partner does not imply a partnership relationship between Cisco and any
other company. (1110R)
Product and service availability are subject to change without notice.
© 2013 - 2014 Cisco and/or its affiliates. All rights reserved.
December 2014