CISCO-COPS-CLIENT-MIB

File: CISCO-COPS-CLIENT-MIB.mib (24286 bytes)

Imported modules

SNMPv2-SMI SNMPv2-CONF SNMPv2-TC
IF-MIB CISCO-SMI

Imported symbols

MODULE-IDENTITY OBJECT-TYPE Unsigned32
MODULE-COMPLIANCE OBJECT-GROUP TEXTUAL-CONVENTION
DisplayString RowStatus TruthValue
ifIndex ciscoMgmt

Defined Types

CopsRole  
A display string where valid letters are a-z, A-Z, 0-9, ., - and _. Name can not start with an '_'. Policies are assigned to a 'role', and one or more 'roles' are assigned to interfaces, such that an interface takes on the policies indirectly as the policies of the roles assigned to that interface.
TEXTUAL-CONVENTION    
  OCTET STRING Size(1..31)  

CopsRoleCombination  
A display string consisting of a set of roles concatenated with '+' characters where the roles are in lexicographic order from minimum to maximum. Policies are assigned to a 'role', and one or more 'roles' are assigned to interfaces, such that an interface takes on the policies indirectly as the policies of the roles assigned to that interface. When one or more roles assigned to an interface, that set of roles is known as a role-combination.
TEXTUAL-CONVENTION    
  OCTET STRING Size(0..255)  

CopsDomainName  
A display string where valid letters are a-z, A-Z, 0-9, ., - and _. Name can not start with an '_'. The COPS domain which a COPS client type belongs to. This is so that a COPS server supporting multiple domains can push the correct set of domain policies to a device.
TEXTUAL-CONVENTION    
  OCTET STRING Size(0..31)  

CopsClientType  
An enumerated value for all the supported COPS client type. rsvp(1) Resource Reservation Protocol(RSVP). RSVP is a signaling mechanism that the applications will use to signal parameters to the network, so that network can assign QoS for the application data stream. provisioning(2) Provisioning. A client type for COPS to support policy provisioning. This client type is independent of the type of policy (QoS, VPNs, Security, etc.) and it is based on the concept of PIBs (Policy Information Bases [PIB]).
TEXTUAL-CONVENTION    
  INTEGER rsvp(1), provisioning(2)  

CcopsServerConfigEntry  
SEQUENCE    
  ccopsServerConfigClientType CopsClientType
  ccopsServerConfigName DisplayString
  ccopsServerConfigPriority Unsigned32
  ccopsServerConfigPort Unsigned32
  ccopsServerConfigStatus RowStatus

CcopsDomainEntry  
SEQUENCE    
  ccopsDomainClientType CopsClientType
  ccopsDomainName CopsDomainName

CcopsRoleEntry  
SEQUENCE    
  ccopsRoleName CopsRole
  ccopsRoleStatus RowStatus

CcopsIfEntry  
SEQUENCE    
  ccopsIfRoleCombination CopsRoleCombination

Defined Values

ciscoCopsClientMIB 1.3.6.1.4.1.9.9.140
This MIB module is for configuration & statistic query of Common Open Policy Service(COPS) client feature on the Cisco device. COPS is a simple client/server model for supporting policy control over QoS Signaling Protocols and provisioned QoS resource management. COPS is a simple query and response protocol that can be used to exchange policy information between a policy server (Policy Decision Point or PDP) and its clients (Policy Enforcement Points or PEPs).
MODULE-IDENTITY    

ccopsMIBObjects 1.3.6.1.4.1.9.9.140.1
OBJECT IDENTIFIER    

ccopsGlobalObjects 1.3.6.1.4.1.9.9.140.1.1
OBJECT IDENTIFIER    

ccopsServerMax 1.3.6.1.4.1.9.9.140.1.1.1
Maximum number of configurable COPS servers allowed for each client type. A value of zero indicates no limitation on the number of configurable COPS servers.
OBJECT-TYPE    
  Unsigned32 0..65535  

ccopsMaxRole 1.3.6.1.4.1.9.9.140.1.1.2
Indicates the maximum number of roles supported by this device. A value of zero indicates no limitation on the number of roles.
OBJECT-TYPE    
  Unsigned32  

ccopsMaxRoleCombination 1.3.6.1.4.1.9.9.140.1.1.3
Indicates the maximum number of role-combinations supported by this device. A value of zero indicates no limitation on the number of role-combinations. Each CopsRoleCombination may contain up to ccopsMaxRole roles.
OBJECT-TYPE    
  Unsigned32  

ccopsServerConfigTable 1.3.6.1.4.1.9.9.140.1.1.4
A list of possible COPS servers that the COPS client will try to connect to in order of ccopsServerConfigPriority.
OBJECT-TYPE    
  SEQUENCE OF  
    CcopsServerConfigEntry

