This chapter walks you through the process of installing and configuring Oracle GoldenGate Monitor Agent for the z/OS and DB2 for i platforms (if you are installing Oracle GoldenGate Monitor Agent on a non-z/OS or DB2 for i platform, see Chapter 2, "Installing and Configuring Oracle GoldenGate Monitor Agent").
This chapter contains the following sections:
Section 3.1, "Installing Oracle GoldenGate Monitor Agent for z/OS"
Section 3.2, "Installing Oracle GoldenGate Monitor Agent for DB2 for i"
Section 3.4, "Creating and Configuring an Oracle GoldenGate Monitor Agent Instance"
The Oracle GoldenGate Monitor Agent product distribution contains the file ogg_agent-zos.tar
, which you will use to install Oracle GoldenGate Monitor Agent on z/OS platforms. Use this procedure:
Create a directory to install Oracle GoldenGate Monitor Agent binaries; for this example, we will call that directory /apps/products/ogg-agent-zos-home/
.
Navigate to /apps/products/ogg-agent-zos-home
and untar ogg_agent-zos.tar
:
$ tar xvf ogg_agent-zos.tar
You will see a new directory, ogg_agent-zos
, under /apps/products/ogg-agent-zos-home/
. This ogg_agent-zos
directory contains all Oracle GoldenGate Monitor Agent binaries and its configuration and scripts files. On z/OS platforms, this directory (/apps/products/ogg-agent-zos-home/ogg_agent-zos
) is your OGG_AGENT_BASE_HOME
.
The Oracle GoldenGate Monitor Agent product distribution contains the file ogg_agent_generic.tar
, which you will use to install Oracle GoldenGate Monitor Agent on DB2 for i platforms. Use this procedure:
Create a directory to install Oracle GoldenGate Monitor Agent binaries; for this example, we will call that directory /apps/products/ogg-agent-ibmi-home/
Navigate to /apps/products/ogg-agent-ibmi-home
and untar ogg_agent_generic.tar
:
$ tar xvf ogg_agent_generic.tar && rm ogg_agent_generic.tar
You will see all Oracle GoldenGate Monitor Agent binaries and its configuration and scripts files. On DB2 for i platforms, this directory (/apps/products/ogg-agent-ibmi-home
) is your OGG_AGENT_BASE_HOME
.
Enter the My Oracle Support link into a web browser:
Click Sign In....
Note:
If you are not already logged in, the Oracle Single Sign-On page appears. Enter your Oracle user id and password and click Sign In.The Dashboard page appears.
Click the Patches & Updates tab.
Search for Management Pack for Oracle GoldenGate patches for your operating system.
Unzip the downloaded file.
Follow the instructions in the README.txt
file, from the patch ZIP file, to verify that the patch is needed for your system and how to install the patch.
This section describes the procedures for creating and configuring an Oracle GoldenGate Monitor Agent instance. This process is comprised of these six steps:
Go to the directory that contains the Oracle GoldenGate Monitor Agent creation script:
cd OGG_AGENT_BASE_HOME
Run the script:
./createMonitorAgentInstance.sh
The system responds:
Please enter absolute path of Oracle GoldenGate home directory :
Enter the absolute path to your Oracle GoldenGate home directory. For example, /u01/ogg/replication/oggcore1
.
The system responds:
Please enter absolute path of OGG Agent instance :
Enter the directory that contains your Oracle GoldenGate Monitor Agent instance, which can be an existing directory. For example, /u01/ogg/agents/oggmon/agent1
. This directory should be different than the Oracle GoldenGate home directory to avoid overwriting your Oracle GoldenGate Monitor Agent JAR and configuration files the next time you install or patch Oracle GoldenGate.
The Oracle GoldenGate Monitor Agent directory can be an existing directory location. In that case, you are prompted:
OGG Agent instance directory already exists, do you want to overwrite the contents (yes | no)".
If you choose yes
, the execution of the script will continue and all the contents related to Oracle GoldenGate Monitor Agent will be overwritten on that location. If you choose no
, the execution of the script will stop.
The system responds:
Please enter unique name to replace timestamp in startMonitorAgent script (startMonitorAgentInstance_<TIMESTAMP>.sh) :
Enter the name you want to use to start your Oracle GoldenGate Monitor Agent instance. For example, startMonitorAgentInstance_production.sh
.
Oracle GoldenGate Monitor Agent operates in one of two modes, Oracle GoldenGate Monitor Server or Oracle GoldenGate Enterprise Management Plug-In. You set the configuration properties for the mode you want to operate in using the following steps:
Once you have completed the steps in the preceding sections, copy the oggmon.properties
file from the OGG_MONITORSERVER_DOMAIN
/config/monitorserver/cfg
directory to the OGG_AGENT_INST_HOME
/cfg
directory of all of your Oracle GoldenGate Monitor Agent Instances.
Edit the OGG_AGENT_INST_HOME/cfg/Config.properties
file.
Review and set the properties for one of the following modes:
Oracle GoldenGate Monitor (OGGMON):
jagent.host=
Use the default or change to the complete hostname or IP of the machine where Oracle GoldenGate Monitor Agent (jagent
) is running.
jagent.jmx.port=
Use the default or change to your preferred port.
monitor.host=
Set to the hostname you provided during your Oracle GoldenGate Monitor Agent installation.
monitor.jmx.port=
Set to the port you provided during your Oracle GoldenGate Monitor Agent installation.
monitor.jmx.username=
Set to the user name you provided during your Oracle GoldenGate Monitor Agent installation
jagent.username=
Set a jagent
user name.
agent.type.enabled=
Ensure it is set to OGGMON
.
jagent.backward.compatibility=
Ensure it is set to false
.
jagent.ssl=
Ensure it is set to false
.
Or
Oracle GoldenGate Enterprise Management Plug-In (OEM):
jagent.host=
Use the default or change to the complete hostname or IP of the machine where Oracle GoldenGate Monitor Agent (jagent
) is running.
jagent.username=
Set a jagent
user name.
jagent.rmi.port=
Use the default or change to a specific port.
agent.type.enabled=
Set it to OEM
.
jagent.backward.compatibility=
Ensure it is set to false
.
jagent.ssl=
Ensure it is set to false
.
Close and save the file.
The oggmon.properties
file is required to create the wallet. For instructions, see "Edit Monitor Properties" in Installing and Configuring Oracle GoldenGate Monitor Server.
Go to OGG_AGENT_INST_HOME/bin
and run the wallet utility to store the Oracle GoldenGate Monitor Agent, Monitor Server JMX, and other passwords; for example:
$ ./pw_agent_util.sh -create Please create a password for Java Agent: Please confirm password for Java Agent: Please enter Monitor Server JMX password: Please confirm Monitor Server JMX password: Jan 06, 2014 5:17:22 PM oracle.security.jps.JpsStartup start INFO: Jps initializing. Jan 06, 2014 5:17:24 PM oracle.security.jps.JpsStartup start INFO: Jps started. Wallet is created successfully.
This step creates the password.properties
file in the OGG_AGENT_INST_HOME/bin
directory.
To create an Oracle GoldenGate Enterprise Management Plug-In Wallet:
Create the wallet credentials:
./pw_agent_util.sh -jagentonly
Enter and confirm a user password for your jagent.username
property.
Please create a password for Java Agent: Please confirm password for Java Agent:
The system responds:
Jan 06, 2016 5:17:22 PM oracle.security.jps.JpsStartup start INFO: Jps initializing. Wallet is created successfully.
This creates the wallet cwallet.sso
and cwallet.sso.lck
files in dirwlt
in the OGG_AGENT_INST_HOME
directory.
Note:
This step is required only if the Oracle GoldenGate Monitor Agent is running in SSL mode.Go to the OGG_AGENT_INST_HOME/dircrt
and copy the Keystore and Truststore files.
After copying the keystore and truststore files, do the following:
Using the pw_agent_util.sh
(or .bat
, on Windows) utility, update the wallet with keystore and truststore passwords, as described in "Updating Oracle GoldenGate Monitor Agent Passwords" in Administering Oracle GoldenGate Monitor.
Update the jagent.keystore
and jagent.truststore
values in the config.properties
file; for example:
jagent.keystore.file=jagentKeyStore jagent.truststore.file=jagentKeyStore
Create a file named GLOBALS
in the OGG_HOME
directory, if this file does not exist.
Edit the GLOBALS
file.
Add ENABLEMONITORING
on a new line.
Close and save the file.
Create the datastore using the CREATE DATASTORE command:
GGSCI> CREATE DATASTORE
Note:
All processes should be stopped before creating the datastore. You can also addautostart jagent
to the mgr.prm
file.Go to the Oracle GoldenGate Core GGSCI console, and start the Oracle GoldenGate Monitor Agent by executing the start
jagent
command:
GGSCI>start jagent
Once you have completed the preceding steps and Oracle GoldenGate Monitor Agent is running, the Oracle GoldenGate Monitor Agent log details will be written to ogg_agent.log
, which is in OGG_AGENT_INST_HOME/logs
.