| Oracle® Enterprise Manager Installation and Configuration Guide for IBM Tivoli Enterprise Console Connector Release 12.1 (12.1.0.2.0) Part Number E28571-04 |
|
|
PDF · Mobi · ePub |
| Oracle® Enterprise Manager Installation and Configuration Guide for IBM Tivoli Enterprise Console Connector Release 12.1 (12.1.0.2.0) Part Number E28571-04 |
|
|
PDF · Mobi · ePub |
The Oracle Enterprise Manager Connector Framework requires a web service interface for forwarding event information to IBM TEC. Since TEC does not provide a web services interface, you must install a third-party TEC web service front-end, which is included in the Oracle Enterprise Manager TEC installation package.
You can install the web service on any Unix or Windows system that supports Oracle JRE 1.6 and has connectivity with the TEC server. In addition to the TEC web service front-end, you must also install a back-end Oracle TEC Agent on the same physical system as the TEC server. The Oracle TEC Agent is preconfigured and is also included in the Oracle Enterprise Manager TEC installation package.
Figure 2–1 shows the communication between the various components of the TEC Connector.
The following sections in this chapter discuss these topics:
You can install the TEC web service on the following platforms that support Oracle JRE 1.6:
Microsoft Windows
Sun Solaris
HP-UX
Linux
You can install the TEC Agent on the following platforms:
Microsoft Windows (2000, 2003, 2008, XP)
Sun Solaris (SPARC OS version 5-10)
IBM AIX (RS/6000 OS version 5.2+)
In order to install the connector, the My Oracle Support Preferred Credentials must be set to enable the download of the connector through self-update. To set the credentials, perform the following steps:
From the Enterprise Manager console, click Setup.
Select My Oracle Support in the pane.
Select Set Credentials... then enter the username and password information and click Apply.
From the Enterprise Manager console, click Setup.
Select Extensibility in the pane.
Select Self Update and click Check Updates to schedule a job to collect the metadata for the connectors.
Refer to the "Setting up Self Update" chapter in the Oracle Enterprise Manager Cloud Control Administrator's Guide for more details.
The following list provides prerequisites to installing the connector:
A utility for unzipping .zip files is available on the system hosting IBM TEC (Windows only).
Java JRE 6.0 Update 11 or higher is installed on the system where the TEC Web Service will be installed.
Use of this connector requires the creation of an event class named OracleEnterpriseManager at the IBM TEC server. Sample BAROC and rules files are provided with the installation that you can install manually or with the included installation script.
The TEC connector is not included out-of-box so it must be downloaded from the Oracle Enterprise Manager store. All connectors in the Enterprise Manager store will be available on the Self Update page for downloading. To install (apply) the connector, you must have super administrator privileges. However, there is no user restriction for downloading the conenctor.
This section identifies the steps required to download and install (apply) the connector.
From the Enterprise Manager console, click Setup.
Select Extensibility in the pane.
Get a list of available connectors by selecting Self Update, then click Management Connector.
The TEC connector should be listed with a status of Available.
Click the TEC connector to select it, then click Download.
The Schedule Download window is displayed to determine when the download should be performed.
Click Select to download immediately.
Note:
If you want to schedule the download for a later time, specify the date/time when the download should take place, then click Select. You must return to finish the remainder of this procedure after the scheduled download date/time.If necessary, refresh the screen until the status of the connector changes to Downloaded.
Click the TEC connector to select it, then click Apply.
You will be prompted to confirm the operation and then a window displays indicating the request has been submitted.
Refresh the screen until the status of the connector changes from Apply Scheduled to Applied.
The TEC web service acts as a front-end for all data flowing into and out of TEC. Oracle Enterprise Manager posts calls to the web service whenever it needs to create or update an event.
You can install the TEC web service on any Unix or Windows system that runs Oracle JRE 1.6 and has connectivity to the TEC server and the Oracle Enterprise Manager server.
The following sections explain how to install and then subsequently run the Web Service.
The following prerequisites must be met before proceeding to the next section.
Oracle Java Runtime Environment (JRE) version 6 Update 11 or higher is installed
JAVA_HOME environment variable is set to the JRE installation directory
To install the web service on a Unix platform, perform the following steps:
Create a directory where you want to install the web service.
Obtain a copy of the TEC_webservices_adapter.jar file from the Management Server host machine as specified in Exporting the Web Service Installation File.
Copy the TEC_webservices_adapter.jar file to the web service installation directory.
Open a terminal and change the working directory to the webservice installation directory.
Enter the following command to unzip and extract the .tar file:
$JAVA_HOME/bin/jar xvf TEC_webservices_adapter.jar
This creates the adapters directory that contains the installation files.
Note:
If the system where the TEC 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.Enter the following command to change the working directory:
cd adapters/endpoints/tec
Enter the following command to run the installation script:
sh ./install.sh
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.
When the script prompts for the user name of the web service, enter the user name that must be provided to access the TEC web service.
The user name (and the password in the next step) can be any value and is not associated with any specific OS or TEC account. Note this value and supply it when configuring the TEC connector in Enterprise Manager.
When the script prompts for the password of the web service, enter the password that must be provided to access the TEC web service.
When the script prompts for the host name of the IBM TEC server, enter the host name or IP address where the server is installed.
When the script prompts for the port number of the IBM TEC server, enter the port number of the TEC reception port if a port mapper is not defined for the server. If a port mapper is defined for the server, specify a port number of 0.
Note:
The TEC reception port is defined by the tec_recv_agent_port parameter in the .tec_config file in the $BINDIR/TME/TEC directory.Copy the API jar files from the TEC installation disk to the adapters/lib/adapters directory. The files you need to copy are log.jar and evd.jar, which are located in the EIFSDK/jars directory of the TEC installation disk.
After the script displays the message "TEC Web Service Complete," press Enter to complete the installation.
If the web service was configured to run using the HTTPS protocol, you must set up SSL as specified in Configuring Enterprise Manager to use SSL.
Delete the TEC_webservices_adapter.jar file from the installation directory.
The web service framework is now installed and ready to start.
To run the IBM TEC Web Service framework commands listed with the following tasks, first change the working directory to the following location in the installation directory:
adapters/bin
Start — ./service.sh start
Shut Down — ./service.sh stop
Restart — ./service.sh restart
Check Status — ./service.sh status
Perform the following steps to verify that the IBM TEC Web Service is functional.
Open a terminal and change the working directory to the adapters/bin directory in the installation directory.
Enter the following command to run the test script:
./testAdapter.sh
When the utility prompts for the web service password, enter the password you specified for the TEC web service in step 10 of Installing the Web Service on Unix.
If the test completes successfully, the last line the utility displays is "Test completed successfully."
The following sections explain how to install and then subsequently run the Web Service.
The following prerequisites must be met before proceeding to the next section.
Oracle Java Runtime Environment (JRE) Version 6 Update 11 or higher is installed
JAVA_HOME environment variable is set to the JRE installation directory
Zip utility, such as WinZip, is installed for unzipping a zip file
To install the web service on a Windows platform, perform the following steps:
Create a directory where you want to install the web service.
Obtain a copy of the web service installation file from the Management Server host machine as specified in Exporting the Web Service Installation File.
Copy the TEC_webservices_adapter.jar file to the web service installation directory.
Open a terminal and change the working directory to the webservice installation directory.
Enter the following command to unzip and extract the .jar file:
%JAVA_HOME%\bin\jar xvf TEC_webservices_adapter.jar
This creates the adapters directory that contains the installation files.
Note:
If the system where the TEC 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.Enter the following command to change the working directory:
cd adapters\endpoints\tec
Enter the following command to run the installation script:
.\install.bat
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.
When the script prompts for the user name of the web service, enter the user name that must be provided to access the TEC web service.
Note:
The user name (and the password in the next step) can be any value and is not associated with any specific OS or TEC account. Note this value and supply it when configuring the TEC connector in Enterprise Manager.When the script prompts for the password of the web service, enter the password that must be provided to access the web service.
When the script prompts for the host name of the IBM TEC server, enter the host name or IP address where the server is installed.
When the script prompts for the port number of the IBM TEC server, enter the port number of the TEC reception port. The default value for this port is 5529.
Note:
The TEC reception port is defined by the tec_recv_agent_port parameter in the .tec_config file in the $BINDIR/TME/TEC directory.Copy the API jar files from the TEC installation disk to the adapters\lib\adapters directory. The files you need to copy are log.jar and evd.jar, which are located in the EIFSDK\jars directory of the TEC installation disk.
After the script displays the message "TEC Web Service Complete," press Enter to complete the installation.
If the web service was configured to run using the HTTPS protocol, you must set up SSL as specified in Configuring Enterprise Manager to use SSL.
Optional: If you want the web service to run as a Windows service, perform the following steps.
Enter the following command to change the working directory to the bin directory:
cd ..\..\bin
Enter the following command to install the web service as a Windows service:
service.bat install
Delete the TEC_webservices_adapter.jar file from the installation directory.
The web service framework is now installed and ready to start.
To start the TEC web service framework when set up as a standalone application (not set up to run as a Windows service):
Change the working directory to the adapters\bin directory in the installation directory.
Run the following command:
startAdapters.bat
To shut down the TEC web service framework, close the window where you started the adapter.
To start the TEC web service framework when set up to run as a Windows service:
net start iWaveAdapters
To shut down the TEC web service framework:
net stop iWaveAdapters
Perform the following steps to verify that the IBM TEC Web Service is functional.
Open a terminal and change the working directory to the adapters/bin directory in the installation directory.
Enter the following command to run the test script:
./testAdapter.bat
When the utility prompts for the web service password, enter the password you specified for the TEC web service in Step 10 of Installing the Web Service on Windows.
If the test completes successfully, the last line the utility displays is "Test completed successfully."
The TEC Web Service installation file is included in the Self Update archive that was installed in Installing the Connector in Enterprise Manager. To extract the installation file, perform the following steps.
Determine the command required to export the web service installation file. To do this, perform the following steps:
From the Enterprise Manager console, click Setup.
Select Extensibility in the pane.
Select Self Update, then click Management Connector.
Click the TEC connector, then select Export from the Actions list.
A popup window appears with the command required to export the file. See Figure 2-2 below for an example of the popup window.
Open a command window on the TEC server machine and navigate to a temporary directory where the file can be copied.
Log into emcli using the following command. You will be asked to provide the password information for the sysman account.
emcli login -username=sysman
Run the emcli export_update command from your system, changing <dirname> to the full path of the temporary directory.
A zip file will be created. The file name is comprised of the id value specified in the export_update command with a .zip extension. In the example command in Figure 2-2, the zip file name would be E9F684312AE7A18E98340715D079E58D.zip
Extract the web service installation file from the zip file using the following command:
unzip *.zip archives/TEC_webservices_adapter.jar
Install the Enterprise Manager EMCLI_Client on the same host on which the connector is installed. This will need to be able to communicate to your OMS. Follow these steps to set up EM CLI on your system:
Log in to the Enterprise Manager console.
Select Setup, then My Preferences. Select Command Line Interface.
Click the Download the EM CLI kit to your workstation link and download the .jar file in the server.
Follow the steps given in the page to install the EM CLI client on the server.
Note:
Refer to EM CLI Guide for more detailed information.The following sections provide procedures for installing and running the TEC Agent.
The back-end TEC Agent pushes data from TEC into the TEC Web Service. The Agent is comprised of a script (invoked by TEC rules and a command line utility invoked by the script) to send a transaction to the TEC Web Service. The TEC Agent must be installed on the same physical system as the TEC server. The TEC Agent is preconfigured to interface with the TEC Web Service and requires minimal configuration.
To install the TEC Agent, perform the following steps:
Obtain a copy of the agent installation file from the Management Server host machine as specified in Exporting the Agent Installation File.
Copy the installation file into the directory where you intend to install the TEC Agent.
Note:
You need to do this on the IBM TEC system host.Table 2–1 identifies the installation file name for each supported platform.
Open a terminal and change the working directory to the installation directory.
Unzip the installation file. This creates the TEC-agent directory that contains the installation files.
For Windows platforms, use a zip utility to unzip the TECAgentWindows.zip file.
For AIX platforms, issue the following command to unzip and untar the files:
gunzip -c TECAgentAIX.tar.gz | tar xvf -
For Solaris platforms, issue the following commands to unzip and untar the files:
gunzip -c TECAgentSolaris.tar.gz | tar xvf -
Set up the TEC environment:
For Windows systems, enter the following commands to start the bash shell:
%SystemRoot%\system32\drivers\etc\Tivoli\setup_env.cmd
bash
For Unix systems, enter the following command to start the bash shell:
/etc/Tivoli/setup_env.sh
Change the working directory to the TEC-agent directory.
Enter the following command to run the setup script to configure the TEC Agent:
./install.sh
The following prompts appear in this sequence:
Enter the hostname or IP address where the TEC Webservice Adapter is installed. [localhost]:
Enter the hostname or IP address where the TEC Webservice Adapter is installed. If the agent is being installed on the same machine as the TEC Web Service, accept the default of localhost.
Do you want to install the default Oracle Enterprise Manager classes and rules [Y]?
Enter Y to install and activate the class definitions and rules for the OracleEnterpriseManager class. This class must be installed before events from Enterprise Manager can be inserted into TEC. Enter N to skip the installation of the OracleEnterpriseManager class. The classes must be manually installed if you choose not to install the class definitions. See Handling Data Flowing from Enterprise Manager to TEC for instructions about how to manually install the class definitions.
WARNING:
If you elect to have the script install the classes and rules, it will restart the TEC server without prompting. If this is unacceptable, you will need install the files and restart the TEC server manually.
The following prompts appear in this sequence if you choose to install the OracleEnterpriseManager class.
Enter the name of the rule base to use:
Enter the name of the rule base where the class should be installed. This can be an existing rule base or one that does not exist.
Rule base could not be found. Do you want to create it [N]?
This prompt only appears if the rule base specified in the previous response did not already exist. Specify Y to create a new rule base, or specify N to exit the script without installing the OracleEnterpriseManager class.
Enter the rule base directory:
This prompt only appears if the script cannot determine the directory where the rule base files are located. Enter the directory where the rule base files are located. The script terminates if the directory does not exist.
Delete the installation file from the installation directory.
You do not need to start or stop the Agent. A TEC rule invokes it whenever a transaction needs to be sent to the TEC Web Service adapter. The Agent terminates after the transaction has been successfully delivered to the TEC Web Service adapter.
The agent installation file is included in the zip file that was extracted in Exporting the Web Service Installation File. To extract the installation file, perform the following steps.
Open a command window on the TEC server machine and navigate to the temporary directory where the zip file was created.
Extract the agent installation file from the zip file using one of the following commands depending on the platform where the agent will be deployed:
For AIX:
unzip *.zip archives/TECAgentAIX.tar.gz
For Solaris:
unzip *.zip archives/TECAgentSolaris.tar.gz
For Windows:
unzip *.zip archives/TECAgentWindows.tar.gz
TEC rules must initiate event information sent from TEC to the TEC Web Service. This requires changes to the TEC rule sets to invoke the tec2uniagt script, which sends event information to the TEC Web Service. The following sections describe the required changes to the TEC rule sets for data flowing in both directions.
For the TEC connector to work out of the box, the Oracle Enterprise Manager default classes must be installed and loaded into the TEC Server. When installing the TEC Agent, you have the option to install the classes and rules.
If you choose to install the default classes, the install script compiles the classes and rules, and loads them into the TEC Server. It also shuts down and restarts the server to pick up the new classes.
If you choose not to install the classes, you must manually install the classes and rules. The default class files are located in the TEC-agent/Samples directory. The OracleEnterpriseManager.baroc file defines the five classes that are required to insert events into TEC. The OracleEnterpriseManager.rls file contains the rules required to send the event data back to the TEC Web Service after an event has been created, updated, or closed. To manually install the classes with the install script, perform the following steps.
Open a command terminal at the system where the TEC server is installed.
Change the working directory to the TEC-agent/Samples directory in the TEC Agent install directory.
Set up the TEC environment:
For Windows systems, enter the following commands to start the bash shell:
%SystemRoot%\system32\drivers\etc\Tivoli\setup_env.cmd
bash
For Unix systems, enter the following command to start the bash shell:
/etc/Tivoli/setup_env.sh
Enter the following command to install the default classes:
./rule_load.sh
|
 Copyright © 2012, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|
