Home
You are not currently signed in.

MIB Smithy

Developer's Guide

  1. Document Conventions
  2. Getting Started
  3. General Provisions

SMI Databases

  1. Basics
  2. Creating Records
  3. Destroying Records
  4. Importing Modules
  5. Database Search
  6. Querying Properties
  7. Setting Properties
  8. Comparing OIDs
  9. Building/Parsing OIDs
  10. Logging
  11. Record Types
  12. Pattern Matching
  13. MIB Validation
  14. Tree Introspection

SNMP Sessions

  1. Basics
  2. Opening Sessions
  3. Closing Sessions
  4. Listing Sessions
  5. Configuring Sessions
  6. Session Aliases
  7. Get Requests
  8. Set Requests
  9. Get-Next Requests
  10. Get-Bulk Requests
  11. Inform Requests
  12. Sending Traps
  13. Walking Subtrees
  14. Receiving Traps
  15. Pending Requests
  16. Waiting for Requests
  17. Cancelling Requests
  18. Variable Bindings
  19. Callback Functions
  20. Formatting Data
  21. Scanning Data
  22. Logging

USM

  1. USM Key Management

Scotty/TNM Porting

  1. Compatibility Package
  2. MIB Commands
  3. SNMP Commands
  1. Up to Table of Contents

Setting Object Properties

Syntax:

% dbcmd set object option value ?option value ...?

Returns:

  • Nothing.

Properties:

-access access
Specifies the value of the ACCESS or MAX-ACCESS field for an OBJECT-TYPE record. Accepted values are not-accessible, accessible-for-notify, read-only, read-write, write-only and read-create.
-augments valuref
Equivalent to -augmentsdecl for set operations.
-augmentsdecl valuref
Specifies a reference to another OBJECT-TYPE defining a table row. This value corresponds to the AUGMENTS field of the OBJECT-TYPE statement, allowing new tables to extend other tables with a one-to-one row relationship between the two.
-comments text
Specifies the body of comment text that is to be associated with the record. Character sequences that start end end the comment should be omitted: these depend on the output format, and it is the responsibility of the converter to insert the appropriate sequences.
-defval list
Specifies the format and value for the OBJECT-TYPE's DEFVAL parameter.
-description text
Specifies the body of text corresponding to the DESCRIPTION field of the OBJECT-TYPE record.
-enumdecl list
Specifies a list of name+value+comment triplets defining the set of named-number enumerations allowed by the object.
-enums list
Equivalent to -enumdecl for set operations.
-extends valueref
Specifies the value of the EXTENDS field of a COPS-PR-SPPI (PIB) OBJECT-TYPE.
-extendsdecl valueref
Equivalent to -extendsdecl for set operations.
-index list
Equivalent to -indexdecl for set operations.
-indexdecl list
Specifies a list of references to other OBJECT-TYPE definitions that are to be listed within the record's INDEX field, defining a union of objects used to uniquely identify a particular row within a table. The last element may be prefixed by the asterisk (*) character to indicate the IMPLIED keyword should be used.
-name lcidentifier
Specifies the descriptor of the OBJECT-TYPE record. If unspecified at creation time, the SDK will automatically assign a name that is unique within the database. This property will accept any value that corresponds to an ASN.1 ValueReference: that is, an identifier that starts with a lowercase first letter.
-oid oidvalue
Equivalent to -valuedecl for set operations.
-piberrors list
Specifies a list of named-number enumerations for the INSTALL-ERRORS field of a COPS-PR-SPPI (PIB) OBJECT-TYPE. The format is the same as that of the -enums and -enumdecl properties.
-pibindex valueref
Specifies the value of the PIB-INDEX field of a COPS-PR-SPPI (PIB) OBJECT-TYPE.
-pibindexdecl valueref
Equivalent to -pibindex for set operations.
-pibreferences valueref
Specifies the value of the PIB-REFERENCES field of a COPS-PR-SPPI (PIB) OBJECT-TYPE.
-pibtag valueref
Specifies the value of the PIB-TAG field of a COPS-PR-SPPI (PIB) OBJECT-TYPE.
-range list
Equivalent to -rangedecl for set operations.
-rangedecl list
Specifies a list of min/max value pairs defining the set of discrete subranges allowed by the object.
-reference text
Specifies the body of text corresponding to the REFERENCE field of the OBJECT-TYPE record.
-size list
Equivalent to -sizedecl for set operations.
-sizedecl list
Specifies a list of min/max value pairs defining the set of octet lengths allowed by the object.
-status status
Specifies the value of the STATUS field for an OBJECT-TYPE record. Accepted values are mandatory, optional, current, deprecated and obsolete.
-subtype list
Specifies only the subtype for the object. In general, this property is only used with table definitions where the subtype is a reference to the SEQUENCE type assignment (as in SEQUENCE OF SubType.
-syntax typeref
Specifies only the base or derived type used by the object's SYNTAX field. Any existing range, size or enumeration refinements are preserved.
-syntaxdecl list
Specifies the full SYNTAX information for the OBJECT-TYPE record as a list of name+value pairs suitable for use with Tcl's array set command (or as returned by array get). The format is the same as that returned for querying and setting the property of the same name for Type Assignments/TEXTUAL-CONVENTIONs.
-uniqueness list
Specifies a list of columns for the UNIQUENESS field of a COPS-PR-SPPI (PIB) OBJECT-TYPE.
-uniquedecel list
Equivalent to -uniqueness for set operations.
-units text
Specifies the text corresponding to the UNITS field of the OBJECT-TYPE record, usually a short string such as "packets", "octets" or "mm".
-value oidvalue
Equivalent to -valuedecl for set operations.
-valuedecl oidvalue
Specifies the object identifier value that uniquely identifies the record in OID space. The oidvalue specified may take the form of a lowercase identifier or any of the forms returned by other get options that return OID values. The form used with this command determines the form returned by the get -valuedecl command.
  1. Up to Table of Contents
Copyright © 2024 Muonics, Inc. All Rights Reserved. Muonics, MIB Smithy, MIB Views, and their respective logos are trademarks of Muonics, Inc.