MODULE-IDENTITY, OBJECT-TYPE, OBJECT-IDENTITY, Integer32, Unsigned32
                                                    FROM SNMPv2-SMI
                                                      -- RFC 2578
RowStatus, StorageType, VariablePointer
                                                    FROM SNMPv2-TC
                                                      -- RFC 2579
MODULE-COMPLIANCE, OBJECT-GROUP
                                                    FROM SNMPv2-CONF
                                                      -- RFC 2580
SnmpAdminString
                                                    FROM SNMP-FRAMEWORK-MIB
                                                      -- RFC 3411
ITSDailyTimeStamp, ITSDateStamp, ITSPduErrorStatus, ITSPositive8, ITSUnsigned8,
ITSUnsigned16
                                                    FROM ISO26048-1-FieldDevice
fdGlobalMIB, fdAdminGlobal, fdGlobalConformance
                                                    FROM ISO26048-1-Global
fdOwnerEntry, fdOwnerIndex  
                                                    FROM ISO26048-1-Owner

This MIB defines a mechanism by which a manager can create a more compact encoding of a group of object instances that are requested together. An Object Group is configured by defining the desired sequence of object instances to be reported as a group. The result is that the device provides a new object instance (fdObjectSetData) which represents the values of each object instance in the specified order, without the name (OID) field for each one and with the values encoded as an OER string rather than a BER string, which further compacts the encoding, especially if the listed objects are all one-octet integers. 

Copyright (C) International Organization for Standardization (ISO). This MIB module is part of ISO 26048-1; see ISO 26048-1 for full legal notices.

A node defining management information related to the administration of the objects within the fdDynObjMIB.

The maximum number of objects that the implementation supports within each dynamic object.

A table containing configuration rights for the dynamic object tables for specific owners.

A row in the fdOwnerDynObjTable.

The maximum number of rows that this owner is allowed to manage within the fdDynObjTable at any point in time.

The maximum number of rows that this owner is allowed to manage for each dynamic object within the fdDynObjFieldTable at any point in time. This value shall have an upper limit of fdAdminDynObjsMaxObjects.

The maximum power outage time in minutes that may occur before the dynamic object configurations for this owner transition to notInService. If this object is set to zero (0), dynamic object definitions for the owner shall transition to notInService at power initialization. The value of 65535 shall mean that the dynamic objects for this owner will not transition to notInService regardless of the length of power outage.

Specifies a relatively unique identifier for the current configuration paramters contained within the fdDynObjTable and FdDynObjFieldTable for this owner. The configuration parameters include all writable objects contained in these tables except for fdDynObjRefresh and fdDynObjNewValue.

The formats in which the field device is able to encode the dynamic object values. Defined bits are: 

Value | Name | Description 
0     | ber  | Supports Basic Encoding Rules (ISO 8825-1) 
1     | oer  | Supports Octet Encoding Rules (ISO 8825-7)

Indicates the level of support for the fdDynObjNewValue column of the table. Values are defined as follows: 

Value   | Description 
none    | The fdDynObjNewValue column is not supported 
partial | The fdDynObjNew column is supported for some possible
        | configurations of a dynamic object, but implementation-specific 
        | limitations apply 
full    | fdDynObjNewValue is supported for any allowed configuration
        | of a writable dynamic object

The processes supported by the dynamic object. Defined values are: 

Value   | Description 
oneStep | The one step process 
twoStep | The two step process

A table that manages the dynamic objects within the field device.

An dynamic object is a user-defined sequence of object instances that can be exchanged as a single entity without having to pass the OID of each object instance in the exchange. The fdDynObjEntry contains information that applies to the entire dynamic object.

The index of this entry within the scope of the fdOwnerIndex.

A textual description of the dynamic object's function and use.

The format in which the field device shall encode this dynamic object. Defined values are: 

Value | Description 
other | Encoding format is not defined by this standard. Implementations
      | using 'other' encodings should define a separate object allowing
      | the specification of the desired encoding format and the deter-
      | mination of the specific custom format when selected. A SET to
      | fdDynObjEncoding (this object) to 'other' shall return a
      | 'wrongValue' error. 
ber   | The value shall be encoded using BER (ISO/IEC 8825-1 / ITU-T
      | X.690). 
oer   | The value shall be encoded using OER (ISO/IEC 8825-7 / ITU-T 
      | X.696).

The process to be followed when making requests related to the dynamic object. Valid values are: 

Value    | Description 
one-step | The field device shall process requests for
         | fdDynObjCurrentValue and fdDynObjNewValue when the request
         | is received and return the resultant SNMP response when done. 
         | When in this mode, the value of fdDynObjRefresh shall be
         | 'notReady', the value of fdDynObjLastRefreshDate shall
         | indicate 01 Jan 2000 and value of fdDynObjLastRefreshTime
         | shall indicate 00:00:00.000.
         |
         | An attempt to set the value of fdDynObjRefresh shall 
         | result in an 'inconsistentValue' result. User's should note 
         | that the time for such an operation may take considerably 
         | longer than a normal SNMP request since the size of 
         | the message may be much greater than normal. 
         | 
