dmshutdown - Shut down CDC Replication

Use this command to stop an instance of CDC Replication 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 CDC Replication.
Note: 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 CDC Replication processes and stop the specified instance, use the dmterminate command on the UNIX and Linux® platforms to force a complete shut down and on Windows, to stop the service.

Syntax

dmshutdown [-I <name>] [-c|-i|-a|-se [-t <timestamp>|-p <log position>] 
[-L <locale>]

Parameters

[-I <name>]
Specifies the name of the CDC Replication instance. Alternatively, you can specify the TSINSTANCE environment variable in place of this value.
[-c]
Specifies that CDC Replication stops the specified instance and ends replication on all subscriptions that use the instance as a source with the Normal option. CDC Replication 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 CDC Replication 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 CDC Replication 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 CDC Replication 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.
You can use the following parameters with this option to end replication at a specific date and time or log position:
–t
Stop the instance and end replication at a specific date and time in your source database log.
–p
Stop the instance and end replication at a specific log position in your source database log.
Note: As latency between the source and target increases, the amount of time required to end replication will also increase.
[-t <timestamp>]
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.
[-p <log position>]
Indicates that CDC Replication will end replication at the specified Informix® LSN in your source database log when using -se. Here is an example of an LSN format for Informix Dynamic Server: 33500745064472
This parameter is optional when you specify -se.
-L <locale>
The name of the locale used for the CDC Replication instance. The default is the locale of the machine where CDC Replication is installed.

Result

This command returns a value of 0 if the command was successful and a non-zero value if the command fails.