idnits 2.17.1 draft-ietf-rap-cops-client-mib-00.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: ---------------------------------------------------------------------------- ** Missing expiration date. The document expiration date should appear on the first and last page. ** The document seems to lack a 1id_guidelines paragraph about Internet-Drafts being working documents. ** The document seems to lack a 1id_guidelines paragraph about 6 months document validity. ** The document is more than 15 pages and seems to lack a Table of Contents. == No 'Intended status' indicated for this document; assuming Proposed Standard Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** 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.) ** The document seems to lack separate sections for Informative/Normative References. All references will be assumed normative when checking for downward references. ** There are 26 instances of too long lines in the document, the longest one being 1 character in excess of 72. ** The abstract seems to contain references ([V2SMI]), which it shouldn't. Please replace those with straight textual mentions of the documents in question. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the RFC 3978 Section 5.4 Copyright Line does not match the current year == Line 527 has weird spacing: '...ulative since...' -- 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 1999) is 9081 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: 'USM' is mentioned on line 915, but not defined == Missing Reference: 'VACM' is mentioned on line 916, but not defined == Unused Reference: 'V3INTRO' is defined on line 975, but no explicit reference was found in the text == Unused Reference: 'ASN1' is defined on line 999, but no explicit reference was found in the text == Unused Reference: 'ASN1BER' is defined on line 1005, but no explicit reference was found in the text == Unused Reference: 'PROCESS' is defined on line 1042, but no explicit reference was found in the text ** Obsolete normative reference: RFC 2571 (ref. 'ARCH') (Obsoleted by RFC 3411) ** Downref: Normative reference to an Historic RFC: RFC 1157 (ref. 'V1PROTO') ** Downref: Normative reference to an Informational RFC: RFC 1215 (ref. 'V1TRAPS') ** Downref: Normative reference to an Historic RFC: RFC 1901 (ref. 'V2COMMUNITY') ** Obsolete normative reference: RFC 1906 (ref. 'V2TRANS') (Obsoleted by RFC 3417) ** Obsolete normative reference: RFC 1905 (ref. 'V2PROTO') (Obsoleted by RFC 3416) ** Obsolete normative reference: RFC 2570 (ref. 'V3INTRO') (Obsoleted by RFC 3410) ** Obsolete normative reference: RFC 2572 (ref. 'V3MPC') (Obsoleted by RFC 3412) ** Obsolete normative reference: RFC 2574 (ref. 'V3USM') (Obsoleted by RFC 3414) ** Obsolete normative reference: RFC 2573 (ref. 'V3APPS') (Obsoleted by RFC 3413) ** Obsolete normative reference: RFC 2575 (ref. 'V3VACM') (Obsoleted by RFC 3415) -- Possible downref: Non-RFC (?) normative reference: ref. 'ASN1' -- Possible downref: Non-RFC (?) normative reference: ref. 'ASN1BER' -- Possible downref: Non-RFC (?) normative reference: ref. 'FRAMEWORK' -- Possible downref: Non-RFC (?) normative reference: ref. 'COPS' -- Possible downref: Non-RFC (?) normative reference: ref. 'COPSRSVP' -- Possible downref: Non-RFC (?) normative reference: ref. 'SRVLOC' Summary: 20 errors (**), 0 flaws (~~), 9 warnings (==), 8 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 Internet Draft A. Smith 2 Expires December 1999 Extreme Networks 3 draft-ietf-rap-cops-client-mib-00.txt D. Partain 4 Ericsson 5 J. Seligson 6 Nortel Networks 7 June 1999 9 Definitions of Managed Objects for Common Open Policy Service (COPS) 10 Protocol Clients 12 Status of this Memo 14 This document is an Internet Draft and is in full conformance with all 15 provisions of Section 10 of RFC2026. Internet Drafts are working 16 documents of the Internet Engineering Task Force (IETF), its Areas, and 17 its Working Groups. Note that other groups may also distribute working 18 documents as Internet Drafts. 20 Internet Drafts are draft documents valid for a maximum of six months. 21 Internet Drafts may be updated, replaced, or obsoleted by other 22 documents at any time. It is not appropriate to use Internet Drafts as 23 reference material or to cite them other than as a "working draft" or 24 "work in progress." 26 The list of current Internet-Drafts can be accessed at 27 http://www.ietf.org/ietf/1id-abstracts.txt 29 The list of Internet-Draft Shadow Directories can be accessed at 30 http://www.ietf.org/shadow.html. 32 This document is a product of the IETF's RSVP Admission Policy Working 33 Group. Copyright (C) The Internet Society (1999). All Rights Reserved. 35 Abstract 37 This memo defines a portion of the Management Information Base (MIB) for 38 use with network management protocols in TCP/IP based internets. In 39 particular it defines objects for managing a client of the Common Open 40 Policy Service (COPS) protocol. 42 This memo includes a MIB module in a manner that is compliant to the 43 SNMPv2 SMI [V2SMI]. 45 1. The SNMP Management Framework 47 The SNMP Management Framework presently consists of five major 48 components: 50 o An overall architecture, described in an Architecture for 51 Describing SNMP Management Frameworks [ARCH]. 53 o Mechanisms for describing and naming objects and events for the 54 purpose of management. The first version of this Structure of 55 Management Information (SMI) is called SMIv1 and described in 56 RFC 1155 [V1SMI], RFC 1212 [V1CONCISE] and RFC 1215 [V1TRAPS]. 57 The second version, called SMIv2, is described in STD 58, RFC 58 2578 [V2SMI], STD 58, RFC 2579 [V2TC] and STD 58, RFC 2580 59 [V2CONFORM]. 61 o Message protocols for transferring management information. The 62 first version of the SNMP message protocol is called SNMPv1 and 63 described in RFC 1157 [V1PROTO]. A second version of the SNMP 64 message protocol, which is not an Internet standards track 65 protocol, is called SNMPv2c and described in RFC 1901 66 [V2COMMUNITY] and RFC 1906 [V2TRANS]. The third version of the 67 message protocol is called SNMPv3 and described in RFC1906 68 [V2TRANS], Message Processing and Dispatching [V3MPC] and User- 69 based Scurity Model [V3USM]. 71 o Protocol operations for accessing management information. The 72 first set of protocol operations and associated PDU formats is 73 described in RFC 1157 [V1PROTO]. A second set of protocol 74 operations and associated PDU formats is described in RFC 1905 75 [V2PROTO]. 77 o A set of fundamental applications described in SNMPv3 78 Applications [V3APPS] and the view-based access control 79 mechanism described in View-based Access Control Model [V3VACM]. 81 Managed objects are accessed via a virtual information store, termed the 82 Management Information Base or MIB. Objects in the MIB are defined 83 using the mechanisms defined in the SMI. 85 This memo specifies a MIB module that is compliant to the SMIv2. A MIB 86 conforming to the SMIv1 can be produced through the appropriate 87 translations. The resulting translated MIB must be semantically 88 equivalent, except where objects or events are omitted because no 89 translation is possible (use of Counter64). Some machine readable 90 information in SMIv2 will be converted into textual descriptions in 91 SMIv1 during the translation process. However, this loss of machine 92 readable information is not considered to change the semantics of the 93 MIB. 95 2. Overview 97 The COPS protocol [COPS] is a client-server protocol intended for the 98 communication of policy requests and decisions between a Policy 99 Enforcement Point (PEP) and a Policy Decision Point (PDP). The PEP acts 100 as a COPS client in this scenario. The model for policy out-sourcing, 101 of which the COPS protocol provides one part, is described in 102 [FRAMEWORK]. 104 2.1. Scope 106 This MIB is intended to provide management of the important 107 features of a COPS protocol client module. It does not provide 108 management for a COPS server - this is outside the scope of the 109 current memo. It provides for monitoring of status and protocol 110 statistics, as well as for configuration of the client, in 111 particular for telling it where to locate its servers. Other 112 mechanisms for achieving this function without SNMP configuration 113 might include use of the Service Location Protocol [SRVLOC] 114 although this is outside the scope of this memo and are not 115 specified by the COPS protocol itself. 117 This MIB also does not provide management of specific COPS client- 118 types e.g. for use with the RSVP protocol [RSVP][COPSRSVP]. 120 3. Structure of COPS Client MIB 122 Objects in this MIB are arranged into groups. Each group is organized 123 as a set of related objects. The overall structure is described below. 125 3.1. copsClientCapabilitiesGroup 127 This group contains objects that represent COPS protocol 128 capabilities implemented by this COPS client. 130 3.2. copsClientStatusGroup 132 This group contains objects that indicate the current status of 133 connection(s) to COPS servers, including per-server protocol 134 statistics. It maintains last-known statistics for all of the 135 servers with which the client has ever been connected since agent 136 restart. 138 3.3. copsConfigGroup 140 This group contains objects that allow for configuration of COPS 141 server addresses and the order to which connections should be 142 attempted. 144 3.4. Textual Conventions 146 The datatypes CopsClientState, CopsServerEntryType, CopsErrorCode 147 and TcpPort are used as textual conventions in this document. 148 These textual conventions have NO effect on either the syntax nor 149 the semantics of any managed object. Objects defined using these 150 conventions are always encoded by means of the rules that define 151 their primitive type. Hence, no changes to the SMI or the SNMP are 152 necessary to accommodate these textual conventions which are 153 adopted merely for the convenience of readers. 155 3.5. Relationship to Other MIBs 157 3.5.1. Relationship to the 'system' group 159 This MIB contains definitions for a single COPS protocol client 160 represented by a single SNMP agent and instance of the MIB-2 system 161 group [MIB2]. It does not address the case of multiple co-located 162 COPS protocol clients. 164 4. Editorial information 166 168 Owners: JS = John Seligson, AS = Andrew Smith, DP = David Partain 169 4.1. Open Issues resolved in this draft 171 (1) When should per-server counters (e.g. copsClientServerInPkts) be 172 zeroed? (all) Resolution: see issue (3). 174 (3) Should error stats be maintained per-server or is global 175 sufficient? If per-server then see also issue #1. (all) Resolution: 176 everything is per-server but not zero'ed on reconnect. 178 (4) Add object to show current security in use (JS). DONE - 179 copsClientServerSecurityMode. 181 (6) Add TCP port number to all tables (JS). DONE - 182 copsClientServerTcpPort, copsClientServerConfigTcpPort. 184 (7) Add server retry configuration (JS). DONE - 185 copsClientServerConfigRetryCount, 186 copsClientServerConfigRetryInterval 188 (8) Add COPS protocol version number capabilities object (JS). DONE - 189 copsClientCapabilities. 191 4.2. Still Open Issues 193 (2) Addressing of server tables by IP Address is frowned on: should 194 this be indexed by a client-determined small integer? Awaiting 195 resolution of general SNMP discussion on this topic. (AS) 197 (5) Do we need to be able to configure the security mode for client to 198 attempt to use to talk to COPS server? (AS) 200 5. Definitions for COPS Client MIB 202 COPS-CLIENT-MIB DEFINITIONS ::= BEGIN 204 -- ------------------------------------------------------------- 205 -- ------------------------------------------------------------- 207 IMPORTS 208 MODULE-IDENTITY, OBJECT-TYPE, Counter32, IpAddress, Integer32 209 FROM SNMPv2-SMI 210 TimeStamp, TimeInterval, RowStatus, TEXTUAL-CONVENTION 211 FROM SNMPv2-TC 212 MODULE-COMPLIANCE, OBJECT-GROUP 213 FROM SNMPv2-CONF; 215 -- REFERENCE 216 -- "The COPS (Common Open Policy Service) Protocol 217 -- draft-ietf-rap-cops-xx.txt" 219 copsClientMIB MODULE-IDENTITY 220 LAST-UPDATED "9906100000Z" 221 ORGANIZATION "IETF RSVP Admission Policy Working Group" 222 CONTACT-INFO 223 " Andrew Smith (WG co-chair) 224 Phone: +1 408 579 2821 225 Email: andrew@extremenetworks.com 227 Tim O'Malley (WG co-chair) 228 Phone: +1 617 873 3076 229 Email: timo@bbn.com" 230 DESCRIPTION 231 "The COPS Client MIB module" 232 ::= { xxx 1 } 234 copsClientMIBObjects OBJECT IDENTIFIER ::= { copsClientMIB 1 } 236 -- ------------------------------------------------------------- 237 -- Textual Conventions 238 -- ------------------------------------------------------------- 240 CopsClientState ::= TEXTUAL-CONVENTION 241 STATUS current 242 DESCRIPTION 243 "A value indicating the state of a COPS client." 244 SYNTAX INTEGER { 245 copsClientInvalid(1), -- default state. 246 copsClientTcpconnected(2), -- TCP connection up but COPS 247 -- not yet open. 248 copsClientAccepted(3), -- COPS server accepted the client 249 copsClientTimingout(4) -- Keepalive timer has expired, 250 -- client is in process of tearing 251 -- down connection 252 } 254 CopsServerEntryType ::= TEXTUAL-CONVENTION 255 STATUS current 256 DESCRIPTION 257 "A value indicating how a COPS server entry came into existence." 258 SYNTAX INTEGER { 259 copsServerStatic(1), -- configured by manager 260 copsServerRedirect(2) -- notified by COPS server 261 } 263 CopsErrorCode ::= TEXTUAL-CONVENTION 264 STATUS current 265 DESCRIPTION 266 "A value describing a COPS protocol error. Codes are identical to 267 those used by the COPS protocol itself." 268 SYNTAX INTEGER { 269 errorOther(0), -- none of the below 270 errorBadHandle(1), 271 errorInvalidHandleReference(2), 272 errorBadMessageFormat(3), 273 errorUnableToProcess(4), 274 errorMandatoryClientSiMissing(5), 275 errorUnsupportedClientType(6), 276 errorMandatoryCopsObjectMissing(7), 277 errorClientFailure(8), 278 errorCommunicationFailure(9), 279 errorUnspecified(10), -- client-type specific subcode 280 errorShuttingDown(11), 281 errorRedirectToPreferredServer(12), 282 errorUnknownCopsObject(13) 283 } 284 -- REFERENCE 285 -- "COPS section 2.2.8" 287 TcpPort ::= TEXTUAL-CONVENTION 288 STATUS current 289 DESCRIPTION 290 "A value indicating a TCP protocol port number." 291 SYNTAX INTEGER (0..65535) 293 -- ------------------------------------------------------------- 295 copsClientCapabilitiesGroup OBJECT IDENTIFIER 296 ::= { copsClientMIBObjects 1 } 298 -- ------------------------------------------------------------- 299 -- 300 -- Capabilities of the COPS client 301 -- 303 copsClientCapabilities OBJECT-TYPE 304 SYNTAX BITS { 305 copsClientVersion1(0), -- supports version1 of the COPS protocol 306 copsClientIpSec(1) -- supports IP-SEC connections to COPS server 307 } 308 MAX-ACCESS read-only 309 STATUS current 310 DESCRIPTION 311 "A list of the optional capabilities that this COPS client 312 supports." 313 ::= { copsClientCapabilitiesGroup 1 } 315 -- ------------------------------------------------------------- 317 copsClientStatusGroup OBJECT IDENTIFIER ::= { copsClientMIBObjects 2 } 319 -- ------------------------------------------------------------- 320 -- 321 -- Current status of COPS server connections, all read-only. 322 -- 324 copsClientServerCurrentTable OBJECT-TYPE 325 SYNTAX SEQUENCE OF CopsClientServerCurrentEntry 326 MAX-ACCESS not-accessible 327 STATUS current 328 DESCRIPTION 329 "A table of information regarding COPS servers as seen from the 330 point of view of a COPS client. This table contains entries 331 for both statically-configured and dynamically-learned servers 332 (from a PDP Redirect operation). One entry exists in this table 333 for each COPS Client-Type served by the COPS server." 334 ::= { copsClientStatusGroup 1 } 336 copsClientServerCurrentEntry OBJECT-TYPE 337 SYNTAX CopsClientServerCurrentEntry 338 MAX-ACCESS not-accessible 339 STATUS current 340 DESCRIPTION 341 "A set of information regarding a single COPS server serving 342 a single COPS Client-Type from the point of view of a COPS 343 client." 344 INDEX { copsClientServerIpAddress, copsClientServerClientType } 345 ::= { copsClientServerCurrentTable 1 } 347 CopsClientServerCurrentEntry ::= 348 SEQUENCE { 349 copsClientServerIpAddress IpAddress, 350 copsClientServerClientType INTEGER, 351 copsClientServerTcpPort TcpPort, 352 copsClientServerType CopsServerEntryType, 353 copsClientServerSecurityMode INTEGER, 354 copsClientServerLastConnectAttempt TimeStamp, 355 copsClientState CopsClientState, 356 copsClientServerKeepaliveTime TimeInterval, 357 copsClientServerAccountingTime TimeInterval, 358 copsClientInPkts Counter32, 359 copsClientOutPkts Counter32, 360 copsClientInErrs Counter32, 361 copsClientLastError CopsErrorCode, 362 copsClientTcpConnectAttempts Counter32, 363 copsClientTcpConnectFailures Counter32, 364 copsClientOpenAttempts Counter32, 365 copsClientOpenFailures Counter32, 366 copsClientErrUnsupportedClienttype Counter32, 367 copsClientErrUnsupportedVersion Counter32, 368 copsClientErrLengthMismatch Counter32, 369 copsClientErrUnknownOpcode Counter32, 370 copsClientErrUnknownCnum Counter32, 371 copsClientErrBadCtype Counter32, 372 copsClientErrBadSends Counter32, 373 copsClientErrWrongObjects Counter32, 374 copsClientErrWrongOpcode Counter32, 375 copsClientKaTimedoutClients Counter32 376 } 378 copsClientServerIpAddress OBJECT-TYPE 379 SYNTAX IpAddress 380 MAX-ACCESS not-accessible 381 STATUS current 382 DESCRIPTION 383 "The address of a COPS Server. It is assumed that the 384 COPS service will be provided on the well-known COPS 385 protocol port number." 386 REFERENCE 387 "COPS section 2.3" 388 ::= { copsClientServerCurrentEntry 1 } 390 copsClientServerClientType OBJECT-TYPE 391 SYNTAX INTEGER (0..65535) 392 MAX-ACCESS not-accessible 393 STATUS current 394 DESCRIPTION 395 "The COPS protocol Client-Type for which this entry 396 applies. Multiple Client-Types can be served by a single 397 COPS server." 398 REFERENCE 399 "COPS section 6, IANA" 400 ::= { copsClientServerCurrentEntry 2 } 402 copsClientServerTcpPort OBJECT-TYPE 403 SYNTAX TcpPort 404 MAX-ACCESS read-only 405 STATUS current 406 DESCRIPTION 407 "The TCP port number on the COPS server to which the 408 client is connected." 409 ::= { copsClientServerCurrentEntry 3 } 411 copsClientServerType OBJECT-TYPE 412 SYNTAX CopsServerEntryType 413 MAX-ACCESS read-only 414 STATUS current 415 DESCRIPTION 416 "Indicator of the source of this COPS server information. 417 COPS servers may be configured by network management 418 into copsClientServerConfigTable and appear in this entry 419 with type copsServerStatic(1). Alternatively, the may be 420 notified from another COPS server by means of the COPS 421 PDP-Redirect mechanism and appear as copsServerRedirect(2)." 422 ::= { copsClientServerCurrentEntry 4 } 424 copsClientServerSecurityMode OBJECT-TYPE 425 SYNTAX INTEGER { other(1), unknown(2), noSec(3), ipSec(4) } 426 MAX-ACCESS read-only 427 STATUS current 428 DESCRIPTION 429 "Indicator of the current security mode in use between 430 client and this COPS server." 431 ::= { copsClientServerCurrentEntry 5 } 433 copsClientServerLastConnectAttempt OBJECT-TYPE 434 SYNTAX TimeStamp 435 MAX-ACCESS read-only 436 STATUS current 437 DESCRIPTION 438 "Timestamp of the last time that this client attempted to 439 connect to this COPS server." 440 ::= { copsClientServerCurrentEntry 6 } 442 copsClientState OBJECT-TYPE 443 SYNTAX CopsClientState 444 MAX-ACCESS read-only 445 STATUS current 446 DESCRIPTION 447 "The state of the connection and COPS protocol with respect 448 to this COPS server." 449 ::= { copsClientServerCurrentEntry 7 } 451 copsClientServerKeepaliveTime OBJECT-TYPE 452 SYNTAX TimeInterval 453 MAX-ACCESS read-only 454 STATUS current 455 DESCRIPTION 456 "The value of the COPS protocol Keepalive timeout, in 457 centiseconds, currently in use by this client, as 458 specified by this COPS server in the Client-Accept operation. 459 A value of zero indicates no keepalive activity is expected." 460 REFERENCE 461 "COPS section 3.7, 4.4" 462 ::= { copsClientServerCurrentEntry 8 } 464 copsClientServerAccountingTime OBJECT-TYPE 465 SYNTAX TimeInterval 466 MAX-ACCESS read-only 467 STATUS current 468 DESCRIPTION 469 "The value of the COPS protocol Accounting timeout, in 470 centiseconds, currently in use by this client, as specified 471 by the COPS server in the Client-Accept operation. A value 472 of zero indicates no accounting activity is to be performed." 473 REFERENCE 474 "COPS section 3.7" 475 ::= { copsClientServerCurrentEntry 9 } 477 copsClientInPkts OBJECT-TYPE 478 SYNTAX Counter32 479 MAX-ACCESS read-only 480 STATUS current 481 DESCRIPTION 482 "A count of the total number of COPS packets that this client has 483 received from this COPS server. This value is cumulative since 484 agent restart and is not zeroed on new connections." 485 ::= { copsClientServerCurrentEntry 10 } 487 copsClientOutPkts OBJECT-TYPE 488 SYNTAX Counter32 489 MAX-ACCESS read-only 490 STATUS current 491 DESCRIPTION 492 "A count of the total number of COPS packets that this client has 493 sent to this COPS server. This value is cumulative since agent 494 restart and is not zeroed on new connections." 495 ::= { copsClientServerCurrentEntry 11 } 497 copsClientInErrs OBJECT-TYPE 498 SYNTAX Counter32 499 MAX-ACCESS read-only 500 STATUS current 501 DESCRIPTION 502 "A count of the total number of COPS packets that this client has 503 received from this COPS server that contained errors in syntax. 504 This value is cumulative since agent restart and is not zeroed on 505 new connections." 506 ::= { copsClientServerCurrentEntry 12 } 508 copsClientLastError OBJECT-TYPE 509 SYNTAX CopsErrorCode 510 MAX-ACCESS read-only 511 STATUS current 512 DESCRIPTION 513 "The code contained in the last COPS protocol Error Object 514 received by this client from this COPS server. This value is 515 not zeroed on COPS Client-Open operations." 516 REFERENCE 517 "COPS section 2.2.8" 518 ::= { copsClientServerCurrentEntry 13 } 520 copsClientTcpConnectAttempts OBJECT-TYPE 521 SYNTAX Counter32 522 MAX-ACCESS read-only 523 STATUS current 524 DESCRIPTION 525 "A count of the number of times that this COPS client has tried 526 to open an TCP connection to a COPS server. This value is 527 cumulative since agent restart and is not zeroed on new 528 connections." 529 ::= { copsClientServerCurrentEntry 14 } 531 copsClientTcpConnectFailures OBJECT-TYPE 532 SYNTAX Counter32 533 MAX-ACCESS read-only 534 STATUS current 535 DESCRIPTION 536 "A count of the number of times that this COPS client has failed 537 to open an TCP connection to a COPS server. This value is 538 cumulative since agent restart and is not zeroed on new 539 connections." 540 ::= { copsClientServerCurrentEntry 15 } 542 copsClientOpenAttempts OBJECT-TYPE 543 SYNTAX Counter32 544 MAX-ACCESS read-only 545 STATUS current 546 DESCRIPTION 547 "A count of the number of times that this COPS client has tried 548 to perform a COPS Client-Open to a COPS server. This value is 549 cumulative since agent restart and is not zeroed on new 550 connections." 551 ::= { copsClientServerCurrentEntry 16 } 553 copsClientOpenFailures OBJECT-TYPE 554 SYNTAX Counter32 555 MAX-ACCESS read-only 556 STATUS current 557 DESCRIPTION 558 "A count of the number of times that this COPS client has failed 559 to perform a COPS Client-Open to a COPS server. This value is 560 cumulative since agent restart and is not zeroed on new 561 connections." 562 ::= { copsClientServerCurrentEntry 17 } 564 copsClientErrUnsupportedClienttype OBJECT-TYPE 565 SYNTAX Counter32 566 MAX-ACCESS read-only 567 STATUS current 568 DESCRIPTION 569 "A count of the total number of COPS packets that this client has 570 received from COPS servers that referred to Client-Types that are 571 unsupported by this client. This value is cumulative 572 since agent restart and is not zeroed on new connections." 573 ::= { copsClientServerCurrentEntry 18 } 575 copsClientErrUnsupportedVersion OBJECT-TYPE 576 SYNTAX Counter32 577 MAX-ACCESS read-only 578 STATUS current 579 DESCRIPTION 580 "A count of the total number of COPS packets that this client has 581 received from COPS servers that had a COPS protocol Version 582 number that is unsupported by this client. This value is 583 cumulative since agent restart and is not zeroed on new 584 connections." 585 ::= { copsClientServerCurrentEntry 19 } 587 copsClientErrLengthMismatch OBJECT-TYPE 588 SYNTAX Counter32 589 MAX-ACCESS read-only 590 STATUS current 591 DESCRIPTION 592 "A count of the total number of COPS packets that this client has 593 received from COPS servers that had a COPS protocol Message 594 Length that did not match the actual received packet. This value 595 is cumulative since agent restart and is not zeroed on new 596 connections." 597 ::= { copsClientServerCurrentEntry 20 } 599 copsClientErrUnknownOpcode OBJECT-TYPE 600 SYNTAX Counter32 601 MAX-ACCESS read-only 602 STATUS current 603 DESCRIPTION 604 "A count of the total number of COPS packets that this client has 605 received from COPS servers that had a COPS protocol Op Code that 606 was unrecognised by this client. This value is cumulative 607 since agent restart and is not zeroed on new connections." 608 ::= { copsClientServerCurrentEntry 21 } 610 copsClientErrUnknownCnum OBJECT-TYPE 611 SYNTAX Counter32 612 MAX-ACCESS read-only 613 STATUS current 614 DESCRIPTION 615 "A count of the total number of COPS packets that this client has 616 received from COPS servers that contained a COPS protocol object 617 C-Num that was unrecognised by this client. This value is 618 cumulative since agent restart and is not zeroed on new 619 connections." 620 ::= { copsClientServerCurrentEntry 22 } 622 copsClientErrBadCtype OBJECT-TYPE 623 SYNTAX Counter32 624 MAX-ACCESS read-only 625 STATUS current 626 DESCRIPTION 627 "A count of the total number of COPS packets that this client has 628 received from COPS servers that contained a COPS protocol object 629 C-Type that was not defined for the C-Nums known by this client. 630 This value is cumulative since agent restart and is not zeroed on 631 new connections." 632 ::= { copsClientServerCurrentEntry 23 } 634 copsClientErrBadSends OBJECT-TYPE 635 SYNTAX Counter32 636 MAX-ACCESS read-only 637 STATUS current 638 DESCRIPTION 639 "A count of the total number of COPS packets that this client 640 attempted to send to COPS servers that resulted in a transmit 641 error. This value is cumulative since agent restart and is not 642 zeroed on new connections." 643 ::= { copsClientServerCurrentEntry 24 } 645 copsClientErrWrongObjects OBJECT-TYPE 646 SYNTAX Counter32 647 MAX-ACCESS read-only 648 STATUS current 649 DESCRIPTION 650 "A count of the total number of COPS packets that this client has 651 received from COPS servers that did not contain a permitted set 652 of COPS protocol objects. This value is cumulative since agent 653 restart and is not zeroed on new connections." 654 ::= { copsClientServerCurrentEntry 25 } 656 copsClientErrWrongOpcode OBJECT-TYPE 657 SYNTAX Counter32 658 MAX-ACCESS read-only 659 STATUS current 660 DESCRIPTION 661 "A count of the total number of COPS packets that this client has 662 received from COPS servers that had a COPS protocol Op Code that 663 should not have been sent to a COPS client e.g. Open-Requests. 664 This value is cumulative since agent restart and is not zeroed 665 on new connections." 666 ::= { copsClientServerCurrentEntry 26 } 668 copsClientKaTimedoutClients OBJECT-TYPE 669 SYNTAX Counter32 670 MAX-ACCESS read-only 671 STATUS current 672 DESCRIPTION 673 "A count of the total number of times that this client has 674 been shut down by COPS servers that had detected a COPS protocol 675 Keepalive timeout. This value is cumulative since agent restart 676 and is not zeroed on new connections." 677 ::= { copsClientServerCurrentEntry 27 } 679 -- ------------------------------------------------------------- 681 copsClientConfigGroup OBJECT IDENTIFIER ::= { copsClientMIBObjects 3 } 683 -- ------------------------------------------------------------- 685 copsClientServerConfigTable OBJECT-TYPE 686 SYNTAX SEQUENCE OF CopsClientServerConfigEntry 687 MAX-ACCESS not-accessible 688 STATUS current 689 DESCRIPTION 690 "Table of possible COPS servers to try to connect to in order 691 of copsClientServerConfigPriority. Note that a PDPRedirect 692 always takes precedence over any locally configured priority." 693 ::= { copsClientConfigGroup 1 } 695 copsClientServerConfigEntry OBJECT-TYPE 696 SYNTAX CopsClientServerConfigEntry 697 MAX-ACCESS not-accessible 698 STATUS current 699 DESCRIPTION 700 "A set of configuration information regarding a single 701 COPS server from the point of view of a COPS client." 702 INDEX { copsClientServerConfigIpAddress, 703 copsClientServerConfigClientType } 704 ::= { copsClientServerConfigTable 1 } 706 CopsClientServerConfigEntry ::= 707 SEQUENCE { 708 copsClientServerConfigIpAddress IpAddress, 709 copsClientServerConfigClientType INTEGER, 710 copsClientServerConfigTcpPort TcpPort, 711 copsClientServerConfigPriority Integer32, 712 copsClientServerConfigRetryCount Integer32, 713 copsClientServerConfigRetryInterval TimeInterval, 714 copsClientServerConfigRowStatus RowStatus 715 } 717 copsClientServerConfigIpAddress OBJECT-TYPE 718 SYNTAX IpAddress 719 MAX-ACCESS not-accessible 720 STATUS current 721 DESCRIPTION 722 "The address of a COPS Server. It is assumed that the 723 COPS service will be provided on the well-known COPS 724 protocol port number." 725 REFERENCE 726 "COPS section 2.3" 727 ::= { copsClientServerConfigEntry 1 } 729 copsClientServerConfigClientType OBJECT-TYPE 730 SYNTAX INTEGER (0..65535) 731 MAX-ACCESS not-accessible 732 STATUS current 733 DESCRIPTION 734 "The COPS protocol Client-Type for which this entry 735 applies and for which this COPS server is capable 736 of serving. Multiple Client-Types can be served by a 737 single COPS server." 738 REFERENCE 739 "COPS section 6, IANA" 741 ::= { copsClientServerConfigEntry 2 } 743 copsClientServerConfigTcpPort OBJECT-TYPE 744 SYNTAX TcpPort 745 MAX-ACCESS read-create 746 STATUS current 747 DESCRIPTION 748 "The TCP port number on the COPS server to which the 749 client should connect." 750 ::= { copsClientServerConfigEntry 3 } 752 copsClientServerConfigPriority OBJECT-TYPE 753 SYNTAX Integer32 754 MAX-ACCESS read-create 755 STATUS current 756 DESCRIPTION 757 "The priority of this entry relative to other entries. 758 COPS client will attempt to contact COPS servers for the 759 appropriate Client-Type in the order of their priority 760 values. The order to be used amongst server entries with 761 the same priority is undefined. COPS servers that are 762 notified to the client using the COPS protocol PDP-Redirect 763 mechanism are always used in preference to any entries in 764 this table." 765 ::= { copsClientServerConfigEntry 4 } 767 copsClientServerConfigRetryCount OBJECT-TYPE 768 SYNTAX Integer32 769 MAX-ACCESS read-create 770 STATUS current 771 DESCRIPTION 772 "The number of times the client should retry to connect 773 to this COPS server before moving on to another server." 774 DEFVAL { 1 } 775 ::= { copsClientServerConfigEntry 5 } 777 copsClientServerConfigRetryInterval OBJECT-TYPE 778 SYNTAX TimeInterval 779 UNITS "centi-seconds" 780 MAX-ACCESS read-create 781 STATUS current 782 DESCRIPTION 783 "The time to wait between retrying to connect to 784 this COPS server." 785 DEFVAL { 1000 } 786 ::= { copsClientServerConfigEntry 6 } 788 copsClientServerConfigRowStatus OBJECT-TYPE 789 SYNTAX RowStatus 790 MAX-ACCESS read-create 791 STATUS current 792 DESCRIPTION 793 "State of this entry in the table." 794 ::= { copsClientServerConfigEntry 7 } 796 -- ------------------------------------------------------------- 797 -- Conformance Information 798 -- ------------------------------------------------------------- 800 copsClientConformance OBJECT IDENTIFIER ::= { copsClientMIB 2 } 802 copsClientGroups OBJECT IDENTIFIER ::= { copsClientConformance 1 } 803 copsClientCompliances OBJECT IDENTIFIER ::= { copsClientConformance 2 } 805 -- ------------------------------------------------------------- 806 -- units of conformance 807 -- ------------------------------------------------------------- 809 copsDeviceStatusGroup OBJECT-GROUP 810 OBJECTS { 811 copsClientCapabilities, 812 copsClientServerTcpPort, copsClientServerType, 813 copsClientServerSecurityMode, copsClientServerLastConnectAttempt, 814 copsClientState, copsClientServerKeepaliveTime, 815 copsClientServerAccountingTime, copsClientInPkts, 816 copsClientOutPkts, copsClientInErrs, copsClientLastError, 817 copsClientTcpConnectAttempts, copsClientTcpConnectFailures, 818 copsClientOpenAttempts, copsClientOpenFailures, 819 copsClientErrUnsupportedClienttype, 820 copsClientErrUnsupportedVersion, copsClientErrLengthMismatch, 821 copsClientErrUnknownOpcode, copsClientErrUnknownCnum, 822 copsClientErrBadCtype, copsClientErrBadSends, 823 copsClientErrWrongObjects, copsClientErrWrongOpcode, 824 copsClientKaTimedoutClients 825 } 826 STATUS current 827 DESCRIPTION 828 "A collection of objects for monitoring the status of 829 connections to COPS servers and statistics for a COPS client." 831 ::= { copsClientGroups 1 } 833 copsDeviceConfigGroup OBJECT-GROUP 834 OBJECTS { 835 copsClientServerConfigTcpPort, copsClientServerConfigPriority, 836 copsClientServerConfigRetryCount, 837 copsClientServerConfigRetryInterval, 838 copsClientServerConfigRowStatus 839 } 840 STATUS current 841 DESCRIPTION 842 "A collection of objects for configuring COPS server 843 information." 844 ::= { copsClientGroups 2 } 846 -- ------------------------------------------------------------- 847 -- compliance statements 848 -- ------------------------------------------------------------- 850 copsClientCompliance MODULE-COMPLIANCE 851 STATUS current 852 DESCRIPTION 853 "The compliance statement for device support of 854 management of the COPS client." 856 MODULE 857 MANDATORY-GROUPS { 858 copsDeviceStatusGroup, copsDeviceConfigGroup 859 } 861 OBJECT copsClientServerConfigTcpPort 862 MIN-ACCESS read-only 863 DESCRIPTION 864 "Write access is required only if the device supports the 865 configuration of COPS server information." 867 OBJECT copsClientServerConfigPriority 868 MIN-ACCESS read-only 869 DESCRIPTION 870 "Write access is required only if the device supports the 871 configuration of COPS server information." 873 OBJECT copsClientServerConfigRetryCount 874 MIN-ACCESS read-only 875 DESCRIPTION 876 "Write access is required only if the device supports the 877 configuration of COPS server information." 879 OBJECT copsClientServerConfigRetryInterval 880 MIN-ACCESS read-only 881 DESCRIPTION 882 "Write access is required only if the device supports the 883 configuration of COPS server information." 885 OBJECT copsClientServerConfigRowStatus 886 MIN-ACCESS read-only 887 DESCRIPTION 888 "Write access is required only if the device supports the 889 configuration of COPS server information." 891 ::= { copsClientCompliances 1 } 893 END 895 6. Acknowledgments 897 This document documents the client side of the COPS protocol which was 898 defined by the RSVP Admission Policy Working Group. 900 7. Security Considerations 902 There are a number of management objects defined in this MIB that have a 903 MAX-ACCESS clause of read-write and/or read-create. Such objects may be 904 considered sensitive or vulnerable in some network environments. The 905 support for SET operations in a non-secure environment without proper 906 protection can have a negative effect on network operations. 908 SNMPv1 by itself is not a secure environment. Even if the network 909 itself is secure (for example by using IPSec), even then, there is no 910 control as to who on the secure network is allowed to access and GET/SET 911 (read/change/create/delete) the objects in this MIB. 913 It is recommended that the implementers consider the security features 914 as provided by the SNMPv3 framework. Specifically, the use of the User- 915 based Security Model [USM] and the View-based Access Control Model 916 [VACM] is recommended. 918 It is then a customer/user responsibility to ensure that the SNMP entity 919 giving access to an instance of this MIB, is properly configured to give 920 access to the objects only to those principals (users) that have 921 legitimate rights to indeed GET or SET (change/create/delete) them. 923 8. References 925 [ARCH] 926 Harrington, D., Presuhn, R., and B. Wijnen, "An Architecture for 927 Describing SNMP Management Frameworks", RFC 2571, April 1999 929 [V1PROTO] 930 Case, J., Fedor, M., Schoffstall, M. and J. Davin, "Simple Network 931 Management Protocol", STD 15, RFC 1157, May 1990. 933 [V1SMI] 934 Rose, M., and K. McCloghrie, "Structure and Identification of 935 Management Information for TCP/IP-based Internets", STD 16, RFC 936 1155, May 1990 938 [V1CONCISE] 939 Rose, M. and K. McCloghrie, "Concise MIB Definitions", STD 16, RFC 940 1212, March 1991 942 [V1TRAPS] 943 M. Rose, "A Convention for Defining Traps for use with the SNMP", 944 RFC 1215, March 1991 946 [V2SMI] 947 McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M. 948 and S. Waldbusser, "Structure of Management Information Version 2 949 (SMIv2)", STD 58, RFC 2578, April 1999. 951 [V2TC] 952 McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M. 953 and S. Waldbusser, "Textual Conventions for SMIv2", STD 58, RFC 954 2579, April 1999. 956 [V2CONFORM] 957 McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M. 958 and S. Waldbusser, "Conformance Statements for SMIv2", STD 58, RFC 959 2580, April 1999. 961 [V2COMMUNITY] 962 Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, "Introduction 963 to Community-based SNMPv2", RFC 1901, January 1996. 965 [V2TRANS] 966 Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, "Transport 967 Mappings for Version 2 of the Simple Network Management Protocol 968 (SNMPv2)", RFC 1906, January 1996. 970 [V2PROTO] 971 Case, J., McCloghrie, K., Rose, M. and Waldbusser, S., "Protocol 972 Operations for Version 2 of the Simple Network Management Protocol 973 (SNMPv2)", RFC 1905, January 1996. 975 [V3INTRO] 976 Case, J., Mundy, R., Partain, D. and B. Stewart, "Introduction to 977 Version 3 of the Internet-standard Network Management Framework", 978 RFC 2570, April 1999. 980 [V3MPC] 981 Case, J., Harrington D., Presuhn R. and B. Wijnen, "Message 982 Processing and Dispatching for the Simple Network Management 983 Protocol (SNMP)", RFC 2572, April 1999. 985 [V3USM] 986 Blumenthal, U. and B. Wijnen, "The User-Based Security Model (USM) 987 for Version 3 of the Simple Network Management Protocol (SNMPv3)", 988 RFC 2574, April 1999. 990 [V3APPS] 991 Levi, D., Meyer, P. and B. Stewart, "SNMP Applications", RFC 2573, 992 April 1999. 994 [V3VACM] 995 Wijnen, B., Presuhn, R. and K. McCloghrie, "View-based Access 996 Control Model for the Simple Network Management Protocol (SNMP)", 997 RFC 2575, April 1999. 999 [ASN1] 1000 Information processing systems - Open Systems Interconnection - 1001 Specification of Abstract Syntax Notation One (ASN.1), 1002 International Organization for Standardization, International 1003 Standard 8824, December 1987. 1005 [ASN1BER] 1006 Information processing systems - Open Systems Interconnection - 1007 Specification of Basic Encoding Rules for Abstract Notation One 1008 (ASN.1), International Organization for Standardization, 1009 International Standard 8825, December 1987. 1011 [MIB2] 1012 McCloghrie K., and M. Rose, Editors, "Management Information Base 1013 for Network Management of TCP/IP-based internets", STD 17, RFC 1014 1213, March 1991. 1016 [FRAMEWORK] 1017 Yavatkar, R., Pendarakis, D. and Guerin, R., "A Framework for 1018 Policy-based Admission Control", Internet Draft, May 1999. 1019 http://www.ietf.org/internet-drafts/draft-ietf-rap-framework-03.txt 1021 [COPS] 1022 Boyle, J., Cohen, R., Durham, D., Herzog, S., Rajan, R. and Sastry, 1023 A., "The COPS (Common Open Policy Service) Protocol", Internet 1024 Draft, February 1999. http://www.ietf.org/internet-drafts/draft- 1025 ietf-rap-cops-06.txt 1027 [RSVP] 1028 Braden, R. ed. et al., "Resource ReSerVation Protocol (RSVP) 1029 Version 1 - Functional Specification", RFC 2205, September 1997. 1031 [COPSRSVP] 1032 Boyle, J., Cohen, R., Durham, D., Herzog, S., Rajan, R. and Sastry, 1033 A., "COPS Usage for RSVP", Internet Draft, February 1999. 1034 http://www.ietf.org/internet-drafts/draft-ietf-rap-cops-rsvp-04.txt 1036 [SRVLOC] 1037 Guttman, E., Perkins, C., Veizades, J., Day, M., "Service Location 1038 Protocol, Version 2", Internet Draft, April 1999. 1039 http://www.ietf.org/internet-drafts/draft-ietf-svrloc-protocol- 1040 v2-15.txt 1042 [PROCESS] 1043 Bradner, S., "The Internet Standards Process -- Revision 3", BCP 9, 1044 RFC 2026, October 1996. 1046 9. Authors' Addresses 1048 Andrew Smith 1049 Extreme Networks 1050 3585 Monroe St. 1051 Santa Clara CA 95051 1052 USA 1053 Phone: +1 408 579 2821 1054 EMail: andrew@extremenetworks.com 1056 David Partain 1057 Ericsson Radio Systems 1058 Research and Innovation 1059 P.O. Box 1248 1060 SE-581 12 Linkoping 1061 Sweden 1062 Phone: +46 13 28 41 44 1063 EMail: David.Partain@ericsson.com 1065 John Seligson 1066 Nortel Networks, Inc. 1067 4401 Great America Parkway 1068 Santa Clara, CA 95054 1069 USA 1070 Phone: +1 408 495 2992 1071 EMail: jseligso@nortelnetworks.com 1073 10. Full Copyright 1075 Copyright (C) The Internet Society (1999). All Rights Reserved. 1077 This document and translations of it may be copied and furnished 1078 to others, and derivative works that comment on or otherwise 1079 explain it or assist in its implmentation may be prepared, copied, 1080 published and distributed, in whole or in part, without 1081 restriction of any kind, provided that the above copyright notice 1082 and this paragraph are included on all such copies and derivative 1083 works. However, this document itself may not be modified in any 1084 way, such as by removing the copyright notice or references to the 1085 Internet Society or other Internet organizations, except as needed 1086 for the purpose of developing Internet standards in which case the 1087 procedures for copyrights defined in the Internet Standards 1088 process must be followed, or as required to translate it into 1089 languages other than English. 1091 The limited permissions granted above are perpetual and will not 1092 be revoked by the Internet Society or its successors or assigns. 1094 This document and the information contained herein is provided on 1095 an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET 1096 ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR 1097 IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF 1098 THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED 1099 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.