two-step | To retrieve the current value of the dynamic object, a manager 
         | shall first set the value of fdDynObjRefresh to 'refresh'.
         | This will cause the field device to calculate the value for
         | fdDynObjCurrentValue whereupon it will become available for
         | retrieval operations. The values of fdDynObjLastRefreshDate,
         | fdDynObjLastRefreshTime, fdDynObjLastError,
         | fdDynObjLastErrorIndex, and fdDynObjLastRequestID shall be
         | updated once the updated value of fdDynObjCurrentValue is
         | ready. An attempt to retrieve fdDynObjCurrentValue while it is
         | being calculated shall result in a zero-length string.         
         |
         | To set the current value of the dynamic object, a command 
         | generator shall shall set fdDynObjNewValue to the desired
         | value and the command responder shall perform the first three
         | checks defined in RFC 3416 Clause 4.2.5. In other words, it
         | will verify that:
         | 1) the object is within the command generator's MIB view,
         | 2) the object can be modified, and 
         | 3) the type of the value field is OCTET SRTING
         | The command responder shall then return an immediate SNMP
         | response based on these three simple checks and will continue
         | the remainder of the verification steps defined in RFC 3416
         | Clause 4.2.5. The final result of the entire RFC 3416
         | verification process shall be stored in fdDynObjLastError and
         | fdDynObjLastErrorIndex, at which point the command responder
         | shall also update the value of fdDynObjLastErrorRequestID.

The state of the refresh operation for fdDynObjCurrentValue. Valid values are: 

Value    | Description 
other    | A state not defined by this standard 
ready    | The object set is ready for a command to calculate 
         | fdDynObjCurrentValue 
refresh  | A command to begin calculating fdDynObjCurrentValue 
pending  | The value of fdDynObjCurrentValue is currently being
         | calculated
oneStep  | The value of fdDynObjProcess is one-step and use of this
         | is not valid 
disabled | The value of fdDynObjEnabled is disabled 
notReady | The value of fdDynObjRowStatus for this row is not 'active'. 

A request to SET this object to any value other than 'refresh' shall
result in an 'wrongValue' error. Setting this value to 'refresh' when it 
is in the 'ready' mode shall: 
1. Cause the object to immediately transition to the 'pending' state, 
2. Force the value of fdDynObjCurrentValue to a zero-length string, 
3. Begin the calculation of a new value for fdDynObjCurrentValue. 

Once the calculation of fdDynObjCurrentValue is complete, the value
will be stored in that object (replacing the zero-length string) and
the value of this object shall transition to 'ready'. 

Setting this value to 'refresh' when its value is anything other than 
'ready' shall result in a 'inconsistentValue' error.

The UTC date on which the dynamic object was last refreshed when in twoStep mode. If the object set is in oneStep mode or if the dynamic object has not been refreshed since this dynamic object was placed into twoStep mode, the value of this object shall be 01 Jan 2000.

The UTC time at which the dynamic object was last refreshed when in twoStep mode. If the object set is in oneStep mode or if the dynamic object has not been refreshed since this dynamic object was placed into twoStep mode, the value of this object shall be 00:00:00.000.

The estimated duration to perform a request (get or set) on the object group. On initial use, this may be based on a simple calculation of the number of objects contained within the dynamic object. After initial use, it should be based on the actual time required for one or more recent requests.

The current value of the SEQUENCE of object instance values referenced by this dynamic object. The value is encoded using the rules specified in fdDynObjEncoding. 

When in oneStep mode, the device shall calculate a new response and return resultant value. Given the potential complexity of dynamic objects, an implementation may require more time than normal to process this type of request. When in twoStep mode, the device shall return the last response calculated by the fdDynObjRefresh process. 

When calculating the value of this object (in either oneStep or twoStep mode), the field device shall act as if it had received a single retrieval request containing each referenced object using the same security parameters associated with the request (i.e., the parameters in the request for this object when in oneStep mode and the parameters in the request for fdDynObjRefresh when in twoStep mode). If an error occurs during the mimicked retrieval request (e.g., a referenced object does not currently exist), fdDynObjLastError shall be updated to reflect the reported error and the value of this object (fdDynObjCurrentValue) shall be a zero-length string. Otherwise, if there is no error in the retrieval request, the value of this object shall be the response encoded according to the chosen encoding rules. If an error occurs during the encoding process (e.g., too large for the buffer), the error shall be reflected in fdDynObjLastError and the value of this object shall be a zero-length string. Otherwise, upon successful encoding, the encoding shall be returned (oneStep) or stored (twoStep) and the value of fdDynObjLastError shall be set to 'noError'.

This object allows a manager to set new values for the SEQUENCE of object instances referenced by this dynamic object. The value is encoded using the rules specified in fdDynObjEncoding. 

An attempt to set an instance of this object type using a request that contains any other object instance shall result in an 'inconsistentValue' error. An attempt to set an instance of this object while the fdDynObjLastError object instance of the same entry has a value of 'pending' shall result in an 'inconsistentValue' error. An attempt to set an instance of this object while the fdDynObjRowStatus object instance of the same entry has a value of anything other than 'active' shall result in an 'inconsistentValue' error. 

