2 Installing the Connector

The Oracle Enterprise Manager Connector Framework requires a web service interface for exchanging event information with Microsoft SCOM. To integrate with Enterprise Manager, a third-party SCOM web service front-end must be installed. In addition to the web service front-end, an Oracle SCOM Agent must also be installed. Both of these components are included in the Oracle Enterprise Manager installation package.

You can install the web service on any Unix or Windows system that has connectivity with the SCOM server. In addition to the SCOM web service front-end, you must also install a back-end SCOM Agent. The Oracle SCOM Agent is preconfigured and is also included in the Oracle Enterprise Manager installation package.

Figure 2–1 shows the communication between the various components of the SCOM Connector.

Figure 2-1 Connector Communication Between Components

Shows flowchart from EM to SCOM root management server

The following sections in this chapter discuss these topics:

Installation Platforms

You can install the SCOM web service on the following platforms that support Java JRE 1.6:

  • Microsoft Windows

  • Sun Solaris

  • HP-UX

  • Linux

You can install the Oracle SCOM Agent on the Microsoft Windows (2000, 2003, 2008, XP) platform.

Installing and Running the Oracle SCOM Agent

The following sections provide procedures for installing and running the Oracle SCOM Agent.

Preinstallation Requirements

The following requirements apply to the system where the Oracle SCOM Agent is installed.

  • .NET framework 2.0 is installed

  • .NET framework 3.0 is installed

  • ASP.NET 2.0 is installed

    After .NET frameword 2.0 is installed, enter the following command to install ASP.NET 2.0:

    %SystemRoot%\Microsoft.NET\Framework\v2.0.xxxxx\aspnet_regiis –i
    

    WARNING:

    This command upgrades other applications running under IIS to version 2.0.

  • Internet Information Services (IIS) 5.0 or higher is installed

  • Operations Manager 2007 Console is installed

  • ASP.NET 2.0 extensions are enabled in IIS

    WARNING:

    Before proceeding, enabling ASP.NET 2.0 extensions may affect other applications that are running under IIS in an earlier version.

    To enable ASP.NET extensions, perform the following steps:

    1. Open the IIS Manager and expand the local computer in the left pane.

    2. Right-click on Web Service Extensions and select Allow all Web service extensions for a specific application …

    3. Select ASP.NET v2.0.0xxxxx from the pull-down list, where xxxxx is the version of the .NET framework 2.0 that is installed.

    4. Click OK to enable the ASP.NET extensions.

Setting Up the Agent Account

Before installing the Oracle SCOM Agent, you need to set up an account for the Oracle SCOM Agent to access the SCOM API. The account must satisfy the following requirements:

  • Must be a domain account

  • Must be used exclusively by the Oracle SCOM Agent

  • Must have local administrator permissions

  • Must be a member of a group designated as an Ops Mgr Administrator (See "Ops Mgr Administrator Groups" below)

  • Must be a member of an Ops Mgr role that has an Author profile (See "Ops Mgr user role for Oracle SCOM Agent" below)

Ops Mgr Administrator Groups

To determine the groups that are designated as an Ops Mgr Administrator, perform the following steps:

  1. In the Administration pane of the Ops Mgr 2007 console, select Administration, then Security, then User Roles. The User Roles should be displayed in the center pane.

  2. Right-click on Operations Manager Administrators and select Properties. The General tab lists the groups that have administrative permissions in the User Role members window. The account the Agent uses must be a member of one of the groups listed here, or you need to add one of its groups to this list.

Ops Mgr user role for Oracle SCOM Agent

To add a new Ops Mgr 2007 user role for the Oracle SCOM Agent, perform the following steps:

  1. In the Administration pane of the Ops Mgr 2007 console, select Administration, then Security, then User Roles. Right-click on User Roles and select New User Role, then Author. The Create User Role wizard window appears.

  2. Enter the name of the Oracle SCOM Agent in the User Role Name field.

  3. Click Add to add a user role member. The Select Users or Groups pop-up window appears.

  4. Enter the domain user account information in the Enter the object names to select dialog box.

    Since this is a domain user account, you need to specify the account as <DOMAIN>\<username> , where <DOMAIN> is the Windows domain where the account was created, and <username> is the user name of the account set up for the Oracle SCOM Agent.

  5. Click OK to add the Oracle SCOM Agent Agent account as a user role member.

  6. Click Next to go to the Approve targets page.

  7. Select the targets that you want the Oracle SCOM Agent to access.

    These are the target types for the alerts that the Oracle SCOM Agent will handle. Typically, you would use the default “All targets are automatically approved, including targets in Management Packs imported in the future.”

  8. Click Next to go to the Approve groups page.

  9. Select the groups that you want the Oracle SCOM Agent to access. You would generally want to use the default of all groups.

  10. Click Next to go to the Approve tasks page.

  11. Click Next to go to the Approve views page.

  12. Click Next to go to the Summary page.

  13. Click Create to create the Oracle SCOM Agent user role.

