The SDK installation includes system files, configuration files, ASL rule set files, scripts, templates, as well as third-party software files that the SDK software uses.

Never alter SDK system files, such as executables, shared libraries, MODEL files, and setup files. Do not alter third-party software system files provided with the Java Runtime Environment.

As part of the configuration process, you will need to make changes to some of the user-modifiable files. The following are examples of user-modifiable files:

  • Configuration files, such as ics.conf, clientConnect.conf, and serverConnect.conf (you are required to edit these)

  • ASL rule sets, such as syslog_mgr.asl

  • Sample actions, such as ics-ping and ics-telnet

  • Template files used to import data, such as service.data.template and topology-group.data.template

    Original versions of configuration files, ASL rule sets, scripts, and template files are installed to the BASEDIR/smarts/conf, BASEDIR/smarts/rules, and BASEDIR/smarts/script directories. When you need to alter a file in one of these directories, make those changes to a local copy of the file. By default, local copies of user-modifiable files should reside in BASEDIR/smarts/local or one of its subdirectories. SDK software is designed to first search for user-modifiable files in BASEDIR/smarts/local or one of its subdirectories. If a modified version of a file is not found in the local area, SDK software then searches appropriate non-local directories.

    To edit a file, invoke the sm_edit utility from the BASEDIR/smarts/bin directory. When used, sm_edit automatically opens a local copy of the specified file and saves the modified file to its appropriate location. “Modifying ITOps files” on page 24 provides further information about how to use the sm_edit utility.

    You should:

  • Only modify local copies of user-modifiable files.

  • Always retain the original, unedited, version of these files.

    Subdirectories for user-modifiable files identifies the default subdirectories that include user-modifiable files found under BASEDIR/smarts/local. The subdirectories vary by product suite.

Table 1. Subdirectories for user-modifiable files

Installation path

Directory

Description

BASEDIR/smarts/local

/actions

Tool scripts

/conf

Configuration files

/data

Import files

/rules

ASL rules files

Note:

The BASEDIR/smarts/local directory has been reserved for directories with local copies of user-modifiable files as well as writable files such as logs and repository files. It typically contains directories listed in Subdirectories for user-modifiable files. During installation, SDK software may create empty subdirectories under the BASEDIR/smarts/local directory. These directories are reserved for use for future service packs and Rolling Patches. The exception is the BASEDIR/smarts/local/bin directory that contains files necessary for the successful installation of SDK software.

In addition, the BASEDIR/smarts/local/conf directory contains the runcmd_env.sh file, which is created during installation. The runcmd_env.sh is a file for setting environment variables, including the default location for the Broker. You can edit this file to change the default location of the Broker or to define any SDK-wide environment variable. “Methods for setting environment variables for ITOps software” on page 138 provides information about setting environment variables.

The product-specific naming convention used for subdirectories under BASEDIR/smarts/local/conf and BASEDIR/smarts/local/rules (as well as their non-local counterparts) typically reflects the SDK product or module within a product suite that uses the files.

You can alter the location for rules files, as described in “Controlling the location for rule set files” on page 27.

Note:

If VMware installs a site-specific patch at your location, then additional directories may be included under BASEDIR/smarts/local. Never alter files in any of these additional subdirectories.