AGGREGATE-MIB

File: AGGREGATE-MIB.mib (17412 bytes)

Imported modules

SNMPv2-SMI RMON-MIB SNMPv2-TC
SNMPv2-CONF SNMP-FRAMEWORK-MIB

Imported symbols

MODULE-IDENTITY experimental Unsigned32
OBJECT-TYPE Opaque OwnerString
RowStatus StorageType TEXTUAL-CONVENTION
MODULE-COMPLIANCE OBJECT-GROUP SnmpAdminString

Defined Types

AggrMOErrorStatus  
This data type is used to model the error status of the constituent MO instances. The error status for a constituent MO instance is given in terms of two elements: o The moIndex, which indicates the position of the MO instance (starting at 1) in the value of the aggregated MO instance. o The moError, which indicates the error that was encountered in fetching that MO instance. The syntax in ASN.1 Notation will be ErrorStatus :: = SEQUENCE { moIndex Integer32, moError SnmpPduErrorStatus } AggrMOErrorStatus ::= SEQUENCE OF { ErrorStatus } Note1: The command responder will supply values for all constituent MO instances, in the same order in which the MO instances are specified for the AgMO. If an error is encountered for an MO instance, then the corresponding value will have an ASN.1 value NULL, and an error will be flagged in the corresponding AggrMOErrorStatus object. Only MOs for which errors have been encountered will have their corresponding moIndex and moError values set. Note2: The error code for the component MO instances will be in accordance with the SnmpPduErrorStatus TC defined in the DISMAN-SCHEDULE-MIB [RFC3231]. Note3: The command generator will need to know constituent MO instances and their order to correctly interpret AggrMOErrorStatus.
TEXTUAL-CONVENTION    
  Opaque Size(0..1024)  

AggrMOValue  
This data type is used to model the aggregate MOs. It will have a format dependent on the constituent MOs, a sequence of values. The syntax in ASN.1 Notation will be MOValue :: = SEQUENCE { value ObjectSyntax } where 'value' is the value of a constituent MO instance. AggrMOValue :: = SEQUENCE OF { MOValue } Note: The command generator will need to know the constituent MO instances and their order to correctly interpret AggrMOValue.
TEXTUAL-CONVENTION    
  Opaque Size(0..1024)  

AggrMOCompressedValue  
This data type is used to model the compressed aggregate MOs.
TEXTUAL-CONVENTION    
  OCTET STRING Size(0..1024)  

AggrCtlEntry  
SEQUENCE    
  aggrCtlEntryID SnmpAdminString
  aggrCtlMOIndex Unsigned32
  aggrCtlMODescr SnmpAdminString
  aggrCtlCompressionAlgorithm INTEGER
  aggrCtlEntryOwner OwnerString
  aggrCtlEntryStorageType StorageType
  aggrCtlEntryStatus RowStatus

AggrMOEntry  
SEQUENCE    
  aggrMOEntryID Unsigned32
  aggrMOEntryMOID Unsigned32
  aggrMOInstance OBJECT IDENTIFIER
  aggrMODescr SnmpAdminString
  aggrMOEntryStorageType StorageType
  aggrMOEntryStatus RowStatus

AggrDataEntry  
SEQUENCE    
  aggrDataRecord AggrMOValue
  aggrDataRecordCompressed AggrMOCompressedValue
  aggrDataErrorRecord AggrMOErrorStatus

Defined Values

aggrMIB 1.3.6.1.3.123
The MIB for servicing aggregate objects. Copyright (C) The Internet Society (2006). This version of this MIB module is part of RFC 4498; see the RFC itself for full legal notices.
MODULE-IDENTITY    

aggrCtlTable 1.3.6.1.3.123.1
A table that controls the aggregation of the MOs.
OBJECT-TYPE    
  SEQUENCE OF  
    AggrCtlEntry

aggrCtlEntry 1.3.6.1.3.123.1.1
A row of the control table that defines one aggregated MO. Entries in this table are required to survive a reboot of the managed entity depending on the value of the corresponding aggrCtlEntryStorageType instance.
OBJECT-TYPE    
  AggrCtlEntry  

aggrCtlEntryID 1.3.6.1.3.123.1.1.1
A locally unique, administratively assigned name for this aggregated MO. It is used as an index to uniquely identify this row in the table.
OBJECT-TYPE    
  SnmpAdminString Size(1..32)  

aggrCtlMOIndex 1.3.6.1.3.123.1.1.2
A pointer to a group of MOs identified by aggrMOEntryID in the aggrMOTable. This is the group of MOs that will be aggregated.
OBJECT-TYPE    
  Unsigned32 1..2147483647  

aggrCtlMODescr 1.3.6.1.3.123.1.1.3
A textual description of the object that is being aggregated.
OBJECT-TYPE    
  SnmpAdminString Size(0..64)  

aggrCtlCompressionAlgorithm 1.3.6.1.3.123.1.1.4
The compression algorithm that will be used by the agent to compress the value of the aggregated object. The deflate algorithm and corresponding data format specification is described in RFC 1951. It is compatible with the widely used gzip utility.
OBJECT-TYPE    
  INTEGER none(1), deflate(2)  

aggrCtlEntryOwner 1.3.6.1.3.123.1.1.5
The entity that created this entry.
OBJECT-TYPE    
  OwnerString  