Installing the Agent

The SCOM Web Service uses the back-end Oracle SCOM Agent to access the SCOM API. The Oracle SCOM Agent must be installed on a Windows system that has connectivity to the SCOM Root Management Server (RMS). The Oracle SCOM Agent is preconfigured to interface with the SCOM Web Service and requires minimal configuration.

Note:

There should only be one installed instance of the Oracle SCOM Agent.

To install the Oracle SCOM Agent, perform the following steps:

  1. Download the connector binaries from Oracle Technology Network and put the SCOMAgent.zip installation file into the directory where you want to install the Oracle SCOM Agent.

  2. Unzip the contents of the SCOMAgent.zip file to any directory.

    This creates the SCOMAgentInstaller.msi and the OracleEnterpriseManager.Alert.Creator.xml files in the designated directory.

  3. Navigate to the directory and run the Oracle SCOM Agent installer by double-clicking on the SCOMAgentInstaller.msi file.

    This starts the installer and displays the Welcome to the Oracle SCOM Agent Setup Wizard page.

  4. Click Next to display the Service Type page.

  5. Select the type of service to be installed under IIS. The default and recommended service type is Web Site.

    This installs the service as a stand-alone web site. Selecting Virtual Directory installs the service as a Virtual Directory under an existing web site.

  6. Click Next to display the Select Installation Folder page.

  7. Enter the location to install the Agent or accept the default location of C:\iWaveSoftware\SCOMConnectorAgent .

  8. Click Next to display the Oracle SCOM Agent Options page.

  9. Enter the name to use when registering the connector in SCOM, or accept the default value of Oracle SCOM Agent.

  10. Click Next to display the Confirm Installation page.

  11. Click Next to display the SCOM Management Group Configuration page, and enter the information for the following required fields on the form:

    • Host name or IP address of the RMS server

    • Domain of the account to use when connecting to the SCOM API

    • User name of the account to use when connecting to the SCOM API

    • Password of the account to use when connecting to the SCOM API

    Note:

    The information for the account from Section 2.2.2, "Setting Up the Agent Account" should be entered in the Domain, Username, and Password fields.
  12. Click Done to proceed. The window displayed next depends on the Service Type you selected in step 5 above.

    • If you selected Web Site:

      The Web Site Configuration window appears. This window contains the Web Site Name and Port Number fields, and both have default values. Accept the default values or change them to the desired values.

    • If you selected Virtual Directory:

      The Virtual Directory Configuration window appears. This window defines the name of the virtual directory to create and the web site within which it will be installed. Accept the default values or change them to the desired values.

  13. For either window, click OK to proceed and display the Web Service Credentials window. This window defines the credentials to specify when testing the newly installed Oracle SCOM Agent.

  14. Specify valid Windows account credentials and click OK.

    The installer now invokes the web service to verify that it is operational. A window pops up with the results of the test.

  15. Close the window. The Installation Successful window appears. This window lists the URL of the Oracle SCOM Agent.

    Note the URL. You will need this whenever you install the SCOM Web Service.

  16. Click OK to continue. The Installation Complete window appears.

  17. Click Close to complete the Agent installation process.

Installing the Alert Creator Management Pack

A management pack file named OracleEnterpriseManager.Alert.Creator.xml is also included in the Agent installation zip file. This management pack is required to create alerts in SCOM. If you are going to forward Enterprise Manager alerts to SCOM, follow the steps below to import the management pack into SCOM.

  1. In the Administration pane of the OpsMgr console, select Administration, then Management Packs.

  2. Right-click on Management Packs and select Import Management Pack… The Select Management Packs to Import window appears.

  3. Navigate to the directory where the OracleEnterpriseManager.Alert.Creator.xml file is located.

  4. Select the OracleEnterpriseManager.Alert.Creator.xml file and click Open. The Import Management Packs window appears.

    Note:

    Depending on the version of SCOM that you are running, you might see the following error when you attempt to open the management pack:
    OracleEnterpriseManager Alert Creator
    The OracleEnterpriseManager Alert Creator Management Pack will fail to import because it depends on the following Management Packs:
    System.Library version 6.0.6278.0
    Microsoft.SystemCenter.Library version 6.0.6278.0
    System.Health.Library version 6.0.6278.0
    Microsoft.Windows.Library version 6.0.6278.0
    Please add them to the list by clicking on the Add... button and searching in your machine.
    

    If you see this error, you need to use a text editor to change four management packs referenced in the References section of the management pack file. The version number information must be updated to match the version numbers used in your system

  5. Click Import to import the management pack.

  6. Click Close after the management pack has been imported.

