This section describes common item options. The sections that describe particular item types define the subset of these options applicable to a particular item type.

-address address

The -address option defines the address of the item. No assumptions are made by the Tnm map implementation about the format and the semantics of the address. Scripts that interpret the value of a -address option should carefully check whether the format is accept-able.

The -color option gets or sets the color of the item. No assumptions are made on the format of the color value. It is however suggested to use Tk color names.

The -ctime option gives access to the creation date and time as a system-dependent integer value. The resolution of the creation time is seconds. The value has the same properties as time-stamps returned by the Tcl clock seconds command. This option is read-only because the creation time-stamp is maintained entirely by the map implementation.

The -expire option defines the default lifetime for events and messages in seconds. Events and messages are removed from the event history automatically if the -tick option is greater than zero and the lifetime of the event or message has expired.

The -font option gets or sets the font of the item. No assumptions are made on the format of the font value. It is however suggested to use Tk font names.

The -group option is used to make the item a member of the group group. Setting this option to an empty string removes the calling item from the group.

The -icon option gets or sets the icon associated with an item. No assumptions are made on the format of the icon value.

The -mtime option gives access to the last modification date and time as a system-dependent integer value. The resolution of the modification time is seconds. The value has the same properties as time-stamps returned by the Tcl clock seconds command. This option is read-only because the modification time-stamp is maintained entirely by the map implementation.

The -name option defines the name of the item. No assumptions are made by the Tnm map implementation about the format and the semantics of the name. Scripts that interpret the value of a -name option should care-fully check whether the format is acceptable.

The -path option defines the path in the file system, where item statistics will be stored. All statistic files are maintained in a sub-directory, which is used to group together all statistics of a particular day.

The -store option is used to maintain a list of message tag pattern that are used to control whether a message is written to a file or not. Each element of the patternList is matched against a message tag. A positive match will cause the message to be saved in a file.

The -tags option is used to tag items. Tags are a convenient way to group items together to form target sets for management operations. For example, one might want to tag all routers with the tag “router” and all dev-ices from vendor acme with “acme”. The map# find command can later be used to retrieve all “routers” from vendor “acme”.