POLICY-MANAGEMENT-MIB
File:
POLICY-MANAGEMENT-MIB.mib (36059 bytes)
Imported modules
Imported symbols
Defined Types
UTF8String |
|
An octet string containing information typically in
human-readable form.
To facilitate internationalization, this
information is represented using the ISO/IEC
IS 10646-1 character set, encoded as an octet
string using the UTF-8 transformation format
described in [RFC2279].
Since additional code points are added by
amendments to the 10646 standard from time
to time, implementations must be prepared to
encounter any code point from 0x00000000 to
0x7fffffff. Byte sequences that do not
correspond to the valid UTF-8 encoding of a
code point or are outside this range are
prohibited.
The use of control codes should be avoided.
When it is necessary to represent a newline,
the control code sequence CR LF should be used.
For code points not directly supported by user
interface hardware or software, an alternative
means of entry and display, such as hexadecimal,
may be provided.
For information encoded in 7-bit US-ASCII,
the UTF-8 encoding is identical to the
US-ASCII encoding.
UTF-8 may require multiple bytes to represent a
single character / code point; thus the length
of this object in octets may be different from
the number of characters encoded. Similarly,
size constraints refer to the number of encoded
octets, not the number of characters represented
by an encoding.
Note that when this TC is used for an object that
is used or envisioned to be used as an index, then
a SIZE restriction MUST be specified so that the
number of sub-identifiers for any object instance
does not exceed the limit of 128, as defined by
[RFC1905].
Note that the size of an UTF8String object is
measured in octets, not characters. |
TEXTUAL-CONVENTION |
|
|
|
|
OCTET STRING |
|
|
PmPolicyEntry |
|
SEQUENCE |
|
|
|
|
pmPolicyIndex |
Unsigned32 |
|
|
pmPolicyFilter |
UTF8String |
|
|
pmPolicyCalendar |
RowPointer |
|
|
pmPolicyAction |
UTF8String |
|
|
pmPolicyFilterMaxLatency |
Unsigned32 |
|
|
pmPolicyActionMaxLatency |
Unsigned32 |
|
|
pmPolicyPrecedence |
Unsigned32 |
|
|
pmPolicyGroup |
UTF8String |
|
|
pmPolicyDescription |
UTF8String |
|
|
pmPolicyMatches |
Gauge32 |
|
|
pmPolicyExecutionErrors |
Counter32 |
|
|
pmPolicyDebugging |
INTEGER |
|
|
pmPolicyStatus |
RowStatus |
|
PmElementTypeRegEntry |
|
SEQUENCE |
|
|
|
|
pmElementTypeRegIndex |
Unsigned32 |
|
|
pmElementTypeRegOIDPrefix |
OBJECT IDENTIFIER |
|
|
pmElementTypeRegName |
UTF8String |
|
|
pmElementTypeRegRowStatus |
RowStatus |
|
PmRoleESEntry |
|
SEQUENCE |
|
|
|
|
pmRoleESElement |
RowPointer |
|
|
pmRoleESString |
UTF8String |
|
|
pmRoleESStatus |
RowStatus |
|
PmRoleSEEntry |
|
SEQUENCE |
|
|
|
|
pmRoleSEString |
UTF8String |
|
|
pmRoleSEElement |
RowPointer |
|
PmCapabilitiesEntry |
|
SEQUENCE |
|
|
|
|
pmCapabilitiesIndex |
Unsigned32 |
|
|
pmCapabilitiesType |
OBJECT IDENTIFIER |
|
|
pmCapabilitiesSubType |
OBJECT IDENTIFIER |
|
|
pmCapabilitiesModificationOID |
OBJECT IDENTIFIER |
|
|
pmCapabilitiesModificationType |
INTEGER |
|
|
pmCapabilitiesModificationValue |
Integer32 |
|
|
pmCapabilitiesModificationString |
OCTET STRING |
|
PmTrackingPolicyToElementEntry |
|
SEQUENCE |
|
|
|
|
pmTrackingPolicyToElementElement |
RowPointer |
|
|
pmTrackingPolicyToElementStatus |
INTEGER |
|
PmTrackingElementToPolicyEntry |
|
SEQUENCE |
|
|
|
|
pmTrackingElementToPolicyElement |
RowPointer |
|
|
pmTrackingElementToPolicyStatus |
INTEGER |
|
PmDebuggingEntry |
|
SEQUENCE |
|
|
|
|
pmDebuggingElement |
RowPointer |
|
|
pmDebuggingLogIndex |
Unsigned32 |
|
|
pmDebuggingMessage |
UTF8String |
|
Defined Values
policyMgt |
1.3.6.1.3.107 |
The MIB module for rule-based configuration of SNMP
infrastructures. |
MODULE-IDENTITY |
|
|
|
pmPolicyTable |
1.3.6.1.3.107.1 |
The policy table. A policy is a pairing of a
policyFilter and a policyAction which is used to apply the
action to a selected set of elements. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
SEQUENCE OF |
|
|
|
|
PmPolicyEntry |
|
pmPolicyEntry |
1.3.6.1.3.107.1.1 |
An entry in the policy table. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
PmPolicyEntry |
|
|
pmPolicyIndex |
1.3.6.1.3.107.1.1.1 |
A unique index for this policy entry. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
|
|
pmPolicyFilter |
1.3.6.1.3.107.1.1.2 |
A policyFilter is an expression which results in a boolean
value which represents whether or not an element is a member
of a set of elements upon which an action is to be
performed.
The format of this expression is the policy expression
language. Filter evaluation stops immediately when any error
is detected without executing the policyAction.
The policyFilter is evaluated for various elements. Any
element for which the policyFilter returns any nonzero value
will match the filter and will have the associated
policyAction executed on that element. |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
UTF8String |
|
|
pmPolicyCalendar |
1.3.6.1.3.107.1.1.3 |
A pointer to an entry in the schedTable of the Scheduling
MIB [20]. This policy is active when specified by the
associated schedule entry.
If the value of this object is 0.0, this policy is always
active. |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
RowPointer |
|
|
pmPolicyAction |
1.3.6.1.3.107.1.1.4 |
A pmPolicyAction is an operation performed on a set of
elements. The format of this expression is the policy
expression language.
Action evaluation stops immediately when any error is
detected. |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
UTF8String |
|
|
pmPolicyFilterMaxLatency |
1.3.6.1.3.107.1.1.5 |
Every element under the control of this agent is
re-checked periodically to see if it is under control of this
policy by re-running the filter expression for this policy.
This object lets the manager control the maximum amount of
time that may pass before an element is re-checked.
In other words, in any given interval of this duration, all
elements must be re-checked. Note that it is an
implementation-dependent matter as to how the policy agent
schedules the checking of various elements within this
interval. |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
|
|
pmPolicyActionMaxLatency |
1.3.6.1.3.107.1.1.6 |
Every element that matches this policy's filter and is
therefore under control of this policy will have this policy's
action executed periodically to ensure that the element
remains in the state dictated by the policy.
This object lets the manager control the maximum amount of
time that may pass before an element has the action run on
it.
In other words, in any given interval of this duration, all
elements under control of this policy must have the action run
on them. Note that it is an implementation-dependent matter as
to how the policy agent schedules the policy action on various
elements within this interval. |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
|
|
pmPolicyPrecedence |
1.3.6.1.3.107.1.1.7 |
The order in which policies on the local system are
evaluated. A policy with a higher precedence value will
be evaluated after a policy with a lower precedence. For
example, a policy with a precedence value of 999 will be
evaluated after a policy with a precedence value of 998.
These values must be unique on the local policy system
that realizes this module. The value for a particular
policy should be the same across an administrative
domain, though that is not mandatory.
When the local policy system performs the evaluation in the
pmPolicyFilter for the policy identified by this row it will
also read the pmTrackingElementToPolicyStatus object for each
object returned as a result of the policy evaluation. If that
object is set to modified(3), then the pmPolicyAction shall
not be taken on that element.
The value of precedence(4), of pmTrackingElementToPolicyStatus
is an indication that when an evaluation was performed by
another policy, the pmTrackingElementToPolicyStatus was found
to have a value of on(1) and that policy had a higher
precedence value than the policy that initially set the value
of the pmTrackingElementToPolicyStatus to on(1). In this
event, the pmTrackingElementToPolicyPrecedence object shall
have the value of the pmPolicyIndex for the policy with the
higher precedence value entered. If the policy identified by
this row of the pmPolicyTable has a higher precedence value
than the value found in pmTrackingElementToPolicyPrecedence
then the pmPolicyAction should be performed on the element and
the pmTrackingElementToPolicyPrecedence object updated with
the value of the pmPolicyIndex for this policy. The only
exception to these rules is when the policy that has the
higher precedence value in not currently running, i.e., the
schedule is off. |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
0..65535 |
|
pmPolicyGroup |
1.3.6.1.3.107.1.1.8 |
An administratively assigned string that is used to group
policies. Any combination is legal, the pmPolicyGroup object
does not constrain precedence. That is precedence is evaluated
independent of grouping though adminstrators might group
related policies together for clarity. |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
UTF8String |
Size(0..32) |
|
pmPolicyDescription |
1.3.6.1.3.107.1.1.9 |
A description of this rule and its significance, typically
provided by a human. |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
UTF8String |
Size(0..255) |
|
pmPolicyMatches |
1.3.6.1.3.107.1.1.10 |
The number of elements that are currently matched by the
associated pmPolicyFilter. |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
Gauge32 |
|
|
pmPolicyExecutionErrors |
1.3.6.1.3.107.1.1.11 |
The number of times execution of this policy has been
terminated due to run-time errors. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
Counter32 |
|
|
pmPolicyDebugging |
1.3.6.1.3.107.1.1.12 |
The status of debugging for this policy. If this is turned
on(1), log entries will be created in the pmDebuggingTable
for each run-time error that is experienced by this policy. |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
INTEGER |
off(0), on(1) |
|
pmPolicyStatus |
1.3.6.1.3.107.1.1.13 |
The status of this pmPolicyEntry. |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
RowStatus |
|
|
pmElementTypeRegEntry |
1.3.6.1.3.107.2.1 |
A registration of an element type. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
PmElementTypeRegEntry |
|
|
pmElementTypeRegOIDPrefix |
1.3.6.1.3.107.2.1.2 |
An OBJECT IDENTIFIER subtree under which all instances of
this element type may be found.
This OBJECT IDENTIFIER should be specified up to, but not
including, any index objects. The agent will discover all
instances in the system that are members of the specified
subtree. It will then execute policy filters (and potentially
policy actions) for each instance discovered.
Each invocation of the policy filter will be supplied with a
parameter. This is derived by taking the last N
sub-identifiers from the discovered instance, where N is:
X = number of sub-identifiers in pmElementTypeRegOIDPrefix
Y = number of sub-identifiers in discovered instance
N = Y - X
|
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
OBJECT IDENTIFIER |
|
|
pmElementTypeRegName |
1.3.6.1.3.107.2.1.3 |
A descriptive label for this registered type. |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
UTF8String |
Size(0..32) |
|
pmRoleESTable |
1.3.6.1.3.107.3 |
The role string table with element as the major index. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
SEQUENCE OF |
|
|
|
|
PmRoleESEntry |
|
pmRoleESEntry |
1.3.6.1.3.107.3.1 |
A role string entry associates a role string with an
individual element. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
PmRoleESEntry |
|
|
pmRoleESElement |
1.3.6.1.3.107.3.1.1 |
The element to which this role string is associated.
If the agent assigns new indexes in the MIB table to
represent the same underlying element (re-indexing), the
agent will modify this value to contain the new index for the
underlying element. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
RowPointer |
|
|
pmRoleESString |
1.3.6.1.3.107.3.1.2 |
The role string that is associated with an element through
this table.
A role string is an administratively specified characteristic
of a managed element (for example, an interface). It is a
selector for policy rules, to determine the applicability of
the rule to a particular managed element. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
UTF8String |
Size(0..64) |
|
pmRoleESStatus |
1.3.6.1.3.107.3.1.3 |
The status of this role string. |
Status: current |
Access: read-create |
OBJECT-TYPE |
|
|
|
|
RowStatus |
|
|
pmRoleSETable |
1.3.6.1.3.107.4 |
A read-only version of the role string table with
roleString as the major index. The purpose of this
table is to make it easy to retrieve all elements that
share a common string. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
SEQUENCE OF |
|
|
|
|
PmRoleSEEntry |
|
pmRoleSEEntry |
1.3.6.1.3.107.4.1 |
A role string entry associates a role string with an
individual element. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
PmRoleSEEntry |
|
|
pmRoleSEString |
1.3.6.1.3.107.4.1.1 |
The role string that is associated with an element through
this table.
A role string is an administratively specified characteristic
of a managed element (for example, an interface). It is a
selector for policy rules, to determine the applicability of
the rule to a particular managed element. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
UTF8String |
Size(0..64) |
|
pmRoleSEElement |
1.3.6.1.3.107.4.1.2 |
The element to which this role string is associated.
If the agent assigns new indexes in the MIB table to
represent the same underlying element (re-indexing), the
agent will modify this value to contain the new index for the
underlying element. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
RowPointer |
|
|
pmCapabilitiesTable |
1.3.6.1.3.107.5 |
The pmCapabilitiesTable contains a description of
the inherent capabilities of the system. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
SEQUENCE OF |
|
|
|
|
PmCapabilitiesEntry |
|
pmCapabilitiesEntry |
1.3.6.1.3.107.5.1 |
The description of a capability or limitation of a
capability of the system. An entry will exist for each
domain and mechanism specific ability the system has. In
the case of a domain specific capability with no mechanism
specific parameters, the pmCapabilitiesSubType and all other
columns may be null. Entries will exist that contain
values for the pmCapabilitiesRestrictOID,
pmCapabilitiesRestrictType, pmCapabilitiesRestrictValue
and pmCapabilitiesRestrictString objects only when
an implementation is reporting a mechanism specific
restriction. Multiple entries are possible when more
than one restriction for a type or subtype are needed. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
PmCapabilitiesEntry |
|
|
pmCapabilitiesType |
1.3.6.1.3.107.5.1.2 |
The type of the capability represented by this entry.
The IANA will publish the list of identifiers that are valid
values for this object. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
OBJECT IDENTIFIER |
|
|
pmCapabilitiesSubType |
1.3.6.1.3.107.5.1.3 |
The sub type of capability is a pointer to a mechanism specific
set of capabilities supporting a base technology. In the case of
DIFFSERV, the OID value here would be the base OID of the
Differentiated Services Policy MIB Module. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
OBJECT IDENTIFIER |
|
|
pmCapabilitiesModificationOID |
1.3.6.1.3.107.5.1.4 |
The OID of the object that is either not supported, supported
with one or more limitations, or expanded by an implementation
specific module. If this columnar object is other than null then
there must be at least an entry in pmCapabilitiesModificationType.
Note that this need not be a leaf node or scalar object. If
an entire table is not supported, this value can be the base OID
for the table. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
OBJECT IDENTIFIER |
|
|
pmCapabilitiesModificationType |
1.3.6.1.3.107.5.1.5 |
An unsupported value indicates that the OID in
pmCapabilitiesModificationOID is not supported on
this system. A value of 1 indicates that the OID
is supported but with restricted values
These constraints are described in the
pmCapabilitiesModificationValue and
pmCapabilitiesModificationString objects. A value of
2 indicates a vendor specific extension to a standard.
The OID of the new object is pmCapabilitiesModificationOID.
For some implementations, additional functions may be
provided. addvalue indicates that this row of the table
describes an additional value that the object can take.
The specific value is in the pmCapabilitiesModificationValue.
The values of 4 and 5 indicate restrictions or the removal
of restrictions for the object identified. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
INTEGER |
unsupported(0), restricted(1), additional(2), addvalue(3), maxlimit(4), minlimit(5) |
|
pmCapabilitiesModificationValue |
1.3.6.1.3.107.5.1.6 |
If the value of pmCapabilitiesModificationType is 0, this
object will be null since 0 indicates no support for the
object at all. A value of 1 in the
pmCapabilitiesModificationType will be further modified by a
single integer value in this object that corresponds to
enumerated integer values that are not supported by the
system for the object that is identified in this row. This
value can also represent the limit values in the
pmCapabilitiesModificationType object. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
Integer32 |
0..2147483647 |
|
pmCapabilitiesModificationString |
1.3.6.1.3.107.5.1.7 |
Any additional details or description or parameters needed. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
OCTET STRING |
|
|
pmTrackingPolicyToElementEntry |
1.3.6.1.3.107.6.1 |
An entry in the pmTrackingPolicyToElementTable. The
pmPolicyIndex in the index specifies the policy tracked by
this entry. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
PmTrackingPolicyToElementEntry |
|
|
pmTrackingPolicyToElementStatus |
1.3.6.1.3.107.6.1.2 |
The status of this policy-element relationship. This value
will be 1 if the associated policyFilter returned 1 for this
element and if the calendar for the policy is active.
Entries will only exist in this table if their status is
on(1). Thus, on(1) is the only value of this object that can
be retrieved. This object exists so that it can serve as the
'payload' in the varbind instead of the
pmTrackingPolicyToElementElement object which is much longer
and is already in the index (it would otherwise be
duplicated). |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
INTEGER |
off(0), on(1) |
|
pmTrackingElementToPolicyEntry |
1.3.6.1.3.107.7.1 |
An entry in the pmTrackingElementToPolicyTable. The
pmPolicyIndex in the index specifies the policy tracked by
this entry. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
PmTrackingElementToPolicyEntry |
|
|
pmTrackingElementToPolicyStatus |
1.3.6.1.3.107.7.1.2 |
The status of this policy-element relationship. This value
will be 1 if the associated policyFilter returned 1 for this
element and if the calendar for the policy is active.
Entries will not exist in this table if their status would be
off(0).
A policy can be forcibly disabled on a particular element
by setting this value to forceOff(2). The agent should then
act as if the policyFilter failed for this element. The
forceOff(2) state will persist (even across reboots) until
this value is set to on(1) by a management request. Even if
the policyFilter later fails for this element, this value
will stay in the forceOff(2) state. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
INTEGER |
off(0), on(1), forceOff(2) |
|
pmDebuggingTable |
1.3.6.1.3.107.8 |
The pmDebuggingPolicyTable logs debugging messages when
policies experience runtime errors. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
SEQUENCE OF |
|
|
|
|
PmDebuggingEntry |
|
pmDebuggingEntry |
1.3.6.1.3.107.8.1 |
An entry in the pmDebuggingTable. The pmPolicyIndex in the
index specifies the policy that encountered the error that
led to this log entry. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
PmDebuggingEntry |
|
|
pmDebuggingElement |
1.3.6.1.3.107.8.1.1 |
The element the policy was executing on when it encountered
the error that led to this log entry. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
RowPointer |
|
|
pmDebuggingLogIndex |
1.3.6.1.3.107.8.1.2 |
A unique index for this log entry amongst other log entries
for this policy/element combination. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
|
|
pmDebuggingMessage |
1.3.6.1.3.107.8.1.3 |
An error message generated by the expression runtime system. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
UTF8String |
Size(0..128) |
|
pmGroups |
1.3.6.1.3.107.20.2 |
OBJECT IDENTIFIER |
|
|
|
pmCompliance |
1.3.6.1.3.107.20.1.1 |
Describes the requirements for conformance to
the Policy-Based Management MIB |
Status: current |
Access: read-only |
MODULE-COMPLIANCE |
|
|
|
pmPolicyManagementGroup |
1.3.6.1.3.107.20.2.1 |
Objects that allow for the creation and management of
configuration policies. |
Status: current |
Access: read-only |
OBJECT-GROUP |
|
|
|