IT Process Automation

Expand all | Collapse all

Create alert from PAM to SOI

Jump to Best Answer
  • 1.  Create alert from PAM to SOI

    Posted 08-10-2015 04:38 PM

    Has anyone been able to create an event or alert from PAM and send it to SOI. We have two implementations of PAM: One specific to SOI and a separate one for other process automation activities. I am working on the PAM for other automation activities. The requirement is to create an event or alert and send it to SOI if any of our process operators fail in a workflow for a particular CI. I looked at the SOI ReST Web Services and it does not seem to have the Alert POST method which I need. As per the SOI wiki, the WS-MAN web services will not be enhanced. That leaves me with Catalyst. However, CA is thinking of dropping Catalyst from future versions of PAM. I would like to know if anyone has had such a requirement to send alerts from PAM to SOI. I understand that it is normally the other way around, where alerts are sent from the monitoring tools to SOI and SOI kicks off a process in PAM. But my requirement is the opposite of it. Here PAM is the alert generator. Thanks in advance for any suggestions or help or pointers to how-to documentation.



  • 2.  Re: Create alert from PAM to SOI
    Best Answer

    Posted 08-10-2015 05:54 PM

    Someone submitted an idea on something like this:

     

    https://communities.ca.com/ideas/235723515

     

    Is this what you were looking for?  If so, vote for it so it can be considered by development for a future release.



  • 3.  Re: Create alert from PAM to SOI

    Posted 08-11-2015 11:12 AM

    Thank you Andrew. I have cast my vote. Any idea how long it takes for the idea to be considered for development? In the meantime, I posted the same question in the SOI community.( Create Alarms through REST API) Looks like I may have to open a support ticket now.



  • 4.  Re: Create alert from PAM to SOI

    Posted 08-11-2015 11:16 AM

    Ideas (enhancements) are considered when a new release of the product is being built.  The time varies from release to release.  But ideas with more votes from the communities are definitely considered above the ideas with less votes.



  • 5.  Re: Create alert from PAM to SOI

    Posted 12-15-2015 02:25 PM

    Received a "postAlert" method for creating alerts in SOI using the SOI connector accelerator. CA Engineering Services provided a document on how to install and use it. Following is an excerpt from it.

    Using the REST API

    The REST API which is included with Connector Accelerator allows users to send alerts and CIs to Connector Accelerator via HTTP using either a browser, a utility such as curl or via a programmatic method such as Perl or Java which can make HTTP connections

     

    In fact the SOIPost client which is shipped with Connector Accelerator uses the same REST API to communicate with Connector Accelerator.

     

    The basic URL syntax for posting to Connector Accelerator via the REST API is:

    http://<server>:<port>/<function>?<param1>=<value1>&<param2>=<value2> ….

     

    <server> represents the Connector Accelerator server

     

    <port> represents the Connector Accelerator port as configured in the <Listener> tag

     

    <function> is the API function and is one of “postAlert”, “delete”

    When calling the REST API, any errors or missing parameters are reported directly in HTML in the http response.

     

    postAlert

    The postAlert function is the most common and is the same one used by the SOIPost client to send alerts.

     

    Param1, 2, etc. must be sent so create the input map. The following parameters are required, similar to what is required by SOIPost.

     

    NOTE: When using the REST API, the URLs and parameter names described below ARE case-sensitive

     

    user_severity or Severity – You must specify the severity (corresponding to the –r parameter of SOIPost). If you assign it to user_severity then you can use all of the extended values and they will be transformed accordingly via connector policy. If you choose to use “Severity”, your values must conform to USM

     

    hostname – As with SOIPost, hostname is a required attribute

     

    Summary – This is the message summary and is the required USM summary. If “Message” is not present, Summary will be copied to Message, but you have the option of including the Message parameter if the values are different

     

    For example,

    http://soi:7777/postAlert?hostname=Myserver&Severity=Minor&Summary=This%20is%20a%20Test

     

    NOTE that because we are using HTML for rest we have to use %20 to represent a space in the summary / message.

     

    delete

    The “delete” function provides away to remove a CI from SOI that may have been posted erroneously from SOIPost, or is in fact, no longer part of the environment

    The delete function contains one parameter, id. The “id” parameter corresponds to the MdrElementID of the CI to be deleted

     

    For example,

    http://soi:7777/delete?id=MyServer

     

    This would delete the “MyServer” CI presuming you are using the host name as the unique ID

     

    Alert/CI Workflow for SOIPost and REST

    The following is the workflow that takes place when the SOIPost client is executed. (The workflow is identical for the “postAlert” function of the REST API, beginning with step 3. Step 2 is you making the REST call.)

     

    1) SOIPost takes the input parameters from the command-line and converts them into an input map consisting solely of name/value pairs of map attributes and their values.

     

    2) An HTTP connection is established with Connector Accelerator on its listening port and the input map is transmitted to Connector Accelerator

     

    3) Connector Accelerator performs validation on the input map, ensuring that all required attributes are present. If not, an error response is sent back to the client

     

    4) Presuming that the map passes validation, TWO input maps are passed to SOI, one representing the data as a CI (Item), and one representing the data as an Alert. This is the critical piece of the workflow and allows for the creation of CIs on the fly. As you know, for an alert to be posted to SOI, there must be a corresponding CI to which to “bind” the alert. Using this “two map” (aka “two pass”) workflow ensures that the CI will also be posted. If you are familiar with the SNMP connector for SOI, it uses a similar workflow when processing incoming traps.

     

    One other function of the workflow that is worthy of note: For each CI/alert posted via SOIPost or REST, a unique GUID is created to identify that client request. This attribute, called either “alertGUID” for Alerts or “ciGUID” for CIs is added to the map passed to SOI, and functions as an audit trail mechanism for troubleshooting purposes. If for some reason the alert or CI doesn’t end up in SOI properly, log files will contain reference to this GUID. The GUID is also passed back to the client in the response for this tracking purpose.