HP Cisco Nexus 5000 Cisco Nexus 5000 Series MIB Quick Reference (OL-16784-01, - Page 5

Syntax Clause, Max-access Clause, Agent-capabilities

Page 5 highlights

MIBs and Network Management Send documentation comments to [email protected] In the example, vsanTable contains two variables: vsanIndex and vsanName. (There are more values in the actual vsanTable.) The index for this table is the ID of the VSAN, or vsanIndex. With n number of VSANs configured, n rows are present in the table. If you want to retrieve the vsanName that matches VSAN ID 3 (vsanIndex is 3), then you would issue an SNMP get for vsanName.3. SYNTAX Clause The SYNTAX clause describes the format of the information, or value, that is returned when you monitor or set information in a MIB. The Cisco Nexus 5000 Series MIBs are defined with the SNMPv2 Structure of Management Information version 2 (SNMPv2-SMI) defined in RFC 1902. Some examples of SNMPv2-SMI syntax are as follows: • Counter32-A nonnegative integer that increases until it reaches some maximum value. After reaching the maximum value, it rolls over to zero. For example, the variable ifInOctets, with a Counter32 syntax, counts the number of input octets on an interface. • Gauge32-A nonnegative integer that increases until it reaches some maximum value. After reaching the maximum value, it stays fixed (there is no roll over). • Counter64-A nonnegative 64-bit integer that increases until it reaches some maximum value. After reaching the maximum value, it rolls back to zero. Counter64 is used for MIB objects that can reach high values in a short period of time (for example, a packet counter for a Gigabit Ethernet port). • Integer32-An integer from -232 to 232-1. • IPAddress-An octet string that represents an IP address. For example, the variable hostConfigAddr indicates the IP address of the host that provided the host configuration file for a switch. • Timeticks-A nonnegative integer that counts the hundredths of a second that have elapsed since an event. For example, the variable loctcpConnElapsed provides the length of time that a TCP connection has been established. MAX-ACCESS Clause The MAX-ACCESS clause identifies the maximum access level for the associated MIB object. This clause can represent one of the following five states: • read-create-You can read, modify, or create objects as rows in a table. • read-write-You can read or modify this object. • read-only-You can only read this object. • accessible-for-notify-You cannot read or write to this object. SNMP notifications can send this object as part of their event information. • not-accessible-You cannot read or write to this object. Table indices are typically objects that are not accessible. AGENT-CAPABILITIES In SNMP, capabilities files provide implementation details for the associated MIB. These files, called AGENT-CAPABILITIES, list supported conformance groups and any deviations from the MIB as implemented in the associated software version. For example, the CISCO-AAA-SERVER-CAPABILITY provides the implementation details for the CISCO-AAA-SERVER-MIB, as implemented in Cisco Nexus 5000 Series switches. OL-16784-01 Cisco Nexus 5000 Series MIB Quick Reference 5

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14

Send documentation comments to [email protected]
5
Cisco Nexus 5000 Series MIB Quick Reference
OL-16784-01
MIBs and Network Management
In the example, vsanTable contains two variables: vsanIndex and vsanName. (There are more values in
the actual vsanTable.) The index for this table is the ID of the VSAN, or vsanIndex. With
n
number of
VSANs configured,
n
rows are present in the table. If you want to retrieve the vsanName that matches
VSAN ID 3 (vsanIndex is 3), then you would issue an SNMP
get
for vsanName.3
.
SYNTAX Clause
The SYNTAX clause describes the format of the information, or value, that is returned when you monitor
or set information in a MIB.
The Cisco Nexus 5000 Series MIBs are defined with the SNMPv2 Structure of Management Information
version 2 (SNMPv2-SMI) defined in RFC 1902. Some examples of SNMPv2-SMI syntax are as follows:
Counter32—A nonnegative integer that increases until it reaches some maximum value. After
reaching the maximum value, it rolls over to zero. For example, the variable ifInOctets, with a
Counter32 syntax, counts the number of input octets on an interface.
Gauge32—A nonnegative integer that increases until it reaches some maximum value. After
reaching the maximum value, it stays fixed (there is no roll over).
Counter64—A nonnegative 64-bit integer that increases until it reaches some maximum value. After
reaching the maximum value, it rolls back to zero. Counter64 is used for MIB objects that can reach
high values in a short period of time (for example, a packet counter for a Gigabit Ethernet port).
Integer32—An integer from -2
32
to 2
32
-1.
IPAddress—An octet string that represents an IP address. For example, the variable
hostConfigAddr
indicates the IP address of the host that provided the host configuration file for a switch.
Timeticks—A nonnegative integer that counts the hundredths of a second that have elapsed since an
event. For example, the variable loctcpConnElapsed
provides the length of time that a TCP
connection has been established.
MAX-ACCESS Clause
The MAX-ACCESS clause identifies the maximum access level for the associated MIB object. This
clause can represent one of the following five states:
read-create—You can read, modify, or create objects as rows in a table.
read-write—You can read or modify this object.
read-only—You can only read this object.
accessible-for-notify—You cannot read or write to this object. SNMP notifications can send this
object as part of their event information.
not-accessible—You cannot read or write to this object. Table indices are typically objects that are
not accessible.
AGENT-CAPABILITIES
In SNMP, capabilities files provide implementation details for the associated MIB. These files, called
AGENT-CAPABILITIES, list supported conformance groups and any deviations from the MIB as
implemented in the associated software version. For example, the
CISCO-AAA-SERVER-CAPABILITY provides the implementation details for the
CISCO-AAA-SERVER-MIB, as implemented in Cisco Nexus 5000 Series switches.