Scripting

Groovy scripting is supported. Groovy is a high level, object-oriented scripting language for the Java platform, which complies down to Java bytecode.

Groovy is aimed at Java developers, and is tightly integrated with the Java platform. It provides you with a similarly powerful and concise coding syntax to that provided by languages such as Python or Ruby, while enabling you to stay on the Java Virtual Machine (JVM). Java beans are supported, and Java and Groovy classes are interchangeable inside the JVM. As Groovy integrates well with Java code and libraries, and enables you to reuse the semantics of Java, and all J2SE and J2EE APIs, you do not have to learn, implement and maintain new semantics and APIs.

For more information about developing and deploying Groovy scripts, see Groovy scripts.

There are three Groovy scripts that can be placed into a topology synchronization package, and these are identified using fixed names within synchronization package directories. Each script runs at a defined point in the synchronization process:

• preEnrichment.groovy — script to be executed before mapping

  The preEnrichment.groovy script is executed before starting the topology synchronization’s mapping process.

• preUpload.groovy — script to be executed before upload

  The preUpload.groovy script is executed after the mapping process but before writing any data to the RTSM (Run-time Service Model)  (for example, to create additional CIs or add extra details to existing CI instances).

• postUpload.groovy — script to be executed after upload

  The postUpload.groovy script is executed after saving the uploaded data in the RTSM, to modify data saved during the upload process (for example, for logging or auditing purposes).

The upload is performed between execution of the preUpload.groovy scripts and the postUpload.groovy scripts.

By default, the use of Groovy scripts is enabled (in the OM Topology Synchronization settings, the Enable usage of Groovy scripts value is set to true).

To help identify the cause of synchronization failure, you can disable scripting. If there is an error in a script, disabling scripting should make successful synchronization more likely.

To disable topology synchronization package script execution, change the Enable usage of Groovy scripts setting from true to false in the OM Topology Synchronization settings in the Infrastructure Settings manager:

Administration > Setup and Maintenance > Infrastructure Settings

Alternatively, click Infrastructure Settings.

Operations Management - HPOM Topology Synchronization > Enable usage of Groovy scripts

The Groovy scripts must be located in the same directory as the topology-synchronization mapping rules:

<OMi_HOME>/conf/opr/topology-sync/sync-packages/<SyncPackageName>

Each script has two predefined variables:

• ScriptInterface

  Object Type: com.hp.opr.ts.scripting.ScriptInterface

  Description: Enables access to CI information function calls to manipulate synchronization data and control the synchronization.

  The object type implements the following interface:

  com.hp.opr.ts.interfaces.scripting.IScriptingInterface

• SyncData

  Object Type: com.hp.opr.ts.common.data.sync.SyncData

  Description: Provides access to the data that is synchronized.

  The object type implements the following interface:

  com.hp.opr.ts.interfaces.data.sync.ISyncData

For more information about the interfaces and object types required for developing your own topology synchronization scripts, see the Java API Documentation document located in the following directory:

<OMi_HOME>/opr/api/doc/opr-ts-interfaces-javadoc.zip

Scripts within a synchronization package share the same variable scope. That means variables assigned in preEnrichment.groovy can be later used in the corresponding preUpload.groovy and postUpload.groovy. Scripts from different synchronization packages do not share variables with the same name, which avoids name clashes and undesired side effects.

Errors in scripts result in the generation of exceptions. The error handling is around each script invocation. By default, an exception in a script aborts the synchronization. This behavior can be changed by calling the command:

scriptInterface.setAbortSyncOnError(boolean) 

When set to false, you can enforce a script failure using the method abortSync(“...“). For example, your script checks conditions, and because of these forced failures, a synchronization cannot be completed.

The following table shows the relationship between synchronization status (successful or unsuccessful synchronization) and script behavior.

The following script is an extract of a sample preUpload.groovy script:

import com.hp.opr.ts.interfaces.data.ci.*  ;
import com.hp.opr.ts.common.data.ci.*  ;
import java.util.*;
import java.lang.String;


List resourceGroups = new LinkedList ();
List haMembers      = new LinkedList ();

// Get all OM services, hosts and node groups
for (ICi ci : syncData.getConfigurationItems()) {


  if (ci.getOmTypeId() == "Class_RG") {
// If type is "Class_RG", then create a CI of type IP for all entries    // of the OM attribute ip address

    scriptInterface.logInfo ("add resource group");
    resourceGroups.add (ci);
  }


}


// Create ip-ci and relationship to the cluster package
for (ICi ipCi : resourceGroups) {
    HashMap hm = new HashMap();
// Get OM service-specific attributes
    hm = ipCi.getOmAttributes();



// Create CI for ip-address attribute
    ICi newCi = scriptInterface.createCi();
    newCi.setContext ("cluster");
        newCi.setCmdbAttribute ("ip_address", hm.get("ipaddr"));
        newCi.setCmdbAttribute ("ip_domain", "\${DefaultDomain}");
        newCi.setCmdbTypeId ("ip");
        scriptInterface.logInfo ("create relationship between two ip-ci: "
        + hm.get("ipaddr") + " and cluster package " );
// Create the “contained” relationship between the cluster package    // and ip
    scriptInterface.createCmdbRelation(ipCi, newCi, "contained");

    }
}