ccopsServerConfigEntry 1.3.6.1.4.1.9.9.140.1.1.4.1
A set of configuration information regarding a single COPS server from the point of view of a COPS client. The entry is created and deleted by using ccopsServerConfigStatus. An entry may not exist in the active state unless all objects in the entry have an appropriate value. Each client type can have its own COPS servers. By creating, deleting or modifying an entry in this table, users can add, delete or modify a COPS server for a particular client type for the device. In order to get policies from COPS server for a client type, user has to create an entry for such client type.
OBJECT-TYPE    
  CcopsServerConfigEntry  

ccopsServerConfigClientType 1.3.6.1.4.1.9.9.140.1.1.4.1.1
The type of policies to be retrieved from this server.
OBJECT-TYPE    
  CopsClientType  

ccopsServerConfigName 1.3.6.1.4.1.9.9.140.1.1.4.1.2
The IP address or the hostname of a COPS server. If a hostname is used, it will be resolved to an address prior to each attempt to setup a connection to a PDP. If the PEP cannot resolve the hostname, the connection attempt will fail. Use of IP address values is preferred, except in cases where a hostname must/should be used (e.g. if the PDP has a dynamic address)
OBJECT-TYPE    
  DisplayString Size(1..64)  

ccopsServerConfigPriority 1.3.6.1.4.1.9.9.140.1.1.4.1.3
The priority of this entry relative to other entries. The COPS client will attempt to contact COPS servers for the appropriate Client-Type in the order of their priority values. COPS servers designated by the COPS protocol PDP-Redirect mechanism are always used in preference to any entries in this table. When ccopsServerMax mib object is not zero, the valid value for ccopsServerConfigPriority ranges from zero to ccopsServerMax minus one. When the ccopsServerMax mib object is zero, any valid unsigned value may be used. For servers with different value of ccopsServerConfigPriority, the server with lowest value has highest priority. For servers with same value of ccopsServerConfigPriority and ccopsServerConfigClientType, the relative priority of Servers is determined by a numerical comparison of their IP addresses, with the lowest address having higher priority.
OBJECT-TYPE    
  Unsigned32 0..255  

ccopsServerConfigPort 1.3.6.1.4.1.9.9.140.1.1.4.1.4
The destination port number to which COPS server messages should be sent. By default the COPS service will be provided on the well-known COPS protocol port number 3288.
OBJECT-TYPE    
  Unsigned32 0..65535  

ccopsServerConfigStatus 1.3.6.1.4.1.9.9.140.1.1.4.1.5
The status of COPS server configuration for a client type. An entry may not exist in the active state unless all objects in the entry have an appropriate value. Once a row becomes active, value in any other column within such row cannot be modified except by setting ccopsServerConfigStatus to notInService(2) for such row.
OBJECT-TYPE    
  RowStatus  

ccopsInitialTimeout 1.3.6.1.4.1.9.9.140.1.1.5
If the device can not connect to the last connected COPS server, it uses this value for the initial retry time-out and then retries to connect after this time-out period. This value is re-used for the first retry after every successful connection. When the device is connecting to COPS server the first time or the last connected COPS server is no longer available, it will attempt to contact COPS servers existing in ccopsServerConfigTable for the appropriate Client-Type in the order of their priority values.
OBJECT-TYPE    
  Unsigned32 0..65535  

ccopsTimeoutIncrement 1.3.6.1.4.1.9.9.140.1.1.6
On every consecutive failure to connect to all existing COPS server for a client type, the COPS client increases the retry time-out by ccopsTimeoutIncrement but not greater than ccopsTimeoutMax.
OBJECT-TYPE    
  Unsigned32 0..65535  

ccopsTimeoutMax 1.3.6.1.4.1.9.9.140.1.1.7
The maximum retry time-out that the COPS client allows. On every consecutive failure to connect to all COPS servers, the COPS client increases the retry time-out up to ccopsTimeoutMax.
OBJECT-TYPE    
  Unsigned32 0..65535  

ccopsDomainTable 1.3.6.1.4.1.9.9.140.1.1.8
A list of COPS domains for each client type supported in the device.
OBJECT-TYPE    
  SEQUENCE OF  
    CcopsDomainEntry

ccopsDomainEntry 1.3.6.1.4.1.9.9.140.1.1.8.1
A set of domain configuration information regarding a single COPS client type. An entry will exist for each COPS client type which is supported in the device. For each COPS client type supported in the device, a domain name should be specified if the COPS server for that client type has multiple domains defined in its database.
OBJECT-TYPE    
  CcopsDomainEntry  

ccopsDomainClientType 1.3.6.1.4.1.9.9.140.1.1.8.1.1
The type of COPS client.
OBJECT-TYPE    
  CopsClientType  

ccopsDomainName 1.3.6.1.4.1.9.9.140.1.1.8.1.2
The COPS domain which this client type belongs to. This is so that a COPS server supporting multiple domains can push the correct set of domain policies to this device. Zero length name is default. COPS server have a default set of policies for clients who have zero length domain names. Changing the COPS domain name while qosPolicySource is cops(2) will result in requesting new policies from the cops server and configuring the device with those new policies. The value of ccopsDomainName is ignored if qosPolicySource is local(1).
OBJECT-TYPE    
  CopsDomainName  

