Propriatery MIB Definition Internet Draft Document: motorola-canopy.txt Motorola Canopy Version: 5x45-07-00 Tuesday 31st January 2006 Definitions of Managed Objects for the Motorola Canopy Wireless Ethernet Bridge Status of this Memo This document is an Internet-Draft and is in full conformance with all provisions of Section 10 of RFC2026 except that the right to produce derivative works is not granted. Abstract This memo defines a portion of the Management Information Base (MIB) for use with the Motorola Canopy 45 Mbps Wireless Ethernet Bridge. 1. The Network Management Framework The Internet-standard Network Management Framework consists of three components. They are: STD16/RFC 1155 which defines the SMI, the mechanisms used for describing and naming objects for the purpose of management. STD16/RFC 1212 defines a more concise description mechanism, which is wholly consistent with the SMI. RFC 1156 which defines MIB-I, the core set of managed objects for the Internet suite of protocols. STD17/RFC 1213, defines MIB-II, an evolution of MIB-I based on implementation experience and new operational requirements. STD15/RFC 1157 which defines the SNMP, the protocol used for network access to managed objects. The Framework permits new objects to be defined for the purpose of experimentation and evaluation. 2. Objects Managed objects are accessed via a virtual information store, termed the Management Information Base or MIB. Objects in the MIB are defined using the subset of Abstract Syntax Notation One (ASN.1) [4] defined in the SMI. In particular, each object is named by an OBJECT IDENTIFIER, an administratively assigned name, which specifies an object type. The object type together with an object instance serves to uniquely identify a specific instantiation of the object. For human convenience, we often use a textual string, termed the descriptor, to also refer to the object type. JanKausKas [Page 1] RFC DRAFT Motorola Canopy MIB January 2006 2.1. Format of Definitions Section 5 contains the specification of all object types contained in this MIB module. The object types are defined using the conventions defined in the SMI, as amended by the extensions specified in [6,7]. 3. Overview The Motorola Canopy 45Mbps Backhaul uses advanced wireless technology to provide non line of sight (NLOS) ethernet communications. 3.1. Structure of MIB Objects in this MIB are arranged into groups. Each group is organized as a set of related objects. The overall structure and assignment of objects to their groups is shown below. +-canopy | +-p2p | +-configuration | | | +-iPAddress | +-subnetMask | +-gatewayIPAddress | +-targetMACAddress | +-masterSlaveMode | +-maximumTransmitPower | +-licence | | | +-regionCode | +-productVariant | +-productName | +-ethernetFibreSupport | +-frequencyVariant | +-mgmt | | | +-targetRange | +-rangingMode | +-phyControl | | | +-asymmetricTDD | +-phyStatus | | | +-receivePower | +-vectorError | +-transmitPower | +-range | +-linkLoss | +-receiveChannel | +-transmitChannel | +-receiveModulationMode | +-transmitModulationMode | +-receiveFreq | +-transmitFreq | +-signalStrengthRatio | +-reset | | | +-systemReset | +-versions | | | +-softwareVersion | +-hardwareVersion | +-secondarySoftwareVersion | +-bootVersion | +-pubStats | | | +-receiveDataRate | +-transmitDataRate | +-aggregateDataRate | +-encryption | | | +-encryptionAlgorithm | 3.1.1. The configuration Group This mandatory group contains the objects which are applicable the P2P unit configuration. 3.1.2. The licence Group This licence group contains a description of the system capabilities that are controlled and managed via the systems licence key 3.1.3. The mgmt Group This mgmt (management) group contains a description of high level system control and monitoring attributes 3.1.4. The phyControl Group The PHY control group contains a description of the attributes that control the behaviour and performance of the wireless links physical layer 3.1.5. The phyStatus Group This mandatory group contains the objects which are applicable the P2P units' wireless physical layer operational parameters 3.1.6. The reset Group This mandatory group contains the objects which are applicable the P2P units' reset information. 3.1.7. The versions Group This mandatory group contains the objects which are applicable the P2P units' version information. 3.1.8. The pubStats Group This group contains the objects which are applicable the P2P units' operational statistics. 3.1.9. The encryption Group 3.2. Textual Conventions The datatypes, MacAddress, BridgeId and Timeout, are used as textual conventions in this document. These textual conventions have NO effect on either the syntax nor the semantics of any managed object. Objects defined using these conventions are always encoded by means of the rules that define their primitive type. Hence, no changes to the SMI or the SNMP are necessary to accommodate these textual conventions which are adopted merely for the convenience of readers. 4. Definitions CANOPY-SYS-MIB DEFINITIONS ::= BEGIN IMPORTS IpAddress, Counter, Gauge, TimeTicks, NetworkAddress, enterprises FROM RFC1155-SMI OBJECT-TYPE FROM RFC-1212 DisplayString, PhysAddress FROM SNMPv2-TC NOTIFICATION-TYPE FROM SNMPv2-SMI; -- Define the Motorola Canopy object identifier motorola OBJECT IDENTIFIER ::= { enterprises 17713 } -- Groups in motorola p2p OBJECT IDENTIFIER ::= { motorola 1 } p2mp OBJECT IDENTIFIER ::= { motorola 2 } -- Groups in p2p configuration OBJECT IDENTIFIER ::= { p2p 5 } licence OBJECT IDENTIFIER ::= { p2p 8 } mgmt OBJECT IDENTIFIER ::= { p2p 9 } phyControl OBJECT IDENTIFIER ::= { p2p 10 } phyStatus OBJECT IDENTIFIER ::= { p2p 12 } reset OBJECT IDENTIFIER ::= { p2p 18 } versions OBJECT IDENTIFIER ::= { p2p 19 } pubStats OBJECT IDENTIFIER ::= { p2p 20 } encryption OBJECT IDENTIFIER ::= { p2p 22 } p2pTraps OBJECT IDENTIFIER ::= { p2p 99 } -- Configuration group attribute definitions -- iPAddress OBJECT-TYPE SYNTAX IpAddress ACCESS read-only STATUS mandatory DESCRIPTION "Internet protocol (IP) address. This address is used by the family of Internet protocols to uniquely this identify the unit on a network" ::= { configuration 1 } subnetMask OBJECT-TYPE SYNTAX IpAddress ACCESS read-only STATUS mandatory DESCRIPTION "A subnet allows the flow of network traffic between hosts to be segregated based on a network configuration. By organizing hosts into logical groups, subnetting can improve network security and performance." ::= { configuration 2 } gatewayIPAddress OBJECT-TYPE SYNTAX IpAddress ACCESS read-only STATUS mandatory DESCRIPTION "The IP address of a computer on the current network that is currently acting as a network gateway. A gateway acts as an entrance / exit to packets from / to other networks." ::= { configuration 3 } targetMACAddress OBJECT-TYPE SYNTAX OCTET STRING (SIZE(6)) ACCESS read-only STATUS mandatory DESCRIPTION "MAC address of the PTP wireless unit forming the other end of the PTP link" ::= { configuration 4 } masterSlaveMode OBJECT-TYPE SYNTAX INTEGER { master(0), slave(1) } ACCESS read-only STATUS mandatory DESCRIPTION "The PTP wireless link operates using a master and slave relationship." ::= { configuration 5 } maximumTransmitPower OBJECT-TYPE SYNTAX INTEGER (-15..25) ACCESS read-only STATUS mandatory DESCRIPTION "Maximum transmit power the wireless unit is permitted to use when establishing and maintaining the wireless link" ::= { configuration 6 } -- Licence group attribute definitions -- regionCode OBJECT-TYPE SYNTAX INTEGER (0..31) ACCESS read-only STATUS mandatory DESCRIPTION "The region code prohibits the wireless unit from operating outside the regulated limits" ::= { licence 1 } productVariant OBJECT-TYPE SYNTAX INTEGER { motorola-canopy-60mbps-backhaul(0), motorola-canopy-60mbps-backhaul(1), motorola-canopy-60mbps-backhaul(2), motorola-canopy-30mbps-backhaul(3), spare-1(4), spare-2(5), spare-3(6), spare-4(7), spare-5(8), spare-6(9), spare-7(10), motorola-canopy-150mbps-backhaul(11), motorola-canopy-300mbps-backhaul(12) } ACCESS read-only STATUS mandatory DESCRIPTION "The product variant" ::= { licence 2 } productName OBJECT-TYPE SYNTAX DisplayString (SIZE(0..255)) ACCESS read-only STATUS mandatory DESCRIPTION "Name of the product variant" ::= { licence 3 } ethernetFibreSupport OBJECT-TYPE SYNTAX INTEGER { disabled(0), enabled(1) } ACCESS read-only STATUS mandatory DESCRIPTION "Gigabit Ethernet fibre support" ::= { licence 4 } frequencyVariant OBJECT-TYPE SYNTAX INTEGER { freq-5800-mhz(0), freq-5400-mhz(1) } ACCESS read-only STATUS mandatory DESCRIPTION "Frequency variant of the wireless unit" ::= { licence 5 } -- Mgmt group attribute definitions -- targetRange OBJECT-TYPE SYNTAX INTEGER (0..2000) ACCESS read-only STATUS mandatory DESCRIPTION "Initial target range used in installation +/-1, expressed in tenths of a kilometer. When Auto-Ranging this must be set to 0" ::= { mgmt 1 } rangingMode OBJECT-TYPE SYNTAX INTEGER { auto-0-5-km(0), auto-0-40-km(1), auto-0-100-km(2), auto-0-200-km(3), target-range(4) } ACCESS read-only STATUS mandatory DESCRIPTION "Type of ranging to use during installation, either Auto-Ranging or use a selectable Target Range" ::= { mgmt 2 } -- PhyControl group attribute definitions -- asymmetricTDD OBJECT-TYPE SYNTAX INTEGER { symmetric-data-rate-1-to-1(0), asymmetric-data-rate-2-to-1(1), prohibited(2), latency-optimised(3) } ACCESS read-only STATUS mandatory DESCRIPTION "Control TDD Structure" ::= { phyControl 1 } -- PhyStatus group attribute definitions -- receivePower OBJECT-TYPE SYNTAX INTEGER ACCESS read-only STATUS mandatory DESCRIPTION "Receive power expressed in tenths of a dBm" ::= { phyStatus 1 } vectorError OBJECT-TYPE SYNTAX INTEGER ACCESS read-only STATUS mandatory DESCRIPTION "The vector error measurement compares the received signal's IQ modulation characteristics to an ideal signal to determine the composite error vector magnitude. The value represented by this attribute is the average vector error over the previous second expressed in tenths of a dB" ::= { phyStatus 2 } transmitPower OBJECT-TYPE SYNTAX INTEGER ACCESS read-only STATUS mandatory DESCRIPTION "Transmit power expressed in tenths of a dBm" ::= { phyStatus 3 } range OBJECT-TYPE SYNTAX INTEGER ACCESS read-only STATUS mandatory DESCRIPTION "Distance between the two peer wireless units expressed in tenths of a kilometer" ::= { phyStatus 4 } linkLoss OBJECT-TYPE SYNTAX INTEGER (-500..500) ACCESS read-only STATUS mandatory DESCRIPTION "The wireless link loss expressed in tenths of a dB" ::= { phyStatus 5 } receiveChannel OBJECT-TYPE SYNTAX INTEGER (0..21) ACCESS read-only STATUS mandatory DESCRIPTION "Current active receive channel" ::= { phyStatus 6 } transmitChannel OBJECT-TYPE SYNTAX INTEGER (0..21) ACCESS read-only STATUS mandatory DESCRIPTION "Current active transmit channel" ::= { phyStatus 7 } receiveModulationMode OBJECT-TYPE SYNTAX INTEGER { mod-acquisition(0), mod-bpsk-1-2(1), mod-qpsk-1-2(2), mod-qpsk-2-3(3), mod-16qam-1-2(4), mod-16qam-3-4(5), mod-64qam-2-3(6), mod-64qam-3-4(7), mod-64qam-7-8(8) } ACCESS read-only STATUS mandatory DESCRIPTION "Current active receive modulation mode" ::= { phyStatus 8 } transmitModulationMode OBJECT-TYPE SYNTAX INTEGER { mod-acquisition(0), mod-bpsk-1-2(1), mod-qpsk-1-2(2), mod-qpsk-2-3(3), mod-16qam-1-2(4), mod-16qam-3-4(5), mod-64qam-2-3(6), mod-64qam-3-4(7), mod-64qam-7-8(8) } ACCESS read-only STATUS mandatory DESCRIPTION "Current active transmit modulation mode" ::= { phyStatus 9 } receiveFreq OBJECT-TYPE SYNTAX INTEGER (0..5875) ACCESS read-only STATUS mandatory DESCRIPTION "Current receive frequency expressed in MHz" ::= { phyStatus 11 } transmitFreq OBJECT-TYPE SYNTAX INTEGER (0..5875) ACCESS read-only STATUS mandatory DESCRIPTION "Current transmit frequency expressed in MHz" ::= { phyStatus 12 } signalStrengthRatio OBJECT-TYPE SYNTAX INTEGER ACCESS read-only STATUS mandatory DESCRIPTION "Signal strength ratio (Vertical / Horizontal) expressed in tenths of a dB" ::= { phyStatus 13 } -- Reset group attribute definitions -- systemReset OBJECT-TYPE SYNTAX INTEGER { running(0), console-reboot(1) } ACCESS read-write STATUS mandatory DESCRIPTION "Setting this attribute to '1' will cause a system reboot" ::= { reset 1 } -- Versions group attribute definitions -- softwareVersion OBJECT-TYPE SYNTAX DisplayString (SIZE(0..255)) ACCESS read-only STATUS mandatory DESCRIPTION "Current software version" ::= { versions 1 } hardwareVersion OBJECT-TYPE SYNTAX DisplayString (SIZE(0..255)) ACCESS read-only STATUS mandatory DESCRIPTION "Hardware platform version." ::= { versions 2 } secondarySoftwareVersion OBJECT-TYPE SYNTAX DisplayString (SIZE(0..255)) ACCESS read-only STATUS mandatory DESCRIPTION "Secondary software version, used when the primary software image is invalid or erased" ::= { versions 3 } bootVersion OBJECT-TYPE SYNTAX DisplayString (SIZE(0..255)) ACCESS read-only STATUS mandatory DESCRIPTION "Boot code sofwtare version" ::= { versions 4 } -- PubStats group attribute definitions -- receiveDataRate OBJECT-TYPE SYNTAX INTEGER ACCESS read-only STATUS mandatory DESCRIPTION "Average data rate over the last one second interval expressed in kbps" ::= { pubStats 1 } transmitDataRate OBJECT-TYPE SYNTAX INTEGER ACCESS read-only STATUS mandatory DESCRIPTION "Average data rate over the last one second interval expressed in kbps" ::= { pubStats 2 } aggregateDataRate OBJECT-TYPE SYNTAX INTEGER ACCESS read-only STATUS mandatory DESCRIPTION "Average data rate over the last one second interval expressed in kbps" ::= { pubStats 3 } -- Encryption group attribute definitions -- encryptionAlgorithm OBJECT-TYPE SYNTAX INTEGER { none(0), aes-rijndael(1) } ACCESS read-only STATUS mandatory DESCRIPTION "The Encryption Algorithm used by the wireless link.nnYou should be aware that enabling encryption results in a reduction in available data bandwidthnnN.B. The same Encryption Algorithm must be configured at BOTH ends of the link for it to function correctly." ::= { encryption 1 } -- Enterprise NOTIFICATION definitions -- dfsChannelChangeTrap NOTIFICATION-TYPE OBJECTS { receiveChannel } STATUS current DESCRIPTION "DFS channel change event" ::= { p2pTraps 1 } dfsImpulsiveInterferenceDetectedTrap NOTIFICATION-TYPE OBJECTS { receiveChannel } STATUS current DESCRIPTION "DFS impulsive interference detected event" ::= { p2pTraps 2 } END 7. References [1] Case, J., Fedor, M., Schoffstall, M., and J. Davin, "Simple Network Management Protocol", STD 15, RFC 1157, SNMP Research, Performance Systems International, Performance Systems International, MIT Laboratory for Computer Science, May 1990. [2] McCloghrie K., and M. Rose, Editors, "Management Information Base for Network Management of TCP/IP-based internets", STD 17, RFC 1213, Performance Systems International, March 1991. [3] Information processing systems - Open Systems Interconnection - Specification of Abstract Syntax Notation One (ASN.1), International Organization for Standardization, International Standard 8824, December 1987. [4] Information processing systems - Open Systems Interconnection - Specification of Basic Encoding Rules for Abstract Notation One (ASN.1), International Organization for Standardization, International Standard 8825, December 1987. [5] Rose, M., and K. McCloghrie, Editors, "Concise MIB Definitions", JanKausKas [Page 2] RFC DRAFT Motorola Canopy MIB January 2006 STD 16, RFC 1212, Performance Systems International, Hughes LAN Systems, March 1991. [6] Rose, M., Editor, "A Convention for Defining Traps for use with the SNMP", RFC 1215, Performance Systems International, March 1991. [7] ANSI/IEEE Standard 802.1D-1990 MAC Bridges, IEEE Project 802 Local and Metropolitan Area Networks, (March 8, 1991). 8. Security Considerations Security issues are not discussed in this memo. 9. Authors' Addresses Rylan JanKausKas Motorola Canopy. 1299 E ALGONQUIN ROAD, SCHAUMBURG, ILLINOIS, 60196, United States Phone: (847)538-1225 Email: rylan@motorola.com