idnits 2.17.1 draft-ietf-entmib-state-01.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** Looks like you're using RFC 2026 boilerplate. This must be updated to follow RFC 3978/3979, as updated by RFC 4748. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- ** The document seems to lack a 1id_guidelines paragraph about the list of current Internet-Drafts -- however, there's a paragraph with a matching beginning. Boilerplate error? == The page length should not exceed 58 lines per page, but there was 1 longer page, the longest (page 5) being 60 lines Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack an Introduction section. ** The document seems to lack an IANA Considerations section. (See Section 2.2 of https://www.ietf.org/id-info/checklist for how to handle the case when there are no actions for IANA.) ** There are 7 instances of too long lines in the document, the longest one being 4 characters in excess of 72. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the RFC 3978 Section 5.4 Copyright Line does not match the current year == Line 198 has weird spacing: '...receive packe...' == Line 725 has weird spacing: '...or more alarm...' == Line 1031 has weird spacing: '...for the purpo...' == The document seems to use 'NOT RECOMMENDED' as an RFC 2119 keyword, but does not include the phrase in its RFC 2119 key words list. -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (June 2003) is 7613 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Missing Reference: 'RFC2863' is mentioned on line 186, but not defined == Missing Reference: 'Alarm-MIB' is mentioned on line 100, but not defined == Missing Reference: 'Alarm MIB' is mentioned on line 579, but not defined == Unused Reference: 'ALARM-MIB' is defined on line 987, but no explicit reference was found in the text == Outdated reference: A later version (-18) exists of draft-ietf-disman-alarm-mib-10 ** Obsolete normative reference: RFC 2737 (Obsoleted by RFC 4133) Summary: 6 errors (**), 0 flaws (~~), 11 warnings (==), 2 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 Entity MIB Working Group S. Chisholm 2 Internet Draft Nortel Networks 3 Document: draft-ietf-entmib-state-01.txt D. Perkins 4 Category: Standards Track SNMPinfo & 5 RiverStone Networks 6 Expiration Date: December 2003 June 2003 8 Entity State MIB 10 Status of this Memo 12 This document is an Internet-Draft and is in full conformance 13 with all provisions of Section 10 of RFC2026. 15 Internet-Drafts are working documents of the Internet Engineering 16 Task Force (IETF), its areas, and its working groups. Note that 17 other groups may also distribute working documents as 18 Internet-Drafts. 20 Internet-Drafts are draft documents valid for a maximum of six 21 months and may be updated, replaced, or obsoleted by other 22 documents at any time. It is inappropriate to use Internet- 23 Drafts as reference material or to cite them other than as 24 "work in progress." 26 The list of current Internet-Drafts can be accessed at 28 http://www.ietf.org/ietf/1id-abstracts.txt 30 The list of Internet-Draft Shadow Directories can be accessed at 31 http://www.ietf.org/shadow.html. 33 Abstract 35 This memo defines a portion of the Management Information Base (MIB) 36 for use with network management protocols in the Internet community. 37 In particular, it describes extensions to the entity MIB to 38 provide information about the state of the entity. 40 Table of Contents 42 1. The Internet-Standard Management Framework 43 2. Entity State 44 2.1. Hierarchical State Management 45 2.2. State Relationships 46 2.3. Physical Classes and State 47 2.4. Relation to Alarm MIB 48 2.5. Entity Redundancy 49 3. Definitions 50 4. Security Considerations 51 5. Authors' Addresses 52 6. Acknowledgements 53 7. References 54 8. Full Copyright Statement 56 1. 1. The Internet-Standard Management Framework 58 For a detailed overview of the documents that describe the current 59 Internet-Standard Management Framework, please refer to section 7 of 60 RFC 3410 [RFC3410]. 62 Managed objects are accessed via a virtual information store, termed 63 the Management Information Base or MIB. MIB objects are generally 64 accessed through the Simple Network Management Protocol (SNMP). 65 Objects in the MIB are defined using the mechanisms defined in the 66 Structure of Management Information (SMI). This memo specifies a MIB 67 module that is compliant to the SMIv2, which is described in STD 58, 68 RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580 69 [RFC2580]. 71 2. Entity State 73 The goal in adding state objects to the Entity MIB [RFC2737] is to 74 define a useful subset of the possible state attributes that could 75 be tracked for a given entity that both fit into the existing IETF 76 model, as well as leveraged existing well-deployed models. The 77 entStateTable contains state objects that are a subset of the 78 popular ISO/OSI states that are also defined in ITU's X.731 79 specification [X.731]. Objects are defined to capture 80 administrative, operational and usage states. In addition there are 81 further state objects defined to provide additional information for 82 these three basic states. 84 Administrative state indicates permission to use or prohibition 85 against using the entity and is imposed through the management 86 services. 88 Operational state indicates whether or not the entity is physically 89 installed and working. Note that unlike the ifOperStatus [RFC2863], 90 this operational state is independent of the administrative state. 92 Usage state indicates whether or not the entity is in use at a 93 specific instance, and if so, whether or not it currently has spare 94 capacity to serve additional users. In the context of this MIB, the 95 user is equivalent to an entity, so this term us substituted. 97 Alarm state indicates whether or not there are any alarms active 98 against the entity. In addition to those alarm status defined in 99 X.731 [X.731], warning and indeterminate status are also defined to 100 provide a more complete mapping to the Alarm MIB [Alarm-MIB]. 102 Standby state indicates whether the entity is currently running as 103 hot standby, cold standby or is currently providing service. 105 The terms state and status are used interchangeably in this memo. 107 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 108 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 109 document are to be interpreted as described in RFC 2119 [RFC2119]. 111 2.1 Hierarchical State Management 113 Physical entities exist within a containment hierarchy. This raises 114 some interesting issues not addresses in existing work on state 115 management [X.731]. 117 There are two types of state for an entity: 119 1) The state of the entity independent of the states of its parents 120 and children in its containment hierarchy. This is often referred to 121 as raw state. 123 2) The state of the entity, as it may be influenced by the state of 124 its parents and children. This is often referred to as computed 125 state. 127 All state objects in this memo are raw state. 129 2.2 State Relationships 131 The following section outlines all of the combinations of the three 132 basic states -administrative, operational and usage - and briefly 133 describes what each of these combinations of states means. It also 134 compare this combination of states to that of the ifAdminStatus and 135 ifOperStatus objects of the Interfaces Group MIB [RFC2863] to both 136 provide insight to those familiar with these status objects as well 137 as to clarify the relationship between entities and interfaces, as 138 indicated by entAliasMappingIdentifier object in the Entity MIB 139 [RFC2737]. 141 The Interfaces MIB [RFC2863] defines the ifAdminStatus object, which 142 has status of up, down and testing and the ifOperStatus object, 143 which has states of up, down, testing, unknown, dormant, notPresent 144 and lowerLayerDown. 146 2.2.1 Admin State Locked, Operational State Disabled and Usage State Idle 148 The entity is totally inoperable, it is not servicing any entities 149 and it is also administratively prohibited from use. To make it 150 available for use, both management permission and some corrective 151 action are necessary. This is similar to an ifAdminStatus of down 152 and ifOperStatus of down. 154 2.2.2 Admin State Locked, Operational State Enabled and Usage State Idle 156 The entity is partially or fully operable, it is not servicing any 157 entities but is administratively prohibited from use. To make it 158 available for use, only management permission is required. This is 159 similar to an ifAdminStatus of down and ifOperStatus of down. 161 2.2.3 Admin State Shutting Down, Operational State Enabled and Usage State 162 Active 164 The entity is partially or fully operable and in use, but usage is 165 administratively limited to current instances of use. For an 166 additional entity to gain access, management permission is required. 167 Otherwise, when all current entities have been removed from the 168 resource, the managed object will automatically transit to the 169 locked, enabled, and idle state. This is similar to the situation 170 described in [RFC2863] where ifAdminStatus transitions to down, but 171 the ifOperStatus's transition does not occur immediately, but rather 172 after a small time lag to complete certain operations before going 173 "down". 175 2.2.4 Admin State Shutting Down, Operational State Enabled and Usage State 176 Busy 178 The entity is partially or fully operable and in use, but usage is 179 administratively limited to current instances of use. In addition, 180 it has no spare capacity to provide for additional entities. For an 181 additional entity to gain access, besides waiting for an existing 182 entity to be removed, management permission is also required. 183 Otherwise, when all current entities have been removed from the 184 resource, the managed object will automatically transit to the 185 locked, enabled, idle state. This is similar to the situation 186 described in [RFC2863] where ifAdminStatus transitions to down, but 187 the ifOperStatus's transition does not occur immediately, but rather 188 after a small time lag to complete certain operations before going 189 "down". 191 2.2.5 Admin State Unlocked, Operational State Enabled and Usage State Idle 193 The entity is partially or fully operable, it is not actually in use 194 and is not administratively prohibited from use. This is similar to 195 an ifAdminStatus of up and ifOperStatus of up if the interface is 196 able to pass packets. If the interface is found to be operable, but 197 the interface is waiting for other, external, events to occur 198 before it can transmit or receive packets, then this is similar to 199 an ifAdminStatus of up and a ifOperStatus of dormant. 201 2.2.6 Admin State Unlocked, Operational State Enabled and Usage State Active 203 The entity is partially or fully operable, it is currently in use 204 and is not 206 administratively prohibited from use. It has sufficient spare 207 capacity to provide for additional entities. This is similar to an 208 ifAdminStatus of up and ifOperStatus of up. 210 2.2.7 Admin State Unlocked, Operational State Enabled and Usage State Busy 212 The entity is partially or fully operable, it is currently in use 213 and it is not administratively prohibited from use. Currently it has 214 no spare capacity to provide for additional entities. For an 215 additional entity to gain access, it is necessary to wait for an 216 existing entity to be removed or for some capacity increase to 217 occur. This is similar to an ifAdminStatus of up and ifOperStatus 218 of up. 220 2.2.8 Admin State Unlocked, Operational State Disabled and Usage State Idle 222 The entity is totally inoperable, it is servicing no entities but it 223 is not administratively prohibited from use. To make it available 224 for use, some corrective action is required. This is similar to an 225 ifAdminStatus of up and ifOperStatus of down. If the cause of the 226 interface being down is because of a lower layer being down, then 227 this is similar to an ifAdminStatus of up and an ifOperStatus of 228 lowerLayerDown. 230 2.3 Physical Classes and States 232 This section provides an overview of applying the states for the 233 basic physical classes as indicated by the entPhysicalClass object 234 in the Entity MIB [RFC2737]. The physical classes are chassis, 235 backplane, container, powerSupply, fan, sensor, module, port and 236 stack. All states can, in theory, be implemented for any class, 237 but some states or some values of states make less sense than 238 others, depending on the physical class of the entity. 240 2.3.1 Chassis 242 2.3.1.1 entStateAdmin 244 A value of unlocked for entStateAdmin means that this system is on. 245 A value of shuttingDown for entStateAdmin means that this system is 246 in the process of shutting down. 248 2.3.1.2 entStateOper 250 A value of enabled for entStateOper indicates that basic functions 251 of this system are functioning. A value of disabled for entStateOper 252 indicates a problem with basic functions on the system. 254 2.3.1.3 entStateUsage 256 Many chassis will come either fully populated or fully populated 257 with empty container entities, which can be filled independently and 258 therefore do not affect the entStateUsage of the chassis itself. In 259 both these cases and in the general case where the chassis can't 260 support any more direct child entities, entStateUsage will have a 261 value of busy. While an empty chassis might happen much in practice, 262 in this case the entStateUsage object would have a value of idle. 263 Likewise, if the chassis is partially used, then entStateUsage would 264 have a value of active. 266 2.3.1.4 entStateStandby 268 A value of hotStandby for enStateStandby indicates that the entire 269 system contained within this chassis is running as a hot standby for 270 another complete system, possibly contained within the same stack. A 271 value of coldStandby for enStateStandby indicates that the entire 272 system contained within this chassis is running as a cold standby 273 for another complete system, possibly contained within the same 274 stack. A value of providingService for enStateStandby indicates that 275 the entire system contained within this chassis is currently 276 providing service. 278 2.3.1.5 entStateAlarm 280 If this chassis is not contained within a stack, the alarm counts 281 indicated by entStateAlarm will be those alarms that are against the 282 general system, as appose sub-components within the containment 283 hierarchy. 285 2.3.2 BackPlane 287 2.3.2.1 entStateAdmin 289 A value of unlocked for entStateAdmin means that the backplane is 290 not administratively prevented from aggregating and forwarding 291 network traffic. A value of shutting down for entStateAdmin means 292 that the backplane will finish aggregating and forwarding the 293 network traffic is currently handling, but then transition to be 294 administratively locked. A value of locked for entStateAdmin means 295 that backplane is administratively prohibited from aggregating and 296 forwarding any network traffic. 298 2.3.2.2 entStateOper 300 A value of enabled for entStateOper means that the backplane is 301 partially or fully capable of aggregating and forwarding network 302 traffic. A value of disabled for entStateOper means that the 303 backplane is unable to aggregate and forward any network traffic. 305 2.3.2.3 entStateUsage 307 The entStateUsage for a backplane will busy. 309 2.3.2.4 entStateStandby 311 A value of hotStandby for enStateStandby indicates that the 312 backplane is running as a hot standby for another backplane within 313 this system. A value of coldStandby for enStateStandby indicates 314 that the backplane is running as a cold standby for another 315 backplane, possibly within this system. A value of providingService 316 for enStateStandby indicates that the backplane is currently 317 providing service. 319 2.3.2.5 entStateAlarm 321 Looking at the entStateAlarm gives a convenient way to see if there 322 are any alarms currently active against this backplane. 324 2.3.3 Container 326 2.3.3.1 entStatAdmin 328 A value of unlocked for entStateAdmin means it is administratively 329 possible to insert things into this container. A value of 330 shuttingDown for entStateAdmin could be used to reflect that 331 inserting objects into this container is administratively 332 prohibited. This value could also be used for systems that do not 333 support hot insertion of components. 335 2.3.3.2 entStateOper 337 It may not make sense for the entStateOper to have values other than 338 enabled. 340 2.3.3.3 entStateUsage 342 The container physical class could be used to indicate, among other 343 things, chassis slots or daughter-card holders. If the container is 344 empty, for example it has no modules in its slots, then 345 entStateUsage would have a value of idle. If the container is 346 partially used, for example it has modules in some but not all of 347 its slots, then entStateUsage would have a value of active. If the 348 container is full, for example it has no empty slots, then 349 entStateUsage would have a value of busy. 351 3.3.3.4 entStateStandby 353 Looking at the entStateStandby indicates whether this container is 354 currently providing service or acting as a backup for another 355 container. 357 2.3.3.5 entStateAlarm 359 If it is not possible to raise alarms against this chassis, the 360 entStateAlarm will have no alarms set. 362 2.3.4 PowerSupply 364 2.3.4.1 entStateAdmin 366 A value of locked for entStateAdmin means that the power supply has 367 been turned off. This only makes sense in the situation where there 368 is a backup power supply. A value of unlocked for entStateAdmin 369 means that the power supply is turned on. 371 2.3.4.2 entStateOper 373 A value of enabled for entStateOper means that the power supply is 374 operational. A value of disabled for entStateOper means that the 375 power supply is not functioning. 377 2.3.4.3 entStateUsage 379 A value of idle for entStateUsage means that the power supply is 380 providing no power to the system. A value of busy for entStateUsage 381 means that the power supply is providing power to the system. 383 2.3.3.4 entStateStandby 385 If this power supply is the currently providing power to the system, 386 then entStateStandby would have a value of providing service. If 387 this power supply is serving as a backup to a primary power supply, 388 then entStateStandby would have a value of hotstandby. 390 2.3.3.5 entStateAlarm 392 Looking at the entStateAlarm gives a convenient way to see if there 393 are any alarms currently active against this power supply. 395 2.3.5 Fan 397 2.3.5.1 entStateAdmin 399 Looking at the entStateAdmin and entStateOper provide useful 400 information to determine why a fan is not running. A value of locked 401 for entStateAdmin means that the fan is not running because it has 402 been administratively disabled. 404 2.3.5.2 entStateOper 406 A value of disabled for the entOperStatus indicates that the fan 407 itself is not operational. A value of enabled for the entOperStatus 408 indicates that the fan is working in theory and that cause of it not 409 operator may lie elsewhere. 411 2.3.5.3 entStateUsage 413 A value of busy for entStateUsage would indicate that the fan was 414 running. A value of idle for entStateUsage would indicate that the 415 fan was not actually running. 417 2.3.5.4 entStateStandby 419 If this fan is serving as a backup to a primary fan, then 420 entStateStandby would have a value of hotstandby. If this fan is the 421 currently providing service to the system, then entStateStandby 422 would have a value of providing service. 424 2.3.5.5 entStateAlarm 426 Looking at the entStateAlarm gives a convenient way to see if there 427 are any alarms currently active against this fan. 429 2.3.6 Sensor 431 2.3.6.1 entStateAdmin 433 A value of unlocked for entStateAdmin indicates that the sensor is 434 not administratively prohibited from sensing. A value of shutting 435 down for entStateAdmin indicates that the sensor will complete its 436 current readings and then shut down. A value of locked for 437 entStateAdmin indicates that the sensor is administratively 438 prohibited from sensing. 440 2.3.6.2 entStateOper 442 A value of enabled for entStateOper indicates that the sensor is 443 functioning properly. A value of disable for entStateOper indicates 444 that the sensor is totally inoperable. 446 2.3.6.3 entStateUsage 448 The value of entStateUsage will be busy. 450 2.3.6.4 entStateStandby 452 Looking at the entStateStandby indicates whether this sensor is 453 currently providing service or acting as a backup for another sensor. 455 2.3.6.5 entStateAlarm 457 Looking at the entStateAlarm gives a convenient way to see if there 458 are any alarms currently active against this sensor. 460 2.3.7 Module 462 2.3.7.1 entStateAdmin 464 For modules that support the functionality of being administratively 465 disabled, entStateAdmin object indicates whether the module is 466 administratively locked (disabled) or unlocked (enabled). Modules 467 that do not support disabling will always have a value of unlocked 468 for entStateAdmin. 470 2.3.7.2 entStateOper 472 A value of enabled for entStateOper indicates that this module is 473 partially or fully operational. A value of disabled for entStateOper 474 indicates that this module is totally inoperable. 476 2.3.7.3 entStateUsage 478 If a module comes fully populated with all possible child 479 components, or if there is not further room for child components, 480 then the value of entStateUsage will be busy. If it supports the 481 concept of dynamically added child components and there is room to 482 add more components, then entStateUsage will have a value of active. 483 If it supports the concept of dynamically added child components and 484 there are currently no children then entStateUsage will have a value 485 of idle. 487 2.3.7.4 entStateStandby 489 Looking at the entStateStandby indicates whether this module is 490 currently providing service or acting as a backup for another module. 492 2.3.7.5 entStateAlarm 494 Looking at the entStateAlarm gives a convenient way to see if there 495 are any alarms currently active against this module. 497 2.3.8 Port 499 2.3.8.1 entStateAdmin 501 A value of enabled for entStateAdmin means the port is not 502 administratively prohibited from passing network traffic. A value of 503 shutting down for entStateAdmin indicates that the port will pass 504 its current traffic and then transition to the locked state. A value 505 of locked for entStateAdmin indicates that the port is 506 administratively prohibited from passing network traffic. 508 2.3.8.2 entStateOper 510 A value of enabled for entStateOper means that the port is partially 511 or fully capable of forwarding network traffic. A value of disabled 512 for entStateOper means that the port is totally unable to forward 513 network traffic. 515 2.2.8.3 entStateUsage 517 A value of idle for entStateUsage indicates that the port is not 518 currently in use. A value of busy for entStateUsage indicates that 519 the port is in use. 521 2.3.8.4 entStateStandby 523 Looking at the entStateStandby indicates whether this port is 524 currently providing service or acting as a backup for another port. 526 2.3.8.5 entStateAlarm 528 Looking at the entStateAlarm gives a convenient way to see if there 529 are any alarms currently active against this port. 531 2.3.9 Stack 533 2.3.9.1 entStateAdmin 535 A value of unlocked for entStateAdmin means that this system is on. 536 A value of shuttingDown for entStateAdmin means that this system is 537 in the process of shutting down. 539 2.3.9.2 entStateOper 541 A value of enabled for entStateOper indicates that basic functions 542 of this system are functioning. A value of disabled for entStateOper 543 indicates a problem with basic functions on the system. 545 2.3.9.3 entStateUsage 547 If a stack comes fully populated with all possible child components, 548 or if there is not further room for child components, then the value 549 of entStateUsage will be busy. If it supports the concept of 550 dynamically added child components and there is room to add more 551 components, then entStateUsage will have a value of active. If it 552 supports the concept of dynamically added child components and there 553 are currently no children then entStateUsage will have a value of 554 idle. 556 2.3.9.4 entStateStandby 558 A value of hotStandby for enStateStandby indicates that the entire 559 system contained within this stack is running as a hot standby for 560 another complete system, possibly contained within the same parent 561 stack. A value of coldStandby for enStateStandby indicates that the 562 entire system contained within this stack is running as a cold 563 standby for another complete system, possibly contained within the 564 same parent stack. A value of providingService for enStateStandby 565 indicates that the entire system contained within this chassis is 566 currently providing service. 568 2.3.9.5 entStateAlarm 570 If this stack is not contained in within a parent stack, the alarm 571 counts indicated by entStateAlarm will be those alarms that are 572 against the general system, as appose sub-components within the 573 containment hierarchy. 575 2.4 Relation to Alarm MIB 577 The entStateAlarm object indicates whether or not there are any 578 active alarms against this entity. If there are active alarms, then 579 the alarmActiveTable in the Alarm MIB [Alarm MIB] should be searched 580 for alarmActiveResourceId that match this entPhysicalIndex. 582 2.5 Entity Redundancy 584 While this memo is not attempting to address the entire problem 585 space around redundancy, the entStateStandby object provides an 586 important piece of state information for entities, which helps 587 identify which pieces of redundant equipment are currently 588 providing service, and which are waiting in either hot or cold 589 standby mode. 591 3. Definitions 593 ENTITY-STATE-MIB DEFINITIONS ::= BEGIN 595 IMPORTS 596 MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE, mib-2 597 FROM SNMPv2-SMI 598 TEXTUAL-CONVENTION, DateAndTime 599 FROM SNMPv2-TC 600 MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP 601 FROM SNMPv2-CONF 602 entPhysicalIndex 603 FROM ENTITY-MIB; 605 entityStateMIB MODULE-IDENTITY 606 LAST-UPDATED "200306300000Z" 607 ORGANIZATION "IETF Entity MIB Working Group" 608 CONTACT-INFO 609 " General Discussion: entmib@ietf.org 610 To Subscribe: 611 http://www.ietf.org/mailman/listinfo/entmib 613 http://www.ietf.org/html.charters/entmib-charter.html 615 Sharon Chisholm 616 Nortel Networks 617 PO Box 3511 Station C 618 Ottawa, Ont. K1Y 4H7 619 Canada 620 schishol@nortelnetworks.com 622 David T. Perkins 623 Riverstone Networks 624 5200 Great America Parkway 625 Santa Clara, CA 95054 626 USA 627 dperkins@snmpinfo.com 628 " 629 DESCRIPTION 630 "This MIB defines a state extension to the entity MIB. 632 Copyright (C) The Internet Society 2003. This version 633 of this MIB module is part of RFC yyyy; see the RFC 634 itself for full legal notices." 635 -- RFC Ed.: replace yyyy with actual RFC number & remove 636 -- this note 637 REVISION "200306300000Z" 638 DESCRIPTION 639 "Initial version, published as RFC YYYY." 640 -- RFC-Editor assigns yyyy 641 ::= { mib-2 XX } -- to be assigned by IANA 643 -- Textual conventions 645 AdminState ::= TEXTUAL-CONVENTION 646 STATUS current 647 DESCRIPTION 648 " Represents the various possible administrative states. 650 A value of locked means the resource is administratively 651 prohibited from use. A value of shuttingDown means that 652 usage is administratively limited to current instances of 653 use. A value of unlocked means the resource is not 654 administratively prohibited from use." 655 REFERENCE 656 "ITU Recommendation X.731, 'Information Technology - Open 657 Systems Interconnection - System Management: State 658 Management Function', 1992" 659 SYNTAX INTEGER 660 { 661 notSupported(1), 662 locked(2), 663 shuttingDown(3), 664 unlocked(4) 665 } 667 OperState ::= TEXTUAL-CONVENTION 668 STATUS current 669 DESCRIPTION 670 " Represents the possible values of operational states. 672 A value of disabled means the resource is totally 673 inoperable. A value of enabled means the resource 674 is partially or fully operable." 675 REFERENCE 676 "ITU Recommendation X.731, 'Information Technology - Open 677 Systems Interconnection - System Management: State 678 Management Function', 1992" 679 SYNTAX INTEGER 680 { 681 notSupported (1), 682 disabled(2), 683 enabled(3) 684 } 686 UsageState ::= TEXTUAL-CONVENTION 687 STATUS current 688 DESCRIPTION 689 " Represents the possible values of usage states. 690 A value of idle means the resource is servicing no users. 691 A value of active means the resource is currently in use 692 and it has sufficient spare capacity to provide for 693 additional users. A value of busy means the resource is 694 currently in use, but it currently has no spare capacity 695 to provide for additional users." 696 REFERENCE 697 "ITU Recommendation X.731, 'Information Technology - Open 698 Systems Interconnection - System Management: State 699 Management Function', 1992" 700 SYNTAX INTEGER 701 { 702 notSupported (1), 703 idle(2), 704 active(3), 705 busy(4) 706 } 708 AlarmStatus ::= TEXTUAL-CONVENTION 709 STATUS current 710 DESCRIPTION 711 "Represents the possible values of alarm status. 713 When no bits of this attribute are set, then none of the 714 status conditions described below are present. When the 715 value of under repair is set, the resource is currently 716 being repaired. 718 When the value of critical is set, one or more critical 719 alarms are active against the resource. When the value of 720 major is set, one or more major alarms are active against 721 the resource. When the value of minor is set, one or more 722 minor alarms are active against the resource. When the 723 value of warning is set, one or more warning alarms are 724 active against the resource. When the value of 725 indeterminate is set, one or more alarms of indeterminate 726 severity are active against the resource. 728 When the value of alarm outstanding is set, one or more 729 alarms is active against the resource. The fault may or may 730 not be disabling. " 731 REFERENCE 732 "ITU Recommendation X.731, 'Information Technology - Open 733 Systems Interconnection - System Management: State 734 Management Function', 1992" 735 SYNTAX BITS 736 { 737 notSupported (0), 738 underRepair(1), 739 critical(2), 740 major(3), 741 minor(4), 742 alarmOutstanding(5), 743 warning (6), -- Not defined in X.731 744 indeterminate (7) -- Not defined in X.731 745 } 747 StandbyStatus ::= TEXTUAL-CONVENTION 748 STATUS current 749 DESCRIPTION 750 " Represents the possible values of standby status. 752 A value of hotStandby means the resource is not providing 753 service, but is will be immediately able to take over the 754 role of the resource to be backed-up, without the need for 755 initialization activity, and will contain the same 756 information as the resource to be backed up. A value of 757 coldStandy means that the resource is to back-up another 758 resource, but will not be immediately able to take over 759 the role of a resource to be backed up, and will require 760 some initialization activity. A value of providingService 761 means the resource is providing service." 762 REFERENCE 763 "ITU Recommendation X.731, 'Information Technology - Open 764 Systems Interconnection - System Management: State 765 Management Function', 1992" 766 SYNTAX INTEGER 767 { 768 notSupported (1), 769 hotStandby(2), 770 coldStandby(3), 771 providingService(4) 772 } 774 -- Entity State Objects 776 entStateObjects OBJECT IDENTIFIER ::= { entityStateMIB 1 } 778 entStateTable OBJECT-TYPE 779 SYNTAX SEQUENCE OF EntStateEntry 780 MAX-ACCESS not-accessible 781 STATUS current 782 DESCRIPTION 783 "A table of information about state/status of entities. 784 This is a sparse augment of the entPhysicalTable. 785 " 786 ::= { entStateObjects 1 } 788 entStateEntry OBJECT-TYPE 789 SYNTAX EntStateEntry 790 MAX-ACCESS not-accessible 791 STATUS current 792 DESCRIPTION "State information about this entity." 793 INDEX { entPhysicalIndex } 794 ::= { entStateTable 1 } 796 EntStateEntry ::= SEQUENCE { 797 entStateLastChanged DateAndTime, 798 entStateAdmin AdminState, 799 entStateOper OperState, 800 entStateUsage UsageState, 801 entStateAlarm AlarmStatus, 802 entStateStandby StandbyStatus 803 } 805 entStateLastChanged OBJECT-TYPE 806 SYNTAX DateAndTime 807 MAX-ACCESS read-only 808 STATUS current 809 DESCRIPTION "The value of this object is the date and 810 time when state/status of the component 811 last changed, or zero." 812 ::= { entStateEntry 1 } 814 entStateAdmin OBJECT-TYPE 815 SYNTAX AdminState 816 MAX-ACCESS read-write 817 STATUS current 818 DESCRIPTION 819 "The administrative state for this entity." 820 ::= { entStateEntry 2 } 822 entStateOper OBJECT-TYPE 823 SYNTAX OperState 824 MAX-ACCESS read-only 825 STATUS current 826 DESCRIPTION 827 "The operational state for this entity." 828 ::= { entStateEntry 3 } 830 entStateUsage OBJECT-TYPE 831 SYNTAX UsageState 832 MAX-ACCESS read-only 833 STATUS current 834 DESCRIPTION 835 "The usage state for this entity." 836 ::= { entStateEntry 4 } 838 entStateAlarm OBJECT-TYPE 839 SYNTAX AlarmStatus 840 MAX-ACCESS read-only 841 STATUS current 842 DESCRIPTION 843 "The alarm status for this entity. It does not include 844 the severity of alarms raised on child components." 845 ::= { entStateEntry 5 } 847 entStateStandby OBJECT-TYPE 848 SYNTAX StandbyStatus 849 MAX-ACCESS read-only 850 STATUS current 851 DESCRIPTION 852 "The standby status for this entity." 853 ::= { entStateEntry 6 } 855 -- Notifications 857 entStateTraps OBJECT IDENTIFIER ::= { entityStateMIB 2 } 858 entStateTrapPrefix OBJECT IDENTIFIER ::= { entStateTraps 0 } 860 entStateOperEnabled NOTIFICATION-TYPE 861 OBJECTS { entStateAdmin, 862 entStateAlarm 863 } 864 STATUS current 865 DESCRIPTION 866 "The entity is operational. The entity this 867 notification refers can be identified by 868 extracting the entPhysicalIndex from one of the 869 variable bindings." 870 ::= { entStateTrapPrefix 1 } 872 entStateOperDisabled NOTIFICATION-TYPE 873 OBJECTS { entStateAdmin, 874 entStateAlarm } 875 STATUS current 876 DESCRIPTION 877 "The entity is not operational. The entity this 878 notification refers can be identified by 879 extracting the entPhysicalIndex from one of the 880 variable bindings." 881 ::= { entStateTrapPrefix 2 } 883 -- Conformance and Compliance 885 entStateConformance OBJECT IDENTIFIER ::= { entityStateMIB 3 } 887 entStateCompliances OBJECT IDENTIFIER 888 ::= { entStateConformance 1 } 890 entStateCompliance MODULE-COMPLIANCE 891 STATUS current 892 DESCRIPTION 893 "The compliance statement for systems supporting 894 the Entity State MIB." 895 MODULE -- this module 896 MANDATORY-GROUPS { 897 entStateGroup 898 } 899 OBJECT entStateAdmin 900 MIN-ACCESS read-only 901 DESCRIPTION 902 "Write access is not required." 903 ::= { entStateCompliances 1 } 905 entStateGroups OBJECT IDENTIFIER ::= { entStateConformance 2 } 907 entStateGroup OBJECT-GROUP 908 OBJECTS { 909 entStateLastChanged, 910 entStateAdmin, 911 entStateOper, 912 entStateUsage, 913 entStateAlarm, 914 entStateStandby 915 } 916 STATUS current 917 DESCRIPTION 918 "Standard Entity State group." 920 ::= { entStateGroups 1} 922 entStateNotificationGroup NOTIFICATION-GROUP 923 NOTIFICATIONS { 924 entStateOperEnabled, 925 entStateOperDisabled 926 } 927 STATUS current 928 DESCRIPTION 929 "Standard Entity State Notification group." 930 ::= { entStateGroups 2} 932 END 934 4. Security Considerations 936 There is one management object defined in this MIB that has a 937 MAX-ACCESS clause of read-write. The object may be considered 938 sensitive or vulnerable in some network environments. The support 939 for SET operations in a non-secure environment without proper 940 protection can have a negative effect on network operations. 942 The following object is defined with a MAX-ACCESS clause of 943 read-write: entStateAdmin. 945 SNMP versions prior to SNMPv3 did not include adequate security. 946 Even if the network itself is secure (for example by using IPSec), 947 even then, there is no control as to who on the secure network is 948 allowed to access and GET/SET (read/change/create/delete) the 949 objects in this MIB module. 951 It is RECOMMENDED that implementers consider the security features 952 as provided by the SNMPv3 framework (see [RFC3410], section 8), 953 including full support for the SNMPv3 cryptographic mechanisms (for 954 authentication and privacy). 956 Further, deployment of SNMP versions prior to SNMPv3 is NOT 957 RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to 958 enable cryptographic security. It is then a customer/operator 959 responsibility to ensure that the SNMP entity giving access to an 960 instance of this MIB module is properly configured to give access to 961 the objects only to those principals (entities) that have legitimate 962 rights to indeed GET or SET (change/create/delete) them. 964 5. Authors' Addresses 966 Sharon Chisholm 967 Nortel Networks 968 PO Box 3511, Station C 969 Ottawa, Ontario, K1Y 4H7 970 Canada 971 Email: schishol@nortelnetworks.com 972 David T. Perkins 973 Riverstone Networks 974 5200 Great America Parkway 975 Santa Clara, CA 95054 976 USA 977 Email: dperkins@snmpinfo.com 979 6. Acknowledgments 981 This document is a product of the Entity MIB Working Group. 983 7. References 985 7.1 Normative 987 [ALARM-MIB] Chisholm, S., Romascanu, D., "Alarm MIB", 988 draft-ietf-disman-alarm-mib-10.txt, April 2003 990 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 991 Requirement Levels", BCP 14, RFC 2119, March 1997. 993 [RFC2578] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 994 Rose, M. and S. Waldbusser, "Structure of Management 995 Information Version 2 (SMIv2)", STD 58, RFC 2578, April 996 1999. 998 [RFC2579] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 999 Rose, M. and S. Waldbusser, "Textual Conventions for 1000 SMIv2", STD 58, RFC 2579, April 1999. 1002 [RFC2580] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 1003 Rose, M. and S. Waldbusser, "Conformance Statements for 1004 SMIv2", STD 58, RFC 2580, April 1999. 1006 [RFC2737] McCloghrie, K., Bierman, A., "Entity MIB (Version 2)", 1007 December 1999. 1009 [X.731] ITU Recommendation X.731, "Information Technology - Open 1010 Systems Interconnection - System Management: State 1011 Management Function", 1992 1013 7.2 Informative References 1015 [RFC3410] Case, J., Mundy, R., Partain, D. and B. Stewart, 1016 "Introduction and Applicability Statements for Internet- 1017 Standard Management Framework", RFC 3410, December 2002. 1019 8. Full Copyright Statement 1021 Copyright (C) The Internet Society (2003). All Rights Reserved. 1023 This document and translations of it may be copied and furnished to 1024 others, and derivative works that comment on or otherwise explain it 1025 or assist in its implementation may be prepared, copied, published 1026 and distributed, in whole or in part, without restriction of any kind, 1027 provided that the above copyright notice and this paragraph are 1028 included on all such copies and derivative works. However, this 1029 document itself may not be modified in any way, such as by removing 1030 the copyright notice or references to the Internet Society or other 1031 Internet organizations, except as needed for the purpose of 1032 developing Internet standards in which case the procedures for 1033 copyrights defined in the Internet Standards process must be followed, 1034 or as required to translate it into languages other than English. 1036 The limited permissions granted above are perpetual and will not be 1037 revoked by the Internet Society or its successors or assigns. 1039 This document and the information contained herein is provided on an 1040 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING 1041 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT 1042 NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN 1043 WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 1044 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.