mibs/ietf/COPS-CLIENT-MIB

   1 COPS-CLIENT-MIB DEFINITIONS ::= BEGIN
   2
   3 -- -------------------------------------------------------------
   4 -- -------------------------------------------------------------
   5
   6 IMPORTS
   7     MODULE-IDENTITY, OBJECT-TYPE, Counter32, Integer32,
   8     Unsigned32, mib-2
   9         FROM SNMPv2-SMI
  10     TimeStamp, TimeInterval, RowStatus, TEXTUAL-CONVENTION
  11         FROM SNMPv2-TC
  12     MODULE-COMPLIANCE, OBJECT-GROUP
  13         FROM SNMPv2-CONF
  14     InetAddressType, InetAddress
  15         FROM INET-ADDRESS-MIB;
  16
  17
  18 --    REFERENCE
  19
  20
  21 --        "The COPS (Common Open Policy Service) Protocol RFC 2748
  22
  23 copsClientMIB MODULE-IDENTITY
  24     LAST-UPDATED "200009280000Z"
  25     ORGANIZATION "IETF RSVP Admission Policy Working Group"
  26     CONTACT-INFO
  27         "       Andrew Smith (WG co-chair)
  28          Phone: +1 408 579 2821
  29          Email: ah_smith@pacbell.net
  30
  31                 Mark Stevens (WG co-chair)
  32          Phone: +1 978 287 9102
  33          Email: markstevens@lucent.com
  34
  35          Editor: Andrew Smith
  36          Phone: +1 408 579 2821
  37          Email: ah_smith@pacbell.net
  38
  39          Editor: David Partain
  40          Phone: +46 13 28 41 44
  41          Email: David.Partain@ericsson.com
  42
  43          Editor: John Seligson
  44          Phone: +1 408 495 2992
  45          Email: jseligso@nortelnetworks.com"
  46
  47     DESCRIPTION
  48         "The COPS Client MIB module"
  49
  50     REVISION    "200009280000Z"
  51     DESCRIPTION "This version published as RFC 2940"
  52
  53     ::= { mib-2 89 }
  54
  55 copsClientMIBObjects OBJECT IDENTIFIER ::= { copsClientMIB 1 }
  56
  57 -- -------------------------------------------------------------
  58 -- Textual Conventions
  59 -- -------------------------------------------------------------
  60
  61 CopsClientState ::= TEXTUAL-CONVENTION
  62     STATUS      current
  63     DESCRIPTION
  64         "A value indicating the state of a COPS client."
  65     SYNTAX      INTEGER {
  66             copsClientInvalid(1),      -- default state.
  67             copsClientTcpconnected(2), -- TCP connection up but COPS
  68                                        -- not yet open.
  69
  70
  71             copsClientAuthenticating(3), -- TCP connection up but still
  72                                          -- authenticating.
  73             copsClientSecAccepted(4),  -- connection authenticated.
  74             copsClientAccepted(5),     -- COPS server accepted client.
  75             copsClientTimingout(6)     -- Keepalive timer has expired,
  76                                        -- client is in process of
  77                                        -- tearing down connection.
  78     }
  79
  80 CopsServerEntryType ::= TEXTUAL-CONVENTION
  81     STATUS      current
  82     DESCRIPTION
  83         "A value indicating how a COPS server entry came into existence."
  84     SYNTAX      INTEGER {
  85             copsServerStatic(1),        -- configured by manager
  86             copsServerRedirect(2)       -- notified by COPS server
  87     }
  88
  89 CopsErrorCode ::= TEXTUAL-CONVENTION
  90     STATUS      current
  91     DESCRIPTION
  92         "A value describing a COPS protocol error. Codes are identical
  93          to those used by the COPS protocol itself."
  94     SYNTAX      INTEGER {
  95             errorOther(0),             -- none of the below
  96             errorBadHandle(1),
  97             errorInvalidHandleReference(2),
  98             errorBadMessageFormat(3),
  99             errorUnableToProcess(4),
 100             errorMandatoryClientSiMissing(5),
 101             errorUnsupportedClientType(6),
 102             errorMandatoryCopsObjectMissing(7),
 103             errorClientFailure(8),
 104             errorCommunicationFailure(9),
 105             errorUnspecified(10),        -- client-type specific subcode
 106             errorShuttingDown(11),
 107             errorRedirectToPreferredServer(12),
 108             errorUnknownCopsObject(13),
 109             errorAuthenticationFailure(14),
 110             errorAuthenticationMissing(15)
 111     }
 112 --  REFERENCE
 113 --      "RFC 2748 section 2.2.8"
 114
 115 CopsTcpPort ::= TEXTUAL-CONVENTION
 116     STATUS      current
 117     DESCRIPTION
 118         "A value indicating a TCP protocol port number."
 119
 120
 121     SYNTAX      INTEGER (0..65535)
 122
 123 CopsAuthType ::= TEXTUAL-CONVENTION
 124     STATUS      current
 125     DESCRIPTION
 126         "A value indicating a type of security authentication mechanism."
 127     SYNTAX      INTEGER {
 128         authNone(0),
 129         authOther(1),
 130         authIpSecAh(2),
 131         authIpSecEsp(3),
 132         authTls(4),
 133         authCopsIntegrity(5)
 134     }
 135
 136 -- -------------------------------------------------------------
 137
 138 copsClientCapabilitiesGroup OBJECT IDENTIFIER
 139                             ::= { copsClientMIBObjects 1 }
 140
 141 -- -------------------------------------------------------------
 142 --
 143 -- Capabilities of the COPS client to connect to a COPS server:
 144 --
 145 copsClientCapabilities OBJECT-TYPE
 146     SYNTAX      BITS {
 147         copsClientVersion1(0),     -- supports version1 of COPS protocol
 148         copsClientAuthIpSecAh(1) , -- supports IP-SEC Authentication
 149         copsClientAuthIpSecEsp(2), -- supports IP-SEC Encryption
 150         copsClientAuthTls(3),      -- supports Transport-Layer Security
 151         copsClientAuthInteg(4)     -- supports COPS Integrity
 152     }
 153     MAX-ACCESS  read-only
 154     STATUS      current
 155     DESCRIPTION
 156         "A list of the optional capabilities that this COPS client
 157         supports."
 158     ::= { copsClientCapabilitiesGroup 1 }
 159
 160 -- -------------------------------------------------------------
 161
 162 copsClientStatusGroup OBJECT IDENTIFIER ::= { copsClientMIBObjects 2 }
 163
 164 -- -------------------------------------------------------------
 165 --
 166 -- Current status of COPS server connections, all read-only.
 167 --
 168
 169
 170
 171 copsClientServerCurrentTable OBJECT-TYPE
 172     SYNTAX      SEQUENCE OF CopsClientServerCurrentEntry
 173     MAX-ACCESS  not-accessible
 174     STATUS      current
 175     DESCRIPTION
 176         "A table of information regarding COPS servers as seen from the
 177         point of view of a COPS client. This table contains entries
 178         for both statically-configured and dynamically-learned servers
 179         (from a PDP Redirect operation). One entry exists in this table
 180         for each COPS Client-Type served by the COPS server. In addition,
 181         an entry will exist with copsClientServerClientType 0 (zero)
 182         representing information about the underlying connection itself:
 183         this is consistent with the COPS specification which reserves
 184         this value for this purpose."
 185
 186     ::= { copsClientStatusGroup 1 }
 187
 188 copsClientServerCurrentEntry OBJECT-TYPE
 189     SYNTAX      CopsClientServerCurrentEntry
 190     MAX-ACCESS  not-accessible
 191     STATUS      current
 192     DESCRIPTION
 193         "A set of information regarding a single COPS server serving
 194         a single COPS Client-Type from the point of view of a COPS
 195         client."
 196     INDEX { copsClientServerAddressType, copsClientServerAddress,
 197             copsClientServerClientType }
 198     ::= { copsClientServerCurrentTable 1 }
 199
 200 CopsClientServerCurrentEntry ::=
 201     SEQUENCE {
 202         copsClientServerAddressType         InetAddressType,
 203         copsClientServerAddress             InetAddress,
 204         copsClientServerClientType          INTEGER,
 205         copsClientServerTcpPort             CopsTcpPort,
 206         copsClientServerType                CopsServerEntryType,
 207         copsClientServerAuthType            CopsAuthType,
 208         copsClientServerLastConnAttempt     TimeStamp,
 209         copsClientState                     CopsClientState,
 210         copsClientServerKeepaliveTime       TimeInterval,
 211         copsClientServerAccountingTime      TimeInterval,
 212         copsClientInPkts                    Counter32,
 213         copsClientOutPkts                   Counter32,
 214         copsClientInErrs                    Counter32,
 215         copsClientLastError                 CopsErrorCode,
 216         copsClientTcpConnectAttempts        Counter32,
 217         copsClientTcpConnectFailures        Counter32,
 218         copsClientOpenAttempts              Counter32,
 219
 220
 221         copsClientOpenFailures              Counter32,
 222         copsClientErrUnsupportClienttype    Counter32,
 223         copsClientErrUnsupportedVersion     Counter32,
 224         copsClientErrLengthMismatch         Counter32,
 225         copsClientErrUnknownOpcode          Counter32,
 226         copsClientErrUnknownCnum            Counter32,
 227         copsClientErrBadCtype               Counter32,
 228         copsClientErrBadSends               Counter32,
 229         copsClientErrWrongObjects           Counter32,
 230         copsClientErrWrongOpcode            Counter32,
 231         copsClientKaTimedoutClients         Counter32,
 232         copsClientErrAuthFailures           Counter32,
 233         copsClientErrAuthMissing            Counter32
 234     }
 235
 236 copsClientServerAddressType OBJECT-TYPE
 237     SYNTAX      InetAddressType
 238     MAX-ACCESS  not-accessible
 239     STATUS      current
 240     DESCRIPTION
 241         "The type of address in copsClientServerAddress."
 242     ::= { copsClientServerCurrentEntry 1 }
 243
 244 copsClientServerAddress OBJECT-TYPE
 245     SYNTAX      InetAddress
 246     MAX-ACCESS  not-accessible
 247     STATUS      current
 248     DESCRIPTION
 249         "The IPv4, IPv6 or DNS address of a COPS Server. Note that,
 250         since this is an index to the table, the DNS name must be
 251         short enough to fit into the maximum length of indices allowed
 252         by the management protocol in use."
 253     REFERENCE
 254         "RFC 2748 section 2.3"
 255     ::= { copsClientServerCurrentEntry 2 }
 256
 257 copsClientServerClientType OBJECT-TYPE
 258     SYNTAX      INTEGER (0..65535)
 259     MAX-ACCESS  not-accessible
 260     STATUS      current
 261     DESCRIPTION
 262         "The COPS protocol Client-Type for which this entry
 263         applies. Multiple Client-Types can be served by a single
 264         COPS server. The value 0 (zero) indicates that this
 265         entry contains information about the underlying connection
 266         itself."
 267     REFERENCE
 268         "RFC 2748 section 6, IANA"
 269
 270
 271     ::= { copsClientServerCurrentEntry 3 }
 272
 273 copsClientServerTcpPort OBJECT-TYPE
 274     SYNTAX      CopsTcpPort
 275     MAX-ACCESS  read-only
 276     STATUS      current
 277     DESCRIPTION
 278         "The TCP port number on the COPS server to which the
 279         client should connect/is connected."
 280     ::= { copsClientServerCurrentEntry 4 }
 281
 282 copsClientServerType OBJECT-TYPE
 283     SYNTAX      CopsServerEntryType
 284     MAX-ACCESS  read-only
 285     STATUS      current
 286     DESCRIPTION
 287         "Indicator of the source of this COPS server information.
 288         COPS servers may be configured by network management
 289         into copsClientServerConfigTable and appear in this entry
 290         with type copsServerStatic(1). Alternatively, the may be
 291         notified from another COPS server by means of the COPS
 292         PDP-Redirect mechanism and appear as copsServerRedirect(2)."
 293     ::= { copsClientServerCurrentEntry 5 }
 294
 295 copsClientServerAuthType OBJECT-TYPE
 296     SYNTAX      CopsAuthType
 297     MAX-ACCESS  read-only
 298     STATUS      current
 299     DESCRIPTION
 300         "Indicator of the current security mode in use between
 301         client and this COPS server."
 302     ::= { copsClientServerCurrentEntry 6 }
 303
 304 copsClientServerLastConnAttempt OBJECT-TYPE
 305     SYNTAX      TimeStamp
 306     MAX-ACCESS  read-only
 307     STATUS      current
 308     DESCRIPTION
 309         "Timestamp of the last time that this client attempted to
 310         connect to this COPS server."
 311     ::= { copsClientServerCurrentEntry 7 }
 312
 313 copsClientState  OBJECT-TYPE
 314     SYNTAX      CopsClientState
 315     MAX-ACCESS  read-only
 316     STATUS      current
 317     DESCRIPTION
 318         "The state of the connection and COPS protocol with respect
 319
 320
 321         to this COPS server."
 322     ::= { copsClientServerCurrentEntry 8 }
 323
 324 copsClientServerKeepaliveTime OBJECT-TYPE
 325     SYNTAX      TimeInterval
 326     MAX-ACCESS  read-only
 327     STATUS      current
 328     DESCRIPTION
 329         "The value of the COPS protocol Keepalive timeout, in
 330         centiseconds, currently in use by this client, as
 331         specified by this COPS server in the Client-Accept operation.
 332         A value of zero indicates no keepalive activity is expected."
 333     REFERENCE
 334         "RFC 2748 section 3.7, 4.4"
 335     ::= { copsClientServerCurrentEntry 9 }
 336
 337 copsClientServerAccountingTime   OBJECT-TYPE
 338     SYNTAX      TimeInterval
 339     MAX-ACCESS  read-only
 340     STATUS      current
 341     DESCRIPTION
 342         "The value of the COPS protocol Accounting timeout, in
 343         centiseconds, currently in use by this client, as specified
 344         by the COPS server in the Client-Accept operation. A value
 345         of zero indicates no accounting activity is to be performed."
 346     REFERENCE
 347         "RFC 2748 section 3.7"
 348     ::= { copsClientServerCurrentEntry 10 }
 349
 350 copsClientInPkts OBJECT-TYPE
 351     SYNTAX      Counter32
 352     MAX-ACCESS  read-only
 353     STATUS      current
 354     DESCRIPTION
 355         "A count of the total number of COPS messages that this client
 356         has received from this COPS server marked for this Client-Type.
 357         This value is cumulative since agent restart and is not zeroed
 358         on new connections."
 359     ::= { copsClientServerCurrentEntry 11 }
 360
 361 copsClientOutPkts OBJECT-TYPE
 362     SYNTAX      Counter32
 363     MAX-ACCESS  read-only
 364     STATUS      current
 365     DESCRIPTION
 366         "A count of the total number of COPS messages that this client
 367         has sent to this COPS server marked for this Client-Type. This
 368         value is cumulative since agent restart and is not zeroed on new
 369
 370
 371         connections."
 372     ::= { copsClientServerCurrentEntry 12 }
 373
 374 copsClientInErrs OBJECT-TYPE
 375     SYNTAX      Counter32
 376     MAX-ACCESS  read-only
 377     STATUS      current
 378     DESCRIPTION
 379         "A count of the total number of COPS messages that this client
 380         has received from this COPS server marked for this Client-Type
 381         that contained errors in syntax. This value is cumulative since
 382         agent restart and is not zeroed on new connections."
 383     ::= { copsClientServerCurrentEntry 13 }
 384
 385 copsClientLastError OBJECT-TYPE
 386     SYNTAX      CopsErrorCode
 387     MAX-ACCESS  read-only
 388     STATUS      current
 389     DESCRIPTION
 390         "The code contained in the last COPS protocol Error Object
 391         received by this client from this COPS server marked for this
 392         Client-Type. This value is not zeroed on COPS Client-Open
 393         operations."
 394     REFERENCE
 395         "RFC 2748 section 2.2.8"
 396     ::= { copsClientServerCurrentEntry 14 }
 397
 398 copsClientTcpConnectAttempts OBJECT-TYPE
 399     SYNTAX     Counter32
 400     MAX-ACCESS  read-only
 401     STATUS      current
 402     DESCRIPTION
 403         "A count of the number of times that this COPS client has tried
 404         (successfully or otherwise) to open an TCP connection to a COPS
 405         server. This value is cumulative  since agent restart and is not
 406         zeroed on new connections. This value is not incremented for
 407         entries representing a non-zero Client-Type."
 408     ::= { copsClientServerCurrentEntry 15 }
 409
 410 copsClientTcpConnectFailures OBJECT-TYPE
 411     SYNTAX     Counter32
 412     MAX-ACCESS  read-only
 413     STATUS      current
 414     DESCRIPTION
 415         "A count of the number of times that this COPS client has failed
 416         to open an TCP connection to a COPS server. This value is
 417         cumulative since agent restart and is not zeroed on new
 418         connections. This value is not incremented for
 419
 420
 421         entries representing a non-zero Client-Type."
 422     ::= { copsClientServerCurrentEntry 16 }
 423
 424 copsClientOpenAttempts OBJECT-TYPE
 425     SYNTAX     Counter32
 426     MAX-ACCESS  read-only
 427     STATUS      current
 428     DESCRIPTION
 429         "A count of the number of times that this COPS client has tried
 430         to perform a COPS Client-Open to a COPS server for this
 431         Client-Type. This value is cumulative since agent restart and is
 432         not zeroed on new connections."
 433     ::= { copsClientServerCurrentEntry 17 }
 434
 435 copsClientOpenFailures OBJECT-TYPE
 436     SYNTAX     Counter32
 437     MAX-ACCESS  read-only
 438     STATUS      current
 439     DESCRIPTION
 440         "A count of the number of times that this COPS client has failed
 441         to perform a COPS Client-Open to a COPS server for this
 442         Client-Type. This value is cumulative since agent restart and is
 443         not zeroed on new connections."
 444     ::= { copsClientServerCurrentEntry 18 }
 445
 446 copsClientErrUnsupportClienttype OBJECT-TYPE
 447     SYNTAX     Counter32
 448     MAX-ACCESS  read-only
 449     STATUS      current
 450     DESCRIPTION
 451         "A count of the total number of COPS messages that this client
 452         has received from COPS servers that referred to Client-Types
 453         that are unsupported by this client. This value is cumulative
 454         since agent restart and is not zeroed on new connections. This
 455         value is not incremented for entries representing a non-zero
 456         Client-Type."
 457     ::= { copsClientServerCurrentEntry 19 }
 458
 459 copsClientErrUnsupportedVersion OBJECT-TYPE
 460     SYNTAX     Counter32
 461     MAX-ACCESS  read-only
 462     STATUS      current
 463     DESCRIPTION
 464         "A count of the total number of COPS messages that this client
 465         has received from COPS servers marked for this Client-Type that
 466         had a COPS protocol Version number that is unsupported by this
 467         client. This value is cumulative since agent restart and is not
 468         zeroed on new connections."
 469
 470
 471     ::= { copsClientServerCurrentEntry 20 }
 472
 473 copsClientErrLengthMismatch OBJECT-TYPE
 474     SYNTAX     Counter32
 475     MAX-ACCESS  read-only
 476     STATUS      current
 477     DESCRIPTION
 478         "A count of the total number of COPS messages that this client
 479         has received from COPS servers marked for this Client-Type that
 480         had a COPS protocol Message Length that did not match the actual
 481         received message. This value is cumulative since agent restart
 482         and is not zeroed on new connections."
 483     ::= { copsClientServerCurrentEntry 21 }
 484
 485 copsClientErrUnknownOpcode OBJECT-TYPE
 486     SYNTAX     Counter32
 487     MAX-ACCESS  read-only
 488     STATUS      current
 489     DESCRIPTION
 490         "A count of the total number of COPS messages that this client
 491         has received from COPS servers marked for this Client-Type that
 492         had a COPS protocol Op Code that was unrecognised by this
 493         client. This value is cumulative since agent restart and is not
 494         zeroed on new connections."
 495     ::= { copsClientServerCurrentEntry 22 }
 496
 497 copsClientErrUnknownCnum OBJECT-TYPE
 498     SYNTAX     Counter32
 499     MAX-ACCESS  read-only
 500     STATUS      current
 501     DESCRIPTION
 502         "A count of the total number of COPS messages that this client
 503         has received from COPS servers marked for this Client-Type that
 504         contained a COPS protocol object C-Num that was unrecognised by
 505         this client. This value is cumulative since agent restart and is
 506         not zeroed on new connections."
 507     ::= { copsClientServerCurrentEntry 23 }
 508
 509 copsClientErrBadCtype OBJECT-TYPE
 510     SYNTAX     Counter32
 511     MAX-ACCESS  read-only
 512     STATUS      current
 513     DESCRIPTION
 514         "A count of the total number of COPS messages that this client
 515         has received from COPS servers marked for this Client-Type that
 516         contained a COPS protocol object C-Type that was not defined for
 517         the C-Nums known by this client. This value is cumulative since
 518         agent restart and is not zeroed on new connections."
 519
 520
 521     ::= { copsClientServerCurrentEntry 24 }
 522
 523 copsClientErrBadSends OBJECT-TYPE
 524     SYNTAX     Counter32
 525     MAX-ACCESS  read-only
 526     STATUS      current
 527     DESCRIPTION
 528         "A count of the total number of COPS messages that this client
 529         attempted to send to COPS servers marked for this Client-Type
 530         that resulted in a transmit error. This value is cumulative
 531         since agent restart and is not zeroed on new connections."
 532     ::= { copsClientServerCurrentEntry 25 }
 533
 534 copsClientErrWrongObjects OBJECT-TYPE
 535     SYNTAX     Counter32
 536     MAX-ACCESS  read-only
 537     STATUS      current
 538     DESCRIPTION
 539         "A count of the total number of COPS messages that this client
 540         has received from COPS servers marked for this Client-Type that
 541         did not contain a permitted set of COPS protocol objects. This
 542         value is cumulative since agent restart and is not zeroed on new
 543         connections."
 544     ::= { copsClientServerCurrentEntry 26 }
 545
 546 copsClientErrWrongOpcode OBJECT-TYPE
 547     SYNTAX     Counter32
 548     MAX-ACCESS  read-only
 549     STATUS      current
 550     DESCRIPTION
 551         "A count of the total number of COPS messages that this client
 552         has received from COPS servers marked for this Client-Type that
 553         had a COPS protocol Op Code that should not have been sent to a
 554         COPS client e.g. Open-Requests. This value is cumulative since
 555         agent restart and is not zeroed on new connections."
 556     ::= { copsClientServerCurrentEntry 27 }
 557
 558 copsClientKaTimedoutClients OBJECT-TYPE
 559     SYNTAX     Counter32
 560     MAX-ACCESS  read-only
 561     STATUS      current
 562     DESCRIPTION
 563         "A count of the total number of times that this client has
 564         been shut down for this Client-Type by COPS servers that had
 565         detected a COPS protocol Keepalive timeout. This value is
 566         cumulative since agent restart and is not zeroed on new
 567         connections."
 568     ::= { copsClientServerCurrentEntry 28 }
 569
 570
 571 copsClientErrAuthFailures OBJECT-TYPE
 572     SYNTAX     Counter32
 573     MAX-ACCESS  read-only
 574     STATUS      current
 575     DESCRIPTION
 576         "A count of the total number of times that this client has
 577         received a COPS message marked for this Client-Type which
 578         could not be authenticated using the authentication mechanism
 579         used by this client."
 580     ::= { copsClientServerCurrentEntry 29 }
 581
 582 copsClientErrAuthMissing OBJECT-TYPE
 583     SYNTAX     Counter32
 584     MAX-ACCESS  read-only
 585     STATUS      current
 586     DESCRIPTION
 587         "A count of the total number of times that this client has
 588         received a COPS message marked for this Client-Type which did not
 589         contain authentication information."
 590     ::= { copsClientServerCurrentEntry 30 }
 591
 592
 593 -- -------------------------------------------------------------
 594
 595 copsClientConfigGroup OBJECT IDENTIFIER ::= { copsClientMIBObjects 3 }
 596
 597 -- -------------------------------------------------------------
 598
 599 copsClientServerConfigTable OBJECT-TYPE
 600      SYNTAX      SEQUENCE OF CopsClientServerConfigEntry
 601     MAX-ACCESS  not-accessible
 602     STATUS      current
 603     DESCRIPTION
 604         "Table of possible COPS servers to try to connect to in order
 605         of copsClientServerConfigPriority. There may be multiple
 606         entries in this table for the same server and client-type which
 607         specify different security mechanisms: these mechanisms will
 608         be attempted by the client in the priority order given. Note
 609         that a server learned by means of PDPRedirect always takes
 610         priority over any of these configured entries."
 611     ::= { copsClientConfigGroup 1 }
 612
 613 copsClientServerConfigEntry OBJECT-TYPE
 614     SYNTAX      CopsClientServerConfigEntry
 615     MAX-ACCESS  not-accessible
 616     STATUS      current
 617     DESCRIPTION
 618         "A set of configuration information regarding a single
 619
 620
 621         COPS server from the point of view of a COPS client."
 622     INDEX { copsClientServerConfigAddrType,
 623             copsClientServerConfigAddress,
 624             copsClientServerConfigClientType,
 625             copsClientServerConfigAuthType }
 626     ::= { copsClientServerConfigTable 1 }
 627
 628 CopsClientServerConfigEntry ::=
 629     SEQUENCE {
 630         copsClientServerConfigAddrType      InetAddressType,
 631         copsClientServerConfigAddress       InetAddress,
 632         copsClientServerConfigClientType    INTEGER,
 633         copsClientServerConfigAuthType      CopsAuthType,
 634         copsClientServerConfigTcpPort       CopsTcpPort,
 635         copsClientServerConfigPriority      Integer32,
 636         copsClientServerConfigRowStatus     RowStatus
 637     }
 638
 639 copsClientServerConfigAddrType OBJECT-TYPE
 640     SYNTAX      InetAddressType
 641     MAX-ACCESS  not-accessible
 642     STATUS      current
 643     DESCRIPTION
 644         "The type of address in copsClientServerConfigAddress."
 645     ::= { copsClientServerConfigEntry 1 }
 646
 647 copsClientServerConfigAddress OBJECT-TYPE
 648     SYNTAX      InetAddress
 649     MAX-ACCESS  not-accessible
 650     STATUS      current
 651     DESCRIPTION
 652         "The IPv4, IPv6 or DNS address of a COPS Server. Note that,
 653         since this is an index to the table, the DNS name must be
 654         short enough to fit into the maximum length of indices allowed
 655         by the management protocol in use."
 656     REFERENCE
 657         "RFC 2748 section 2.3"
 658     ::= { copsClientServerConfigEntry 2 }
 659
 660 copsClientServerConfigClientType OBJECT-TYPE
 661     SYNTAX      INTEGER (0..65535)
 662     MAX-ACCESS  not-accessible
 663     STATUS      current
 664     DESCRIPTION
 665         "The COPS protocol Client-Type for which this entry
 666         applies and for which this COPS server is capable
 667         of serving. Multiple Client-Types can be served by a
 668         single COPS server."
 669
 670
 671     REFERENCE
 672         "RFC 2748 section 6, IANA"
 673     ::= { copsClientServerConfigEntry 3 }
 674
 675 copsClientServerConfigAuthType OBJECT-TYPE
 676     SYNTAX      CopsAuthType
 677     MAX-ACCESS  not-accessible
 678     STATUS      current
 679     DESCRIPTION
 680         "The type of authentication mechanism for this COPS client
 681         to request when negotiating security at the start of a
 682         connection to a COPS server."
 683     REFERENCE
 684         "RFC 2748 section 4."
 685     ::= { copsClientServerConfigEntry 4 }
 686
 687
 688 copsClientServerConfigTcpPort OBJECT-TYPE
 689     SYNTAX      CopsTcpPort
 690     MAX-ACCESS  read-create
 691     STATUS      current
 692     DESCRIPTION
 693         "The TCP port number on the COPS server to which the
 694         client should connect."
 695     ::= { copsClientServerConfigEntry 5 }
 696
 697 copsClientServerConfigPriority OBJECT-TYPE
 698     SYNTAX      Integer32
 699     MAX-ACCESS  read-create
 700     STATUS      current
 701     DESCRIPTION
 702         "The priority of this entry relative to other entries.
 703         COPS client will attempt to contact COPS servers for the
 704         appropriate Client-Type. Higher numbers are tried first. The
 705         order to be used amongst server entries with the same priority
 706         is undefined. COPS servers that are notified to the client using
 707         the COPS protocol PDP-Redirect mechanism are always used in
 708         preference to any entries in this table."
 709     ::= { copsClientServerConfigEntry 6 }
 710
 711 copsClientServerConfigRowStatus OBJECT-TYPE
 712     SYNTAX      RowStatus
 713     MAX-ACCESS  read-create
 714     STATUS      current
 715     DESCRIPTION
 716         "State of this entry in the table."
 717     ::= { copsClientServerConfigEntry 7 }
 718
 719
 720
 721 copsClientServerConfigRetryAlgrm OBJECT-TYPE
 722     SYNTAX      INTEGER {
 723                     other(1),
 724                     sequential(2),
 725                     roundRobin(3)
 726                 }
 727     MAX-ACCESS  read-write
 728     STATUS      current
 729     DESCRIPTION
 730         "The algorithm by which the client should retry when it
 731          fails to connect to a COPS server."
 732     DEFVAL { sequential }
 733     ::= { copsClientConfigGroup 2 }
 734
 735 copsClientServerConfigRetryCount OBJECT-TYPE
 736     SYNTAX      Unsigned32
 737     MAX-ACCESS  read-write
 738     STATUS      current
 739     DESCRIPTION
 740         "A retry count for use by the retry algorithm.  Each retry
 741          algorithm needs to specify how it uses this value.
 742
 743          For the 'sequential(2)' algorithm, this value is the
 744          number of times the client should retry to connect
 745          to one COPS server before moving on to another.
 746          For the 'roundRobin(3)' algorithm, this value is not used."
 747     DEFVAL { 1 }
 748     ::= { copsClientConfigGroup 3 }
 749
 750 copsClientServerConfigRetryIntvl OBJECT-TYPE
 751     SYNTAX      TimeInterval
 752     UNITS       "centi-seconds"
 753     MAX-ACCESS  read-write
 754     STATUS      current
 755     DESCRIPTION
 756         "A retry interval for use by the retry algorithm.  Each retry
 757          algorithm needs to specify how it uses this value.
 758
 759          For the 'sequential(2)' algorithm, this value is the time to
 760          wait between retries of a connection to the same COPS server.
 761
 762          For the 'roundRobin(3)' algorithm, the client always attempts
 763          to connect to each Server in turn, until one succeeds or they
 764          all fail; if they all fail, then the client waits for the value
 765          of this interval before restarting the algorithm."
 766     DEFVAL { 1000 }
 767     ::= { copsClientConfigGroup 4 }
 768
 769
 770
 771 -- -------------------------------------------------------------
 772 -- Conformance Information
 773 -- -------------------------------------------------------------
 774
 775 copsClientConformance OBJECT IDENTIFIER ::= { copsClientMIB 2 }
 776
 777 copsClientGroups OBJECT IDENTIFIER ::= { copsClientConformance 1 }
 778 copsClientCompliances OBJECT IDENTIFIER ::= { copsClientConformance 2 }
 779
 780 -- -------------------------------------------------------------
 781 -- units of conformance
 782 -- -------------------------------------------------------------
 783
 784 copsDeviceStatusGroup OBJECT-GROUP
 785     OBJECTS {
 786         copsClientCapabilities,
 787         copsClientServerTcpPort, copsClientServerType,
 788         copsClientServerAuthType, copsClientServerLastConnAttempt,
 789         copsClientState, copsClientServerKeepaliveTime,
 790         copsClientServerAccountingTime, copsClientInPkts,
 791         copsClientOutPkts, copsClientInErrs, copsClientLastError,
 792         copsClientTcpConnectAttempts, copsClientTcpConnectFailures,
 793         copsClientOpenAttempts, copsClientOpenFailures,
 794         copsClientErrUnsupportClienttype,
 795         copsClientErrUnsupportedVersion, copsClientErrLengthMismatch,
 796         copsClientErrUnknownOpcode, copsClientErrUnknownCnum,
 797         copsClientErrBadCtype, copsClientErrBadSends,
 798         copsClientErrWrongObjects, copsClientErrWrongOpcode,
 799         copsClientKaTimedoutClients, copsClientErrAuthFailures,
 800         copsClientErrAuthMissing
 801     }
 802     STATUS      current
 803     DESCRIPTION
 804         "A collection of objects for monitoring the status of
 805         connections to COPS servers and statistics for a COPS client."
 806     ::= { copsClientGroups 1 }
 807
 808 copsDeviceConfigGroup OBJECT-GROUP
 809     OBJECTS {
 810         copsClientServerConfigTcpPort, copsClientServerConfigPriority,
 811         copsClientServerConfigRowStatus,
 812         copsClientServerConfigRetryAlgrm,
 813         copsClientServerConfigRetryCount,
 814         copsClientServerConfigRetryIntvl
 815     }
 816     STATUS      current
 817     DESCRIPTION
 818         "A collection of objects for configuring COPS server
 819
 820
 821         information."
 822     ::= { copsClientGroups 2 }
 823
 824 -- -------------------------------------------------------------
 825 -- compliance statements
 826 -- -------------------------------------------------------------
 827
 828 copsClientCompliance MODULE-COMPLIANCE
 829     STATUS  current
 830     DESCRIPTION
 831         "The compliance statement for device support of
 832         management of the COPS client."
 833
 834     MODULE
 835         MANDATORY-GROUPS {
 836             copsDeviceStatusGroup, copsDeviceConfigGroup
 837         }
 838
 839         OBJECT      copsClientServerConfigTcpPort
 840         MIN-ACCESS  read-only
 841         DESCRIPTION
 842             "Write access is required only if the device supports the
 843             configuration of COPS server information."
 844
 845         OBJECT      copsClientServerConfigPriority
 846         MIN-ACCESS  read-only
 847         DESCRIPTION
 848             "Write access is required only if the device supports the
 849             configuration of COPS server information."
 850
 851         OBJECT      copsClientServerConfigRowStatus
 852         MIN-ACCESS  read-only
 853         DESCRIPTION
 854             "Write access is required only if the device supports the
 855             configuration of COPS server information."
 856
 857         OBJECT      copsClientServerConfigRetryAlgrm
 858         MIN-ACCESS  read-only
 859         DESCRIPTION
 860             "Write access is required only if the device supports the
 861             configuration of COPS server information."
 862
 863         OBJECT      copsClientServerConfigRetryCount
 864         MIN-ACCESS  read-only
 865         DESCRIPTION
 866             "Write access is required only if the device supports the
 867             configuration of COPS server information."
 868
 869
 870
 871         OBJECT      copsClientServerConfigRetryIntvl
 872         MIN-ACCESS  read-only
 873         DESCRIPTION
 874             "Write access is required only if the device supports the
 875             configuration of COPS server information."
 876
 877        ::= { copsClientCompliances 1 }
 878
 879 END