VPN Connection Alert

The VPN Connection Alert triggers when a VPN connection is denied access and/or disconnected. The VPN Connection alert is only applicable to Cisco VPN, Radius, and Nortel Contivity devices.

Request Parameters

VPNUser, VPNGroup, VPNIP, DisconnectReason

Example

Example of VPN Connection Alert with VPNUser request parameter: 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aler="AlertService">
   <soapenv:Header/>
   <soapenv:Body>
      <aler:createAlert>
         <!--Optional:-->
         <aler:authToken>admin/admin123</aler:authToken>
         <!--Optional:-->
         <aler:alertTypeName>VPN Connection Alert</aler:alertTypeName>
         <!--Optional:-->
         <aler:name>Alert22</aler:name>
         <!--Optional:-->
         <aler:desc>VPN Connections Alert - user alert</aler:desc>
         <!--Optional:-->
         <aler:priorityName>high</aler:priorityName>
         <!--Optional:-->
         <aler:enabled>no</aler:enabled>
         <!--Optional:-->
         <aler:deviceNames>All Other Unix</aler:deviceNames>
         <!--Optional:-->
         <aler:usernames>admin</aler:usernames>
         <!--Optional:-->
         <aler:trapIds></aler:trapIds>
         <!--Optional:-->
         <aler:resetTime>900</aler:resetTime>
         <!--Optional:-->
         <aler:trackIndividualDevice>yes</aler:trackIndividualDevice>
         <!--Optional:-->
         <aler:alertRules>VPNUser/aaa//VPNGroup/ssbb//VPNIP/null//DisconnectReason/both</aler:alertRules>
         <!--Optional:-->
         <aler:snmpOId></aler:snmpOId>
      </aler:createAlert>
   </soapenv:Body>
</soapenv:Envelope>

Example of VPN Connection Alert with VPNGroup request parameter: 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aler="AlertService">
   <soapenv:Header/>
   <soapenv:Body>
      <aler:createAlert>
         <!--Optional:-->
         <aler:authToken>admin/admin123</aler:authToken>
         <!--Optional:-->
         <aler:alertTypeName>VPN Connection Alert</aler:alertTypeName>
         <!--Optional:-->
         <aler:name>Alert23</aler:name>
         <!--Optional:-->
         <aler:desc>VPN Connections Alert - user alert</aler:desc>
         <!--Optional:-->
         <aler:priorityName>high</aler:priorityName>
         <!--Optional:-->
         <aler:enabled>no</aler:enabled>
         <!--Optional:-->
         <aler:deviceNames>All Other Unix</aler:deviceNames>
         <!--Optional:-->
         <aler:usernames>admin</aler:usernames>
         <!--Optional:-->
         <aler:trapIds></aler:trapIds>
         <!--Optional:-->
         <aler:resetTime>900</aler:resetTime>
         <!--Optional:-->
         <aler:trackIndividualDevice>yes</aler:trackIndividualDevice>
         <!--Optional:-->
         <aler:alertRules>VPNUser/null//VPNGroup/null//VPNIP/2.2.2.3//DisconnectReason/is disconnected</aler:alertRules>
         <!--Optional:-->
         <aler:snmpOId></aler:snmpOId>
      </aler:createAlert>
   </soapenv:Body>
</soapenv:Envelope>

Example of VPN Connection Alert with DisconnectReason request parameter: 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aler="AlertService">
   <soapenv:Header/>
   <soapenv:Body>
      <aler:createAlert>
         <!--Optional:-->
         <aler:authToken>admin/admin123</aler:authToken>
         <!--Optional:-->
         <aler:alertTypeName>VPN Connection Alert</aler:alertTypeName>
         <!--Optional:-->
         <aler:name>Alert24</aler:name>
         <!--Optional:-->
         <aler:desc>VPN Connections Alert - user alert</aler:desc>
         <!--Optional:-->
         <aler:priorityName>high</aler:priorityName>
         <!--Optional:-->
         <aler:enabled>no</aler:enabled>
         <!--Optional:-->
         <aler:deviceNames>All Other Unix</aler:deviceNames>
         <!--Optional:-->
         <aler:usernames>admin</aler:usernames>
         <!--Optional:-->
         <aler:trapIds></aler:trapIds>
         <!--Optional:-->
         <aler:resetTime>900</aler:resetTime>
         <!--Optional:-->
         <aler:trackIndividualDevice>yes</aler:trackIndividualDevice>
         <!--Optional:-->
         <aler:alertRules>VPNUser/null//VPNGroup/null//VPNIP/2.2.2.3//DisconnectReason/is denied access</aler:alertRules>
         <!--Optional:-->
         <aler:snmpOId></aler:snmpOId>
      </aler:createAlert>
   </soapenv:Body>
</soapenv:Envelope>

The following table lists the VPN Connections Alert-specific parameters. You must include the parameters as inputs for the alertRules parameter.

Note: If there is no alert rule provided, AlertIf value is All in the GUI and DisconnectReason is with both
VPN Connections Alert-specific rules
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.
Note: You cannot specify VPNUser and VPNIP values 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
DisconnectReason Identifies the reason for sending an alert. An alert is generated if a connection is disconnected and/or if a connection is denied access. Possible values:

is disconnected, is denied access, both

is disconnected — alert when a connection is disconnected.



is denied access — alert when a connection is denied access. 



both — both means, is disconnected and is denied access.

yes string