System Alert

The System Alert allows for notification when system health and status criteria exceed acceptable bounds.

Request Parameters

alertCriteria, lowThreshold, highThreshold, drive, peerIP

Example

“alertCriteria/CPU Temperature//highThreshold/65”

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

System Alert-specific Rules
Parameter Description Values Required Type
alertCriteria The criteria used to generate an alert.
  • CPU Temperature — CPU temperature, in Celsius degrees, under which the CPU temperature must remain.
  • Disk Usage — Drive and percentage under which the disk usage must remain.
  • Dropped Messages — Maximum dropped message rate (messages per second).
  • Fail-over — Identifies when fail-over is enacted.
  • Network Connection Speed — Minimum throughput threshold for the network connection.
  • Network Interface — Identifies that a network interface (for example, eth0 or eth1) fails to function.
  • Synchronization Failure — Identifies if the data synchronization process fails after failover occurs.
  • Secure Tunnel connection status — Downstream device IP address. Forwarding Rules are required for this alert criterion. Use the Message Routing Service Operations or specify the message routing rules on the GUI (Administration > Message Routing).
  • Data Migration complete
  • Emergency Disk Usage
  • Engine Status
  • Resource Exhaustion
  • Secure Tunnel connection status
  • RAID Disk Failure
Possible values:
  • CPU Temperature
  • Disk Usage
  • Dropped Messages
  • Fail-over
  • Network Connection Speed
  • Network Interface
  • Synchronization Failure
  • TCP Forward Connection Status
  • Data Migration complete
  • RAID Disk Failure
  • Resource Exhaustion
  • TCP Forward Falling Behind

 		yes string
Interface

(Network Interface only)

Specify the interfaces that the system should alert on.

Example: 

<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>System Alert</aler:alertTypeName>
         <!--Optional:-->
         <aler:name>Alert9</aler:name>
         <!--Optional:-->
         <aler:desc>System Alert - user alert</aler:desc>
         <!--Optional:-->
         <aler:priorityName>high</aler:priorityName>
         <!--Optional:-->
         <aler:enabled>no</aler:enabled>
         <!--Optional:-->
         <aler:deviceNames>All Cisco ASA</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>alertCriteria/Network Interface//Interface/eth0</aler:alertRules>
         <!--Optional:-->
         <aler:snmpOId></aler:snmpOId>
      </aler:createAlert>
   </soapenv:Body>
</soapenv:Envelope>
 Possible values:

eth0, eth1 or eth1

yes string
LowThreshold

(Network Connection Speed only)

Minimum connection speed.

Specify a value if implementing the Network Connection Speed alert criteria (alertCritera parameter)

Possible values:

10-half
100-half
100-full
1000-full

The default is 10-half.

yes string
HighThreshold

(CPU Temperature only)

CPU temperature, in Celsius degrees, under which the CPU temperature must remain.

Specify a value if implementing the CPU Temperature alert criteria (AlertCritera parameter)

Any positive integer between 1 and 100. The value is in Celsius degrees.

The default is 80 degrees Celsius.

yes string
HighThreshold

(Disk Usage only)

The percentage of allowable disk space usage on the specified disk drive. Use in conjunction with the drive parameter.

Specify only if the alertCriteria value is Disk Usage.

Any positive integer between 1 and 100.

The default is 90 (90%).

yes string
HighThreshold

( Emergency Disk Usage only)

HighThreshold

(Dropped Messages only)

Maximum dropped message rate (messages per second).

Specify only if the alertCriteria value is Dropped Messages.

Any positive integer. The value is in seconds.

The default is 100 messages per second.

yes string
Drive

(Disk Usage only)

The disk drive under which usage must remain below the value specified in the highThreshold (Disk Usage) parameter. Use in conjunction with the highThreshold (Disk Usage) parameter.

Specify only if the alertCriteria value is Disk Usage.

Example: 
<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>System Alert</aler:alertTypeName>
         <!--Optional:-->
         <aler:name>Alert16</aler:name>
         <!--Optional:-->
         <aler:desc>System 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>alertCriteria/Disk Usage//HighThreshold/10//Drive/%2Floglogic%2Fdata%2Fdbi</aler:alertRules>
         <!--Optional:-->
         <aler:snmpOId></aler:snmpOId>
      </aler:createAlert>
   </soapenv:Body>
</soapenv:Envelope>
 Possible values:
  • /
  • /failsafe
  • /tmp
  • /loglogic
  • /dev
  • /loglogic/data/dbi
Note: Substitute %2F for each forward slash. (The 'F' is case-sensitive). For example: %2Floglogic%2Fdata%2Fdbi
yes string
PeerIP

(Secure Tunnel connection status only)

Downstream device IP address. The IP address is created using the destinationIP parameter in Message Routing Service Operations or by specifying the Destination IP on the GUI (Administration > Message Routing).

Specify only if the alertCriteria value is Secure Tunnel connection status.

Example: 

<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>System Alert</aler:alertTypeName>
         <!--Optional:-->
         <aler:name>Alert21</aler:name>
         <!--Optional:-->
         <aler:desc>System 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>alertCriteria/Secure Tunnel connection status//PeerIP/2.2.2.2</aler:alertRules>
         <!--Optional:-->
         <aler:snmpOId></aler:snmpOId>
      </aler:createAlert>
   </soapenv:Body>
</soapenv:Envelope>
 Valid IP address associated with a message routing rule. yes string