The Agent is now configured to insert alerts into SCOM.

Starting and Stopping the Agent

The installer automactically starts the Agent. To stop the agent, open the IIS manager, select the web site where it was installed, then click Stop. To start, click Start.

Installing the Microsoft SCOM Web Service

The SCOM web service acts as a front-end for all data flowing into and out of SCOM. Oracle Enterprise Manager posts calls to the web service whenever it needs to create or update an alert, or get new or updated alerts from SCOM.

You can install the SCOM web service on any Unix or Windows system that has connectivity to the Oracle SCOM Agent and the Oracle Enterprise Manager server.

Installing and Running the Microsoft SCOM Web Service on Unix

The following sections explain how to install and then subsequently run the Web Service.

Installing the Web Service on Unix

To install the web service on a Unix platform, perform the following steps:

  1. Create a directory where you want to install the web service.

  2. Open a terminal and change the working directory to the installation directory.

  3. Download the SCOM_webservices_adapter.jar file from the Oracle Technology Network to the installation directory, then extract the component .jar files.

  4. Make sure the JAVA_HOME environment variable is set to the directory where Java 1.6 is installed.

  5. Enter the following command to unzip and extract the .jar file:

    $JAVA_HOME/bin/jar xvf SCOM_webservices_adapter.jar
    

    This creates the adapters directory that contains the installation files.

    Note:

    If the system where the SCOM web service is being installed does not have the JDK installed, you cannot extract the jar file contents. You need to copy the jar file to a system that has the JDK installed and transfer the files after they have been extracted.
  6. Enter the following command to change the working directory:

    cd adapters/endpoints/SCOM2007
    
  7. Enter the following command to run the installation script:

    sh ./install.sh
    
  8. When the script prompts whether you want to use HTTPS:

    • If you specify Y, the web service is set up to use HTTPS port number 8443.

    • If you specify N, the web service is set up to use HTTP port number 8080.

  9. When the script prompts for the user name of the web service, enter the user name that must be provided to access the SCOM Web Service.

  10. When the script prompts for the password of the web service, enter the password that must be provided to access the SCOM Web Service.

  11. After the script prompts for the URL of the Oracle SCOM Agent, enter the URL that was noted when you installed the Oracle SCOM Agent.

  12. After the script prompts for the username and password to use when accessing the Agent, enter a valid windows username and password.

  13. After the the script displays the message "SCOM Web Service Complete," press Enter to complete the installation.

  14. If the web service was configured to run using the HTTPS protocol, you must install a SSL certificate. You can install a self-signed certificate, or you can acquire a certificate from a Certificate Authority (CA).

    • To generate and install a self-signed SSL certificate, enter the following commands, and replace <hostname> with the system host name or IP address that the SCOM web service will use:

      "%JAVA_HOME%\bin\keytool" –delete -alias iwave -keypass iwavepw -storepass iwavepw -keystore keystore.jks
      
      "%JAVA_HOME%\bin\keytool" -genkey -alias iwave -keyalg RSA -keysize 1024 -dname "CN=<hostname>, OU=Development, O=iWave Software, L=Frisco, ST=TX, C=US" -keypass iwavepw -storepass iwavepw -keystore keystore.jks
      
    • To install a certificate that the Certificate Authority issues:

      • Request a certificate from a Certificate Authority, such as VeriSign.

        In the certificate request, make sure to specify the host name or IP address that the SCOM web service will use. The host name in the certificate must match the host name configured for the web service. If they do not match, the web service cannot function.

      • After you obtain the certificate from the Certificate Authority, enter the following command to install the certificate, where <certificateFile> is the full path name of the file provided by the Certificate Authority:

        "%JAVA_HOME%\bin\keytool" -export -alias iwave -file <certificateFile> -keypass iwavepw -storepass iwavepw -keystore keystore.jks
        

The web service framework is now installed and ready to start.

If the Microsoft SCOM Web Service was configured to use the HTTPS protocol, the certificate must be imported into Enterprise Manager. See Section 2.3.3, "Adding Signed Certificates to Enterprise Manager" for instructions.

