3.2 checkprm

Use the checkprm command to assess the validity of the specified parameter file, with a configurable application and running environment. It can provide either a simple PASS/FAIL or with optional details about how the values of each parameter are stored and interpreted.

When you use checkprm and do not use any of these arguments, then checkprm attempts to automatically detect Extract or Replicat and the platform and database of the Oracle GoldenGate installation.

For more information about using checkprm, see Administering Oracle GoldenGate.

Syntax

checkprm
[None]
[-v]
[? | help]
[parameter_file]
[-COMPONENT | -C) component_name]
[-MODE | -M) mode_name] 
[-PLATFORM | -P) platform_name]
[-DATABASE | -D) database _ame] 
[-VERBOSE | -V)]
None

Displays usage information.

-v

Displays banner. Cannot be combined with other options. Does not produce verbose (-VERBOSE | -V) output.

? | help

Displays detailed usage information, include all possible values of each option. Cannot be combine with other options.

parameter_file

Specifies the name of the parameter file, has to be the first argument if a validation is requested. You must specify the absolute path to the parameter file. For example, CHECKPRM ./dirprm/myext.prm.

-COMPONENT | -C component_name

Specifies the running component (application) that this parameter file is validated for. This option can be omitted for Extract or Replicat because automatic detection is attempted. Valid values include:

CACHEFILEDUMP COBGEN CONVCHK CONVPRM DDLCOB DEFGEN EMSCLNT EXTRACT GGCMD GGSCI KEYGEN LOGDUMP
MGR OGGERR REPLICAT RETRACE
REVERSE SERVER GLOBALS

There is no default for this option.

-MODE | -M mode_name

Specifies the mode of the running application if applicable. This option is optional, only applicable to Extract or Replicat.

Valid input of this option includes:

  • Classic Extract

  • Integrated Extract

  • Initial Load Extract

  • Remote Task Extract

  • Data Pump Extract

  • Passive Extract

  • Classic Replicat

  • Coordinated Replicat

  • Integrated Replicat

  • Special Run Replicat

  • Remote Task

  • Replicat All

When key in the value for this option, the application name is optional, as long as it matches the value of component. For example, "Â"Data Pump ExtractÂ" is equivalent to "Â"Data PumpÂ" if the component is Extract. However, it is invalid if the component is Replicat.

-PLATFORM | -P platform_name

Specifies the platform the application is supposed to run on. The default value is the platform that this checkprm executable is running on.

The possible values are:

AIX HP-OSS HPUX-IT HPUX-PA
Linux OS400 ZOS Solaris SPARC
Solaris x86 Windows x64 All
-DATABASE | -D database_name

Specifies the database the application is built against. The default value is the database for your Oracle GoldenGate installation.

The database options are:

Generic Oracle 8 Oracle 9i
Oracle 10g Oracle 11g Oracle 12c
DB2LUW 9.5 DB2LUW 9.7
DB2LUW 10.5 DB2LUW 10.1 DB2 Remote
Teradata MySQL  DB2 for I 
DB2 for i Remote MS SQL DB2 z/OS
-VERBOSE | -V

Directs checkprm to display detailed parameter information, to demonstrate how the values are read and interpreted. It must be the last option specified in a validation and provides more information than the -v option.