history

Manage a history file instance.

Syntax

[no] history <instance> [<command>]

Syntax Description

Keyword
Description

no

(Optional) Deletes the specified history instance.

instance

The history instance to be created or modified. If the specified instance does not exist, it will be created unless the no keyword was also specified. Must be alphanumeric.

command

One of “empty”, “filter”, “interval”, “output-format”, “rename”, “url”, or “utc”. The command is required unless the no parameter is specified.

Defaults

Usage Guidelines

This command is used to create, modify, or delete a history file instance.

Island maintans a record of all device-related activity such as Internet access and session data counters, online and offline events, etc. These “history” events are stored internally in a compact binary format, and can be displayed with the show history command.

History data can formatted and saved in files to be transferred to a remote file server on a periodic basis. A history “instance” refers to a set of named history configuration commands that control the creation, format, transfer, and other characteristics of the associated history files.

The creation of history files is enabled with the history interval command. Therefore when creating a new history instance, it is usually preferrable to issue all other desired history commands such as history output-format and history filter before issuing the history interval command, otherwise the system may create one or more initial history files with improper characteristics.

History files are automatically deleted upon successful transfer to the remote system. To see the list of history files waiting to be transferred, use the show syslog history command.

An entire history instance can be deleted by entering this command with the no prefix. This will delete all unsent history files and all configuration commands associated with the instance.

Examples

no history myhist2
history emptyhistory filterhistory intervalhistory output-formathistory renamehistory urlhistory utcshow historyshow syslog

Last updated