createAlert Operation
The createAlert operation is used to create new alert rules in the TIBCO LogLogic® Appliance.
When using createAlert, you must specify:
- Common Request Parameters
- Alert-Specific Request Parameters (includes alertRules format description)
Request Parameters
authToken, alertTypeName, desc, priorityName, enabled, deviceNames, usernames, trapIds, resetTime, trackIndividualDevice, alertRules, snmpOId
For more information about each common request parameter, see Common Request Parameters.
Example
SOAP request for createAlert Operation. To create a VPN Connection Alert named MyAlertName:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:aler="AlertService"> <soapenv:Header/> <soapenv:Body> <aler:createAlert> <aler:authToken>admin+1Y2O2W261O1C1J1X294</aler:authToken> <aler:alertTypeName>VPN Connection Alert</aler:alertTypeName> <aler:name>MyAlertName</aler:name> <aler:desc>VPN Connection Alert Description</aler:desc> <aler:priorityName>low</aler:priorityName> <aler:enabled>yes</aler:enabled> <aler:deviceNames>10.1.2.3_04</aler:deviceNames> <aler:usernames>admin</aler:usernames> <aler:trapIds></aler:trapIds> <aler:resetTime>400</aler:resetTime> <aler:trackIndividualDevice>yes</aler:trackIndividualDevice> <aler:alertRules>VPNUser/LogLogicUser//VPNGroup/LogLogicGroup//disconnectReason/is denied access</aler:alertRules> <aler:snmpOId></aler:snmpOId> </aler:createAlert> </soapenv:Body> </soapenv:Envelope>
SOAP response for the createAlert Operation:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header/> <soapenv:Body> <ns:createAlertResponse xmlns:ns="AlertService"> <ns:return xsi:type="ax27:AlertResponse" xmlns:ax27="http://alert.services.logapp.loglogic.com/xsd" xmlns:ax28="http://services.logapp.loglogic.com/xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ax28:authToken xsi:nil="true"/> <ax28:resultCount>1</ax28:resultCount> <ax28:statusCode>2000</ax28:statusCode> <ax28:statusMessage>Successful</ax28:statusMessage> <ax28:summaryOnly>false</ax28:summaryOnly> <ax27:resultSet xsi:type="ax27:AlertDetail"> <ax27:alertRules>FewerThan/100//MoreThan/200</ax27:alertRules> <ax27:alertType>Adaptive Baseline Alert</ax27:alertType> <ax27:desc>hello there</ax27:desc> <ax27:devices>All Other UNIX</ax27:devices> <ax27:enabled>yes</ax27:enabled> <ax27:name>Myalert</ax27:name> <ax27:networkMonitorPolicyRules xsi:nil="true"/> <ax27:priority>Low</ax27:priority> <ax27:resetTime>900</ax27:resetTime> <ax27:snmpOId/> <ax27:trackIndividualDevice>yes</ax27:trackIndividualDevice> <ax27:users>admin</ax27:users> </ax27:resultSet> </ns:return> </ns:createAlertResponse> </soapenv:Body> </soapenv:Envelope>
Copyright © 2020. Cloud Software Group, Inc. All Rights Reserved.