Muonics: MIB Smithy - Developer's Guide - Querying Variation Properties

Querying Variation Properties

Syntax:

% dbcmd get property ?property ...? variation

Returns:

The value of the specified parameter (see below).

Properties:

Option	Description
`-access -min-access`	Returns the value of the ACCESS (AGENT-CAPABILITIES), MIN-ACCESS (MODULE-COMPLIANCE) or PIB-MIN-ACCESS (COPS-PR-SPPI MODULE-COMPLIANCE) field for the variation. This property will return the value `undefined` if the field is not present in variation definition.
`-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.
`-creation-requires`	Returns a list of identifiers or OID values corresponding to the list of OBJECT-TYPEs referenced by the CREATION-REQUIRES field of an AGENT-CAPABILITIES conformance module (SUPPORTS).
`-defval`	Returns the value of the DEFVAL field for the variation, if any. The format for the return value is the same as that for the OBJECT-TYPE property of the same name.
`-description`	Returns the body of text corresponding to the DESCRIPTION field for the variation.
`-enumdecl`	Returns the as-declared list of named-number enumerations allowed by the variation's SYNTAX field. Returns an empty string if the variation has no such declared enumerations. Each list element is its self a list of two or three elements corresponding to the name, value and any comments associated with the value. `{ name value ?comments? } ...` Hex and binary enumeration values not converted to integers in the result.
`-enums`	Returns the as-inherited list of named-number enumerations allowed by the variation's SYNTAX field. If the variation contains an enumerated refinement then it is returned as in `-enumdecl`. Otherwise, this property returns the `-enums` property for the OBJECT-TYPE referenced by the variation. In any case, hex and binary enumeration values are converted to integers in the result.
`-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, conformance name, conformance module name, and variation name joined together with a `!` (exclamation point), as in `@File2!EX-MIB!exCompliance!EX-MIB!exObject`.
`-name`	Returns the unqualified name of the
`-range`	Returns the as-inherited list of discrete ranges allowed by the variation's SYNTAX field. If the variation contains a range refinement then it is returned as in `-rangedecl`. Otherwise, this property returns the `-range` property for the OBJECT-TYPE referenced by the variation.
`-rangedecl`	Returns the as-declared list of discrete ranges allowed by the variation's SYNTAX field. Returns an empty string if the variation has no such declared range refinement. Each list element is a minimum/maximum value pair, regardless of whether or not the minimum and maximum values are equal.
`-size`	Returns the as-inherited list of discrete lengths allowed by the variation's SYNTAX field. If the variation contains a size refinement then it is returned as in `-sizedecl`. Otherwise, this property returns the `-size` property for the OBJECT-TYPE referenced by the variation.
`-sizedecl`	Returns the as-declared list of discrete lengths allowed by the variation's SYNTAX field. Returns an empty string if the variation has no such declared size refinement. Each list element is a minimum/maximum length pair, regardless of whether or not the minimum and maximum lengths are equal.
`-subtype`	Returns a list of name/value pairs equivalent to the `components` field of the `-syntaxdecl` option, including any further structure/subtype information thereof.
`-syntax`	Returns the data type referenced by the variation's SYNTAX field. This property will return an empty string no SYNTAX field is present in the imported module.
`-syntaxdecl`	Returns the full as-declared SYNTAX information for the variation as a list of name/value pairs suitable for use with Tcl's `array set` command. The format is the same as that returned for Type Assignments and TEXTUAL-CONVENTIONs. This property will return an empty string no SYNTAX field is present in the imported module.
`-write-enumdecl`	Returns the as-declared list of named-number enumerations allowed by the variation's WRITE-SYNTAX field. Returns an empty string if the variation has no such declared enumerations. Each list element is its self a list of two or three elements corresponding to the name, value and any comments associated with the value. `{ name value ?comments? } ...` Hex and binary enumeration values not converted to integers in the result.
`-write-enums`	Returns the as-inherited list of named-number enumerations allowed by the variation's WRITE-SYNTAX field. If the variation contains an enumerated refinement then it is returned as in `-write-enumdecl`. Otherwise, this property returns the `-enums` property for the variation. In any case, hex and binary enumeration values are converted to integers in the result.
`-write-range`	Returns the as-inherited list of discrete ranges allowed by the variation's WRITE-SYNTAX field. If the variation contains a range refinement then it is returned as in `-write-rangedecl`. Otherwise, this property returns the `-range` property for the variation.
`-write-rangedecl`	Returns the as-declared list of discrete ranges allowed by the variation's WRITE-SYNTAX field. Returns an empty string if the variation has no such declared range refinement. Each list element is a minimum/maximum value pair, regardless of whether or not the minimum and maximum values are equal.
`-write-sizedecl`	Returns the as-declared list of discrete lengths allowed by the variation's WRITE-SYNTAX field. Returns an empty string if the variation has no such declared size refinement. Each list element is a minimum/maximum length pair, regardless of whether or not the minimum and maximum lengths are equal.
`-write-size`	Returns the as-inherited list of discrete lengths allowed by the variation's WRITE-SYNTAX field. If the variation contains a size refinement then it is returned as in `-write-sizedecl`. Otherwise, this property returns the `-size` property for the variation.
`-write-subtype`	Returns a list of name/value pairs equivalent to the `components` field of the `-write-syntaxdecl` option, including any further structure/subtype information thereof.
`-write-syntax`	Returns the data type referenced by the variation's WRITE-SYNTAX field. This property will return an empty string no WRITE-SYNTAX field is present in the imported module.
`-write-syntaxdecl`	Returns the full as-declared WRITE-SYNTAX information for the variation as a list of name/value pairs suitable for use with Tcl's `array set` command. The format is the same as that returned for Type Assignments and TEXTUAL-CONVENTIONs. This property will return an empty string no SYNTAX field is present in the imported module.

< Prev

Back to Table of Contents

Next >