3 Using the Oracle GoldenGate Monitor Agent

This chapter explains how to use the Oracle GoldenGate agent. It includes information such as how to change passwords and how to change memory allotment settings.

This chapter includes the following sections:

3.1 Installing Oracle GoldenGate Monitor Agent

To install and configure Oracle GoldenGate agent, use the procedures described in Installing and Configuring Oracle GoldenGate Monitor Agent. Oracle GoldenGate agent must be installed on the same host as Oracle GoldenGate Monitor.

3.2 Starting the Oracle GoldenGate Monitor Agent

You need to start Oracle GoldenGate agent whenever you start Oracle GoldenGate Monitor. To do so, go to Oracle GoldenGate Core GGSCI and execute the start jagent command:

GGSCI>START JAGENT

Notes:

If processes were added or deleted, Oracle GoldenGate agent will detect them without requiring restart.

3.3 Updating Oracle GoldenGate Monitor Agent Passwords

Oracle GoldenGate agent passwords are stored in the Oracle Wallet for all supported platforms except IBM z/OS, where they are stored in the password.properties file (found in the installation_location/cfg directory).

Use the pw_agent_util.bat and pw_agent_util.sh utilities to change agent passwords on all supported platforms.

To change agent passwords:

  1. Navigate to the installation directory.

    Shell> cd ./installation_directory/
    
  2. Using the appropriate runtime argument, run the appropriate pw_agent_util file.

    Note:

    The password utility can be run only by the user who installed the Oracle GoldenGate instance.

    On Windows enter the following at the command line:

    Shell> pw_agent_util.bat -[updateAgentJMX | updateServerJMX | updateKeystore | updateTruststore]
    

    On UNIX enter the following command:

    Shell>./pw_agent_util.sh -[updateAgentJMX | updateServerJMX |  updateKeystore | updateTruststore]
    

    Where the pw_agent_util options are:

    • -updateAgentJMX, which changes the agent's JMX password.

    • -updateServerJMX, which changes Oracle GoldenGate Monitor Server's JMX password.

    • -keystore, which adds the Java keystore password.

    • -truststore, which adds the Java truststore password.

    • -updateKeystore,Which changes the Java keystore password.

    • -updateTruststore, which changes the Java truststore password.

    If the wallet is needed and it exists, the utility will prompt with the password to be modified. If the Oracle Wallet is needed and does not exist, the utility will return a message indicating that you will need to first run with the -create option and then the utility will stop. To create the wallet, use this command (using the same options as above):

    On Windows:

    Shell> ./pw_agent_util.bat -create | -jagentonly 
    

    On Linux:

    Shell> ./pw_agent_util.sh -create | -jagentonly 
    
  3. Enter and confirm the new password to implement the change. Press Enter without entering any data to cancel the request.

  4. To activate the changes, navigate to the Oracle GoldenGate installation location and bring up GGSCI. Then do one of the following depending on your Oracle GoldenGate release:

    • For Oracle GoldenGate release 11.1.1.1, stop and restart the Oracle GoldenGate Manager.

      GGSCI> STOP MANAGER
      GGSCI> START MANAGER
      
    • For Oracle GoldenGate release 11.2.1 and later, stop and restart the Oracle GoldenGate agent.

      GGSCI> STOP JAGENT
      GGSCI> START JAGENT
      

3.4 Changing Oracle GoldenGate Monitor Agent Memory Allotment

You can change the memory allotment for the standalone agent of Oracle GoldenGate release 11.2.1 and later by following these steps:

  1. Navigate to the Oracle GoldenGate installation location.

  2. Start GGSCI and edit the agent parameter file.

    Shell> GGSCI
    GGSCI> EDIT PARAMS JAGENT
    
  3. The settings for the default memory allotment, -Xms, and the maximum memory allotment, -Xmx, are included in the start-up string for the agent. The following example sets the default to 64 MB and the maximum to 512 MB.

    java -jar -Xms64m -Xmx512m dirjar/jagent.jar
    
  4. Change the allotment numbers as needed, save the parameter file, and exit the editor.

  5. Stop and restart the agent to implement the changes.

    GGSCI> STOP JAGENT
    GGSCI> START JAGENT