ITM: Debugging the Situation Update Forwarder (SUF) - Part 4: SOAP Calls
carinb 100000JKNU Visits (8009)
This is Part 4 in a series of SUF (Situation Update Forwarder) debugging posts.
Debugging the SUF means breaking down the components that allow for events to be sent back to ITM.
The major area of event handling include
- NetCool Event Management to handle the ITM event and writes the event out to a cache file.
- Persistence Directory Cache File to hand the event to the SUF listening process
- SUF process to read the cache file
- SOAP calls to send the event to the ITM SOAP client
- ITM event matching to match the receiving event to the original sent event.
In Part 2 we confirmed that netcool could write the event to the cache file.
In Part 3 we confirmed that the SUF could read the event from the cache file.
Now we will work on confirming if SOAP calls work successfully to send the event to ITM.
SUF Log Files
Here is where the SUF log files become important. You should not need to set any additional tracing in the SUF as most of the details can be found in the logs.
On Unix/Linux: /tmp/itmsynch/logs
On Windows: C:\t
For debugging, I recommend you stop the SUF process, move the old files from the logs directory and restart the SUF process so that you have new logs to review. This makes it easier to find the start up messages in the logs more easily.
The SUF configuration only contains a couple of key settings that more commonly are the cause of SUF related errors.
The configuration files are found under the <ins
SOAP connection information for the Hub TEMS is stored in the situpdate.conf
There is one key value in the situpdate.conf related to the SOAP connection.
In almost all cases, this default value is correct and should not be changed.
Customer's may try to modify the setting by adding a complete http url and incorrectly set the value to:
For example, when the cmsSoapUrl is set to the value of:
this results in an error in the SUF log that would read like:
Connection error: KDH1_STC_NOTFOUND on URL
Note: The SUF will automatically prepend the serverid and the port to the value of the cmsSoapUrl value in the value of "http://<teps hostname>:<port>". So adding the full url to the cmsSoapUrl variable will make the URL invalid. The same note goes for using kshhsoap.htm as the filename being called which is automatically appended to the end of the URL behind the cmsSoapUrl value.
SOAP Serverid Name
SOAP connection userid and password are stored in <ins
The serverid parameter is the most common cause of errors.
When the Hub TEMS sends in an EIF event, it has a field called cms_hostname which contains the server name of the TEMS that sent the event.
When you configure the SUF, ensure you use exactly the same name as the serverid when doing the SUF configuration.
The serverid, as configured in the the situser.conf, and the cms_hostname from the EIF event values need to exactly match. For example, you can't use a short name as the serverid when the cms_hostname field on the event coming into Netcool is a long, fully-qualified name. You can't use a different hostname from DNS or from /etc/hosts or use an IP address instead.
The SUF process will take the event that was read from the cache file and will only send the event is there is an exactly matching serverid in the situser.conf file. If the values are different, the event will not match an existing serverid in the situser.conf file and the event will be dropped and not sent. So take the time to verify what the cms_hostname field is on the incoming ITM event and use the same value as the serverid in the situser.conf.
An example situser.conf file:
Also, make sure that serverid is reachable from the Netcool system by that exact name. You may need to add it to /etc/hosts to ensure it is reachable. The soap call will use the serverid name in the URL so the hostname needs to be resolved correctly and reachable.
Successfully Sending the Event
Successful messages will be logged in the SUF files located in the directory: /tmp
Tivoli Monitoring Tivoli Event Synchronization prodtems.ibm.com net IP Entry, parm 1 = op=a
IP Successfully sent event:
Any errors will be logged in the SUF files located in the directory: /tmp/itmsynch/logs
Password for the SOAP userid was either not configured or the serverid name was incorrect. Review the situser.conf and ensure the serverid is correct, the password files exists and the password is correct. Watch out for special characters in the password that may cause issues.
Connection error: KDH1_STC_NOTFOUND on URL
note: The url above is incorrect because the cmsSoapUrl was modified from the default setting. Review the situpdate.conf file and ensure the value is set to 'cms
[KFAIT0013E The CMS logon validation failed. logon
Userid and Password for the SOAP userid was either not configured or the serverid name was incorrect or unreachable. Review the situser.conf and ensure the serverid is correct, the password files exists and the password is correct. Following the debugging steps and open the URL that the SUF is using and test that the SOAP client is available a the URL and that the userid and password are valid.
If the SOAP call is refused (error: remote host refused an attempted connect operation) or it appears that the url is not correc, ensure the soap client is reachable. You can use a browser located on the Netcool server to open the url as noted in the SUF log in the form of:
Ensure that the http SOAP client is accessible and that page is reachable. You can confirm the userid and password work as configured in the SUF configuration files at this time. Double check that you are using the same url that the SUF is using and as it appears in the SUF log (look for typos, odd characters, spelling errors, etc).
If you cannot reach the url, verify that there are no firewall issues blocking the port, that the teps serverid is resolving correctly. Then confirm if the web page is reachable.
If the web page is not reachable, then locally attempt to connect to the URL on the TEPS server to confirm it is available which may reveal a network connection or firewall issue between the Netcool server and the ITM Hub TEMS server, If everything is correct, then you may have SOAP/tacmd/HTTP access turned off at the Hub TEMS.
Test and see if you can run tacmd commands from the Hub TEMS using tacmd login (tacmd commands use the same SOAP interface on the Hub TEMS). If you cannot run any tacmd commands (because tacmd is disabled), that is an indication you have the HTTP SOAP interface turned off and you will need to enable it on the Hub TEMS in order to use the SUF to send events to ITM.
Subscribe and follow us for all the latest information directly on your social feeds: