Script variables used in KSS NG
Fields, a globally accessible object, passes variables to and from the script. Variables are used to store data values you receive from messages in Kiwi Syslog Server NG (KSS NG). See Use variables in a script for reference.
The current version of KSS NG only supports PowerShell scripts.
Use the following variables for scripts in KSS NG.
Common variables
| Display name | Variable name | Description | Variable type | Example |
|---|---|---|---|---|
VarFacility
|
$Common.VarFacility
|
The facility value of the message. | Integer (0-32767) | 19
|
VarLevel
|
$Common.VarLevel
|
The level value of the message. | Integer (0-32767) | 7
|
VarInputSource
|
$Common.VarInputSource
|
The message input source. | Integer (0-32767) | 4
|
VarPeerAddress
|
$Common.VarPeerAddress
|
The IP address of the sending device in nnn.nnn.nnn.nnn format. If another syslog collector forwards the message, this value contains the original sender's address. |
String | 192.168.1.67
|
VarPeerName
|
$Common.VarPeerName
|
If you enable DNS lookup options and a lookup is successful, this field only contains a resolved host name. Otherwise, this field contains the same value as VarPeerAddress in the format. | String | myhost
|
VarPeerDomain
|
$Common.VarPeerDomain
|
The domain name of the resolved FQDN. This is the domain suffix. It does not contain the host name. | String | http://mydomain.com
|
VarCleanMessageText
|
$Common.VarCleanMessageText
|
The modified message text (for example, header removed, DNS lookups, original address removed, and Cisco date removed). | String | SEC-6-IPACCESSLOGP: list 101 denied udp 10.0.0.3 (firewall) (137) -> 216.7.14.105 (webserver.company. com) (137), 1 packet |
Other variables
| Display name | Variable name | Description | Variable type | Example |
|---|---|---|---|---|
VarDate
|
$Other.VarTime
|
The date the message was received by the syslog program. | String (10 bytes) | 2022-12-31
|
VarTime
|
$Other.VarTime
|
The time the message was received by the syslog program. | String (8 bytes) | 23:10:04
|
VarMilliSeconds
|
$Other.VarSocketPeerAddress
|
The time the message was received by the syslog program, in milliseconds past the second. | String (3 bytes) | 099 |
VarSocketPeerAddress
|
$Other.VarSocketPeerAddress
|
The IP address of the device, or the closest syslog collector, that sent the message. | String | 192.168.1.67 |
VarPeerAddressHex
|
$Other.VarPeerAddressHex
|
The IP address of the device that sent the message converted to an 8 digit hex value. | String (8 bytes) | C0A80102
|
VarPeerPort
|
$Other.VarPeerPort
|
The UDP/TCP port that the message was sent from. | Integer (0-65535) | 65535
|
VarLocalAddress
|
$Other.VarLocalAddress
|
The IP address that the message was sent to on this machine. | String | 192.0.2.0
|
VarLocalPort
|
$Other.VarLocalPort |
The local machine UDP/TCP port that received the message. | Integer (0-65535) | 191
|
VarPriority |
$Other.VarPriority |
The message priority value. | Integer (0-32767) | 65535
|
VarRawMessageText
|
$Other.VarRawMessageText
|
The message as it was received before modification (includes <pri> tag, original address, and so on). |
String | $Other.VarRawMessageText |
Global variables
| Display name | Variable name | Description | Variable type | Example |
|---|---|---|---|---|
<UserDefinedName>
|
$Global.<UserDefined>
|
Variable to be set in scripts that are executed on each syslog/trap message. (The system does not erase static values with each new message like the other script fields) | String | $Custom.<UserDefined>
|
Custom variables
| Display name | Variable name | Description | Variable type | Example |
|---|---|---|---|---|
<UserDefinedName>
|
$Custom.<UserDefined>
|
Variable to be set in scripts that are executed on each syslog/trap message. | String | $Custom.<UserDefined>
|
The scripts are not supported under any SolarWinds support program or service. The scripts are provided AS IS without warranty of any kind. SolarWinds further disclaims all warranties including, without limitation, any implied warranties of merchantability or of fitness for a particular purpose. The risk arising out of the use or performance of the scripts and documentation stays with you. In no event shall SolarWinds or anyone else involved in the creation, production, or delivery of the scripts be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use of or inability to use the scripts or documentation.