This MIB defines objects that describe dynamic templates. A dynamic template is a set of configuration attributes that a system can dynamically apply to a target.
The target of a dynamic template is the entity configured by the system using the configuration attributes contained by a template. At the time of this writing, an interface represents the only valid target of a dynamic template. However, the architecture does not prevent other target types, and hence, the MIB definition generalizes the notion of a target to allow for this.
Generally, the system does not directly apply the attributes contained by a dynamic template to an associated target. The system might generate a derived configuration from the set of dynamic templates associated with the target. A derived configuration represents the union of the configuration attributes contained by each associated dynamic template. In the case of a conflict (i.e., more than one dynamic template specifies the same configuration attribute), the system accepts the configuration attribute from the dynamic template with the highest precedence.
This table lists the dynamic templates maintained by the system, including those that have been locally-configured on the system and those pushed to the system by external policy servers.
cdtTemplateName
1.3.6.1.4.1.9.9.784.1.1.1.1.1
DynamicTemplateNameA string-value that identifies a dynamic template. The semantics of the string-value are the same as those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB [RFC3411].Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (1..64) · OCTET STRING
This object indicates a string-value that uniquely identifies the dynamic template.
If the corresponding instance of cdtTemplateSrc is not 'local', then the system automatically generates the name identifying the dynamic template.
cdtTemplateStatus
1.3.6.1.4.1.9.9.784.1.1.1.1.2
RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of [2].)
The status column has six defined values:
- `active', which indicates that the conceptual row is available for use by the managed device;
- `notInService', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device;
- `notReady', which indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instanciated);
- `createAndGo', which is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device;
- `createAndWait', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device); and, - `destroy', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row.
Whereas five of the six values (all except `notReady') may be specified in a management protocol set operation, only three values will be returned in response to a management
protocol retrieval operation: `notReady', `notInService' or
`active'. That is, when queried, an existing conceptual row
has only three states: it is either available for use by
the managed device (the status column has value `active'); it is not available for use by the managed device, though the agent has sufficient information to attempt to make it so (the status column has value `notInService'); or, it is not available for use by the managed device, and an attempt to make it so would fail because the agent has insufficient information (the state column has value `notReady').
NOTE WELL
This textual convention may be used for a MIB table, irrespective of whether the values of that table's conceptual rows are able to be modified while it is active, or whether its conceptual rows must be taken out of service in order to be modified. That is, it is the responsibility of the DESCRIPTION clause of the status column to specify whether the status column must not be `active' in order for the value of some other column of the same conceptual row to be modified. If such a specification is made, affected columns may be changed by an SNMP set PDU if the RowStatus would not be equal to `active' either immediately before or after processing the PDU. In other words, if the PDU also contained a varbind that would change the RowStatus value, the column in question may be changed if the RowStatus was not equal to `active' as the PDU was received, or if the varbind sets the status to a value other than 'active'.
Also note that whenever any elements of a row exist, the RowStatus column must also exist.
To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram:
STATE +--------------+-----------+-------------+-------------
| A | B | C | D
| |status col.|status column|
|status column | is | is |status column
ACTION |does not exist| notReady | notInService| is active
--------------+--------------+-----------+-------------+-------------
set status |noError ->D|inconsist- |inconsistent-|inconsistent-
column to | or | entValue| Value| Value
createAndGo |inconsistent- | | |
| Value| | |
--------------+--------------+-----------+-------------+-------------
set status |noError see 1|inconsist- |inconsistent-|inconsistent-
column to | or | entValue| Value| Value
createAndWait |wrongValue | | |
--------------+--------------+-----------+-------------+-------------
set status |inconsistent- |inconsist- |noError |noError
column to | Value| entValue| |
active | | | |
| | or | |
| | | |
| |see 2 ->D|see 8 ->D| ->D
--------------+--------------+-----------+-------------+-------------
set status |inconsistent- |inconsist- |noError |noError ->C
column to | Value| entValue| |
notInService | | | |
| | or | | or
| | | |
| |see 3 ->C| ->C|see 6
--------------+--------------+-----------+-------------+-------------
set status |noError |noError |noError |noError ->A
column to | | | | or
destroy | ->A| ->A| ->A|see 7
--------------+--------------+-----------+-------------+-------------
set any other |see 4 |noError |noError |see 5
column to some| | | |
value | | see 1| ->C| ->D
--------------+--------------+-----------+-------------+-------------
(1) goto B or C, depending on information available to the agent.
(2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D.
(3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C.
(4) at the discretion of the agent, the return value may be either:
inconsistentName: because the agent does not choose to
create such an instance when the corresponding RowStatus instance does not exist, or
inconsistentValue: if the supplied value is
inconsistent with the state of some other MIB object's value, or
noError: because the agent chooses to create the instance.
If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A.
(5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned.
(6) the return value can indicate one of the following errors:
wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or
inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated.
(7) the return value can indicate the following error:
inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated.
(8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue.
NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc.
Conceptual Row Creation
There are four potential interactions when creating a
conceptual row: selecting an instance-identifier which is
not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device.
Interaction 1: Selecting an Instance-Identifier
The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics.
In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.)
Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different.
Finally, the management station could select a pseudo-random number to use as the index. In the event that this index
was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation.
A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used.
Interaction 2: Creating the Conceptual Row
Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions.
Interaction 2a: Creating and Activating the Conceptual Row
The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes:
- a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1.
- the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created.
- the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column.
Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'.
When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information
available to the agent is provided by two sources: the
management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row.
NOTE WELL
Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm.
Interaction 2b: Negotiating the Creation of the Conceptual Row
The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the
columns indicated by its column requirements.) Otherwise,
the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3.
Interaction 3: Initializing non-defaulted Objects
The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes:
- a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column.
- the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column.
- the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column.
If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4.
Interaction 4: Making the Conceptual Row Available
Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'.
NOTE WELL
A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device.
If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row.
Conceptual Row Suspension
When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified).
Conceptual Row Deletion
For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady',
`notInService' or `active'.) If the operation succeeds,
then all instances associated with the conceptual row are immediately removed. · Integer32
This object specifies the status of the dynamic template. The following columns must be valid before activating a dynamic template:
- cdtTemplateStorage - cdtTemplateType
However, these objects specify a default value. Thus, it is possible to use create-and-go semantics without setting any additional columns.
An implementation must allow the EMS/NMS to modify any column when this column is 'active', including columns defined in tables that have a one-to-one or sparse dependent relationship on this table.
cdtTemplateStorage
1.3.6.1.4.1.9.9.784.1.1.1.1.3
StorageType1 = other2 = volatile3 = nonVolatile4 = permanent5 = readOnlyDescribes the memory realization of a conceptual row. A row which is volatile(2) is lost upon reboot. A row which is either nonVolatile(3), permanent(4) or readOnly(5), is backed up by stable storage. A row which is permanent(4) can be changed but not deleted. A row which is readOnly(5) cannot be changed nor deleted.
If the value of an object with this syntax is either permanent(4) or readOnly(5), it cannot be written. Conversely, if the value is either other(1), volatile(2) or nonVolatile(3), it cannot be modified to be permanent(4) or readOnly(5). (All illegal modifications result in a 'wrongValue' error.)
Every usage of this textual convention is required to specify the columnar objects which a permanent(4) row must at a minimum allow to be writable. · Integer32
This object specifies what happens to the dynamic template upon restart.
If the corresponding instance of cdtTemplateSrc is not 'local', then this column must be 'volatile'.
cdtTemplateType
1.3.6.1.4.1.9.9.784.1.1.1.1.4
DynamicTemplateType1 = other2 = derived3 = ppp4 = ethernet5 = ipSubscriber6 = serviceAn enumerated integer-value describing the type of dynamic template:
'other' The implementation of the MIB module using this textual convention does not recognize the type of dynamic template.
'derived' A configuration resulting from the union of the attributes contained by all the dynamic templates associated with a target. The system generates a derived configuration, and an EMS/NMS cannot directly modify it. An EMS/NMS can only affect a derived configuration by modifying one or more of the dynamic templates associated with the target.
'ppp' A PPP template is a set of locally-configured attributes relating to the configuration of a PPP interface.
'ethernet' An Ethernet template is a set of locally-configured attributes used by the system to configure dynamic interfaces initiated on Ethernet virtual interfaces (e.g., EoMPLS) or automatically created VLANs.
'ipSubscriber' An IP subscriber template is a set of locally-configured attributes used by the system to configure certain types of IP and L2 subscriber sessions.
'service' A service template is a set of locally-configured attributes used by the system to configure subscriber sessions. These attributes specifically relate to services, and the system applies these attributes in response to subscriber session life-cycle events. · Integer32
This object indicates the types of dynamic template.
This object specifies the source of the dynamic template:
'other' The implementation of the MIB module does not recognize the source of the dynamic template.
'derived' The system created the set of attributes from one or more dynamic templates.
'local' The dynamic template was locally configured through a management entity, such as the local console or a SNMP entity.
'aaaUserProfile' The dynamic template originated from a user profile pushed from an external policy server.
'aaaServiceProfile' The dynamic template originated from a service profile pushed from an external policy server.
cdtTemplateUsageCount
1.3.6.1.4.1.9.9.784.1.1.1.1.6
Unsigned32
This object specifies the number of targets using a dynamic template
This table contains a list of targets associated with one or more dynamic templates.
cdtTemplateTargetType
1.3.6.1.4.1.9.9.784.1.1.2.1.1
DynamicTemplateTargetType1 = other2 = interfaceAn enumerated integer-value describing the type of target associated with one or more dynamic templates:
'other' The implementation of the MIB module using this textual convention does not recognize the type of target.
'interface' The target is a physical, logical, or virtual interface represented by an ifEntry (defined by the IF-MIB).
An implementation must ensure that DynamicTemplateTargetType object and any associated DynamicTemplateTargetId objects are consistent. An attempt to set a DynamicTemplateTargetType object to a value inconsistent with the associated DynamicTemplateTargetId object must result in a response with an error-status of 'inconsistentValue'.Reference: K. McCloghrie and F. Kastenholtz, 'The Interfaces Group MIB', RFC-2863, June 2000. · Integer32
This object indicates the type of target.
cdtTemplateTargetId
1.3.6.1.4.1.9.9.784.1.1.2.1.2
DynamicTemplateTargetIdAn binary string-value in network byte order identifying a target associated with one or more dynamic templates.
An implementation must interpret a DynamicTemplateTargetId value within the context of a DynamicTemplateTargetType. Every usage of the DynamicTemplateTargetId textual convention must have a corresponding object specifying the DynamicTemplateType that provides this context. It is most appropriate that a MIB module logical registers the DynamicTemplateType object before the use of the DynamicTemplateTargetId textual convention within the same logical row.
The value of a DynamicTemplateTargetId object must always be consistent with the value of the associated DynamicTemplateTargetType object. An attempt to set a DynamicTemplateTargetId object to a value inconsistent with the with the associated DynamicTemplateTargetType object must result in a response with an error-status of 'inconsistentValue'.
If the DynamicTemplateTargetType is 'interface', then the representation of DynamicTemplateTargetId is as below
octets contents encoding
1-4 ifIndex network-byte orderReference: K. McCloghrie and F. Kastenholtz, 'The Interfaces Group MIB', RFC-2863, June 2000. SIZE (1..20) · OCTET STRING
This object uniquely identifies the target within the scope of its type.
cdtTemplateTargetStatus
1.3.6.1.4.1.9.9.784.1.1.2.1.3
RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of [2].)
The status column has six defined values:
- `active', which indicates that the conceptual row is available for use by the managed device;
- `notInService', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device;
- `notReady', which indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instanciated);
- `createAndGo', which is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device;
- `createAndWait', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device); and, - `destroy', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row.
Whereas five of the six values (all except `notReady') may be specified in a management protocol set operation, only three values will be returned in response to a management
protocol retrieval operation: `notReady', `notInService' or
`active'. That is, when queried, an existing conceptual row
has only three states: it is either available for use by
the managed device (the status column has value `active'); it is not available for use by the managed device, though the agent has sufficient information to attempt to make it so (the status column has value `notInService'); or, it is not available for use by the managed device, and an attempt to make it so would fail because the agent has insufficient information (the state column has value `notReady').
NOTE WELL
This textual convention may be used for a MIB table, irrespective of whether the values of that table's conceptual rows are able to be modified while it is active, or whether its conceptual rows must be taken out of service in order to be modified. That is, it is the responsibility of the DESCRIPTION clause of the status column to specify whether the status column must not be `active' in order for the value of some other column of the same conceptual row to be modified. If such a specification is made, affected columns may be changed by an SNMP set PDU if the RowStatus would not be equal to `active' either immediately before or after processing the PDU. In other words, if the PDU also contained a varbind that would change the RowStatus value, the column in question may be changed if the RowStatus was not equal to `active' as the PDU was received, or if the varbind sets the status to a value other than 'active'.
Also note that whenever any elements of a row exist, the RowStatus column must also exist.
To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram:
STATE +--------------+-----------+-------------+-------------
| A | B | C | D
| |status col.|status column|
|status column | is | is |status column
ACTION |does not exist| notReady | notInService| is active
--------------+--------------+-----------+-------------+-------------
set status |noError ->D|inconsist- |inconsistent-|inconsistent-
column to | or | entValue| Value| Value
createAndGo |inconsistent- | | |
| Value| | |
--------------+--------------+-----------+-------------+-------------
set status |noError see 1|inconsist- |inconsistent-|inconsistent-
column to | or | entValue| Value| Value
createAndWait |wrongValue | | |
--------------+--------------+-----------+-------------+-------------
set status |inconsistent- |inconsist- |noError |noError
column to | Value| entValue| |
active | | | |
| | or | |
| | | |
| |see 2 ->D|see 8 ->D| ->D
--------------+--------------+-----------+-------------+-------------
set status |inconsistent- |inconsist- |noError |noError ->C
column to | Value| entValue| |
notInService | | | |
| | or | | or
| | | |
| |see 3 ->C| ->C|see 6
--------------+--------------+-----------+-------------+-------------
set status |noError |noError |noError |noError ->A
column to | | | | or
destroy | ->A| ->A| ->A|see 7
--------------+--------------+-----------+-------------+-------------
set any other |see 4 |noError |noError |see 5
column to some| | | |
value | | see 1| ->C| ->D
--------------+--------------+-----------+-------------+-------------
(1) goto B or C, depending on information available to the agent.
(2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D.
(3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C.
(4) at the discretion of the agent, the return value may be either:
inconsistentName: because the agent does not choose to
create such an instance when the corresponding RowStatus instance does not exist, or
inconsistentValue: if the supplied value is
inconsistent with the state of some other MIB object's value, or
noError: because the agent chooses to create the instance.
If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A.
(5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned.
(6) the return value can indicate one of the following errors:
wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or
inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated.
(7) the return value can indicate the following error:
inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated.
(8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue.
NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc.
Conceptual Row Creation
There are four potential interactions when creating a
conceptual row: selecting an instance-identifier which is
not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device.
Interaction 1: Selecting an Instance-Identifier
The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics.
In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.)
Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different.
Finally, the management station could select a pseudo-random number to use as the index. In the event that this index
was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation.
A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used.
Interaction 2: Creating the Conceptual Row
Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions.
Interaction 2a: Creating and Activating the Conceptual Row
The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes:
- a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1.
- the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created.
- the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column.
Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'.
When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information
available to the agent is provided by two sources: the
management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row.
NOTE WELL
Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm.
Interaction 2b: Negotiating the Creation of the Conceptual Row
The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the
columns indicated by its column requirements.) Otherwise,
the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3.
Interaction 3: Initializing non-defaulted Objects
The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes:
- a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column.
- the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column.
- the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column.
If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4.
Interaction 4: Making the Conceptual Row Available
Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'.
NOTE WELL
A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device.
If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row.
Conceptual Row Suspension
When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified).
Conceptual Row Deletion
For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady',
`notInService' or `active'.) If the operation succeeds,
then all instances associated with the conceptual row are immediately removed. · Integer32
This object specifies the status of the dynamic template target. The following columns must be valid before activating a subscriber access profile:
- cdtTemplateTargetStorage
However, these objects specify a default value. Thus, it is possible to use create-and-go semantics without setting any additional columns.
An implementation must allow the EMS/NMS to modify any column when this column is 'active', including columns defined in tables that have a one-to-one or sparse dependent relationship on this table.
cdtTemplateTargetStorage
1.3.6.1.4.1.9.9.784.1.1.2.1.4
StorageType1 = other2 = volatile3 = nonVolatile4 = permanent5 = readOnlyDescribes the memory realization of a conceptual row. A row which is volatile(2) is lost upon reboot. A row which is either nonVolatile(3), permanent(4) or readOnly(5), is backed up by stable storage. A row which is permanent(4) can be changed but not deleted. A row which is readOnly(5) cannot be changed nor deleted.
If the value of an object with this syntax is either permanent(4) or readOnly(5), it cannot be written. Conversely, if the value is either other(1), volatile(2) or nonVolatile(3), it cannot be modified to be permanent(4) or readOnly(5). (All illegal modifications result in a 'wrongValue' error.)
Every usage of this textual convention is required to specify the columnar objects which a permanent(4) row must at a minimum allow to be writable. · Integer32
This object specifies what happens to the dynamic template target upon restart.
This table contains a list of templates associated with each target.
This table has an expansion dependent relationship on the cdtTemplateTargetTable, containing zero or more rows for each target.
cdtTemplateAssociationName
1.3.6.1.4.1.9.9.784.1.1.3.1.1
DynamicTemplateNameA string-value that identifies a dynamic template. The semantics of the string-value are the same as those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB [RFC3411].Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (1..64) · OCTET STRING
This object indicates the name of the template associated with the target.
cdtTemplateAssociationPrecedence
1.3.6.1.4.1.9.9.784.1.1.3.1.2
Unsigned32
This object indicates the relative precedence of the associated dynamic template. Lower values have higher precedence than higher values.
This table contains a list of targets using each dynamic template.
This table has an expansion dependent relationship on the cdtTemplateTable, containing zero or more rows for each dynamic template.
cdtTemplateUsageTargetType
1.3.6.1.4.1.9.9.784.1.1.4.1.1
DynamicTemplateTargetType1 = other2 = interfaceAn enumerated integer-value describing the type of target associated with one or more dynamic templates:
'other' The implementation of the MIB module using this textual convention does not recognize the type of target.
'interface' The target is a physical, logical, or virtual interface represented by an ifEntry (defined by the IF-MIB).
An implementation must ensure that DynamicTemplateTargetType object and any associated DynamicTemplateTargetId objects are consistent. An attempt to set a DynamicTemplateTargetType object to a value inconsistent with the associated DynamicTemplateTargetId object must result in a response with an error-status of 'inconsistentValue'.Reference: K. McCloghrie and F. Kastenholtz, 'The Interfaces Group MIB', RFC-2863, June 2000. · Integer32
This object indicates the type of target using the dynamic template.
cdtTemplateUsageTargetId
1.3.6.1.4.1.9.9.784.1.1.4.1.2
DynamicTemplateTargetIdAn binary string-value in network byte order identifying a target associated with one or more dynamic templates.
An implementation must interpret a DynamicTemplateTargetId value within the context of a DynamicTemplateTargetType. Every usage of the DynamicTemplateTargetId textual convention must have a corresponding object specifying the DynamicTemplateType that provides this context. It is most appropriate that a MIB module logical registers the DynamicTemplateType object before the use of the DynamicTemplateTargetId textual convention within the same logical row.
The value of a DynamicTemplateTargetId object must always be consistent with the value of the associated DynamicTemplateTargetType object. An attempt to set a DynamicTemplateTargetId object to a value inconsistent with the with the associated DynamicTemplateTargetType object must result in a response with an error-status of 'inconsistentValue'.
If the DynamicTemplateTargetType is 'interface', then the representation of DynamicTemplateTargetId is as below
octets contents encoding
1-4 ifIndex network-byte orderReference: K. McCloghrie and F. Kastenholtz, 'The Interfaces Group MIB', RFC-2863, June 2000. SIZE (1..20) · OCTET STRING
This object indicates the name of the target using the dynamic template
cdtTemplateCommonTable
1.3.6.1.4.1.9.9.784.1.1.5
Index: cdtTemplateName
This table contains attributes relating to all dynamic templates. Observe that the type of dynamic templates containing these attributes may change with the addition of new dynamic template types.
This table has a sparse-dependent relationship on the cdtTemplateTable, containing a row for each dynamic template having a cdtTemplateType of one of the following values:
'derived' 'ppp' 'ethernet' 'ipSubscriber' 'service'
cdtCommonValid
1.3.6.1.4.1.9.9.784.1.1.5.1.1
BITS
This object specifies which attributes in the dynamic template have been configured to valid values.
Each bit in this bit string corresponds to a column in this table. If the bit is '0', then the value of the corresponding column is not valid. If the bit is '1', then the value of the corresponding column has been configured to a valid value.
The following list specifies the mappings between bits and the columns:
'descr' => cdtCommonDescr
'keepaliveInt' => cdtCommonKeepaliveInt
'keepaliveRetries' => cdtCommonKeepaliveRetries
'vrf' => cdtCommonVrf
'addrPool' => cdtCommonAddrPool
'ipv4AccessGroup' => cdtCommonIpv4AccessGroup
'ipv4Unreachables' => cdtCommonIpv4Unreachables
'ipv6AccessGroup' => cdtCommonIpv6AccessGroup
'ipv6Unreachables' => cdtCommonIpv6Unreachables
'srvSubControl' => cdtCommonSrvSubControl
'srvRedirect' => cdtCommonSrvRedirect
'srvAcct' => cdtCommonSrvAcct
'srvQos' => cdtCommonSrvQos
'srvNetflow' => cdtCommonSrvNetflow
cdtCommonDescr
1.3.6.1.4.1.9.9.784.1.1.5.1.2
SnmpAdminStringAn octet string containing administrative information, preferably 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.
The use of leading or trailing white space should be avoided.
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 [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
This object specifies a human-readable description for the dynamic template.
This column is valid only if the 'descr' bit of the corresponding instance of cdtCommonValid is '1'.
cdtCommonKeepaliveInt
1.3.6.1.4.1.9.9.784.1.1.5.1.3
Unsigned32 (1..4294967295) · seconds
This object specifies the interval that the system sends keepalive messages to a target.
This column is valid only if the 'keepaliveInterval' bit of the corresponding instance of cdtCommonValid is '1'.
cdtCommonKeepaliveRetries
1.3.6.1.4.1.9.9.784.1.1.5.1.4
Unsigned32 (1..255) · retries
This object specifies the number of times the system will resend a keepalive message without a response before it transitions a target to an operationally down state.
This column is valid only if the 'keepaliveRetries' bit of the corresponding instance of cdtCommonValid is '1'.
cdtCommonVrf
1.3.6.1.4.1.9.9.784.1.1.5.1.5
CiscoVrfNameThe name of the Virtual Private Network Routing and Forwarding (VRF) domain.
Semantics of a zero length CiscoVrfName are object-specific and must be defined as part of the description of any object which uses this syntax. SIZE (0..32) · OCTET STRING
This object specifies the name of the VRF with which a target has an association.
This column is valid only if the 'vrf' bit of the corresponding instance of cdtCommonValid is '1'.
cdtCommonAddrPool
1.3.6.1.4.1.9.9.784.1.1.5.1.6
SnmpAdminStringAn octet string containing administrative information, preferably 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.
The use of leading or trailing white space should be avoided.
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 [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
This object specifies the name of the IP address pool the system will use to assign an IP address to a peer of a target.
This column is valid only if the 'addrPool' bit of the corresponding instance of cdtCommonValid is '1'.
cdtCommonIpv4AccessGroup
1.3.6.1.4.1.9.9.784.1.1.5.1.7
SnmpAdminStringAn octet string containing administrative information, preferably 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.
The use of leading or trailing white space should be avoided.
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 [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
This object specifies the name (or number) of the IPv4 ACL applied to a target.
This column is valid only if the 'ipv4AccessGroup' bit of the corresponding instance of cdtCommonValid is '1'.
cdtCommonIpv4Unreachables
1.3.6.1.4.1.9.9.784.1.1.5.1.8
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
This object specifies whether a target generates ICMPv4 unreachable messages.
This column is valid only if the 'ipv4Unreachables' bit of the corresponding instance of cdtCommonValid is '1'.
cdtCommonIpv6AccessGroup
1.3.6.1.4.1.9.9.784.1.1.5.1.9
SnmpAdminStringAn octet string containing administrative information, preferably 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.
The use of leading or trailing white space should be avoided.
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 [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
This object specifies the name (or number) of the IPv4 ACL applied to a target.
This column is valid only if the 'ipv6AccessGroup' bit of the corresponding instance of cdtCommonValid is '1'.
cdtCommonIpv6Unreachables
1.3.6.1.4.1.9.9.784.1.1.5.1.10
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
This object specifies whether a target generates ICMPv6 unreachable messages.
This column is valid only if the 'ipv6Unreachables' bit of the corresponding instance of cdtCommonValid is '1'.
cdtCommonSrvSubControl
1.3.6.1.4.1.9.9.784.1.1.5.1.11
CbpElementNameA string-value that identifies an element used to specify a class-based policy. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB [RFC3411].
Observe that the null string is reserved for cases when an instance of an object needs to specify 'no element'.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..127) · OCTET STRING · hint 127a
This object specifies the name of the subscriber control policy applied to a target.
The system should assume that the cbpPolicyMapType (defined by the CISCO-CBP-BASE-CFG-MIB) of the policy is cbpPmtControlSubscriber (defined by the CISCO-CBP-TYPE-OID-MIB).
This column is valid only if the 'srvSubControl' bit of the corresponding instance of cdtCommonValid is '1'.
cdtCommonSrvRedirect
1.3.6.1.4.1.9.9.784.1.1.5.1.12
CbpElementNameA string-value that identifies an element used to specify a class-based policy. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB [RFC3411].
Observe that the null string is reserved for cases when an instance of an object needs to specify 'no element'.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..127) · OCTET STRING · hint 127a
This object specifies the name of the traffic redirect policy applied to a target.
The system should assume that the cbpPolicyMapType (defined by the CISCO-CBP-BASE-CFG-MIB) of the policy is cbpPmtTrafficRedirect (defined by the CISCO-CBP-TYPE-OID-MIB).
This column is valid only if the 'srvRedirect' bit of the corresponding instance of cdtCommonValid is '1'.
cdtCommonSrvAcct
1.3.6.1.4.1.9.9.784.1.1.5.1.13
CbpElementNameA string-value that identifies an element used to specify a class-based policy. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB [RFC3411].
Observe that the null string is reserved for cases when an instance of an object needs to specify 'no element'.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..127) · OCTET STRING · hint 127a
This object specifies the name of the traffic accounting policy applied to a target.
The system should assume that the cbpPolicyMapType (defined by the CISCO-CBP-BASE-CFG-MIB) of the policy is cbpPmtTrafficAccounting (defined by the CISCO-CBP-TYPE-OID-MIB).
This column is valid only if the 'srvAcct' bit of the corresponding instance of cdtCommonValid is '1'.
cdtCommonSrvQos
1.3.6.1.4.1.9.9.784.1.1.5.1.14
CbpElementNameA string-value that identifies an element used to specify a class-based policy. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB [RFC3411].
Observe that the null string is reserved for cases when an instance of an object needs to specify 'no element'.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..127) · OCTET STRING · hint 127a
This object specifies the name of the traffic QoS policy applied to a target.
The system should assume that the cbpPolicyMapType (defined by the CISCO-CBP-BASE-CFG-MIB) of the policy is cbpPmtQos (defined by the CISCO-CBP-TYPE-OID-MIB).
This column is valid only if the 'srvQos' bit of the corresponding instance of cdtCommonValid is '1'.
cdtCommonSrvNetflow
1.3.6.1.4.1.9.9.784.1.1.5.1.15
CbpElementNameA string-value that identifies an element used to specify a class-based policy. The semantics of the string-value are the same those specified by the SnmpAdminString textual convention defined by the SNMP-FRAMEWORK-MIB [RFC3411].
Observe that the null string is reserved for cases when an instance of an object needs to specify 'no element'.Reference: D. Harrington, R. Resuhn, B. Wijnen, 'An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks', RFC-3411, December 2002. SIZE (0..127) · OCTET STRING · hint 127a
This object specifies the name of the NetFlow policy applied to a target.
The system should assume that the cbpPolicyMapType (defined by the CISCO-CBP-BASE-CFG-MIB) of the policy is cbpPmtNetflow (defined by the CISCO-CBP-TYPE-OID-MIB).
This column is valid only if the 'srvNetflow' bit of the corresponding instance of cdtCommonValid is '1'.
cdtIfTemplateTable
1.3.6.1.4.1.9.9.784.1.2.1
Index: cdtTemplateName
This table contains attributes relating to interface configuration.
This table has a sparse-dependent relationship on the cdtTemplateTable, containing a row for each dynamic template having a cdtTemplateType of one of the following values:
'derived' 'ppp' 'ethernet' 'ipSubscriber'
cdtIfValid
1.3.6.1.4.1.9.9.784.1.2.1.1.1
BITS
This object specifies which attributes in the dynamic template have been configured to valid values.
Each bit in this bit string corresponds to a column in this table. If the bit is '0', then the value of the corresponding column is not valid. If the bit is '1', then the value of the corresponding column has been configured to a valid value.
The following list specifies the mappings between bits and the columns:
'mtu' => cdtIfMtu
'cdpEnable' => cdtIfCdpEnable
'flowMonitor' => cdtIfFlowMonitor
'ipv4Unnumbered' => cdtIfIpv4Unnumbered
'ipv4SubEnable' => cdtIfIpv4SubEnable
'ipv4Mtu' => cdtIfIpv4Mtu
'ipv4TcpMssAdjust' => cdtIfIpv4TcpMssAdjust
'ipv4VerifyUniRpf' => cdtIfIpv4VerifyUniRpf
'ipv4VerifyUniRpfAcl' => cdtIfIpv4VerifyUniRpfAcl
'ipv4VerifyUniRpfOpts' => cdtIfIpv4VerifyUniRpfOpts
'ipv6Enable' => cdtIfIpv6Enable
'ipv6SubEnable' => cdtIfIpv6SubEnable
'ipv6TcpMssAdjust' => cdtIfIpv6TcpMssAdjust
'ipv6VerifyUniRpf' => cdtIfIpv6VerifyUniRpf
'ipv6VerifyUniRpfAcl' => cdtIfIpv6VerifyUniRpfAcl
'ipv6VerifyUniRpfOpts' => cdtIfIpv6VerifyUniRpfOpts
'ipv6NdPrefix' => cdtIfIpv6NdPrefix,
cdtIfIpv6NdPrefixLength
'ipv6NdValidLife' => cdtIfIpv6NdValidLife
'ipv6NdPreferredLife' => cdtIfIpv6NdPreferredLife
'ipv6NdOpts' => cdtIfIpv6NdOpts
'ipv6NdDadAttempts' => cdtIfIpv6NdDadAttempts
'ipv6NdNsInterval' => cdtIfIpv6NdNsInterval
'ipv6NdReacableTime' => cdtIfIpv6NdReacableTime
'ipv6NdRaIntervalMax' => cdtIfIpv6NdRaIntervalUnits,
cdtIfIpv6NdRaIntervalMax
'ipv6NdRaIntervalMin' => cdtIfIpv6NdRaIntervalMin
'ipv6NdRaLife' => cdtIfIpv6NdRaLife
'ipv6NdRouterPreference'' => cdtIfIpv6NdRouterPreference
cdtIfMtu
1.3.6.1.4.1.9.9.784.1.2.1.1.2
Unsigned32 (0 | 64..65535) · octets
This object specifies the Maximum Transfer Unit (MTU) size for all packets sent on the target interface.
The value '0' cannot be written to an instance of this object. However, it serves as a convenient value when the column is not valid.
This column is valid only if the 'mtu' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfCdpEnable
1.3.6.1.4.1.9.9.784.1.2.1.1.3
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
This object specifies whether the target interface participates in the Cisco Discovery Protocol (CDP).
This column is valid only if the 'cdpEnable' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfFlowMonitor
1.3.6.1.4.1.9.9.784.1.2.1.1.4
SnmpAdminStringAn octet string containing administrative information, preferably 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.
The use of leading or trailing white space should be avoided.
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 [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
This object specifies the name of the flow monitor associated with the target interface.
This column is valid only if the 'flowMonitor' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv4Unnumbered
1.3.6.1.4.1.9.9.784.1.2.1.1.5
InterfaceIndexOrZeroThis textual convention is an extension of the InterfaceIndex convention. The latter defines a greater than zero value used to identify an interface or interface sub-layer in the managed system. This extension permits the additional value of zero. the value zero is object-specific and must therefore be defined as part of the description of any object which uses this syntax. Examples of the usage of zero might include situations where interface was unknown, or when none or all interfaces need to be referenced. (0..2147483647) · Integer32 · hint d
This object specifies the interface of the source address that the target interface uses when originating IPv4 packets.
The value '0' cannot be written to an instance of this object. However, it serves as a convenient value when the column is not valid (e.g., immediately following the creation of an instance of the object).
This column is valid only if the 'ipv4Unnumbered' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv4SubEnable
1.3.6.1.4.1.9.9.784.1.2.1.1.6
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
This object specifies whether the target interface allows IPv4 subscriber sessions.
This column is valid only if the 'ipv4SubEnable' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv4Mtu
1.3.6.1.4.1.9.9.784.1.2.1.1.7
Unsigned32 (0 | 128..65535) · octets
This object specifies the Maximum Transfer Unit (MTU) size for IPv4 packets sent on the target interface.
The value '0' cannot be written to an instance of this object. However, it serves as a convenient value when the column is not valid.
This column is valid only if the 'ipv4Mtu' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv4TcpMssAdjust
1.3.6.1.4.1.9.9.784.1.2.1.1.8
Unsigned32 (0 | 500..1460) · octets
This object specifies the adjustment to the Maximum Segment Size (MSS) of TCP SYN packets received by the target interface contained in IPv4 datagrams.
The value '0' cannot be written to an instance of this object. However, it serves as a convenient value when the column is not valid.
This column is valid only if the 'ipv4TcpMssAdjust' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv4VerifyUniRpf
1.3.6.1.4.1.9.9.784.1.2.1.1.9
UnicastRpfType1 = strict2 = loose3 = disabledAn enumerated integer-value describing the type of unicast Reverse Path Forwarding (RPF) a system applies to traffic received on an interface. UnicastRpfTypes 'strict' and 'loose' RPF methods are defined in RFC3704.
'disabled' The system does not perform unicast RPF on packets received by the interface.
'strict' The system performs strict unicast RPF on packets received by the interface. 'loose' The system performs loose unicast RPF on packets received by the interface.Reference: RFC3704 (http://tools.ietf.org/html/rfc3704) · Integer32
This object specifies whether the type of unicast RPF the system performs on IPv4 packets received by the target interface.
This column is valid only if the 'ipv4VerifyUniRpf' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv4VerifyUniRpfAcl
1.3.6.1.4.1.9.9.784.1.2.1.1.10
SnmpAdminStringAn octet string containing administrative information, preferably 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.
The use of leading or trailing white space should be avoided.
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 [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
This object specifies the name (or number) of the IPv4 ACL used to determine whether the system should permit/deny packets received by the target interface that fail unicast RPF verification.
This column is valid only if the 'ipv4VerifyUniRpfAcl' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv4VerifyUniRpfOpts
1.3.6.1.4.1.9.9.784.1.2.1.1.11
UnicastRpfOptionsA bit string describing unicast Reverse Path Forwarding (RPF) options:
'allowDefault' Allows the use of the default route for RPF verification.
'allowSelfPing' Allows a router to ping its own interface or interfaces. · BITS
This object specifies the options that affect how the system performs unicast RPF on IPv4 packets received by the target interface.
This column is valid only if the 'ipv4VerifyUniRpfOpts' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv6Enable
1.3.6.1.4.1.9.9.784.1.2.1.1.12
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
This object specifies whether the system processes IPv6 packets received by the target interface.
This column is valid only if the 'ipv6Enable' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv6SubEnable
1.3.6.1.4.1.9.9.784.1.2.1.1.13
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
This object specifies whether the target interface allows IPv6 subscriber sessions.
This column is valid only if the 'ipv6SubEnable' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv6TcpMssAdjust
1.3.6.1.4.1.9.9.784.1.2.1.1.14
Unsigned32 (0 | 500..1460) · octets
This object specifies the adjustment to the Maximum Segment Size (MSS) of TCP SYN packets received by the target interface contained in IPv6 datagrams.
The value '0' cannot be written to an instance of this object. However, it serves as a convenient value when the column is not valid.
This column is valid only if the 'ipv6TcpMssAdjust' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv6VerifyUniRpf
1.3.6.1.4.1.9.9.784.1.2.1.1.15
UnicastRpfType1 = strict2 = loose3 = disabledAn enumerated integer-value describing the type of unicast Reverse Path Forwarding (RPF) a system applies to traffic received on an interface. UnicastRpfTypes 'strict' and 'loose' RPF methods are defined in RFC3704.
'disabled' The system does not perform unicast RPF on packets received by the interface.
'strict' The system performs strict unicast RPF on packets received by the interface. 'loose' The system performs loose unicast RPF on packets received by the interface.Reference: RFC3704 (http://tools.ietf.org/html/rfc3704) · Integer32
This object specifies whether the type of unicast RPF the system performs on IPv6 packets received by the target interface.
This column is valid only if the 'ipv6VerifyUniRpf' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv6VerifyUniRpfAcl
1.3.6.1.4.1.9.9.784.1.2.1.1.16
SnmpAdminStringAn octet string containing administrative information, preferably 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.
The use of leading or trailing white space should be avoided.
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 [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
This object specifies the name (or number) of the IPv6 ACL used to determine whether the system should permit/deny packets received by the target interface that fail unicast RPF verification.
This column is valid only if the 'ipv6VerifyUniRpfAcl' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv6VerifyUniRpfOpts
1.3.6.1.4.1.9.9.784.1.2.1.1.17
UnicastRpfOptionsA bit string describing unicast Reverse Path Forwarding (RPF) options:
'allowDefault' Allows the use of the default route for RPF verification.
'allowSelfPing' Allows a router to ping its own interface or interfaces. · BITS
This object specifies the options that affect how the system performs unicast RPF on IPv6 packets received by the target interface.
This column is valid only if the 'ipv6VerifyUniRpfOpts' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv6NdPrefix
1.3.6.1.4.1.9.9.784.1.2.1.1.18
InetAddressIPv6Represents an IPv6 network address:
Octets Contents Encoding
1-16 IPv6 address network-byte order
The corresponding InetAddressType value is ipv6(2).
This textual convention SHOULD NOT be used directly in object definitions, as it restricts addresses to a specific format. However, if it is used, it MAY be used either on its own or in conjunction with InetAddressType, as a pair. SIZE (16) · OCTET STRING · hint 2x:2x:2x:2x:2x:2x:2x:2x
Reference: T. Narten, E. Nordmark, W. Simpson, H. Soliman, 'Neighbor Discovery for IP version 6 (IPv6)', RFC-4861, September 2007.
This object specifies the IPv6 network number included in IPv6 router advertisements sent on the target interface.
This column is valid only if the 'ipv6NdPrefix' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv6NdPrefixLength
1.3.6.1.4.1.9.9.784.1.2.1.1.19
InetAddressPrefixLengthDenotes the length of a generic Internet network address prefix. A value of n corresponds to an IP address mask that has n contiguous 1-bits from the most significant bit (MSB), with all other bits set to 0.
An InetAddressPrefixLength value is always interpreted within the context of an InetAddressType value. Every usage of the InetAddressPrefixLength textual convention is required to specify the InetAddressType object that provides the context. It is suggested that the InetAddressType object be logically registered before the object(s) that use the InetAddressPrefixLength textual convention, if they appear in the same logical row.
InetAddressPrefixLength values larger than the maximum length of an IP address for a specific InetAddressType are treated as the maximum significant value applicable for the InetAddressType. The maximum significant value is 32 for the InetAddressType 'ipv4(1)' and 'ipv4z(3)' and 128 for the InetAddressType 'ipv6(2)' and 'ipv6z(4)'. The maximum significant value for the InetAddressType 'dns(16)' is 0.
The value zero is object-specific and must be defined as part of the description of any object that uses this syntax. Examples of the usage of zero might include situations where the Internet network address prefix is unknown or does not apply.
The upper bound of the prefix length has been chosen to be consistent with the maximum size of an InetAddress. (0..2040) · Unsigned32 · hint d
Reference: T. Narten, E. Nordmark, W. Simpson, H. Soliman, 'Neighbor Discovery for IP version 6 (IPv6)', RFC-4861, September 2007.
This object specifies the length of the IPv6 prefix specified by the corresponding instance of cdtIpv6NdPrefix.
This column is valid only if the 'ipv6NdPrefix' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv6NdValidLife
1.3.6.1.4.1.9.9.784.1.2.1.1.20
Unsigned32 (1..4294967295) · seconds
Reference: T. Narten, E. Nordmark, W. Simpson, H. Soliman, 'Neighbor Discovery for IP version 6 (IPv6)', RFC-4861, September 2007.
This object specifies the interval that the system advertises the IPv6 prefix (i.e., the corresponding instance of cdtIfIpv6NdPrefix) as 'valid' for IPv6 router advertisements sent on the target interface.
This column is valid only if the 'ipv6NdValidLife' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv6NdPreferredLife
1.3.6.1.4.1.9.9.784.1.2.1.1.21
Unsigned32 (1..4294967295) · seconds
Reference: T. Narten, E. Nordmark, W. Simpson, H. Soliman, 'Neighbor Discovery for IP version 6 (IPv6)', RFC-4861, September 2007.
This object specifies the interval that the system advertises the IPv6 prefix (i.e., the corresponding instance of cdtIfIpv6NdPrefix) as 'preferred' for IPv6 router advertisements sent on the target interface.
This column is valid only if the 'ipv6NdPreferredLife' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv6NdOpts
1.3.6.1.4.1.9.9.784.1.2.1.1.22
BITS
Reference: T. Narten, E. Nordmark, W. Simpson, H. Soliman, 'Neighbor Discovery for IP version 6 (IPv6)', RFC-4861, September 2007.
This object specifies options that affect advertisements sent on the target interface:
'advertise' This option specifies that the system should advertise the IPv6 prefix (i.e., the corresponding instance of cdtIfIpv6NdPrefix).
'onlink' This option specifies that the IPv6 prefix has been assigned to a link. If set to '0', the system advertises the IPv6 prefix as 'offlink'.
'router' This option indicates that the router will send the full router address and not set the 'R' bit in prefix advertisements.
'autoConfig' This option indicates to hosts on the local link that the specified prefix supports IPv6 auto-configuration.
'advertisementInterval' This option specifies the advertisement interval option in router advertisements sent on the target interface.
'managedConfigFlag' This option causes the system to set the 'managed address configuration flag' in router advertisements sent on the target interface.
'otherConfigFlag' This option causes the system to set the 'other stateful configuration' flag in router advertisements sent on the target interface.
'frameIpv6Prefix' This option causes the system to add the prefix in a received RADIUS framed IPv6 prefix attribute to the target interface's neighbor discovery prefix queue and includes it in router advertisements sent on the target interface.
'raSupress' This option suppresses the transmission of router advertisements on the target interface.
This column is valid only if the 'ipv6NdOpts' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv6NdDadAttempts
1.3.6.1.4.1.9.9.784.1.2.1.1.23
Unsigned32 (0..600)
Reference: T. Narten, E. Nordmark, W. Simpson, H. Soliman, 'Neighbor Discovery for IP version 6 (IPv6)', RFC-4861, September 2007.
This object specifies the number of consecutive neighbor solitication messages the system sends on the target interface while performing duplicate address detection on unicast IPv6 addresses on the target interface. The value '0' disables duplicate address detection on the target interface.
This column is valid only if the 'ipv6NdDadAttempts' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv6NdNsInterval
1.3.6.1.4.1.9.9.784.1.2.1.1.24
Unsigned32 (1000..3600000) · milliseconds
Reference: T. Narten, E. Nordmark, W. Simpson, H. Soliman, 'Neighbor Discovery for IP version 6 (IPv6)', RFC-4861, September 2007.
This object specifies the interval between neighbor solicitation retransmissions on the target interface.
This column is valid only if the 'ipv6NdNsIntervals' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv6NdReachableTime
1.3.6.1.4.1.9.9.784.1.2.1.1.25
Unsigned32 · milliseconds
Reference: T. Narten, E. Nordmark, W. Simpson, H. Soliman, 'Neighbor Discovery for IP version 6 (IPv6)', RFC-4861, September 2007.
This object specifies the amount of time the system considers a neighbor of the target interface reachable after a reachability confirmation event has occurred. The value '0' disables neighbor reachability detection on the target interface.
This column is valid only if the 'ipv6NdReachable' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv6NdRaIntervalUnits
1.3.6.1.4.1.9.9.784.1.2.1.1.26
INTEGER1 = seconds2 = milliseconds · Integer32
This object specifies the units of time for the corresponding instances of cdtIfIpv6NdRaIntervalMin and cdtIfIpv6NdRaIntervalMax.
This column is valid only if the 'ipv6NdRaInterval' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv6NdRaIntervalMax
1.3.6.1.4.1.9.9.784.1.2.1.1.27
Unsigned32
Reference: T. Narten, E. Nordmark, W. Simpson, H. Soliman, 'Neighbor Discovery for IP version 6 (IPv6)', RFC-4861, September 2007.
This object specifies the maximum interval between IPv6 router advertisements sent on the target interface.
The value '0' cannot be written to an instance of this object. However, it serves as a convenient value when the column is not valid.
This column is valid only if the 'ipv6NdRaInterval' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv6NdRaIntervalMin
1.3.6.1.4.1.9.9.784.1.2.1.1.28
Unsigned32
Reference: T. Narten, E. Nordmark, W. Simpson, H. Soliman, 'Neighbor Discovery for IP version 6 (IPv6)', RFC-4861, September 2007.
This object specifies the minimum interval between IPv6 router advertisements sent on the target interface. The value of this column has the following restrictions:
1) This value cannot be less than 75% of the value specified
for cdtIfIpv6NdRaIntervalMax.
2) If the corresponding instance of cdtIfIpv6NdRaIntervalUnits
is 'seconds', then this value cannot be less than '3'.
3) If the corresponding instance of cdtIfIpv6NdRaIntervalUnits
is 'milliseconds', then this value cannot be less than '30'.
If the target interface template does not specify this value, then the system automatically assumes a minimum interval that is 75% of the corresponding instance of cdtIfIpv6NdRaIntervalMax.
The value '0' cannot be written to an instance of this object. However, it serves as a convenient value when the column is not valid.
This column is valid only if the 'ipv6NdRaInterval' bit of the corresponding instance of cdtIfValid is '1'.
cdtIfIpv6NdRaLife
1.3.6.1.4.1.9.9.784.1.2.1.1.29
Unsigned32 · seconds
Reference: T. Narten, E. Nordmark, W. Simpson, H. Soliman, 'Neighbor Discovery for IP version 6 (IPv6)', RFC-4861, September 2007.
This object specifies the router lifetime value in IPv6 router advertisements sent on the target interface. The value '0' specifies that neighbors should not consider the router as a default router.
cdtIfIpv6NdRouterPreference
1.3.6.1.4.1.9.9.784.1.2.1.1.30
INTEGER1 = high2 = medium3 = low · Integer32
Reference: T. Narten, E. Nordmark, W. Simpson, H. Soliman, 'Neighbor Discovery for IP version 6 (IPv6)', RFC-4861, September 2007.
This object specifies the Default Router Preference (DRP) for the router on the target interface.
This column is valid only if the 'ipv6NdRouterPreference' bit of the corresponding instance of cdtIfValid is '1'.
cdtPppTemplateTable
1.3.6.1.4.1.9.9.784.1.3.1
Index: cdtTemplateName
This table contains attributes relating to PPP connection configuration.
This table has a sparse-dependent relationship on the cdtTemplateTable, containing a row for each dynamic template having a cdtTemplateType of one of the following values:
'derived' 'ppp'
cdtPppValid
1.3.6.1.4.1.9.9.784.1.3.1.1.1
BITS
This object specifies which attributes in the dynamic template have been configured to valid values.
Each bit in this bit string corresponds to a column in this table. If the bit is '0', then the value of the corresponding column is not valid. If the bit is '1', then the value of the corresponding column has been configured to a valid value.
The following list specifies the mappings between bits and the columns:
accounting => cdtPppAccounting
authentication => cdtPppAuthentication
authenticationMethods => cdtPppAuthenticationMethods
authorization => cdtPppAuthorization
loopbackIgnore => cdtPppLoopbackIgnore
maxBadAuth => cdtPppMaxBadAuth
maxConfigure => cdtPppMaxConfigure
maxFailure => cdtPppMaxFailure
maxTerminate => cdtPppMaxTerminate
timeoutAuthentication => cdtPppTimeoutAuthentication
timeoutRetry => cdtPppTimeoutRetry
chapOpts => cdtPppChapOpts
chapHostname => cdtPppChapHostname
chapPassword => cdtPppChapPassword
msChapV1Opts => cdtPppMsChapV1Opts
msChapV1Hostname => cdtPppMsChapV1Hostname
msChapV1Password => cdtPppMsChapV1Password
msChapV2Opts => cdtPppMsChapV2Opts
msChapV2Hostname => cdtPppMsChapV2Hostname
msChapV2Password => cdtPppMsChapV2Password
papOpts => cdtPppPapOpts
papSentUsername => cdtPppPapUsername
papSentPassword => cdtPppPapPassword
eapOpts => cdtPppEapOpts
eapIdentity => cdtPppEapIdentity
eapPassword => cdtPppEapPassword
ipcpAddrOption => cdtPppIpcpAddrOption
ipcpDnsOption => cdtPppIpcpDnsOption
ipcpDnsPrimary => cdtPppIpcpDnsPrimary
ipcpDnsSecondary => cdtPppIpcpDnsSecondary
ipcpWinsOption => cdtPppIpcpWinsOption
ipcpWinsPrimary => cdtPppIpcpWinsPrimary
ipcpWinsSecondary => cdtPppIpcpWinsSecondary
ipcpMaskOption => cdtPppIpcpMaskOption
ipcpMask => cdtPppIpcpMask
peerDefIpAddrOpts => cdtPppPeerOpts
peerDefIpAddrSrc => cdtPppPeerDefIpAddrSrc
peerDefIpAddr => cdtPppPeerDefIpAddr
cdtPppAccounting
1.3.6.1.4.1.9.9.784.1.3.1.1.2
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
This object specifies whether the system applies accounting services to the target PPP connection.
This column is valid only if the 'accounting' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppAuthentication
1.3.6.1.4.1.9.9.784.1.3.1.1.3
BITS
This object specifies authentication services applied to a target PPP connection and other options affecting authentication services:
'chap' This option enables the Challenge Handshake Protocol (CHAP) on a target PPP connection.
'msChap' This option enables Microsoft's CHAP on a target PPP connection.
'msChapV2' This option enables version 2 of Microsoft's CHAP on a target PPP connection.
'pap' This option enables Password Authentication Protocol (PAP) on a target PPP connection.
'eap' This option enables Extensible Authentication Protocol (EAP) on a target PPP connection.
'optional' This option specifies that the system accepts the connection even if the peer of a target PPP connection refuses to accept the authentication methods the system has requested.
'callin' This option specifies that authentication should only happen for incoming calls.
'oneTime' This option specifies that the system accepts the username and password in the username field of authentication responses received on a target PPP connection.
This column is valid only if the 'authentication' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppAuthenticationMethods
1.3.6.1.4.1.9.9.784.1.3.1.1.4
SnmpAdminStringAn octet string containing administrative information, preferably 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.
The use of leading or trailing white space should be avoided.
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 [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
This object specifies the name of a list of authentication methods used on a target PPP connection. If the template does not include this attribute, then the system uses the default method list.
This column is valid only if the 'authentication' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppAuthorization
1.3.6.1.4.1.9.9.784.1.3.1.1.5
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
This object specifies whether the system applies authorization services to a target PPP connection.
This column is valid only if the 'authorization' bit of the corresponding instance of cditPppValid is '1'.
cdtPppLoopbackIgnore
1.3.6.1.4.1.9.9.784.1.3.1.1.6
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
Reference: W. Simpson, 'The Point-to-Point Protocol (PPP)', RFC-1661, July 1994.
This object specifies whether the system ignores loopback on a target PPP connection. When the system ignores loopback, loopback detection is disabled.
This column is valid only if the 'loopbackIgnore' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppMaxBadAuth
1.3.6.1.4.1.9.9.784.1.3.1.1.7
Unsigned32
This object specifies the number of authentication failures allowed by the system before a target PPP connection is reset.
The value '0' cannot be written to an instance of this object. However, it serves as a convenient value when the column is not valid.
This column is valid only if the 'maxBadAuth' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppMaxConfigure
1.3.6.1.4.1.9.9.784.1.3.1.1.8
Unsigned32 (1..4294967295)
Reference: W. Simpson, 'The Point-to-Point Protocol (PPP)', RFC-1661, July 1994.
This object specifies the number of unacknowledged Configure-Request messages a target PPP connection can send before the system abandons LCP or NCP negotiations.
This column is valid only if the 'maxConfigure' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppMaxFailure
1.3.6.1.4.1.9.9.784.1.3.1.1.9
Unsigned32 (1..4294967295)
Reference: W. Simpson, 'The Point-to-Point Protocol (PPP)', RFC-1661, July 1994.
This object specifies the number of Configure-Nak messages a target PPP connection can receive before the system abandons LCP or NCP negotiations.
This column is valid only if the 'maxFailure' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppMaxTerminate
1.3.6.1.4.1.9.9.784.1.3.1.1.10
Unsigned32 (1..4294967295)
Reference: W. Simpson, 'The Point-to-Point Protocol (PPP)', RFC-1661, July 1994.
This object specifies the number of unacknowledged Terminate-Request messages a target PPP connection can send before the system abandons LCP or NCP negotiations.
This column is valid only if the 'maxTerminate' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppTimeoutAuthentication
1.3.6.1.4.1.9.9.784.1.3.1.1.11
Unsigned32 (1..255) · seconds
This objects specifies the maximum time the system will wait for a response to an authentication request on a target PPP connection.
This column is valid only if the 'timeoutAuthentication' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppTimeoutRetry
1.3.6.1.4.1.9.9.784.1.3.1.1.12
Unsigned32 (1..255) · seconds
Reference: W. Simpson, 'The Point-to-Point Protocol (PPP)', RFC-1661, July 1994.
This objects specifies the maximum time the system will wait for a response to a PPP control packets on a target PPP connection.
This column is valid only if the 'timeoutRetry' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppChapOpts
1.3.6.1.4.1.9.9.784.1.3.1.1.13
BITS
Reference: W. Simpson, 'PPP Challenge Handshake Authentication Protocol (CHAP)', RFC-1994, August 1996.
This object specifies how the system processes the CHAP on a target PPP connection:
'refuse' This option specifies that the system should refuse CHAP requests from peers of a target PPP connection.
'callin' This option specifies that the system should only refuse CHAP requests for incoming calls on a target PPP connection. This option is only relevant if the 'refuse' option is set to '1'.
'wait' This option delays CHAP authentication until after the peer of a target PPP connection has authenticated itself to the system.
'encrypted' This option specifies that the value specified by the corresponding instance of cdtPppChapPassword is already encrypted.
This column is valid only if the 'chapOpts' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppChapHostname
1.3.6.1.4.1.9.9.784.1.3.1.1.14
SnmpAdminStringAn octet string containing administrative information, preferably 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.
The use of leading or trailing white space should be avoided.
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 [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
Reference: W. Simpson, 'PPP Challenge Handshake Authentication Protocol (CHAP)', RFC-1994, August 1996.
This object specifies the hostname sent in a CHAP response on a target PPP connection. If the template does not include this attribute, then the system uses its assigned hostname.
This column is valid only if the 'chapHostname' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppChapPassword
1.3.6.1.4.1.9.9.784.1.3.1.1.15
SnmpAdminStringAn octet string containing administrative information, preferably 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.
The use of leading or trailing white space should be avoided.
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 [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
Reference: W. Simpson, 'PPP Challenge Handshake Authentication Protocol (CHAP)', RFC-1994, August 1996.
This object specifies the password used to construct a CHAP response on the target PPP connection.
This column is valid only if the 'chapPassword' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppMsChapV1Opts
1.3.6.1.4.1.9.9.784.1.3.1.1.16
BITS
Reference: G. Zorn, S. Cobb, 'Microsoft PPP CHAP Extensions', RFC-2433, October 1998.
This object specifies how the system processes version 1 of Microsoft CHAP on a target PPP connection:
'refuse' This option specifies that the system should refuse Microsoft CHAP (v1) requests from peers of a target PPP connection.
'callin' This option specifies that the system should only refuse Microsoft CHAP (v1) requests for incoming calls on a target PPP connection. This option is only relevant if the 'refuse' option is set to '1'.
'wait' This option delays Microsoft CHAP (v1) authentication until after the peer of a target PPP connection has authenticated itself to the system.
'encrypted' This option specifies that the value specified by the corresponding instance of cdtPppMsChapV1Password is already encrypted.
This column is valid only if the 'msChapV1Opts' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppMsChapV1Hostname
1.3.6.1.4.1.9.9.784.1.3.1.1.17
SnmpAdminStringAn octet string containing administrative information, preferably 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.
The use of leading or trailing white space should be avoided.
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 [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
Reference: G. Zorn, S. Cobb, 'Microsoft PPP CHAP Extensions', RFC-2433, October 1998.
This object specifies the hostname sent in a Microsoft CHAP (v1) response on a target PPP connection. If the template does not include this attribute, then the system uses its assigned hostname.
This column is valid only if the 'msChapV1Hostname' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppMsChapV1Password
1.3.6.1.4.1.9.9.784.1.3.1.1.18
SnmpAdminStringAn octet string containing administrative information, preferably 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.
The use of leading or trailing white space should be avoided.
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 [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
Reference: G. Zorn, S. Cobb, 'Microsoft PPP CHAP Extensions', RFC-2433, October 1998.
This object specifies the password used to construct a Microsoft CHAP (v1) response on a target PPP connection.
This column is valid only if the 'msChapV1Password' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppMsChapV2Opts
1.3.6.1.4.1.9.9.784.1.3.1.1.19
BITS
Reference: G. Zorn, 'Microsoft PPP CHAP Extensions, Version 2', RFC-2759, January 2000.
This object specifies how the system processes version 2 of Microsoft CHAP on a target PPP connection:
'refuse' This option specifies that the system should refuse Microsoft CHAP (v2) requests from peers of a target PPP connection.
'callin' This option specifies that the system should only refuse Microsoft CHAP (v2) requests for incoming calls on a target PPP connection. This option is only relevant if the 'refuse' option is set to '1'.
'wait' This option delays Microsoft CHAP (v2) authentication until after the peer of a target PPP connection has authenticated itself to the system.
'encrypted' This option specifies that the value specified by the corresponding instance of cdtPppMsChapV2Password is already encrypted.
This column is valid only if the 'msChapV2Opts' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppMsChapV2Hostname
1.3.6.1.4.1.9.9.784.1.3.1.1.20
SnmpAdminStringAn octet string containing administrative information, preferably 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.
The use of leading or trailing white space should be avoided.
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 [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
Reference: G. Zorn, 'Microsoft PPP CHAP Extensions, Version 2', RFC-2759, January 2000.
This object specifies the hostname sent in a Microsoft CHAP (v2) response on a target PPP connection. If the template does not include this attribute, then the system uses its assigned hostname.
This column is valid only if the 'msChapV2Hostname' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppMsChapV2Password
1.3.6.1.4.1.9.9.784.1.3.1.1.21
SnmpAdminStringAn octet string containing administrative information, preferably 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.
The use of leading or trailing white space should be avoided.
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 [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
Reference: G. Zorn, 'Microsoft PPP CHAP Extensions, Version 2', RFC-2759, January 2000.
This object specifies the password used to construct a Microsoft CHAP (v2) response on a target PPP connection.
This column is valid only if the 'msChapV2Password' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppPapOpts
1.3.6.1.4.1.9.9.784.1.3.1.1.22
BITS
Reference: B. Lloyd and W. Simpson, 'PPP Authentication Protocols', RFC-1334, October 1992.
This object specifies how the system processes the PAP on a target PPP connection:
'refuse' This option specifies that the system should refuse PAP requests from peers of a target PPP connection.
'encrypted' This option specifies that the value specified by the corresponding instance of cdtPppPapSentPassword is already encrypted.
This column is valid only if the 'papOpts' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppPapUsername
1.3.6.1.4.1.9.9.784.1.3.1.1.23
SnmpAdminStringAn octet string containing administrative information, preferably 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.
The use of leading or trailing white space should be avoided.
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 [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
Reference: B. Lloyd and W. Simpson, 'PPP Authentication Protocols', RFC-1334, October 1992.
This object specifies the username sent in a PAP response on a target PPP connection.
This column is valid only if the 'papUsername' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppPapPassword
1.3.6.1.4.1.9.9.784.1.3.1.1.24
SnmpAdminStringAn octet string containing administrative information, preferably 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.
The use of leading or trailing white space should be avoided.
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 [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
Reference: B. Lloyd and W. Simpson, 'PPP Authentication Protocols', RFC-1334, October 1992.
This object specifies the username used to construct a PAP response on a target PPP connection.
This column is valid only if the 'papPassword' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppEapOpts
1.3.6.1.4.1.9.9.784.1.3.1.1.25
BITS
Reference: B. Aboba, L. Blunk, J. Vollbrecht, J. Carlson, and H. Levkowetz, 'Extensible Authentication Protocol (EAP)', RFC-3748, June 2004.
This object specifies how the system processes the EAP on a target PPP connection:
'refuse' This option specifies that the system should refuse EAP requests from peers of a target PPP connection.
'callin' This option specifies that the system should only refuse EAP requests for incoming calls on a target PPP connection. This option is only relevant if the 'refuse' option is set to '1'.
'wait' This option delays EAP authentication until after the peer of a target PPP connection has authenticated itself to the system.
'local' This option specifies that the system should locally authenticate the peer of a target PPP connection, rather than acting as a proxy to an external AAA server.
This column is valid only if the 'eapOpts' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppEapIdentity
1.3.6.1.4.1.9.9.784.1.3.1.1.26
SnmpAdminStringAn octet string containing administrative information, preferably 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.
The use of leading or trailing white space should be avoided.
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 [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
Reference: B. Aboba, L. Blunk, J. Vollbrecht, J. Carlson, and H. Levkowetz, 'Extensible Authentication Protocol (EAP)', RFC-3748, June 2004.
This object specifies the identity sent in an EAP response on a target PPP connection.
This column is valid only if the 'eapIdentity' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppEapPassword
1.3.6.1.4.1.9.9.784.1.3.1.1.27
SnmpAdminStringAn octet string containing administrative information, preferably 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.
The use of leading or trailing white space should be avoided.
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 [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
Reference: B. Aboba, L. Blunk, J. Vollbrecht, J. Carlson, and H. Levkowetz, 'Extensible Authentication Protocol (EAP)', RFC-3748, June 2004.
This object specifies the password used to construct an EAP response on a target PPP connection.
This column is valid only if the 'eapPassword' bit of the corresponding instance of cdtPppValid is '1'.
Reference: G. McGregor, 'The PPP Internet Protocol Control Protocol (IPCP)', RFC-1332, May 1992.
This object specifies the IPCP address option for a target PPP connection:
'other' The implementation of this MIB module does not recognize the configured IPCP address option.
'accept' The system accepts any non-zero IP address from the peer of a target PPP connection.
'required' The system disconnects the peer of a target PPP connection if it could not negotiate an IP address.
'unique' The system disconnects the peer of a target PPP connection if the IP address is already in use.
This column is valid only if the 'ipcpAddrOption' bit of the corresponding instance of cdtPppValid is '1'.
Reference: G. McGregor, 'The PPP Internet Protocol Control Protocol (IPCP)', RFC-1332, May 1992.
This object specifies the IPCP DNS option for the dynamic interface:
'other' The implementation of this MIB module does not recognize the configured DNS option.
'accept' The system accepts any non-zero DNS address form the peer of a target PPP connection.
'request' The system requests the DNS address from the peer of a target PPP connection.
'reject' The system rejects the DNS option from the peer of a target PPP connection.
This column is valid only if the 'ipcpDnsOption' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppIpcpDnsPrimary
1.3.6.1.4.1.9.9.784.1.3.1.1.30
InetAddressIPv4Represents an IPv4 network address:
Octets Contents Encoding
1-4 IPv4 address network-byte order
The corresponding InetAddressType value is ipv4(1).
This textual convention SHOULD NOT be used directly in object definitions, as it restricts addresses to a specific format. However, if it is used, it MAY be used either on its own or in conjunction with InetAddressType, as a pair. SIZE (4) · OCTET STRING · hint 1d.1d.1d.1d
Reference: G. McGregor, 'The PPP Internet Protocol Control Protocol (IPCP)', RFC-1332, May 1992.
This object specifies the IP address of the primary DNS server offered to the peer of a target PPP connection.
This column is valid only if the 'ipcpDnsPrimary' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppIpcpDnsSecondary
1.3.6.1.4.1.9.9.784.1.3.1.1.31
InetAddressIPv4Represents an IPv4 network address:
Octets Contents Encoding
1-4 IPv4 address network-byte order
The corresponding InetAddressType value is ipv4(1).
This textual convention SHOULD NOT be used directly in object definitions, as it restricts addresses to a specific format. However, if it is used, it MAY be used either on its own or in conjunction with InetAddressType, as a pair. SIZE (4) · OCTET STRING · hint 1d.1d.1d.1d
Reference: G. McGregor, 'The PPP Internet Protocol Control Protocol (IPCP)', RFC-1332, May 1992.
This object specifies the IP address of the secondary DNS server offered to the peer of a target PPP connection.
This column is valid only if the 'ipcpDnsSecondary' bit of the corresponding instance of cdtPppValid is '1'.
Reference: G. McGregor, 'The PPP Internet Protocol Control Protocol (IPCP)', RFC-1332, May 1992.
This object specifies the IPCP WINS option for a target PPP connection:
'other' The implementation of this MIB module does not recognize the configured WINS option.
'accept' The system accepts any non-zero WINS address from the peer of a target PPP connection.
'request' The system requests the WINS address from the peer of a target PPP connection.
'reject' The system rejects the WINS option from the peer of a target PPP connection.
This column is valid only if the 'ipcpWinsOption' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppIpcpWinsPrimary
1.3.6.1.4.1.9.9.784.1.3.1.1.33
InetAddressIPv4Represents an IPv4 network address:
Octets Contents Encoding
1-4 IPv4 address network-byte order
The corresponding InetAddressType value is ipv4(1).
This textual convention SHOULD NOT be used directly in object definitions, as it restricts addresses to a specific format. However, if it is used, it MAY be used either on its own or in conjunction with InetAddressType, as a pair. SIZE (4) · OCTET STRING · hint 1d.1d.1d.1d
Reference: G. McGregor, 'The PPP Internet Protocol Control Protocol (IPCP)', RFC-1332, May 1992.
This object specifies the IP address of the primary WINS server offered to the peer of a target PPP connection.
This column is valid only if the 'ipcpWinsPrimary' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppIpcpWinsSecondary
1.3.6.1.4.1.9.9.784.1.3.1.1.34
InetAddressIPv4Represents an IPv4 network address:
Octets Contents Encoding
1-4 IPv4 address network-byte order
The corresponding InetAddressType value is ipv4(1).
This textual convention SHOULD NOT be used directly in object definitions, as it restricts addresses to a specific format. However, if it is used, it MAY be used either on its own or in conjunction with InetAddressType, as a pair. SIZE (4) · OCTET STRING · hint 1d.1d.1d.1d
Reference: G. McGregor, 'The PPP Internet Protocol Control Protocol (IPCP)', RFC-1332, May 1992.
This object specifies the IP address of the secondary WINS server offered to the peer of a target PPP connection.
This column is valid only if the 'ipcpWinsSecondary' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppIpcpMaskOption
1.3.6.1.4.1.9.9.784.1.3.1.1.35
INTEGER1 = other2 = request3 = reject · Integer32
Reference: G. McGregor, 'The PPP Internet Protocol Control Protocol (IPCP)', RFC-1332, May 1992.
This object specifies the IPCP IP subnet mask option for a target PPP connection:
'other' The implementation of this MIB module does not recognize the configured IP subnet mask option.
'request' The system requests the IP subnet mask from the peer of a target PPP connection.
'reject' The system rejects the IP subnet mask option from the peer of a target PPP connection.
This column is valid only if the 'ipcpMaskOption' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppIpcpMask
1.3.6.1.4.1.9.9.784.1.3.1.1.36
InetAddressIPv4Represents an IPv4 network address:
Octets Contents Encoding
1-4 IPv4 address network-byte order
The corresponding InetAddressType value is ipv4(1).
This textual convention SHOULD NOT be used directly in object definitions, as it restricts addresses to a specific format. However, if it is used, it MAY be used either on its own or in conjunction with InetAddressType, as a pair. SIZE (4) · OCTET STRING · hint 1d.1d.1d.1d
Reference: G. McGregor, 'The PPP Internet Protocol Control Protocol (IPCP)', RFC-1332, May 1992.
This object specifies the IP address mask offered to the peer of a target PPP connection.
This column is valid only if the 'ipcpMask' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppPeerDefIpAddrOpts
1.3.6.1.4.1.9.9.784.1.3.1.1.37
BITS
This object specifies options that affect how the system assigns an IP address to the peer of a target PPP connection:
'ipAddrForced' This option forces the system to assign the next available IP address in the pool to the peer of a target PPP connection. When disabled, the peer may negotiate a specific IP address or the system can assign the peer its previously assigned IP address.
'matchAaaPools' This option specifies that the names of the IP address pools provided by an external AAA server must appear in the corresponding list of IP address pool specified by the cdtPppPeerIpAddrPoolTable.
'backupPools' This option specifies that the corresponding names of the IP address pools specified by the cditPppPeerIpAddrPoolTable serve as backup pools to those provided by an external AAA server.
'staticPools' This option suppresses an attempt to load pools from an external AAA server when the system encounters a missing pool name.
This column is valid only if the 'peerIpAddrOpts' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppPeerDefIpAddrSrc
1.3.6.1.4.1.9.9.784.1.3.1.1.38
INTEGER1 = static2 = pool3 = dhcp · Integer32
This object specifies how the system assigns an IP address to the peer of a target PPP connection:
'static' The system assigns the IP address specified by the corresponding instance of cdtPppPeerDefIpAddr.
'pool' The system allocates the first available IP address from the corresponding list of named pools contained by the cdtPppPeerIpAddrPoolTable.
'dhcp' The system acts as a DHCP proxy-client to obtain an IP address.
This column is valid only if the 'peerDefIpAddrSrc' bit of the corresponding instance of cdtPppValid is '1'.
cdtPppPeerDefIpAddr
1.3.6.1.4.1.9.9.784.1.3.1.1.39
InetAddressIPv4Represents an IPv4 network address:
Octets Contents Encoding
1-4 IPv4 address network-byte order
The corresponding InetAddressType value is ipv4(1).
This textual convention SHOULD NOT be used directly in object definitions, as it restricts addresses to a specific format. However, if it is used, it MAY be used either on its own or in conjunction with InetAddressType, as a pair. SIZE (4) · OCTET STRING · hint 1d.1d.1d.1d
This object specifies the IP address the system assigns to the peer of a target PPP connection.
This column is valid only if the 'peerDefIpAddr' bit of the corresponding instance of cdtPppValid is '1'.
This table contains a prioritized list of named pools for each PPP template. A list corresponding to a PPP template specifies the pools the system searches in an attempt to assign an IP address to the peer of a target PPP connection. The system searches the pools in the order of their priority.
This table has an expansion dependent relationship on the cdtPppTemplateTable, containing zero or more rows for each PPP template.
cdtPppPeerIpAddrPoolPriority
1.3.6.1.4.1.9.9.784.1.3.2.1.1
Unsigned32 (1..4294967295)
This object indicates the relative priority of the named pool in the list corresponding to a PPP template. The system searches pools in the order of priority, where lower values represent higher priority.
cdtPppPeerIpAddrPoolStatus
1.3.6.1.4.1.9.9.784.1.3.2.1.2
RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of [2].)
The status column has six defined values:
- `active', which indicates that the conceptual row is available for use by the managed device;
- `notInService', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device;
- `notReady', which indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instanciated);
- `createAndGo', which is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device;
- `createAndWait', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device); and, - `destroy', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row.
Whereas five of the six values (all except `notReady') may be specified in a management protocol set operation, only three values will be returned in response to a management
protocol retrieval operation: `notReady', `notInService' or
`active'. That is, when queried, an existing conceptual row
has only three states: it is either available for use by
the managed device (the status column has value `active'); it is not available for use by the managed device, though the agent has sufficient information to attempt to make it so (the status column has value `notInService'); or, it is not available for use by the managed device, and an attempt to make it so would fail because the agent has insufficient information (the state column has value `notReady').
NOTE WELL
This textual convention may be used for a MIB table, irrespective of whether the values of that table's conceptual rows are able to be modified while it is active, or whether its conceptual rows must be taken out of service in order to be modified. That is, it is the responsibility of the DESCRIPTION clause of the status column to specify whether the status column must not be `active' in order for the value of some other column of the same conceptual row to be modified. If such a specification is made, affected columns may be changed by an SNMP set PDU if the RowStatus would not be equal to `active' either immediately before or after processing the PDU. In other words, if the PDU also contained a varbind that would change the RowStatus value, the column in question may be changed if the RowStatus was not equal to `active' as the PDU was received, or if the varbind sets the status to a value other than 'active'.
Also note that whenever any elements of a row exist, the RowStatus column must also exist.
To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram:
STATE +--------------+-----------+-------------+-------------
| A | B | C | D
| |status col.|status column|
|status column | is | is |status column
ACTION |does not exist| notReady | notInService| is active
--------------+--------------+-----------+-------------+-------------
set status |noError ->D|inconsist- |inconsistent-|inconsistent-
column to | or | entValue| Value| Value
createAndGo |inconsistent- | | |
| Value| | |
--------------+--------------+-----------+-------------+-------------
set status |noError see 1|inconsist- |inconsistent-|inconsistent-
column to | or | entValue| Value| Value
createAndWait |wrongValue | | |
--------------+--------------+-----------+-------------+-------------
set status |inconsistent- |inconsist- |noError |noError
column to | Value| entValue| |
active | | | |
| | or | |
| | | |
| |see 2 ->D|see 8 ->D| ->D
--------------+--------------+-----------+-------------+-------------
set status |inconsistent- |inconsist- |noError |noError ->C
column to | Value| entValue| |
notInService | | | |
| | or | | or
| | | |
| |see 3 ->C| ->C|see 6
--------------+--------------+-----------+-------------+-------------
set status |noError |noError |noError |noError ->A
column to | | | | or
destroy | ->A| ->A| ->A|see 7
--------------+--------------+-----------+-------------+-------------
set any other |see 4 |noError |noError |see 5
column to some| | | |
value | | see 1| ->C| ->D
--------------+--------------+-----------+-------------+-------------
(1) goto B or C, depending on information available to the agent.
(2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D.
(3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C.
(4) at the discretion of the agent, the return value may be either:
inconsistentName: because the agent does not choose to
create such an instance when the corresponding RowStatus instance does not exist, or
inconsistentValue: if the supplied value is
inconsistent with the state of some other MIB object's value, or
noError: because the agent chooses to create the instance.
If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A.
(5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned.
(6) the return value can indicate one of the following errors:
wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or
inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated.
(7) the return value can indicate the following error:
inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated.
(8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue.
NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc.
Conceptual Row Creation
There are four potential interactions when creating a
conceptual row: selecting an instance-identifier which is
not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device.
Interaction 1: Selecting an Instance-Identifier
The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics.
In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.)
Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different.
Finally, the management station could select a pseudo-random number to use as the index. In the event that this index
was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation.
A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used.
Interaction 2: Creating the Conceptual Row
Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions.
Interaction 2a: Creating and Activating the Conceptual Row
The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes:
- a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1.
- the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created.
- the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column.
Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'.
When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information
available to the agent is provided by two sources: the
management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row.
NOTE WELL
Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm.
Interaction 2b: Negotiating the Creation of the Conceptual Row
The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the
columns indicated by its column requirements.) Otherwise,
the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3.
Interaction 3: Initializing non-defaulted Objects
The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes:
- a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column.
- the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column.
- the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column.
If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4.
Interaction 4: Making the Conceptual Row Available
Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'.
NOTE WELL
A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device.
If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row.
Conceptual Row Suspension
When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified).
Conceptual Row Deletion
For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady',
`notInService' or `active'.) If the operation succeeds,
then all instances associated with the conceptual row are immediately removed. · Integer32
This object specifies the status of the entry. The following columns must be valid before activating a subscriber access profile:
- cdtPppPeerIpAddrPoolStorage - cdtPppPeerIpAddrPoolName
However, these objects specify a default value. Thus, it is possible to use create-and-go semantics without setting any additional columns.
An implementation must not allow the EMS/NMS to create an entry if the corresponding instance of cdtPppPeerIpAddrSrc is not 'pool'.
An implementation must allow the EMS/NMS to modify any column when this column is 'active'.
cdtPppPeerIpAddrPoolStorage
1.3.6.1.4.1.9.9.784.1.3.2.1.3
StorageType1 = other2 = volatile3 = nonVolatile4 = permanent5 = readOnlyDescribes the memory realization of a conceptual row. A row which is volatile(2) is lost upon reboot. A row which is either nonVolatile(3), permanent(4) or readOnly(5), is backed up by stable storage. A row which is permanent(4) can be changed but not deleted. A row which is readOnly(5) cannot be changed nor deleted.
If the value of an object with this syntax is either permanent(4) or readOnly(5), it cannot be written. Conversely, if the value is either other(1), volatile(2) or nonVolatile(3), it cannot be modified to be permanent(4) or readOnly(5). (All illegal modifications result in a 'wrongValue' error.)
Every usage of this textual convention is required to specify the columnar objects which a permanent(4) row must at a minimum allow to be writable. · Integer32
This object specifies what happens to the name pool entry upon restart.
If the corresponding instance of cdtTemplateSrc is not 'local', then this column must be 'volatile'.
cdtPppPeerIpAddrPoolName
1.3.6.1.4.1.9.9.784.1.3.2.1.4
SnmpAdminStringAn octet string containing administrative information, preferably 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.
The use of leading or trailing white space should be avoided.
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 [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
This object specifies the name of the IP address pool associated with the PPP template.
cdtEthernetTemplateTable
1.3.6.1.4.1.9.9.784.1.4.1
Index: cdtTemplateName
This table contains attributes relating to dynamic interfaces initiated on Ethernet virtual interfaces (e.g., EoMPLS) or automatically created VLANs.
This table has a sparse-dependent relationship on the cdtTemplateTable, containing a row for each dynamic template having a cdtTemplateType of one of the following values:
'derived' 'ethernet'
cdtEthernetValid
1.3.6.1.4.1.9.9.784.1.4.1.1.1
BITS
This object specifies which attributes in the dynamic template have been configured to valid values.
Each bit in this bit string corresponds to a column in this table. If the bit is '0', then the value of the corresponding column is not valid. If the bit is '1', then the value of the corresponding column has been configured to a valid value.
The following list specifies the mappings between bits and the columns:
bridgeDomain => cdtEthernetBridgeDomain
pppoeEnable => cdtEthernetPppoeEnable
ipv4PointToPoint => cdtEthernetIpv4PointToPoint
macAddr => cdtEthernetMacAddr
cdtEthernetBridgeDomain
1.3.6.1.4.1.9.9.784.1.4.1.1.2
SnmpAdminStringAn octet string containing administrative information, preferably 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.
The use of leading or trailing white space should be avoided.
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 [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
This object specifies the name of the bridge domain...
cdtEthernetPppoeEnable
1.3.6.1.4.1.9.9.784.1.4.1.1.3
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
This object specifies whether...
cdtEthernetIpv4PointToPoint
1.3.6.1.4.1.9.9.784.1.4.1.1.4
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
This object specifies whether...
cdtEthernetMacAddr
1.3.6.1.4.1.9.9.784.1.4.1.1.5
MacAddressRepresents an 802 MAC address represented in the `canonical' order defined by IEEE 802.1a, i.e., as if it were transmitted least significant bit first, even though 802.5 (in contrast to other 802.x protocols) requires MAC addresses to be transmitted most significant bit first. SIZE (6) · OCTET STRING · hint 1x:
This object specifies the...
cdtSrvTemplateTable
1.3.6.1.4.1.9.9.784.1.6.1
Index: cdtTemplateName
This table contains attributes relating to a service.
This table has a sparse-dependent relationship on the cdtTemplateTable, containing a row for each dynamic template having a cdtTemplateType of one of the following values:
'derived' 'service'
cdtSrvValid
1.3.6.1.4.1.9.9.784.1.6.1.1.1
BITS
This object specifies which attributes in the dynamic template have been configured to valid values.
Each bit in this bit string corresponds to a column in this table. If the bit is '0', then the value of the corresponding column is not valid. If the bit is '1', then the value of the corresponding column has been configured to a valid value.
The following list specifies the mappings between bits and the columns:
networkSrv => cdtSrvNetworkSrv
vpdnGroup => cdtSrvVpdnGroup
sgSrvGroup => cdtSrvGroup
sgSrvType => cdtSrvSgSrvType
multicast => cdtSrvMulticast
This object specifies the type of network service provided by the target service:
'other' The implementation of this MIB module does not recognize the configured network service.
'none' The target subscriber service does not provide a network service to subscribers sessions.
'local' The target subscriber service provides local termination for subscriber sessions.
'vpdn' The target subscriber service provides a Virtual Private Dialup Network service for subscriber sessions.
This column is valid only if the 'networkSrv' bit of the corresponding instance of cdtSrvValid is '1'.
cdtSrvVpdnGroup
1.3.6.1.4.1.9.9.784.1.6.1.1.3
SnmpAdminStringAn octet string containing administrative information, preferably 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.
The use of leading or trailing white space should be avoided.
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 [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
This object specifies the name of the VPDN group used to configure the network service.
This column is valid only if the 'vpdnGroup' bit of the corresponding instance of cdtSrvValid is '1'.
cdtSrvSgSrvGroup
1.3.6.1.4.1.9.9.784.1.6.1.1.4
SnmpAdminStringAn octet string containing administrative information, preferably 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.
The use of leading or trailing white space should be avoided.
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 [RFC3416].
Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t
This object specifies the name of the service group with which the system associates subscriber sessions. A service group specifies a set of services that may be active simultaneously for a given subscriber session. Typically, a service group contains a primary service and one or more secondary services.
This column is valid only if the 'sgSrvGroup' bit of the corresponding instance of cdtSrvValid is '1'.
cdtSrvSgSrvType
1.3.6.1.4.1.9.9.784.1.6.1.1.5
INTEGER1 = primary2 = secondary · Integer32
This object specifies whether the target service specifies a network-forwarding policy:
'primary' The target service specifies a network-forwarding policy. Primary services are mutually exclusive; that is, only one primary service can be activated for any given subscriber session.
'secondary' The target service has a dependence on the primary service in the group specified by the corresponding instance of cdtSuBSrvSgSrvGroup. After the system activates the primary service, it activates secondary services. When the system deactivates the primary service, then it deactivates all the secondary services in the service group.
This column is valid only if the 'sgSrvType' bit of the corresponding instance of cdtSrvValid is '1'.
cdtSrvMulticast
1.3.6.1.4.1.9.9.784.1.6.1.1.6
TruthValue1 = true2 = falseRepresents a boolean value. · Integer32
This objects specifies whether the system enables multicast service for subscriber sessions of the target service.
This column is valid only if the 'sgSrvMcastRoutingIf' bit of the corresponding instance of cdtSrvValid is '1'.