Skip to Content

Web methods

The CLI tools allow you to easily create a web method that can serve XML information (or HTML information) to a requesting program. This application supports the ability to serve message data to a requesting party, including ticket information, and simple searches by keyword, or more complex searches that may target specific information. 

Information
Example

The following complete program can be copied and pasted into the s-auth\GETKEY.bat file location of the BMC Defender Server to list recent BMC Defender messages by keyword.

@echo off
REM: GETKEY.bat web method.
REM: List Keyword Values in XML format.
REM: Supply the CGI header.

echo Content-type: text/xml
echo.
REM: Run the CLI programs to fetch and format the XML.
..\cli-bin\CatKeyw %1 | ..\cli-bin\CFmt –xml

REM: Program finished.

Given the preceding implementation, a program can then fetch all the recent messages on the system that match a keyword. 

Information
Example

To list the messages that contain the security keyword, the URL is as follows:

https://(hostname)/s-auth/GETKEY.bat?security

The preceding URL displays an XML document showing the messages. The user specifies the keyword to match via the ?(keyword) part of the URL.

The preceding technique can be generalized for any of the Cat CLI programs, to list device information, ticket information, or other data that might be required or pertinent to third parties. The operator can modify the format of the message to be -text, or -html, by modifying the CFmt.exe program arguments, and by modifying the CGI header (if needed.)

Related topic

Command-Line-Interface-reference


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

BMC Defender SIEM Correlation Server 6.1