ISMTool environment variables

The ISMTool references the shell environment variables described in this section.

• CRYPTO_PATH
• ISMTOOLBINPATH
• ISMTOOLCC
• ISMTOOLCE
• ISMTOOLDA
• ISMTOOLPASSWORD
• ISMTOOLSITEPATH
• ISMTOOLSR
• ISMTOOLUSERNAME

CRYPTO_PATH

This environment variable indicates the directory that contains the files agent.p12 and opsware-ca.crt.

CRYPTO_PATH, agent.p12 and opsware-ca.crt are required only if you are uploading the ISM from a server not managed by SA (that is, a server that has no Server Agent.)

To connect to the SA Core during the upload of an ISM, the ISMTool needs the client certificate files that were generated during the installation of HPE Server Automation.

Keep in mind that using these certificates with the ISMTool invokes a different security mechanism than the one used by the SA Client. As a result, you might have increased or reduced permissions. You might have access to servers belonging to customers that you usually do not have access to.

Also, you might be able to perform operations that you cannot perform with the SA Client. Therefore, in this situation use the ISMTool with caution to avoid unintended consequences caused by a possible change in security permissions.

To obtain the needed files and set the CRYPTO_PATH environment variable, perform the following steps:

1. Log in to the SA Core server as root and execute the following command: /opt/opsware/bin/python –m opsware_common.crypto.bundle –r agent –c opsware –b <zip_bundle_name>
2. Copy the generated .zip to the server where you have installed the IDK, and extract it in a location of your choosing (<some-path>)
   
3. Set the CRYPTO_PATH environment variable to <some-path>.
   For example, on a Unix server, suppose that the location where the bundle is extracted is:
   /home/jdoe/dev/
   In csh you would set the environment variable as follows:
   setenv CRYPTO_PATH /home/jdoe/dev/
   On Windows, if the path is: C:\jdoe\dev\ , set the environment variable to: set CRYPTO_PATH=C:\jdoe\dev\

ISMTOOLBINPATH

This environment variable is a list of directory names, separated by colons, where the ISMTool searches for system-level tools (such as tar and cpio). The following search strategy is used:

1. Search the paths from the environment variable ISMTOOLBINPATH.
2. Search the complied-in binaries (if any) in /usr/local/ismtool/lib/tools/bin.
3. Search within the user's path.

ISMTOOLCC

This environment variable is the HOST[:PORT] of the Opsware Command Center core component used during an ISMTool upload to a folder.

ISMTOOLCE

This environment variable is the HOST[:PORT] of the SA Command Engine used by the ISMTool.

ISMTOOLDA

This environment variable is the HOST[:PORT] of the SA Data Access Engine used by the ISMTool.

ISMTOOLPASSWORD

This environment variable is a STRING that specifies the SA password during an ISMTool upload.

ISMTOOLSITEPATH

This environment variable is a PATH for a “site” directory.

The ISMTool contains certain default scripts and attribute values (for example, the install prefix) which are referenced when a new ISM is created. A developer can override the default scripts and a selected set of attribute values by using a site directory.

The defaults.conf File

Within the site directory, a developer can create the defaults.conf file, which contains overrides for attribute values. A line in defaults.conf has the format: <tag>:<value>. A line starting with the # character is a comment. The following example shows the values that can be set in defaults.conf:

Unix:

prefix: 	/usr/local
ctlprefix: 	/var/opt/OPSWism
opswpath: 	/System Utilities/${NAME}/${VERSION}/${PLATFORM}
version: 	1.0.0
ctluser: 	root
ctlgroup: 	bin

Windows:

prefix: 	???
ctlprefix: 	???
opswpath: 	/System Utilities/${NAME}/${VERSION}/${PLATFORM}
version: 	1.0.0

The templates Subdirectory

Developers can override the files in the /usr/local/ismtool/lib/ismtoollib/templates directory by placing their own copies in a templates subdirectory located within the ISMTOOLSITEPATH. For example, developers can override the files that are the default packaging hooks for Windows or Unix.

The control Subdirectory

Sometimes, developers need to install a common set of tools into an ISM's control directory. The ISMTool supports this requirement by copying all files from a control subdirectory of the ISMTOOLSITEPATH to the ISM's control directory. If a file already exists in the ISM's control directory, it will not be overwritten.

ISMTOOLSR

This environment variable is the HOST[:PORT] of the SA Software Repository used by the ISMTool.

ISMTOOLUSERNAME

This environment variable is a STRING that specifies the SA user name during an ISMTool upload.