MIB Smithy

Querying Module Identity Properties

Syntax:

% dbcmd get property ?property ...? moduleid

Returns:

• The value of the specified property or properties (see below).

Properties:

-categories

Returns a list corresponding to the SUBJECT-CATEGORIES field of a COPS-PR-SPPI (PIB) MODULE-IDENTITY statement. An empty string is returned to represent the is "all" case. Otherwise, the format of the result the same as that of the -enumdecl property for other record types: a list of name+value pairs or name+value+comments triplets.

{ name value ?comments? } ...

-comments

Returns the textual comments associated with record.

-contactinfo

Returns the body of text corresponding to the CONTACT-INFO field of the MODULE-IDENTITY statement.

-container

Returns the fully-qualified name of the record in which the queried record is contained. This property equivalent to -fullname for the container record, or for the queried record with the last envelope stripped off.

-description

Returns the body of text corresponding to the DESCRIPTION field of the MODULE-IDENTITY statement.

-fullname

Returns the fully qualified name of the MODULE-IDENTITY statement (e.g. @File3!SNMPv2-MIB!snmpMIB).

-fulloid

Returns the absolute (or as close as possible) OID value for the record, in dotted numeric notation (e.g. 1.3.6....). If the OID is not able to be resolved all the way to one of the root nodes (ccitt, iso, joint-iso-ccitt), due to one or more dependent modules not being present in the database, then the first component will be that of the descriptor that could not be resolved.

-lastupdated

Returns the value of the LAST-UPDATED field of the MODULE-IDENTITY statement as it appears in the source file. Assuming it is valid, this value is returned in ExtUTCTime format.

-name

Returns the unqualified name of the MODULE-IDENTITY statement.

-oid

Returns the OID value for the record, in dot-delimited notation, with the module name and name portion of name-and-number forms (if any) stripped out. That is, a.1.2.3 will be returned even if the OID value is declared in the ASN.1 as { EX-MIB.a b(1) c(2) 3 }.

-oidsuffix

Returns a dot-delimited list of "extra" subidentifiers specified in the record search string that were not part of the matched portion that pointed to this record. e.g., the -oidsuffix property for sysDescr.0 is 0.

-organization

Returns the body of text corresponding to the ORGANIZATION field of the MODULE-IDENTITY statement.

-revisions

Returns a list of timestamp+description pairs corresponding to each REVISION clause of the MODULE-IDENTITY statement. Timestamps are returned as they appear in the source module. Assuming they are valid, they are returned in ExtUTCTime format.

-subids

Returns a list of integers representing the next subidentifier for each record whose OID values are assigned immediately subordinate to the OID value of the record search string. For example, if records assigned the OID values x.1 and x.2, then the -subids property for x is the list { 1 2 }.

-subnodes

Returns a list of records whose OID values are assigned immediately subordinate to the OID value of the record search string and that are defined in the same module. An element may be returned as a relative OID for "implicit" node definitions (e.g., assuming records are assigned values x.1.1 and x.1.2, but none are defined for x.1, then the result will include the value x.1).

-value

Equivalent to -oid for get operations.

-valuedecl

Returns the "as-declared" OID value for the record, in dot-delimited notation. If the first component is specified using module.descriptor form it is returned as module:descriptor. That is, SNMPv2-MIB:system.1 will be returned if the OID value is declared in the ASN.1 it as { SNMPv2-MIB.system 1 }.