Auditor Help: Using Custom Methods

For additional flexibility in reporting, Ecora allows you to create a file where you specify shell commands to be executed on the target system and the output included in your report. This allows you to run any shell (/bin/sh) command for custom collection and include its results in the Ecora report under a new node in the HTML tree.

Warning! CAUTION:
Any command in this file will be executed across all systems reported with access privileges of the logged in/specified user. Do not allow this file to remain unexamined - use Change Reports (and checksums) to detect any modifications to ensure that only the intended commands are executed.

The file must be called SolarisCustomMethods.xml, SuSeLinuxCustomMethods.xml, LinuxCustomMethods.xml, AIXCustomMethods.xml or HpuxCustomMethods.xml and must be located in the "$InstallDir/etc/UNIX" directory.

To report custom methods, create a file of commands to be executed, called custom$OSMethods.xml (where $OS is replaced by the actual operating system name), containing a list of commands in the format shown below. If the software detects the file, it will execute the contents and report the results.

The file can be created in any ASCII text editor and saved with the filename and extension custom$OSMethods.xml. To edit an existing file, remember that some text editors need to have the file type setting changed to locate and open a file with an .xml (any non-.txt) extension.

The SolarisCustomMethods.xml, SuSeLinuxCustomMethods.xml, LinuxCustomMethods.xml, AIXCustomMethods.xml or HpuxCustomMethods.xml file must contain a list of "tags" and "methods." The tag is the text that is displayed in the report as the heading in the tree. The method defines the path and command whose results will be reported.

The following example shows the file format:

   <file tag="Last" method="/bin/last" />

The above example would result in an additional node in the HTML tree: "Last" would contain the results of running the command /bin/last on the target system.

Note Notes:

  • Comment characters (such as #, //, or /*) are not recognized in the file.
  • Special characters, such as quotes " " ", parenthesis "()", and escapes "\" should be avoided in the tag attribute. The system will attach the tag to the "echo" command to the remote system, which could cause unintended (undesirable) results.
  • Both tag and method attributes are limited to 110 characters (each).