Previous Topic: AttributeGroup (Vendor Certification)Next Topic: Configuration Data Attributes


General Attributes (Vendor Certification)

The general attributes for all vendor certifications are as follows:

Attribute/name

Specifies the attribute name.

Recommendation: Set to the MIB variable name, which the OBJECT-TYPE clause defines in the ASN.1 file.

Can be updated: Yes

Possible values: Alphanumeric and underscore. Dot and dash are not permitted.

Effect of updating: You must update any expressions that reference this attribute.

When does the update take effect: Immediately

Required actions for updates to take effect: None

Attribute/type

Specifies the data type of the attribute.

Recommendation: Use the attribute type that best matches the variable type that the SYNTAX clause defines in the ASN.1 file.

Can be updated: Yes

Possible values: Boolean, Int, Long, Double, BigInteger, String, DateTime, IPAddress, MACaddress, IPSubnet, OctetString, ObjectID

Effect of updating: Polled SNMP data is converted to this type.

When does the update take effect: Next poll

Required actions for updates to take effect: None

Documentation

(Optional) Specifies the description for the attribute, which documents the semantics (such as the unit) of the MIB variable.

Recommendation: Use the descriptions that are taken from the MIB ASN.1 file.

Can be updated: Yes

Possible values: Plain text

Effect of updating: None

IsKey

(Optional) Uses a flag to indicate whether the MIB variable is key for determining support for a table. When multiple fields are specified as keys, all of the fields are considered together as a compound key.

Default: false

Recommendation: Set to true if it is a key MIB object for component discovery.

Can be updated: Yes

Possible values: true, false

Effect of updating: Components could change to a new vendor certification.

When does the update take effect: After component rediscovery.

Required actions for updates to take effect: Update the metric family or change the vendor certification priority.

IsIndex

(Optional) Uses a flag to indicate whether this variable is an index to the MIB table.

Default: false

Recommendation: Set to true for an index attribute.

Can be updated: Yes

Possible values: true, false

Effect of updating: Component indexing could change.

When does the update take effect: After component rediscovery.

Required actions for updates to take effect: Update the metric family or change the vendor certification priority.

NeedsDelta

(Optional) Uses a flag to indicate whether to delta (that is, store the difference between current and last poll for Counters) the MIB variable.

Default: false

Recommendation: Set to true if the variable is defined as a Counter, Counter32, Counter64, or TimeTicks quantity in the MIB.

Can be updated: Yes

Possible values: true, false

Effect of updating: The polled data changes.

When does the update take effect: Next poll

Required actions for updates to take effect: None

Source

Specifies the ObjectID of the attribute.

Recommendation: Set to the fully qualified MIB variable OID that the OBJECT-TYPE defines.

Can be updated: Yes

Possible values: Dot-separated numbers (for example, 1.3.6.1.4.1…)

Effect of updating: Data is polled from the specified OID.

When does the update take effect: Next poll

Required actions for updates to take effect: None

Version

Specifies the version of the vendor certification. When a vendor certification is installed during an upgrade, the installer checks the version of the certification. If the version is newer than the one in the installer package, the installer does not change the existing vendor certification.

Default: 1.0

Can be updated: Yes

Possible values: Dot-separated numbers (for example, 1.3.6.1.4.1…)

Effect of updating: The version attribute is updated.

When does the update take effect: Immediately

Required actions for updates to take effect: None

Author

Specifies the creator of the vendor certification.

Default: "Custom"

Can be updated: Yes

Possible values: Any alphanumeric string.

Effect of updating: The author attribute is updated.

When does the update take effect: Immediately

Required actions for updates to take effect: None

The list of attributes specifies the set of data that a metric family collects when supported by this vendor certification. Typically, this data falls into two categories:

More information:

Multi-MIB Table Support

Filtering Support