-- extracted from draft-ietf-rap-cops-client-mib-00.txt -- at Mon Nov 15 17:11:15 1999 COPS-CLIENT-MIB DEFINITIONS ::= BEGIN -- ------------------------------------------------------------- -- ------------------------------------------------------------- IMPORTS MODULE-IDENTITY, OBJECT-TYPE, Counter32, IpAddress, Integer32 FROM SNMPv2-SMI TimeStamp, TimeInterval, RowStatus, TEXTUAL-CONVENTION FROM SNMPv2-TC MODULE-COMPLIANCE, OBJECT-GROUP FROM SNMPv2-CONF; -- REFERENCE -- "The COPS (Common Open Policy Service) Protocol -- draft-ietf-rap-cops-xx.txt" copsClientMIB MODULE-IDENTITY LAST-UPDATED "9906100000Z" ORGANIZATION "IETF RSVP Admission Policy Working Group" CONTACT-INFO " Andrew Smith (WG co-chair) Phone: +1 408 579 2821 Email: andrew@extremenetworks.com Tim O'Malley (WG co-chair) Phone: +1 617 873 3076 Email: timo@bbn.com" DESCRIPTION "The COPS Client MIB module" ::= { xxx 1 } copsClientMIBObjects OBJECT IDENTIFIER ::= { copsClientMIB 1 } -- ------------------------------------------------------------- -- Textual Conventions -- ------------------------------------------------------------- CopsClientState ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "A value indicating the state of a COPS client." SYNTAX INTEGER { copsClientInvalid(1), -- default state. copsClientTcpconnected(2), -- TCP connection up but COPS -- not yet open. copsClientAccepted(3), -- COPS server accepted the client copsClientTimingout(4) -- Keepalive timer has expired, -- client is in process of tearing -- down connection } CopsServerEntryType ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "A value indicating how a COPS server entry came into existence." SYNTAX INTEGER { copsServerStatic(1), -- configured by manager copsServerRedirect(2) -- notified by COPS server } CopsErrorCode ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "A value describing a COPS protocol error. Codes are identical to those used by the COPS protocol itself." SYNTAX INTEGER { errorOther(0), -- none of the below errorBadHandle(1), errorInvalidHandleReference(2), errorBadMessageFormat(3), errorUnableToProcess(4), errorMandatoryClientSiMissing(5), errorUnsupportedClientType(6), errorMandatoryCopsObjectMissing(7), errorClientFailure(8), errorCommunicationFailure(9), errorUnspecified(10), -- client-type specific subcode errorShuttingDown(11), errorRedirectToPreferredServer(12), errorUnknownCopsObject(13) } -- REFERENCE -- "COPS section 2.2.8" TcpPort ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "A value indicating a TCP protocol port number." SYNTAX INTEGER (0..65535) -- ------------------------------------------------------------- copsClientCapabilitiesGroup OBJECT IDENTIFIER ::= { copsClientMIBObjects 1 } -- ------------------------------------------------------------- -- -- Capabilities of the COPS client -- copsClientCapabilities OBJECT-TYPE SYNTAX BITS { copsClientVersion1(0), -- supports version1 of the COPS protocol copsClientIpSec(1) -- supports IP-SEC connections to COPS server } MAX-ACCESS read-only STATUS current DESCRIPTION "A list of the optional capabilities that this COPS client supports." ::= { copsClientCapabilitiesGroup 1 } -- ------------------------------------------------------------- copsClientStatusGroup OBJECT IDENTIFIER ::= { copsClientMIBObjects 2 } -- ------------------------------------------------------------- -- -- Current status of COPS server connections, all read-only. -- copsClientServerCurrentTable OBJECT-TYPE SYNTAX SEQUENCE OF CopsClientServerCurrentEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A table of information regarding COPS servers as seen from the point of view of a COPS client. This table contains entries for both statically-configured and dynamically-learned servers (from a PDP Redirect operation). One entry exists in this table for each COPS Client-Type served by the COPS server." ::= { copsClientStatusGroup 1 } copsClientServerCurrentEntry OBJECT-TYPE SYNTAX CopsClientServerCurrentEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A set of information regarding a single COPS server serving a single COPS Client-Type from the point of view of a COPS client." INDEX { copsClientServerIpAddress, copsClientServerClientType } ::= { copsClientServerCurrentTable 1 } CopsClientServerCurrentEntry ::= SEQUENCE { copsClientServerIpAddress IpAddress, copsClientServerClientType INTEGER, copsClientServerTcpPort TcpPort, copsClientServerType CopsServerEntryType, copsClientServerSecurityMode INTEGER, copsClientServerLastConnectAttempt TimeStamp, copsClientState CopsClientState, copsClientServerKeepaliveTime TimeInterval, copsClientServerAccountingTime TimeInterval, copsClientInPkts Counter32, copsClientOutPkts Counter32, copsClientInErrs Counter32, copsClientLastError CopsErrorCode, copsClientTcpConnectAttempts Counter32, copsClientTcpConnectFailures Counter32, copsClientOpenAttempts Counter32, copsClientOpenFailures Counter32, copsClientErrUnsupportedClienttype Counter32, copsClientErrUnsupportedVersion Counter32, copsClientErrLengthMismatch Counter32, copsClientErrUnknownOpcode Counter32, copsClientErrUnknownCnum Counter32, copsClientErrBadCtype Counter32, copsClientErrBadSends Counter32, copsClientErrWrongObjects Counter32, copsClientErrWrongOpcode Counter32, copsClientKaTimedoutClients Counter32 } copsClientServerIpAddress OBJECT-TYPE SYNTAX IpAddress MAX-ACCESS not-accessible STATUS current DESCRIPTION "The address of a COPS Server. It is assumed that the COPS service will be provided on the well-known COPS protocol port number." REFERENCE "COPS section 2.3" ::= { copsClientServerCurrentEntry 1 } copsClientServerClientType OBJECT-TYPE SYNTAX INTEGER (0..65535) MAX-ACCESS not-accessible STATUS current DESCRIPTION "The COPS protocol Client-Type for which this entry applies. Multiple Client-Types can be served by a single COPS server." REFERENCE "COPS section 6, IANA" ::= { copsClientServerCurrentEntry 2 } copsClientServerTcpPort OBJECT-TYPE SYNTAX TcpPort MAX-ACCESS read-only STATUS current DESCRIPTION "The TCP port number on the COPS server to which the client is connected." ::= { copsClientServerCurrentEntry 3 } copsClientServerType OBJECT-TYPE SYNTAX CopsServerEntryType MAX-ACCESS read-only STATUS current DESCRIPTION "Indicator of the source of this COPS server information. COPS servers may be configured by network management into copsClientServerConfigTable and appear in this entry with type copsServerStatic(1). Alternatively, the may be notified from another COPS server by means of the COPS PDP-Redirect mechanism and appear as copsServerRedirect(2)." ::= { copsClientServerCurrentEntry 4 } copsClientServerSecurityMode OBJECT-TYPE SYNTAX INTEGER { other(1), unknown(2), noSec(3), ipSec(4) } MAX-ACCESS read-only STATUS current DESCRIPTION "Indicator of the current security mode in use between client and this COPS server." ::= { copsClientServerCurrentEntry 5 } copsClientServerLastConnectAttempt OBJECT-TYPE SYNTAX TimeStamp MAX-ACCESS read-only STATUS current DESCRIPTION "Timestamp of the last time that this client attempted to connect to this COPS server." ::= { copsClientServerCurrentEntry 6 } copsClientState OBJECT-TYPE SYNTAX CopsClientState MAX-ACCESS read-only STATUS current DESCRIPTION "The state of the connection and COPS protocol with respect to this COPS server." ::= { copsClientServerCurrentEntry 7 } copsClientServerKeepaliveTime OBJECT-TYPE SYNTAX TimeInterval MAX-ACCESS read-only STATUS current DESCRIPTION "The value of the COPS protocol Keepalive timeout, in centiseconds, currently in use by this client, as specified by this COPS server in the Client-Accept operation. A value of zero indicates no keepalive activity is expected." REFERENCE "COPS section 3.7, 4.4" ::= { copsClientServerCurrentEntry 8 } copsClientServerAccountingTime OBJECT-TYPE SYNTAX TimeInterval MAX-ACCESS read-only STATUS current DESCRIPTION "The value of the COPS protocol Accounting timeout, in centiseconds, currently in use by this client, as specified by the COPS server in the Client-Accept operation. A value of zero indicates no accounting activity is to be performed." REFERENCE "COPS section 3.7" ::= { copsClientServerCurrentEntry 9 } copsClientInPkts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "A count of the total number of COPS packets that this client has received from this COPS server. This value is cumulative since agent restart and is not zeroed on new connections." ::= { copsClientServerCurrentEntry 10 } copsClientOutPkts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "A count of the total number of COPS packets that this client has sent to this COPS server. This value is cumulative since agent restart and is not zeroed on new connections." ::= { copsClientServerCurrentEntry 11 } copsClientInErrs OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "A count of the total number of COPS packets that this client has received from this COPS server that contained errors in syntax. This value is cumulative since agent restart and is not zeroed on new connections." ::= { copsClientServerCurrentEntry 12 } copsClientLastError OBJECT-TYPE SYNTAX CopsErrorCode MAX-ACCESS read-only STATUS current DESCRIPTION "The code contained in the last COPS protocol Error Object received by this client from this COPS server. This value is not zeroed on COPS Client-Open operations." REFERENCE "COPS section 2.2.8" ::= { copsClientServerCurrentEntry 13 } copsClientTcpConnectAttempts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "A count of the number of times that this COPS client has tried to open an TCP connection to a COPS server. This value is cumulative since agent restart and is not zeroed on new connections." ::= { copsClientServerCurrentEntry 14 } copsClientTcpConnectFailures OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "A count of the number of times that this COPS client has failed to open an TCP connection to a COPS server. This value is cumulative since agent restart and is not zeroed on new connections." ::= { copsClientServerCurrentEntry 15 } copsClientOpenAttempts OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "A count of the number of times that this COPS client has tried to perform a COPS Client-Open to a COPS server. This value is cumulative since agent restart and is not zeroed on new connections." ::= { copsClientServerCurrentEntry 16 } copsClientOpenFailures OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "A count of the number of times that this COPS client has failed to perform a COPS Client-Open to a COPS server. This value is cumulative since agent restart and is not zeroed on new connections." ::= { copsClientServerCurrentEntry 17 } copsClientErrUnsupportedClienttype OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "A count of the total number of COPS packets that this client has received from COPS servers that referred to Client-Types that are unsupported by this client. This value is cumulative since agent restart and is not zeroed on new connections." ::= { copsClientServerCurrentEntry 18 } copsClientErrUnsupportedVersion OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "A count of the total number of COPS packets that this client has received from COPS servers that had a COPS protocol Version number that is unsupported by this client. This value is cumulative since agent restart and is not zeroed on new connections." ::= { copsClientServerCurrentEntry 19 } copsClientErrLengthMismatch OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "A count of the total number of COPS packets that this client has received from COPS servers that had a COPS protocol Message Length that did not match the actual received packet. This value is cumulative since agent restart and is not zeroed on new connections." ::= { copsClientServerCurrentEntry 20 } copsClientErrUnknownOpcode OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "A count of the total number of COPS packets that this client has received from COPS servers that had a COPS protocol Op Code that was unrecognised by this client. This value is cumulative since agent restart and is not zeroed on new connections." ::= { copsClientServerCurrentEntry 21 } copsClientErrUnknownCnum OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "A count of the total number of COPS packets that this client has received from COPS servers that contained a COPS protocol object C-Num that was unrecognised by this client. This value is cumulative since agent restart and is not zeroed on new connections." ::= { copsClientServerCurrentEntry 22 } copsClientErrBadCtype OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "A count of the total number of COPS packets that this client has received from COPS servers that contained a COPS protocol object C-Type that was not defined for the C-Nums known by this client. This value is cumulative since agent restart and is not zeroed on new connections." ::= { copsClientServerCurrentEntry 23 } copsClientErrBadSends OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "A count of the total number of COPS packets that this client attempted to send to COPS servers that resulted in a transmit error. This value is cumulative since agent restart and is not zeroed on new connections." ::= { copsClientServerCurrentEntry 24 } copsClientErrWrongObjects OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "A count of the total number of COPS packets that this client has received from COPS servers that did not contain a permitted set of COPS protocol objects. This value is cumulative since agent restart and is not zeroed on new connections." ::= { copsClientServerCurrentEntry 25 } copsClientErrWrongOpcode OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "A count of the total number of COPS packets that this client has received from COPS servers that had a COPS protocol Op Code that should not have been sent to a COPS client e.g. Open-Requests. This value is cumulative since agent restart and is not zeroed on new connections." ::= { copsClientServerCurrentEntry 26 } copsClientKaTimedoutClients OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "A count of the total number of times that this client has been shut down by COPS servers that had detected a COPS protocol Keepalive timeout. This value is cumulative since agent restart and is not zeroed on new connections." ::= { copsClientServerCurrentEntry 27 } -- ------------------------------------------------------------- copsClientConfigGroup OBJECT IDENTIFIER ::= { copsClientMIBObjects 3 } -- ------------------------------------------------------------- copsClientServerConfigTable OBJECT-TYPE SYNTAX SEQUENCE OF CopsClientServerConfigEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Table of possible COPS servers to try to connect to in order of copsClientServerConfigPriority. Note that a PDPRedirect always takes precedence over any locally configured priority." ::= { copsClientConfigGroup 1 } copsClientServerConfigEntry OBJECT-TYPE SYNTAX CopsClientServerConfigEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A set of configuration information regarding a single COPS server from the point of view of a COPS client." INDEX { copsClientServerConfigIpAddress, copsClientServerConfigClientType } ::= { copsClientServerConfigTable 1 } CopsClientServerConfigEntry ::= SEQUENCE { copsClientServerConfigIpAddress IpAddress, copsClientServerConfigClientType INTEGER, copsClientServerConfigTcpPort TcpPort, copsClientServerConfigPriority Integer32, copsClientServerConfigRetryCount Integer32, copsClientServerConfigRetryInterval TimeInterval, copsClientServerConfigRowStatus RowStatus } copsClientServerConfigIpAddress OBJECT-TYPE SYNTAX IpAddress MAX-ACCESS not-accessible STATUS current DESCRIPTION "The address of a COPS Server. It is assumed that the COPS service will be provided on the well-known COPS protocol port number." REFERENCE "COPS section 2.3" ::= { copsClientServerConfigEntry 1 } copsClientServerConfigClientType OBJECT-TYPE SYNTAX INTEGER (0..65535) MAX-ACCESS not-accessible STATUS current DESCRIPTION "The COPS protocol Client-Type for which this entry applies and for which this COPS server is capable of serving. Multiple Client-Types can be served by a single COPS server." REFERENCE "COPS section 6, IANA" ::= { copsClientServerConfigEntry 2 } copsClientServerConfigTcpPort OBJECT-TYPE SYNTAX TcpPort MAX-ACCESS read-create STATUS current DESCRIPTION "The TCP port number on the COPS server to which the client should connect." ::= { copsClientServerConfigEntry 3 } copsClientServerConfigPriority OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-create STATUS current DESCRIPTION "The priority of this entry relative to other entries. COPS client will attempt to contact COPS servers for the appropriate Client-Type in the order of their priority values. The order to be used amongst server entries with the same priority is undefined. COPS servers that are notified to the client using the COPS protocol PDP-Redirect mechanism are always used in preference to any entries in this table." ::= { copsClientServerConfigEntry 4 } copsClientServerConfigRetryCount OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-create STATUS current DESCRIPTION "The number of times the client should retry to connect to this COPS server before moving on to another server." DEFVAL { 1 } ::= { copsClientServerConfigEntry 5 } copsClientServerConfigRetryInterval OBJECT-TYPE SYNTAX TimeInterval UNITS "centi-seconds" MAX-ACCESS read-create STATUS current DESCRIPTION "The time to wait between retrying to connect to this COPS server." DEFVAL { 1000 } ::= { copsClientServerConfigEntry 6 } copsClientServerConfigRowStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "State of this entry in the table." ::= { copsClientServerConfigEntry 7 } -- ------------------------------------------------------------- -- Conformance Information -- ------------------------------------------------------------- copsClientConformance OBJECT IDENTIFIER ::= { copsClientMIB 2 } copsClientGroups OBJECT IDENTIFIER ::= { copsClientConformance 1 } copsClientCompliances OBJECT IDENTIFIER ::= { copsClientConformance 2 } -- ------------------------------------------------------------- -- units of conformance -- ------------------------------------------------------------- copsDeviceStatusGroup OBJECT-GROUP OBJECTS { copsClientCapabilities, copsClientServerTcpPort, copsClientServerType, copsClientServerSecurityMode, copsClientServerLastConnectAttempt, copsClientState, copsClientServerKeepaliveTime, copsClientServerAccountingTime, copsClientInPkts, copsClientOutPkts, copsClientInErrs, copsClientLastError, copsClientTcpConnectAttempts, copsClientTcpConnectFailures, copsClientOpenAttempts, copsClientOpenFailures, copsClientErrUnsupportedClienttype, copsClientErrUnsupportedVersion, copsClientErrLengthMismatch, copsClientErrUnknownOpcode, copsClientErrUnknownCnum, copsClientErrBadCtype, copsClientErrBadSends, copsClientErrWrongObjects, copsClientErrWrongOpcode, copsClientKaTimedoutClients } STATUS current DESCRIPTION "A collection of objects for monitoring the status of connections to COPS servers and statistics for a COPS client." ::= { copsClientGroups 1 } copsDeviceConfigGroup OBJECT-GROUP OBJECTS { copsClientServerConfigTcpPort, copsClientServerConfigPriority, copsClientServerConfigRetryCount, copsClientServerConfigRetryInterval, copsClientServerConfigRowStatus } STATUS current DESCRIPTION "A collection of objects for configuring COPS server information." ::= { copsClientGroups 2 } -- ------------------------------------------------------------- -- compliance statements -- ------------------------------------------------------------- copsClientCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for device support of management of the COPS client." MODULE MANDATORY-GROUPS { copsDeviceStatusGroup, copsDeviceConfigGroup } OBJECT copsClientServerConfigTcpPort MIN-ACCESS read-only DESCRIPTION "Write access is required only if the device supports the configuration of COPS server information." OBJECT copsClientServerConfigPriority MIN-ACCESS read-only DESCRIPTION "Write access is required only if the device supports the configuration of COPS server information." OBJECT copsClientServerConfigRetryCount MIN-ACCESS read-only DESCRIPTION "Write access is required only if the device supports the configuration of COPS server information." OBJECT copsClientServerConfigRetryInterval MIN-ACCESS read-only DESCRIPTION "Write access is required only if the device supports the configuration of COPS server information." OBJECT copsClientServerConfigRowStatus MIN-ACCESS read-only DESCRIPTION "Write access is required only if the device supports the configuration of COPS server information." ::= { copsClientCompliances 1 } END