Upon receipt of a SET request for this object (and the value of fdDynObjLastError for the dynamic object is not already 'pending'), the field device shall transition the value of fdDynObjLastError for the row to 'pending'. The field device shall then attempt to decode the value contained within the SetRequest-PDU according to the configuration of the dynamic object. If the field device encounters an error in decoding the provided values, it shall stop processing, set fdDynObjLastError for the row to 'newValueEncodingError', set fdDynObjLastErrorIndex for the row to zero (0), and return a 'wrongValue' error to the manager. 

If the field device successfully decodes the value and it is in oneStep mode, the field device shall mimic as if it had received a single SET request containing each object referenced within the dynamic object with the the values provided in the request using the same security parameters associated with the request used to SET this object. Upon completing the processing of the mimicked request, the field device shall set fdDynObjLastError to reflect the error status of the mimicked request, set fdDynObjLastErrorIndex to the error index of the mimicked request and then respond to the original request indicating the error status of the mimicked request and the index of one (i.e., by definition a set on an dynamic object only contains a single object). 

If the field device successfully decodes the value and it is in twoStep mode, the field device shall respond to the request with a 'noError' response and then mimic as if it had received a single SET request containing each object referenced within the dynamic object with the values provided in the request using the same security parameters associated with the request used to SET this object. Upon completing the processing of the mimicked request, the field device shall set fdDynObjLastError to reflect the error status of the mimicked request and set fdDynObjLastErrorIndex to the error index of the mimicked request. 

Retrieving this object shall return the last value SET (with a 'noError' response), which may be different than fdDynObjCurrentValue. Upon the activation of this row of the table, the value of this object is ignored. In other words, a set operation is only mimicked when this object is set while the row is 'active'.

An indication of any error associated with the last operation on fdDynObjCurrentValue or fdDynObjNewValue.

An indication of the field within the dynamic object that caused the error.

An indication of the request-id field contained in the request for which the values of fdDynObjLastError and fdDynObjLastErrorIndex apply.

The storageType for this conceptual row and the associated rows within the fdDynObjFieldTable. Conceptual rows having the value 'permanent' and supporting SET operations shall allow write access to the fdDynObjNewValue column; all other columns in the row do not need to allow write-access.

The status of this conceptual row. This object may be used to create or remove rows from this table. 

With the exception of fdDynObjNewValue, all columns of this table and associated rows of the fdDynObjFieldTable shall be appropriately configured before the value of this object can transition to active. In addition, there shall be at least two rows in the fdDynObjFieldTable associated with this entry before the value of this object can transition to active. 

With the exception of fdDynObjNewValue, objects within this row of the table associated rows of the fdDynObjFieldTable can not be modified while the value of this object is active. The value of fdDynObjNewValue, can only be modified when this object has the value of 'active'. An attempt to modify fdDynObjNewValue when this object is in any other state shall result in an 'inconsistentValue' error. 

The create-and-go command can be used to configure the dynamic object but such a command cannot be combined with setting the value of fdDynObjNewValue. 

Creation and modification of any object within this conceptual row and corresponding rows of the fdDynObjFieldTable are allowed when the value of this object is notInService or notReady, within the capabilities of the implementation. For example, the implementation might not support newValues for all combinations of data.

This table defines the sequential list of object instances that are contained within the dynamic object.

An entry specifying one object instance to be contained within the object group.

The logical order of the fdDynObjFieldObject within the dynamic object SEQUENCE structure where the object with the lowest index occurs first within the SEQUENCE followed by each next larger index. 

fdDynObjFieldIndex values for an dynamic object do not have to begin with one nor are they required to increment by one. For example, a dynamic object could be defined with two active entries within the fdDynObjFieldTable with values for fdDynObjFieldIndex of 3 and 5. Such an entry would result in a sequence as follows: 

SEQUENCE { 
     <object referred to by fdDynObjFieldObject.3>, 
     <object referred to by fdDynObjFieldObject.5> }

Entries that are not not 'active' or non-existant are omitted from the encoding.

The OBJECT IDENTIFIER of the object instance to be contained within the dynamic object in the position indicated by fdDynObjFieldIndex.

The status of this conceptual row. This object may be used to create or remove rows from this table. Commands and changes in status of this object are prohibited while the associated fdDynObjRowStatus is 'active'. 

In order for this object to transition to 'active', the value of fdDynObjFieldObject for this row must be: 

1) of an object type that the device supports and 

2) an object instance that is accessible for read operations within the view associated with the security credentials used to activate this object. 

The value of fdDynObjFieldObject for this row cannot be modified while the value of this object is 'active'.

A node containing conformance statements related to the fdDynObjMIB, as defined in ISO/TS 20684-7.

A node for compliance statements for the fdDynObjMIB.

A node for group definitions related to fdDynObjMIB.

Management information that is required if the field device supports the capability to accept SET requests for a dynamic object.

Administrative information for the dynamic object feature.

Management information that identifies the capabilities of the object group.

Management information used for refreshing the value for an dynamic object entry according to the two-step process.

Management information used for SETting the values of the objects contained within an dynamic object entry.