CISCO-COPS-CLIENT-MIB
AI MIB Summary
The CISCO-COPS-CLIENT-MIB enables configuration and statistical monitoring of the Common Open Policy Service (COPS) client on Cisco devices, specifically tracking Policy Enforcement Point (PEP) session states, policy request/response counters, and resource management metrics for Quality of Service (QoS) signaling. This module facilitates the exchange of policy information between the local device and a central Policy Decision Point (PDP) to enforce QoS resource allocation.
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).
38
Objects
Active
Status
5
Dependencies
Imported Objects
Objects
38 total| Object Name |
|---|
ciscoCopsClientMIB OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.140 |
IMPORTS Unknown .1.3.6.1.4.1.9.9.140 |
ccopsMIBObjects OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.140.1 |
ccopsGlobalObjects OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.140.1.1 |
ccopsServerMaxMaximum number of configurable COPS servers allowed for
each client type. A value of zero indicates no limitation
on the number of configurable COPS servers.ro Unsigned32 .1.3.6.1.4.1.9.9.140.1.1.1 |
ccopsMaxRoleIndicates the maximum number of roles supported by
this device. A value of zero indicates no limitation on
the number of roles.ro Unsigned32 -- Rsyntax Gauge32 -- Units -- roles .1.3.6.1.4.1.9.9.140.1.1.2 |
ccopsMaxRoleCombinationIndicates 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.ro Unsigned32 -- Rsyntax Gauge32 -- Units -- role-combinations .1.3.6.1.4.1.9.9.140.1.1.3 |
ccopsServerConfigTableA list of possible COPS servers that the COPS client will
try to connect to in order of ccopsServerConfigPriority. SEQUENCE OF CcopsServerConfigEntry .1.3.6.1.4.1.9.9.140.1.1.4 |
ccopsServerConfigEntryA 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. CcopsServerConfigEntry .1.3.6.1.4.1.9.9.140.1.1.4.1 |
ccopsServerConfigClientTypeThe type of policies to be retrieved from this server. CopsClientType -- Rsyntax INTEGER { -- rsvp(1), -- provisioning(2) -- } .1.3.6.1.4.1.9.9.140.1.1.4.1.1 |
ccopsServerConfigNameThe 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) DisplayString .1.3.6.1.4.1.9.9.140.1.1.4.1.2 |
ccopsServerConfigPriorityThe 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.rw Unsigned32 .1.3.6.1.4.1.9.9.140.1.1.4.1.3 |
ccopsServerConfigPortThe 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.rw Unsigned32 .1.3.6.1.4.1.9.9.140.1.1.4.1.4 |
ccopsServerConfigStatusThe 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.rw RowStatus -- Rsyntax INTEGER { -- active(1), -- notInService(2), -- notReady(3), -- createAndGo(4), -- createAndWait(5), -- destroy(6) -- } .1.3.6.1.4.1.9.9.140.1.1.4.1.5 |
ccopsInitialTimeoutIf 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.rw Unsigned32 .1.3.6.1.4.1.9.9.140.1.1.5 |
ccopsTimeoutIncrementOn 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.rw Unsigned32 .1.3.6.1.4.1.9.9.140.1.1.6 |
ccopsTimeoutMaxThe 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.rw Unsigned32 .1.3.6.1.4.1.9.9.140.1.1.7 |
ccopsDomainTableA list of COPS domains for each client type supported in
the device. SEQUENCE OF CcopsDomainEntry .1.3.6.1.4.1.9.9.140.1.1.8 |
ccopsDomainEntryA 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. CcopsDomainEntry .1.3.6.1.4.1.9.9.140.1.1.8.1 |
ccopsDomainClientTypeThe type of COPS client. CopsClientType -- Rsyntax INTEGER { -- rsvp(1), -- provisioning(2) -- } .1.3.6.1.4.1.9.9.140.1.1.8.1.1 |
ccopsDomainNameThe 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).rw CopsDomainName -- Rsyntax OCTET STRING .1.3.6.1.4.1.9.9.140.1.1.8.1.2 |
ccopsRoleTableA list of roles. The number of entries is
determined by ccopsMaxRole. SEQUENCE OF CcopsRoleEntry .1.3.6.1.4.1.9.9.140.1.1.9 |
ccopsRoleEntryEntry 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. CcopsRoleEntry .1.3.6.1.4.1.9.9.140.1.1.9.1 |
ccopsRoleNameThe 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. CopsRole -- Rsyntax OCTET STRING .1.3.6.1.4.1.9.9.140.1.1.9.1.1 |
ccopsRoleStatusThis 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 ccopsIfTablerw RowStatus -- Rsyntax INTEGER { -- active(1), -- notInService(2), -- notReady(3), -- createAndGo(4), -- createAndWait(5), -- destroy(6) -- } .1.3.6.1.4.1.9.9.140.1.1.9.1.2 |
ccopsIfTableA list of interface entries. An entry will exist for each
interface which supports COPS-PR feature. SEQUENCE OF CcopsIfEntry .1.3.6.1.4.1.9.9.140.1.1.10 |
ccopsIfEntryEntry 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. CcopsIfEntry .1.3.6.1.4.1.9.9.140.1.1.10.1 |
ccopsIfRoleCombinationA 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.rw CopsRoleCombination -- Rsyntax OCTET STRING .1.3.6.1.4.1.9.9.140.1.1.10.1.1 |
ccopsRoleConfigSupportedIndicates 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.ro TruthValue -- Rsyntax INTEGER { -- true(1), -- false(2) -- } .1.3.6.1.4.1.9.9.140.1.1.11 |
ccopsMIBNotifications OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.140.2 |
ccopsMIBConformance OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.140.3 |
ccopsMIBCompliances OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.140.3.1 |
ccopsMIBCompliance OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.140.3.1.1 |
ccopsMIBComplianceRev2 OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.140.3.1.2 |
ccopsMIBGroups OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.140.3.2 |
ccopsGlobalGroup OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.140.3.2.1 |
ccopsGlobalGroupRev2 OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.140.3.2.2 |
ccopsRoleGroup OBJECT IDENTIFIER .1.3.6.1.4.1.9.9.140.3.2.3 |