Dict Module

The dict module registers expansions which query the dictionaries.

Expansions

The following expansions allow querying the dictionaries.

%dict.attr(<string>)

Takes an attribute name, and returns the canonicalized name of the attribute.

If the attribute does not exist, nothing is returned.

%dict.attr.by_num(<uint32>)

Return: string

Takes an attribute number, and returns the canonicalized name of the attribute.

If the attribute does not exist, nothing is returned.

This function is useful only for "top level" attributes such as User-Name. Where the attribute is nested, use %dict.attr.by_oid() instead.

%dict.attr.by_oid(<string>)

Return: string

Takes a full OID reference (e.g. 26.9.1), and returns the name of the attribute.

If the attribute does not exist, nothing is returned.

%dict.attr.num(<string>)

Return: string

Takes an attribute name, and returns the number of the attribute.

If the attribute does not exist, nothing is returned.

Note that only the final attribute number is returned. For example, the OID for Vendor-Specific.Cisco.AVPair is 26.9.1. This function will return 1, and not the full OID.

%dict.attr.type(<string>)

Return: uint32

Takes an attribute name, and returns the data type of the attribute.

If the attribute does not exist, nothing is returned.

%dict.vendor(<string>)

Return: string

Takes an vendor name, and returns the canonicalized name of the vendor.

If the vendor does not exist, nothing is returned.

%dict.vendor.by.num(<uint32>)

Return: string

Takes an vendor number, and returns the canonicalized name of the vendor.

If the vendor does not exist, nothing is returned.

Configuration Settings

Return: string

This module takes no configuration.

Default Configuration

dict {
}