5 Commands and Parameters

This chapter describes the parameters set in the Oracle GoldenGate instance to enable monitoring, and the commands used to create and alter the Oracle GoldenGate Monitor data store and to start the Oracle GoldenGate Monitor Java Agent that handles monitoring data.

This chapter includes the following sections:

5.1 Parameters

Oracle GoldenGate parameters are used to configure, run, and manage Oracle GoldenGate processes. The parameters included here apply to monitoring by Oracle GoldenGate Monitor Server or Oracle Enterprise Manager.

5.1.1 ENABLEMONITORAGENT

Valid for

GLOBALS

Use the ENABLEMONITORAGENT parameter to enable the Oracle GoldenGate Monitor Java Agent for Oracle GoldenGate release 11.1.1.1. For more information on this parameter, consult the Oracle GoldenGate Windows and UNIX Reference Guide for the 11.1.1.1 release.

Note:

ENABLEMONITORAGENT is deprecated for Oracle GoldenGate release 11.2.1 and later.

Syntax

ENABLEMONITORAGENT

5.1.2 ENABLEMONITORING

Valid for

GLOBALS

Use the ENABLEMONITORING parameter to enable monitoring for Oracle GoldenGate. Monitoring is enabled for Extract, Replicat, and Manager processes within the instance of Oracle GoldenGate to which it is applied.

ENABLEMONITORING activates collection of monitoring points providing status and other information on the Oracle GoldenGate processes to Oracle GoldenGate Monitor or Oracle Enterprise Manager.

Note:

ENABLEMONITORING is a valid parameter for Oracle GoldenGate release 11.2.1 and later.

Syntax

ENABLEMONITORING

5.1.3 AUTOSTART JAGENT

Valid for

Manager

Use the JAGENT option of the AUTOSTART parameter to automatically start the Oracle GoldenGate Monitor Java Agent when Manager starts up.

You can use multiple AUTOSTART statements in the same parameter file.

Syntax

AUTOSTART {{EXTRACT | REPLICAT | ER} group_name | JAGENT}

Example

AUTOSTART JAGENT

5.2 GGSCI Commands

The Oracle GoldenGate Software Command Interface (GGSCI) is the command interface between users and Oracle GoldenGate functional components. For Oracle GoldenGate release 11.2.1 and later, commands are used to set up and control the interface between Oracle GoldenGate and monitoring by Oracle GoldenGate Monitor Server or Oracle Enterprise Manager.

Note:

Some commands or options in this section are marked as valid only for Oracle GoldenGate 11.2.1.0.7 and later; the others are valid for 11.2.1 and later.

5.2.1 CREATE DATASTORE

Use CREATE DATASTORE to create an Oracle GoldenGate Monitor data store in the Oracle GoldenGate installation directory. The data store holds monitoring information supplied by the Oracle GoldenGate Extract, Replicat, and Manager processes. This is a required step to use monitoring.

Syntax

CREATE DATASTORE [ MMAP | SHM [ID number] ]

MMAP indicates that the data store should use memory mapped files for interprocess communications. This is the default for Windows platforms. The MMAP option is valid with Oracle GoldenGate release 11.2.1.0.7 and later.

Note:

Do not use MMAP if you are running on a shared network file system such as Network File System (NFS), ASM Cluster File System (ACFS), or an Oracle Database File System (DBFS).

SHM indicates that the data store should use System V shared memory for interprocess communications. This is the default for non-Windows platforms. The optional ID specifies that number should be used as the System V shared memory key. If ID number is not entered, a default key will be assigned starting with 1000 and incrementing by 1 for each assignment. The SHM option is not available on Windows platforms and is valid only with Oracle GoldenGate release 11.2.1.0.7 and later.

Examples

CREATE DATASTORE
CREATE DATASTORE MMAP
CREATE DATASTORE SHM
CREATE DATASTORE SHM ID 1000

5.2.2 ALTER DATASTORE

Use ALTER DATASTORE to change the memory model used for interprocess communications by the Oracle GoldenGate Monitor data store. Before using this command, stop all Oracle GoldenGate processes, including Manager. This command is valid with Oracle GoldenGate release 11.2.1.0.7 and later.

Syntax

ALTER DATASTORE [ MMAP | SHM [ID number] ]

MMAP indicates that the data store should use memory mapped files for interprocess communications.

SHM indicates that the data store should use System V shared memory for interprocess communications. The optional ID specifies that number should be used as the System V shared memory key. If ID number is not entered, the key will be selected by GGSCI. This option is not available on Windows platforms.

Examples

ALTER DATASTORE MMAP
ALTER DATASTORE SHM
ALTER DATASTORE SHM ID 1000

5.2.3 DELETE DATASTORE

Use the DELETE DATASTORE command to remove the Oracle GoldenGate Monitor data store from the Oracle GoldenGate installation directory. Before using this command, stop all Oracle GoldenGate processes, including Manager. This command is valid with Oracle GoldenGate release 11.2.1.0.7 and later.

Syntax

DELETE DATASTORE [!]

! (exclamation point character) bypasses the prompt that confirms the intent to remove the data store.

Examples

DELETE DATASTORE
DELETE DATASTORE !

5.2.4 INFO DATASTORE

Use the INFO DATASTORE command to display information about the memory model that is being used for interprocess communications by the Oracle GoldenGate Monitor data store. This command is valid with Oracle GoldenGate release 11.2.1.0.7 and later.

Syntax

INFO DATASTORE

5.2.5 REPAIR DATASTORE

Use the REPAIR DATASTORE command to repair the data store for the Oracle GoldenGate installation. It checks that all Extract and Replicat processes are registered and attempts to resolve any internal consistency errors. Use REPAIR DATASTORE to apply required updates when upgrading from a previous version of the data store.

Before using this command, stop all Oracle GoldenGate process, including Manager.

Syntax

REPAIR DATASTORE

5.2.6 INFO JAGENT

Use INFO JAGENT to display whether or not the Jagent is running.

Syntax

INFO JAGENT

Example

The INFO request will respond that the Oracle GoldenGate Monitor Java Agent is running or is down.

INFO JAGENT

JAgent is DOWN!

5.2.7 START JAGENT

Use START JAGENT to start the agent process. To confirm that it has started, use the INFO JAGENT or STATUS JAGENT command.

Note:

You do not need to restart an agent process to detect added or deleted processes.

Syntax

START JAGENT

Example

START JAGENT

GGCMD JAGENT started.

5.2.8 INFO JAGENT

Use STATUS JAGENT to determine whether or not the agent is running.

Syntax

STATUS JAGENT

Example

STATUS JAGENT 

JAgent is running.

5.2.9 STOP JAGENT

Use STOP JAGENT to stop the agent process. To confirm that it has stopped, use the INFO JAGENT or STATUS JAGENT command.

Syntax

STOP JAGENT [!]

Where:

!(exclamation point) bypasses the prompt to confirm the request to stop the agent.