ccopsRoleTable 1.3.6.1.4.1.9.9.140.1.1.9
A list of roles. The number of entries is determined by ccopsMaxRole.
OBJECT-TYPE    
  SEQUENCE OF  
    CcopsRoleEntry

ccopsRoleEntry 1.3.6.1.4.1.9.9.140.1.1.9.1
Entry containing COPS-PR role information. The entry is created, deleted and modified by using ccopsRoleStatus. There is a maximum on the number of roles which may be configured per device. In order to make a role available for interface to construct its role combination, such role must exist in the role table. Deleting a role in ccopsRoleTable also removes that role from all role combinations for all interfaces. Therefore, a particular role can not be added into the role combination for any interface if it is removed from this table.
OBJECT-TYPE    
  CcopsRoleEntry  

ccopsRoleName 1.3.6.1.4.1.9.9.140.1.1.9.1.1
The name of the role. Only roles which were defined in COPS server should be used. COPS server will only supply the policies for those roles defined in its database.
OBJECT-TYPE    
  CopsRole  

ccopsRoleStatus 1.3.6.1.4.1.9.9.140.1.1.9.1.2
This object is used to manage creation, deletion and modification of rows in this table. An entry may not exist in the active state unless all objects in the entry have an appropriate value. Once a row becomes active, value in any other column within such row cannot be modified except by setting ccopsRoleStatus to notInService(2) for such row. Deleting a row results in removing this ccopsRoleName from all role combinations in the ccopsIfTable
OBJECT-TYPE    
  RowStatus  

ccopsIfTable 1.3.6.1.4.1.9.9.140.1.1.10
A list of interface entries. An entry will exist for each interface which supports COPS-PR feature.
OBJECT-TYPE    
  SEQUENCE OF  
    CcopsIfEntry

ccopsIfEntry 1.3.6.1.4.1.9.9.140.1.1.10.1
Entry containing COPS status for a particular interface. By default each interface has no roles. It then has a role combination that is the zero length string. Roles in a role combination for an interface are reported to the PDP by the PEP. An interface may have multiple roles. Adding/deleting roles results in changes to the role combination for an interface. Therefore, a new set of QoS policies will be used for the interface with the new role combination.
OBJECT-TYPE    
  CcopsIfEntry  

ccopsIfRoleCombination 1.3.6.1.4.1.9.9.140.1.1.10.1.1
A display string, role combination, that is associated with an interface. This is the administratively-desired role combination which represents roles that are currently set by the administrator for a particular interface in the COPS domain. If copsMaxRoleCombination is one, the new role will be applied to all interfaces which support COPS feature on the device. Agent returns inconsistentValue if this role does not exist in ccopsRoleTable, resourceUnavailable if the role combination exceeds copsMaxRoleCombination in the device, wrongValue if a non-lexicographically-ordered value is written to it. On some platforms, roles may be assigned per port group rather than per port. If multiple ports belong to a port group, the role combination assigned to any of the ports in such group will apply to all ports in the same group. On some platforms, there can be a single role combination for the entire device. The role combination assigned to any of the interfaces will apply to all interfaces which support COPS feature in the device.
OBJECT-TYPE    
  CopsRoleCombination  

ccopsRoleConfigSupported 1.3.6.1.4.1.9.9.140.1.1.11
Indicates whether this device supports the ccopsMaxRole and ccopsRoleTable, and thereby, whether a role must be present in the ccopsRoleTable before it can be used within a value of ccopsIfRoleCombination.
OBJECT-TYPE    
  TruthValue  

ccopsMIBNotifications 1.3.6.1.4.1.9.9.140.2
OBJECT IDENTIFIER    

ccopsMIBConformance 1.3.6.1.4.1.9.9.140.3
OBJECT IDENTIFIER    

ccopsMIBCompliances 1.3.6.1.4.1.9.9.140.3.1
OBJECT IDENTIFIER    

ccopsMIBGroups 1.3.6.1.4.1.9.9.140.3.2
OBJECT IDENTIFIER    

ccopsMIBCompliance 1.3.6.1.4.1.9.9.140.3.1.1
The compliance statement for the CISCO-COPS-CLIENT-MIB.
MODULE-COMPLIANCE    

ccopsMIBComplianceRev2 1.3.6.1.4.1.9.9.140.3.1.2
The compliance statement for the CISCO-COPS-CLIENT-MIB.
MODULE-COMPLIANCE    

ccopsGlobalGroup 1.3.6.1.4.1.9.9.140.3.2.1
A collection of objects providing the COPS ability on the device. Devices implementing the COPS client feature should support this group.
OBJECT-GROUP    

ccopsGlobalGroupRev2 1.3.6.1.4.1.9.9.140.3.2.2
A collection of objects providing the COPS ability on the device.
OBJECT-GROUP    

ccopsRoleGroup 1.3.6.1.4.1.9.9.140.3.2.3
A collection of objects which allow an agent to require a limited set of allowed roles be specified, and to reject any role-combination containing any other role.
OBJECT-GROUP