Running the Web Service on Unix

To run the Microsoft SCOM Web Service framework commands listed with the following tasks, first change the working directory to ...

adapters/bin

... in the installation directory.

  • Start — ./service.sh start

  • Shut Down — ./service.sh stop

  • Restart — ./service.sh restart

  • Check Status — ./service.sh status

Testing the Web Service on Unix

Perform the following steps to verify that the Microsoft SCOM Web Service is functional.

  1. Open a terminal and change the working directory to the adapters/bin directory in the installation directory.

  2. Enter the following command to run the test script:

    ./testAdapter.sh
    
  3. When the utility prompts for the web service password, enter the password you specified for the SCOM web service in step 10 of section Section 2.3.1.1, "Installing the Web Service on Unix".

  4. If the test completes successfully, the last line the utility displays is "Test completed successfully."

    Note:

    If the HTTPS protocol is being used, the test fails if the installed JRE version is 1.6_10. An issue with this version causes the test to fail. To test the web service, you need to verify that you can load the WSDL in a web browser. See "Testing the Microsoft SCOM Connector" on page 3-5.

Installing and Running the Microsoft SCOM Web Service on Windows

The following sections explain how to install and then subsequently run the Web Service.

Installing the Web Service on Windows

To install the web service on a Windows platform, perform the following steps:

  1. Create a directory where you want to install the web service.

  2. Open a terminal and change the working directory to the installation directory.

  3. Download the SCOM_webservices_adapter.jar file from the Oracle Technology Network to the installation directory, then extract the component .jar files.

  4. Make sure the JAVA_HOME environment variable is set to the directory where Java 1.6 is installed.

  5. Enter the following command to unzip and extract the .jar file:

    %JAVA_HOME%\bin\jar xvf SCOM_webservices_adapter.jar
    

    This creates the adapters directory that contains the installation files.

    Note:

    If the system where the SCOM web service is being installed does not have the JDK installed, you cannot extract the jar file contents. You need to copy the jar file to a system that has the JDK installed and transfer the files after they have been extracted.
  6. Enter the following command to change the working directory:

    cd adapters\endpoints\SCOM2007
    
  7. Enter the following command to run the installation script:

    .\install.bat
    
  8. When the script prompts whether you want to use HTTPS:

    • If you specify Y, the web service is set up to use HTTPS port number 8443.

    • If you specify N, the web service is set up to use HTTP port number 8080.

  9. After the script prompts for the URL of the Oracle SCOM Agent, enter the URL that was noted when you installed the Oracle SCOM Agent.

  10. After the script prompts for the username and password to use when accessing the Agent, enter a valid windows username and password.

  11. After the script displays the message "SCOM Web Service Complete," click Enter to complete the installation.

  12. If the web service was configured to run using the HTTPS protocol, you must install a SSL certificate. You can install a self-signed certificate, or you can acquire a certificate from a Certificate Authority (CA).

    • To generate and install a self-signed SSL certificate, enter the following commands, and replace <hostname> with the system host name or IP address that the SCOM web service will use:

      cd ..\..\conf
      
      "%JAVA_HOME%\bin\keytool" –delete -alias iwave -keypass iwavepw -storepass iwavepw -keystore keystore.jks
      
      "%JAVA_HOME%\bin\keytool" -genkey -alias iwave -keyalg RSA -keysize 1024 -dname "CN=<hostname>, OU=Development, O=iWave Software, L=Frisco, ST=TX, C=US" -keypass iwavepw -storepass iwavepw -keystore keystore.jks
      
    • To install a certificate that the Certificate Authority issues:

      • Request a certificate from a Certificate Authority, such as VeriSign.

        In the certificate request, make sure to specify the host name or IP address that the SCOM web service will use. The host name in the certificate must match the host name configured for the web service. If they do not match, the web service cannot function.

      • After you obtain the certificate from the Certificate Authority, enter the following command to install the certificate, where <certificateFile> is the full path name of the file provided by the Certificate Authority:

        cd ..\..\conf
        
        "%JAVA_HOME%\bin\keytool" -export -alias iwave -file <certificateFile> -keypass iwavepw -storepass iwavepw -keystore keystore.jks
        

The following steps are optional. If you want the web service to run as a Windows service, perform the following steps.

  1. Change the working directory to the adapters\bin directory in the installation directory.

  2. Enter the following command to install the web service as a Windows service:

    service.bat install
    

