base/misc/version.zeek

Version

Provide information about the currently running Zeek version. The most convenient way to access this are the Version::number and Version::info constants.

Namespace:Version
Imports:base/frameworks/reporter, base/utils/strings.zeek

Summary

Constants

Version::info: Version::VersionDescription VersionDescription record pertaining to the currently running version of Zeek.
Version::number: count version number of the currently running version of Zeek as a numeric representation.

Types

Version::VersionDescription: record A type exactly describing a Zeek version

Functions

Version::at_least: function Test if the current running version of Zeek is greater or equal to the given version string.
Version::parse: function Parse a given version string.

Detailed Interface

Constants

Version::info
Type:Version::VersionDescription

VersionDescription record pertaining to the currently running version of Zeek.

Version::number
Type:count

version number of the currently running version of Zeek as a numeric representation. The format of the number is ABBCC with A being the major version, bb being the minor version (2 digits) and CC being the patchlevel (2 digits). As an example, Zeek 2.4.1 results in the number 20401

Types

Version::VersionDescription
Type:

record

version_number: count

Number representing the version which can be used for easy comparison. The format of the number is ABBCC with A being the major version, bb being the minor version (2 digits) and CC being the patchlevel (2 digits). As an example, Zeek 2.4.1 results in the number 20401.

major: count

Major version number (e.g. 2 for 2.5)

minor: count

Minor version number (e.g. 5 for 2.5)

patch: count

Patch version number (e.g. 0 for 2.5 or 1 for 2.4.1)

commit: count

Commit number for development versions, Versions prior to 3.0.0, like “2.4-12”, use a post-release commit number (12 commits after the 2.4 release). Versions after 3.0.0, like “3.1.0-dev.37”, use a pre-release commit number (37 commits into the development cycle for 3.1.0). For non-development version this number will be zero.

beta: bool

If set to true, the version is a beta build of Zeek. These versions may start like “2.6-beta” or “3.0.0-rc” (the “rc” form started being used for 3.0.0 and later).

debug: bool

If set to true, the version is a debug build

version_string: string

String representation of this version

A type exactly describing a Zeek version

Functions

Version::at_least
Type:function (version_string: string) : bool

Test if the current running version of Zeek is greater or equal to the given version string.

Version_string:Version to check against the current running version.
Returns:True if running version greater or equal to the given version.
Version::parse
Type:function (version_string: string) : Version::VersionDescription

Parse a given version string.

Version_string:Zeek version string.
Returns:VersionDescription record.