aggrCtlEntryStorageType 1.3.6.1.3.123.1.1.6
This object defines whether the parameters defined in this row are kept in volatile storage and lost upon reboot or backed up by non-volatile (permanent) storage. Conceptual rows having the value 'permanent' need not allow write-access to any columnar objects in the row.
OBJECT-TYPE    
  StorageType  

aggrCtlEntryStatus 1.3.6.1.3.123.1.1.7
The row status variable, used according to row installation and removal conventions. Objects in a row can be modified only when the value of this object in the corresponding conceptual row is not 'active'. Thus, to modify one or more of the objects in this conceptual row, a. change the row status to 'notInService', b. change the values of the row, and c. change the row status to 'active'. The aggrCtlEntryStatus may be changed to 'active' if all the MOs in the conceptual row have been assigned valid values.
OBJECT-TYPE    
  RowStatus  

aggrMOTable 1.3.6.1.3.123.2
The table of primary(simple) MOs that will be aggregated. Each row in this table represents a MO that will be aggregated. The aggrMOEntryID index is used to identify the group of MOs that will be aggregated. The aggrMOIndex instance in the corresponding row of the aggrCtlTable will have a value equal to the value of aggrMOEntryID. The aggrMOEntryMOID index is used to identify an MO in the group.
OBJECT-TYPE    
  SEQUENCE OF  
    AggrMOEntry

aggrMOEntry 1.3.6.1.3.123.2.1
A row of the table that specifies one MO. Entries in this table are required to survive a reboot of the managed entity depending on the value of the corresponding aggrMOEntryStorageType instance.
OBJECT-TYPE    
  AggrMOEntry  

aggrMOEntryID 1.3.6.1.3.123.2.1.1
An index uniquely identifying a group of MOs that will be aggregated.
OBJECT-TYPE    
  Unsigned32 1..2147483647  

aggrMOEntryMOID 1.3.6.1.3.123.2.1.2
An index to uniquely identify an MO instance in the group of MO instances that will be aggregated.
OBJECT-TYPE    
  Unsigned32 1..65535  

aggrMOInstance 1.3.6.1.3.123.2.1.3
The OID of the MO instance, the value of which will be sampled by the agent.
OBJECT-TYPE    
  OBJECT IDENTIFIER  

aggrMODescr 1.3.6.1.3.123.2.1.4
A textual description of the object that will be aggregated.
OBJECT-TYPE    
  SnmpAdminString Size(0..64)  

aggrMOEntryStorageType 1.3.6.1.3.123.2.1.5
This object defines whether the parameters defined in this row are kept in volatile storage and lost upon reboot or backed up by non-volatile (permanent) storage. Conceptual rows having the value 'permanent' need not allow write-access to any columnar objects in the row.
OBJECT-TYPE    
  StorageType  

aggrMOEntryStatus 1.3.6.1.3.123.2.1.6
The row status variable, used according to row installation and removal conventions. Objects in a row can be modified only when the value of this object in the corresponding conceptual row is not 'active'. Thus, to modify one or more of the objects in this conceptual row, a. change the row status to 'notInService', b. change the values of the row, and c. change the row status to 'active'. The aggrMOEntryStatus may be changed to 'active' iff all the MOs in the conceptual row have been assigned valid values.
OBJECT-TYPE    
  RowStatus  

aggrDataTable 1.3.6.1.3.123.3
Each row of this table contains information about an aggregateMO indexed by aggrCtlEntryID.
OBJECT-TYPE    
  SEQUENCE OF  
    AggrDataEntry

aggrDataEntry 1.3.6.1.3.123.3.1
Entry containing information pertaining to an aggregate MO.
OBJECT-TYPE    
  AggrDataEntry  

aggrDataRecord 1.3.6.1.3.123.3.1.1
The snapshot value of the aggregated MO. Note that the access privileges to this object will be governed by the access privileges of the component objects. Thus, an entity attempting to access an instance of this MO MUST have access rights to all the component instance objects and this MO instance.
OBJECT-TYPE    
  AggrMOValue  

aggrDataRecordCompressed 1.3.6.1.3.123.3.1.2
The compressed value of the aggregated MO. The compression algorithm will depend on the aggrCtlCompressionAlgorithm given in the corresponding aggrCtlEntry. If the value of the corresponding aggrCtlCompressionAlgorithm is (1) 'none', then the value of all instances of this object will be a string of zero length. Note that the access privileges to this object will be governed by the access privileges of the component objects. Thus, an entity attempting to access an instance of this MO MUST have access rights to all the component instance objects and this MO instance.
OBJECT-TYPE    
  AggrMOCompressedValue  

aggrDataErrorRecord 1.3.6.1.3.123.3.1.3
The error status corresponding to the MO instances aggregated in aggrDataRecord (and aggrDataRecordCompressed).
OBJECT-TYPE    
  AggrMOErrorStatus  

aggrConformance 1.3.6.1.3.123.4
OBJECT IDENTIFIER    

aggrGroups 1.3.6.1.3.123.4.1
OBJECT IDENTIFIER    

aggrCompliances 1.3.6.1.3.123.4.2
OBJECT IDENTIFIER    

aggrMibCompliance 1.3.6.1.3.123.4.2.1
The compliance statement for SNMP entities that implement the AGGREGATE-MIB.
MODULE-COMPLIANCE    

aggrMibBasicGroup 1.3.6.1.3.123.4.1.1
A collection of objects for aggregation of MOs.
OBJECT-GROUP