The web service framework is now installed and ready to start.

If the Microsoft SCOM Web Service was configured to use the HTTPS protocol, the certificate must be imported into Enterprise Manager. See Section 2.3.3, "Adding Signed Certificates to Enterprise Manager" for instructions.

Running the Web Service on Windows

Standalone Service

To start the SCOM web service framework when set up as a standalone application (not set up to run as a Windows service):

  1. Change the working directory to the adapters\bin directory in the installation directory.

  2. Run the following command:

    startAdapters.bat
    

To shut down the SCOM web service framework, close the window where you started the adapter.

Windows Service

To start the SCOM web service framework when set up to run as a Windows service, enter the following command:

net start iWaveAdapters

To shut down the SCOM web service framework, enter the following command:

net stop iWaveAdapters

Testing the Web Service on Windows

Perform the following steps to verify that the Microsoft SCOM Web Service is functional.

  1. Open a terminal and change the working directory to the adapters\bin directory in the installation directory.

  2. Enter the following command to run the test script:

    .\testAdapter.bat
    
  3. When the utility prompts for the web service password, enter the password you specified for the SCOM web service in step 10 of section Section 2.3.2.1, "Installing the Web Service on Windows" (Windows).

  4. If the test completes successfully, the last line the utility displays is "Test completed successfully."

    Note:

    If the HTTPS protocol is being used, the test fails if the installed JRE version is 1.6_10. An issue with this version causes the test to fail. To test the web service, you need to verify that you can load the WSDL in a web browser. See "Testing the Microsoft SCOM Connector" on page 3-5.

Adding Signed Certificates to Enterprise Manager

The Service Manager SSL certificate must be imported into Enterprise Manager. For versions 10.2.0.4 and 10.2.0.5, perform the steps in Adding Signed Certificates to Wallet Manager. For version 11.1.0.1, perform the steps in Adding Signed Certificates to cacerts.

Adding Signed Certificates to Wallet Manager

Note:

Oracle Wallet Manager is available at $ORACLE_HOME/bin on OMS for versions 10.2.0.4 and 10.2.0.5. See the Oracle Application Server Administrator's Guide for details.

Perform the following steps in Oracle Enterprise Manager to add signed certificates:

  1. Do the following to obtain a copy of the certificate that the OVO web service is using:

    1. Open a command prompt window and change the working directory to ...

      <SCOMWS_INSTALL>/adapters/conf
      

      ... where <SCOMWS_INSTALL> is the directory where the OVO web service is installed.

    2. Issue the following command to extract the certificate:

      — Unix platforms:

      $JAVA_HOME/bin/keytool -exportcert -alias iwave -file SCOMws.cer -keystore keystore.jks -storepass iwavepw
      

      — Windows platforms:

      "%JAVA_HOME%\bin\keytool" -exportcert -alias iwave -file SCOMws.cer -keystore keystore.jks -storepass iwavepw
      
    3. Transfer the certificate file SCOMws.cer to the system where Enterprise Manager is installed.

  2. Open a new terminal and set the ORACLE_HOME environment variable to the directory where OMS is installed.

  3. As Super Administrator, create a wallet using the following orapki utility command at the OMS host:

    orapki wallet create -wallet client -auto_login
    
  4. Add the trusted certificate to the wallet by entering the following command:

    orapki wallet add -wallet client -trusted_cert -cert <certFile>
    
  5. To view the content of the wallet, enter the following command:

    orapki wallet display -wallet client
    

    Verify that the certificate that was added is listed in the Trusted Certificates.

  6. Start Oracle Wallet Manager and open the client wallet.

  7. Click on Trusted Certificates and select Operations on the main menu.

  8. Select Export All Trusted Certificates.

  9. Save the file as certdb.txt.

  10. Place the file certdb.txt in the connector home root directory ($OMS_HOME/sysman/connector).

    If the certdb.txt file already exists in the root directory, open the file and add the contents of your certdb.txt file to the existing content.

Java SSL can now use this file for communication between Oracle Enterprise Manager and the SCOM web service in HTTPS mode.

See Also:

For additional information on creating a wallet, see "Creating and Viewing Oracle Wallets with orapki" in the Oracle Database Advanced Security Administrator's Guide, 10g Release 2 (10.2).

Adding Signed Certificates to cacerts

