VPN Statistics Alert
The VPN Statistics Alert triggers when recorded statistics on VPN or Radius messages match relative or absolute criteria. For example, an alert can be configured to trigger when the Number of Bytes Received per day for a specific user exceeds, say, 1 Mb per day, which is an absolute value. The alert rule could also be configured as a relative rule, for example “grows by 10%.”
Request Parameters
VPNUser, VPNGroup, VPNIP, Statistic, MatchCount, PerTimeUnit, MeasureBy, ChangeAs, ChangeValue
Example
“VPNUser/null//VPNGroup/null//VPNIP/null//Statistic/bytes sent//PerTimeUnit/minute//ChangeAs/equals//ChangeValue/3.0//MeasureBy/0//MatchCount/55”
The following table lists the VPN Statistics Alert-specific parameters. You must include the parameters as inputs for the alertRules parameter.
| Parameter | Description | Values | Required | Type |
|---|---|---|---|---|
| VPNUser | Defines the VPN user from where the connection originates.
If you specify a value for the VPNUser parameter, you must also specify a value for the VPNGroup parameter. You can specify a value for the VPNIP parameter instead of the VPNUser and VPNGroup parameters together. |
optional | string | |
| VPNGroup | Defines the VPN Group from where the connection originates.
You must specify a value for the VPNGroup parameter if you specify a value for the VPNUser parameter. You can specify a value for the VPNIP parameter instead of the VPNUser and VPNGroup parameters together. |
optional | string | |
| VPNIP | Defines the VPN IP address from where the connection originates.
You can use the VPNIP parameter as an additional filter instead of using the VPNUser and VPNGroup parameters. |
Standard IP address format. For example:
10.1.2.3 |
optional | string |
| statistic | Identifies the type of statistic.
Specify the perTimeUnit parameter with the statistic parameter. If you specify the value as Connection Duration, the perTimeUnit parameter is not necessary as the value defaults to seconds. |
Possible values:
Number of Connections, Number of Denies, Bytes Sent, Bytes Received, Connection Duration. |
yes | string |
| matchCount | In the Threshold field, enter the number of times a match must occur before an alert is sent. The match is determined by the combination of the fields you define for this type of alert. | yes | int | |
| perTimeUnit | Rate at which the statistic type (statistic parameter) is sampled. This field is not applicable to if the value of the statistic parameter is Connection Duration. | Possible values:
second, minute, hour, day, week, none. If you specify none, statistics are measured regardless of rate. |
yes | string |
| measureBy | Select wheather to use a relative or absolute measurement to trigger the alert. | 0 or 1. | yes | string |
| changeAs | Defines the percentage of increase or decrease of the alert type (statistic parameter).
For example, to be alerted when a number of Denied Connections per second grows by 400% from the average, enter the value “grows by 400". The average is taken from the previous time period and varies depending on the type of information you view. |
Possible values:
grows by ##% drops by ##% Where ## is a positive integer. The ## value is a percentage. For example: grows by 400 or drops by 200 |
yes | string |
| changeValue | Defines the absolute number of denied connections per second that an alert type (statistic parameter) must change by for an alert to be generated.
For example, to be alerted when a number of Denied Connections per second increases by 400 from the average, enter the value “increases by 400". |
Possible values:
exceeds ## falls below ## equals ## increase by ## decrease by ## Where ## is a positive integer. The ## value is the number of denied connections per second. For example: exceeds 400 or TIBCO LogLogic LMI Web Services API Implementation Guide |
yes | string |