The Capture Agent configuration (.cab) file is a binary file created and maintained by the SQDconf utility. While this section focuses primarily on the initial configuration of the Capture/Publisher Agent, sequences of SQDconf commands to create and configure the capture agent should be saved in a shell script or a zOS PARMLIB member for migration to other operating environments and for recovery. The zOS ISPF provides an option to generate Capture/Publisher configuration (.cab) file recovery JCL.
The SQDconf create command will be used to prepare the initial Capture/Publisher configuration (.cab) file for the Db2 zOS, Db2/LUW (UDB) and Oracle Capture agents:
Syntax
sqdconf create <cab_file_name>
--type=<type>
[--ssid=<value>]
[--single-member]
[--database=<name>]
[--user=<name>]
[--password=<value>]
[--passcmd=<filename>]
[--ccsid=<coded_character_set_identifier>]
[--plan=<sqdata_plan>]
[--exclude-plan=<value>]
[--auto-exclude-plan=<y or n>]
[--exclude-user=<value>]
[--exclude-correlation-id=<value>]
[--retry=<number> | --noretry]
[--size=<number>]
[--disable-continuous-mining]
[--encryption | --no-encryption]
[--auth-keys-list=<name>]
[--store=<store_cab_file_name>]
Keyword and Parameter Descriptions
| Keyword | Description |
|---|---|
| <cab_file_name> | Path and name of the Capture/Publisher Configuration (.cab) file. The directory must exist and the user-id associated with the agent must have the right to create and delete files in that directory. Precisely recommends including the Capture Agent alias as the third node in the directory structure and first node of the file name, for example, /home/sqdata/db2cdc/db2cdc.cab. In a windows environment .cfg may be substituted for .cab since .cab files have special meaning in windows. |
| --type=<type> | Agent type, in the case of the DB2 or Db2/LUW (UDB) Log Reader Capture, "DB2", Oracle Log Reader Capture, "ORACLE". |
| [--ssid=<value>] | Db2 z/OS only. Subsystem ID or the Db2/z Data Sharing Group or Member Name |
| [--single-member] | Db2 z/OS only. |
| [--ccsid=<number>] | The coded character set identifier or code page number of the source database. |
| [--database=<name> | -d <name>] | Db2/LUW (UDB) and Oracle Only. Name of the database associated with the Capture configuration file. The database does not need to actually exist at the time Capture Agent configuration file is created. |
| [--user=<name> | -u <name>] | User name/id required to connect to the underlying database. This user must have the authority to perform log capture/log mining on the underlying database. |
| [--password=<value> | -p <value>] |
Plain text passwords are exposed in the cab file. DO NOT use plain text passwords. Precisely highly recommends using |
| [--passcmd='./getpassword.sh'] | A script that will return the user password. |
| [--exclude-plan=<name>] | DB2 and Db2/LUW (UDB) Only. Exclude transactions associated with the given plan name from capture. This parameter can be repeated multiple times. |
| [--auto-exclude-plan-name=<y|n>] | Db2 and Db2/LUW (UDB) Only. Excluded from capture by default, all updates made by an Engine running under the same plan name used by the capture, including the default Plan, SQDDB2D. The reason for this is to avoid circular replication. |
| [--exclude-user=<name>] | Db2 Db2/LUW (UDB) and Oracle Only. Exclude transactions associated with the given user name from capture. This parameter can be repeated multiple time. |
| [--exclude-correlation-id=<value>] | Db2 Only. Exclude transactions with the given correlation id value from capture. This parameter can be repeated multiple times. While the translation of correlation Id can be modified, the defaults are:
|
| [--retry=<number>] | Number of seconds to wait before re-attempting to write to the CDCSTORE transient data store. When a write to fails due to a Full condition, the capture agent will wait the specified number of seconds before re-attempting the write. If the second write fails the agent stops and reports an error, otherwise processing will continue normally. This allows for throttling the output rate. A negative or null value disables the retry mechanism. The retry mechanism is used to deal with the situation where the storage agent is full. In this case ONLY, the capture agent will wait the specified number of seconds and retry indefinitely, until some space becomes available in the storage agent or the capture agent is Stopped. Disable the retry mechanism. |
| [--noretry] | Disable the retry mechanism. |
| [--size=<number> | -s <number>] | Number of entries in a configuration file at creation. The default is 31 entries. The configuration file will grow automatically by doubling its size when ever needed. The only restriction is that such growth cannot occur while the associated capture agent is in the STARTED state. |
| [--disable-continuous-mining] | Oracle RAC capture only. This option must be specified when capturing Oracle 11 or 12 on a RAC system. It instructs the Capture Agent not to use the Oracle LogMiner CONTINUOUS_MINE option. The --disable-continuous-mining option is the default for Oracle version 19 on both RAC and non-RAC systems. |
| [--encryption | --no-encryption] | Enables or disables NaCL encryption of the published CDC record payload. On z/OS Precisely recommends zIIP processors be used to enhance CPU cycle efficiency and reduce CPU cost associated with NaCL software encryption. |
| [--auth-keys-list="<name>"] | Required for NaCL software encrypted CDC record payload. File name must be enclosed in quotes and must contain public key(s) of only the subscribing Engines requiring encryption of the CDC record payload. See --encryption option. |
| [--store=<name>] | Db2, Db2/LUW (UDB)and Oracle Only. Path and name of the CDCStore Storage Agent Configuration (.cab) file. |
Note: The sqdconf create command defines the location and initial content of the agent's configuration (.cab) file. Once created, the file also contains information related to the current position in the database log. This command should never be run again unless you want to destroy and recreate the agent.