Do the following in Enterprise Manager to add signed certificates to the Java cacerts keystore:

  1. Copy the certificate to the Enterprise Manager server system.

  2. Determine the location of the JRE in the Oracle Home directory.

  3. Open a command window and navigate to the JRE bin directory.

  4. Enter the following command to add the certificate to the cacerts keystore:

    keytool -importcert -keystore ..\lib\security\cacerts -storepass changeit -trustcacerts -file <certfile> -alias scomws_cert
    
  5. Restart OMS by opening a command window, changing the working directory to <ORACLE_HOME>/oms10g/bin, and issuing the following commands:

    emctl stop oms
    emctl start oms
    

Oracle Enterprise Manager Alert Polling to SCOM

After installation and configuration, the alert connector automatically polls the SCOM web service for alerts to exchange alerts with Oracle Enterprise Manager. The poll cycle is configurable; the duration is specified in minutes with a minimum possible duration of 5 minutes.

For every poll cycle, the alert connector polls for up to (40 * polling interval) new or updated alerts in SCOM. The Oracle Enterprise Manager connector framework processes and acknowledges all of the alerts provided in the poll response.

Installing the Microsoft SCOM Connector in Oracle Enterprise Manager

The following procedure explains how to add the new SCOM Connector.

Note:

Table 2–1 provides descriptions for the parameters shown for the emctl command in this procedure.
  1. Copy scom_connector.jar to $ORACLE_HOME/sysman/connector on the server hosting your OMS. For multiple OMSes, you need to copy the .jar file for all OMSes.

  2. Run the following emctl command on all OMSes if you have a multi-OMS environment:

        $OMS_HOME/bin/emctl extract_jar connector –jar <jarfile> -cname      <connector_name>
    

    Note:

    The commands in this section and the following section reference the OMS_HOME environment variable. OMS_HOME must be set to the OMS sub-directory in the Enterprise Manager installation directory. For versions 10.2.0.4 and 10.2.0.5, this is the oms10g directory. For version 11.1.0.1, this is the oms11g directory. Example settings of the OMS_HOME variable are /gc/OracleHomes/oms10g on a Unix platform running version 10.2.0.5, and C:\Oracle\Middleware2\oms11g on a Windows platform running version 11.1.0.1.

    This extracts the scom_connector.jar file to the following folder:

        $OMS_HOME/sysman/connector/SCOM_Connector/
    

    For example:

        emctl extract_jar connector -jar scom_connector.jar -cname "SCOM Connector"
    
  3. Deploy the connector by running the following emctl command based on the Enterprise Manager version. You only need to run this step on one OMS.

    11.1.0.1

         $OMS_HOME/bin/emctl register_connector connector -dd       <connectorType.xml> repos_pwd <password>
    
    
    

    10.2.0.5

         $OMS_HOME/bin/emctl register_connector connector -dd          <connectorType.xml> -cs //<server>:<port>/<databaseSID>      -repos_user <username> -repos_pwd <password>
    

    For example:

        $OMS_HOME/bin/emctl register_connector connector -dd $OMS_HOME/     sysman/connector/SCOM_Connector/SCOMConnector.xml -repos_pwd $repospwd
    

The new SCOM connector should now appear in the Management Connectors page after the emctl register_connector command has loaded the connector, as shown in Figure 2–2.

Figure 2-2 Installed SCOM Connector

Shows Management Connectors page with installed SCOM

Table 2–1 provides descriptions for the parameters shown in the procedure above.

Table 2-1 emctl Parameters

Parameter Description

cname

Connector name. Specify "SCOM Connector". The double quotes ("") are mandatory.

connectorType.xml

Fully-qualified name of the connector deployment file. This SCOMConnector.xml file resides in the SCOM connector directory:

$OMS_HOME/sysman/connector/SCOM_Connector/

cs

Connect string. Specify as "//$emHost:$dbPort/$dbSID”, where, $emHost is the server, $dbPort is the port, and $dbSID is the database session identifier.

ctname

Connector type name. Specify "SCOM Connector". The double quotes ("") are mandatory.

database sid/ Service Name for RAC DB

Repository database instance ID or service name if you are using a RAC database as the repository.

description

Short description for the ticket template. This description is also displayed in Enterprise Manager.

iname

Internal name — Depending on the template, the values can be acknowledgeAlerts, createEvent, getNewAlerts, getUpdatedAlerts, or updateEvent.

jarfile

Name of the jar file that contains the connector files. The file name is scom_connector.jar for the SCOM connector.

port

Listener port of the repository.

repos_pwd

Password for SYSMAN.

repos_user

Specify SYSMAN.

server

Host name of the Enterprise Manager repository.

tname

Template name — Depending on the template, the values can be Acknowledge Alerts, Create Event, Get New Alerts, Get Updated Alerts, or Update Event.

