MIB Smithy

Querying Capability Properties

Capability records (for AGENT-CAPABILITIES statements) are another type of container record in MIB Smithy SDK, most similar to MODULE-COMPLIANCE statements. Where MODULE-COMPLIANCE statements define minimum implementation requirements, AGENT-CAPABILITIES statements document actual implementations. Like files and modules, they provide a number of properties to list information about contained records in a heirarchical fashion, in addition to properties of the AGENT-CAPABILITIES statement its self, such as the product version to which it applies.

Syntax:

% dbcmd get property ?property ...? capability

Returns:

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

Properties:

-cmodules

Returns a list of conformance module records corresponding to each SUPPORTS section within the AGENT-CAPABILITIES record.

MODULE1 MODULE2 MODULE3 ...

-comments

Returns the textual comments associated with record

-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 AGENT-CAPABILITIES record.

-fullname

Returns the fully-qualified name of the record in the form accepted by the SDK as a search query. For this record type, that is the file handle, the module name and the record name joined together with a ! (exclamation point), as in @File2!WIDGET-MIB!widgetCapabilities.

-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.

-includes

Like -cmodules, but each conformance module is coupled with a list of identifiers or OID values corresponding the list of groups referenced by the INCLUDES field for the module.

MODULE1 { group1 group2 ... } MODULE2 {} ...

-name

Returns the unqualified name of the AGENT-CAPABILITIES record.

-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.

-reference

Returns the body of text corresponding to the REFERENCE field of the AGENT-CAPABILITIES record.

-release

Returns the text corresponding to the PRODUCT-RELEASE field of the AGENT-CAPABILITIES record.

-status

Returns the value of the STATUS field for the AGENT-CAPABILITIES record.

-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 }.

-variations

Like -cmodules, but each conformance module is coupled with a list of records corresponding to OBJECT references within the SUPPORTS section.

MODULE1 { var1 var2 ... } MODULE2 {} ...