This section contains miscellaneous commands that allow you to determine the version of IBM InfoSphere CDC, verify communications, shutdown, and terminate IBM InfoSphere CDC (UNIX servers only), set system parameters, and backup your metadata.
Use this command to create a backup of the IBM InfoSphere CDC metadata database which contains information about your current replication configuration. You should always back up your metadata when there are changes to your subscription configuration and table status. You can only back up your metadata while IBM InfoSphere CDC is running.
The backup of the metadata database is created in <Installation_directory>/ instance/<instance_name>/conf/backup for UNIX and Linux and in <Installation_directory>\instance\<instance_name>\conf\backup for Windows. The files in the backup directory should be stored on separate media for possible recovery.
Syntax
dmbackupmd -I <instance_name> [-L <locale>]
Parameters
-I <instance_name>
Specifies the name of the IBM InfoSphere CDC instance. Alternatively, you can specify the TSINSTANCE environment variable in place of this value.
-L <locale>
The name of the locale used for the IBM InfoSphere CDC instance. The default is the locale of the machine where IBM InfoSphere CDC is installed.
Result
This command returns a value of 0 if the command was successful and a non-zero value if the command fails.
Use this command to launch the IBM InfoSphere CDC configuration tool. You can use this tool to create instances and configure your installation of IBM InfoSphere CDC.
Syntax
dmconfigurets [-L <locale>]
Parameters
-L <locale>
The name of the locale used for the IBM InfoSphere CDC instance. The default is your machine's locale.
Result
This command returns a value of 0 if the command was successful and a non-zero value if the command fails.
dmclearstagingstore: Remove cached operations from the staging store
Use this command to remove all the contents from the IBM InfoSphere CDC staging store on your source system. The staging store is used to provide a cache of change data that is read from the database logs. There may be times when the contents of the staging store are no longer valid and IBM InfoSphere CDC will give instructions to clear the staging store with this command.
Use this command to enable Continuous Capture for your staging store.
Continuous Capture allows the IBM InfoSphere CDC log reader to continue operating when communication with the target datastore is interrupted due to network difficulties or other issues. Upon resumption of communication with the target, Continuous Capture will reduce the latency between the source and target datastores.
Use this command to view or change IBM InfoSphere CDC system parameters. You can also change system parameters in Management Console. For more information, see your Management Console documentation.
You can set any system parameter using this command. However, it will only display system parameters that are set to non-default values.
Specifies the password for the Access Server user.
-H <hostname>
Specifies the host name (system name) or full IP address of the workstation running Access Server.
-P <port>
Specifies a unique TCP/IP port number that is used to connect to Access Server. You specify this port number when you install the Access Server and when you log on to the Management Console. The default value is 10101.
-L <locale>
The name of the locale used for the IBM InfoSphere CDC instance. The default is the locale of the machine where IBM InfoSphere CDC is installed.
When using dmsetaccessserverparams for the first time, specify all the parameters. If you do not specify the parameter values, the following default values are set:
▪User - Admin
▪Password - "" (blank)
▪Host - localhost
▪Port - 10101
After you have set the values, you can modify them by issuing the command again, including all or some of the parameters.
Result
This command returns a value of 0 if the command was successful and a non-zero value if the command fails.
Use this command to display the IBM InfoSphere CDC version and build number. Run this command before you contact your UNICOM Systems, Inc. representative, so that you can provide the version and build number of IBM InfoSphere CDC that you are running.
Syntax
dmshowversion [-L <locale>]
Parameters
-L <locale>
The name of the locale used for the IBM InfoSphere CDC instance. The default is your machine's locale.
Result
This command returns a value of 0 if the command was successful and a non-zero value if the command fails.
Use this command to stop an instance of IBM InfoSphere CDC and end replication on all subscriptions that use the instance as a source. This command is often used prior to taking a server or database offline for maintenance purposes or upgrading IBM InfoSphere CDC.
As a best practice before you run this command and to ensure that it completes successfully, use the dmendreplication command to end replication on all subscriptions that use the specified instance as a source and as a target. This command will not complete successfully if target subscriptions are still running.
To end replication on subscriptions that use the specified instance as a target, you can use the –a parameter which will generate an error when forcefully ending replication on subscriptions that use the specified instance as the target.
If this command does not end IBM InfoSphere CDC processes and stop the specified instance, use the dmterminate command on the UNIX and Linux platforms to force a complete shut down. On Windows platforms, use the dmterminate command to stop the service.
Specifies the name of the IBM InfoSphere CDC instance. Alternatively, you can specify the TSINSTANCE environment variable in place of this value.
-c
Specifies that IBM InfoSphere CDC stops the specified instance and ends replication on all subscriptions that use the instance as a source with the Normal option. IBM InfoSphere CDC will use this option by default if you do not specify –se, -i, or –a.
This option completes in progress work and then ends replication. If a refresh is in progress, Normal will complete the refresh for the current table before replication ends.
Normal is the most appropriate option for most business requirements and is the preferred method for ending replication in most situations.
-i
Specifies that IBM InfoSphere CDC stops the specified instance and ends replication on all subscriptions that use the instance as a source with the Immediate option.
This option stops all in progress work and then ends replication. Starting replication after using this option can be slower than using -c. If a refresh is in progress, the refresh for the current table will be interrupted and then replication will end.
Use this option if business reasons require replication to end faster than -c at the expense of a slower start when you resume replication on the specified subscriptions.
-a
Specifies that IBM InfoSphere CDC stops the specified instance and ends replication on all subscriptions that use the instance as a source or target with the Abort option. Subscriptions that use the specified instance as a target will end replication with an error.
This option stops all in progress work and then ends replication rapidly. Starting replication after using this option can be much slower than using -c. A refresh in progress will be interrupted and the target will stop processing any data that has not been committed before replication ends.
Use this option if your business reasons require a rapid end to replication and you are willing to tolerate a much slower start when you resume replication on the specified subscriptions.
A sudden business requirement for an unplanned shutdown of your source system may require this option for ending replication.
As a best practice, use the dmendreplication command to end replication on all subscriptions that use the instance specified in this command as a source or target.
-se
Specifies that IBM InfoSphere CDC will stop the specified instance and end replication normally at the current source system time in the source database log with the Scheduled End option. Replication will end on subscriptions that use the specified instance as a source. The source system time when replication will end is set when you issue this command.
As latency between the source and target increases, the amount of time required to end replication will also increase.
-t <date and time>
Indicates the date and time in the source database log when replication will end when using –se.
When specifying a value for this parameter, use the following format:
“yyyy-MM-dd HH:mm”
This parameter is optional when you specify –se.
-L <locale>
The name of the locale used for the IBM InfoSphere CDC instance. The default is the locale of the machine where IBM InfoSphere CDC is installed.
Result
This command returns a value of 0 if the command was successful and a non-zero value if the command fails.
You should only run this command when the Management Console Support Assistant cannot connect to your IBM InfoSphere CDC datastore because it is not running or it will not run. For more information on the Support Assistant, see Management Console - Administration Guide.
When requested by UNICOM Systems, Inc. Support, use this command to collect IBM InfoSphere CDC environment information in a generated .zip file that is used to diagnose and troubleshoot your support issue.
Once the command has completed collecting information and generating the .zip file, the output will display the full path and name of the .zip file. If you run this command multiple times, the generated .zip files are numbered randomly. Note that you are responsible for deleting the generated .zip files when they are no longer required.
Specifies the name of the IBM InfoSphere CDC instance. Alternatively, you can specify the TSINSTANCE environment variable in place of this value.
-t <"yyyy-MM-dd hh:mm:ss to yyyy-MM-dd hh:mm:ss">
Specifies the date and time range (relative to the time zone of the operating system where you issue this command) used by IBM InfoSphere CDC to retrieve environment information.
As a best practice, specify a date and time range that only captures the time period when you experienced problems. This allows for easier problem diagnosis and reduces the size of the files retrieved.
-L <locale>
The name of the locale used for the IBM InfoSphere CDC instance. The default is the locale of the machine where IBM InfoSphere CDC is installed.
Result
This command returns a value of 0 if the command was successful and a non-zero value if the command fails.
Examples
dmsupportinfo -I PRODUCTION -t "2009-12-03 08:00:00 to 2009-12-03 12:00:00"
Retrieves support information for the Production instance from 8:00 AM to 12:00 PM on December 3, 2009. This is the time range when you experienced support issues with this instance of IBM InfoSphere CDC.
dmterminate: Terminate IBM InfoSphere CDC processes
This command is not supported on Windows.
Use this command to terminate all IBM InfoSphere CDC processes, for all instances running on a UNIX or Linux server that you cannot completely shut down with the dmshutdown command (see dmshutdown: Shut down IBM InfoSphere CDC). IBM InfoSphere CDC terminates only processes that are started by the UNIX account used to run this command.
You can use this command prior to taking a server or database offline for maintenance purposes or upgrading IBM InfoSphere CDC to the latest version.
Use the dmshutdown command to gracefully shut down IBM InfoSphere CDC. If dmshutdown is unable to completely shut down IBM InfoSphere CDC, then use dmterminate to terminate any active IBM InfoSphere CDC processes that still remain after issuing dmshutdown.
Syntax
dmterminate [-L <locale>]
Parameters
-L <locale>
The name of the locale used for the IBM InfoSphere CDC instance. The default is your machine's locale.
Result
This command returns a value of 0 if the command was successful and a non-zero value if the command fails.