ttype

Template type — Specify 1 for inbound transformation and 2 for outbound transformation.


Registering Templates

Before proceeding, if you are using SCOM version R2 in the integration, no changes are required to the template files. If you are using a version prior to R2 of SCOM, make the following changes to the templates before registering:

  1. Open the createEvent_request.xsl file in a text editor.

  2. Change the contents of the preSCOMR2 variable on line 6 from false to true.

  3. Save the changes and close the file.

After you have done this, run the following emctl register_template connector command for each template. The command must specify a user with execute privilege on emctl and the ability to read the template:

11.1.0.1

$OMS_HOME/bin/emctl register_template connector -t <template.xml> -repos_pwd <password> -ctname <connector_type_name> -cname <connector_name> -iname <internal_name> -tname <template_name> -ttype <template_type> -d <description>

10.2.0.5

$OMS_HOME/bin/emctl register_template connector -t <template.xml> -cs //<server>:<port>/<dbSID> -repos_user <username> -repos_pwd <password> -ctname <connector_type_name> -cname <connector_name> -iname <internal_name> -tname <template_name> -ttype <template_type> -d <description>

Replace <template.xml>, <internal_name>, <template_name> and <template_type> with the values listed in Table 2–2.

Table 2-2 Possible Replacement Values for register_template Parameters

template.xsl and template.xml internal_name template_name template_type

acknowledge_request.xsl

acknowledgeAlerts

Acknowledge Alerts

2

cleanup_request.xml

cleanup

Cleanup

3

cleanup_request.xsl

cleanup

Cleanup

2

createEvent_request.xsl

createEvent

Create Event

2

createEvent_response.xsl

createEvent

Create Event

1

generic_request_acknowledgealerts.xml

acknowledgeAlerts

Acknowledge Alerts

3

getNewAlerts_request.xsl

getNewAlerts

Get New Alerts

2

getNewAlerts_response.xsl

getNewAlerts

Get New Alerts

1

getUpdatedAlerts_request.xsl

getUpdatedAlerts

Get Updated Alerts

2

getUpdatedAlerts_response.xsl

getUpdatedAlerts

Get Updated Alerts

1

setup_request.xml

setup

Setup

3

setup_request.xsl

setup

Setup

2

setup_response.xsl

setup

Setup

1

updateEvent_request.xsl

updateEvent

Update Event

2

updateEvent_response.xsl

updateEvent

Update Event

1

template_type Key:

template_type1 — Inbound transformation template_type 2 — Outbound transformation template_type 3 — XML outbound transformation


The following examples are based on the template values shown in Table 2–2.

Example 2-1 Request XSL File for acknowledgeAlerts Method

$OMS_HOME/bin/emctl register_template connector -t $OMS_HOME/sysman/connector/ SCOM_Connector/acknowledge_request.xsl -repos_pwd <password> -ctname "SCOM Connector" -cname "SCOM Connector" -tname "Acknowledge Alerts" -iname "acknowledgeAlerts" -ttype 2 -d "This is the request xsl file for acknowledgeAlerts method"

Example 2-2 Request XML File for Cleanup Method

$OMS_HOME/bin/emctl register_template connector -t $OMS_HOME/sysman/connector/ SCOM_Connector/cleanup_request.xml -repos_pwd <password> -ctname "SCOM Connector" -cname " SCOM Connector " -tname "Cleanup Request" -iname "cleanup" -ttype 3 -d "This is the request xml file for cleanup method"

Example 2-3 Request XSL File for Cleanup Method

$OMS_HOME/bin/emctl register_template connector -t $OMS_HOME/sysman/connector/ SCOM_Connector/cleanup_request.xsl -repos_pwd <password> -ctname "SCOM Connector" -cname "SCOM Connector" -tname "Cleanup Request" -iname "cleanup" -ttype 2 -d "This is the request xsl file for cleanup method"

Example 2-4 Request XSL File for createEvent Method

$OMS_HOME/bin/emctl register_template connector -t $OMS_HOME/sysman/connector/ SCOM_Connector/createEvent_request.xsl -repos_pwd <password> -ctname "SCOM Connector" -cname "SCOM Connector" -tname "Create Event Request" -iname "createEvent" -ttype 2 -d "This is the request xsl file for createEvent method"

Example 2-5 Response XSL File for createEvent Method

$OMS_HOME/bin/emctl register_template connector -t $OMS_HOME/sysman/connector/ SCOM_Connector/createEvent_response.xsl -repos_pwd <password> -ctname "SCOM Connector" -cname "SCOM Connector" -tname "CreateEvent Response" -iname "createEvent" -ttype 1 -d "This is the response xsl file for createEvent method"

Example 2-6 Request XML File for acknowledgeAlerts Method

$OMS_HOME/bin/emctl register_template connector -t $OMS_HOME/sysman/connector/ SCOM_Connector/generic_request_acknowledgealerts.xml -repos_user SYSMAN -repos_pwd <password> -ctname "SCOM Connector" -cname "SCOM Connector" -tname "Acknowledge Alerts" -iname "acknowledgeAlerts" -ttype 3 -d "This is the request xml file for acknowledgeAlerts method"

Example 2-7 Request XSL File for getNewAlerts Method

$OMS_HOME/bin/emctl register_template connector -t $OMS_HOME/sysman/connector/ SCOM_Connector/getNewAlert_request.xsl -repos_pwd <password> -ctname "SCOM Connector" -cname "SCOM Connector" -tname "Get New Alerts Request" -iname "getNewAlerts" -ttype 2 -d "This is the request xsl file for getNewAlerts method"

Example 2-8 Response XSL File for getNewAlerts Method

$OMS_HOME/bin/emctl register_template connector -t $OMS_HOME/sysman/connector/ SCOM_Connector/getNewAlerts_response.xsl -repos_pwd <password> -ctname "SCOM Connector" -cname "SCOM Connector" -tname "Get New Alerts Response" -iname "getNewAlerts" -ttype 1 -d "This is the response xsl file for getNewAlerts method"

Example 2-9 Request XSL File for getUpdatedAlerts Method

$OMS_HOME/bin/emctl register_template connector -t $OMS_HOME/sysman/connector/ SCOM_Connector/getUpdatedAlert_request.xsl -repos_pwd <password> -ctname "SCOM Connector" -cname "SCOM Connector" -tname "Get Updated Alerts Request" -iname "getUpdatedAlerts" -ttype 2 -d "This is the request xsl file for getUpdatedAlerts method"

Example 2-10 Response XSL File for getUpdatedAlerts Method

$OMS_HOME/bin/emctl register_template connector -t $OMS_HOME/sysman/connector/SCOM_Connector/getUpdatedAlerts_response.xsl -repos_pwd <password> -ctname "SCOM Connector" -cname "SCOM Connector" -tname "Get Updated Alerts Response" -iname "getUpdatedAlerts" -ttype 1 -d "This is the response xsl file for getUpdatedAlerts method"

Example 2-11 Request XML File for Setup Method

$OMS_HOME/bin/emctl register_template connector -t $OMS_HOME/sysman/connector/ SCOM_Connector/setup_request.xml -repos_pwd <password> -ctname "SCOM Connector" -cname "SCOM Connector" -tname "Setup Request" -iname "setup" -ttype 3 -d "This is the request xml file for setup method"

Example 2-12 Request XSL File for Setup Method

$OMS_HOME/bin/emctl register_template connector -t $OMS_HOME/sysman/connector/SCOM_Connector/setup_request.xsl -repos_pwd <password> -ctname "SCOM Connector" -cname "SCOM Connector" -tname "Setup Request" -iname "setup" -ttype 2 -d This is the request xsl file for setup method"

Example 2-13 Response XSL File for Setup Method

$OMS_HOME/bin/emctl register_template connector -t $OMS_HOME/sysman/connector/SCOM_Connector/setup_response.xsl -repos_pwd <password> -ctname "SCOM Connector" -cname "SCOM Connector" -tname "Setup Response" -iname "setup" -ttype 1 -d "This is the response xsl file for setup method"

Example 2-14 Request XSL File for updateEvent Method

$OMS_HOME/bin/emctl register_template connector -t $OMS_HOME/sysman/connector/SCOM_Connector/updateEvent_request.xsl -repos_pwd <password> -ctname "SCOM Connector" -cname "SCOM Connector" -tname "Update Event Request" -iname "updateEvent" -ttype 2 -d "This is the request xsl file for updateEvent method"

Example 2-15 Response XSL File for updateEvent Method

$OMS_HOME/bin/emctl register_template connector -t $OMS_HOME/sysman/connector/SCOM_Connector/updateEvent_response.xsl -repos_pwd <password> -ctname "SCOM Connector" -cname "SCOM Connector" -tname "UpdateEvent Response" -iname "updateEvent" -ttype 1 -d "This is the response xsl file for updateEvent method"