ctmholdque (lock schedule queues)

Format

ctmholdque  [-h] [-CTMDomain CTM-domain-name] [-CTMID CTM-identifier]
            [-CTMMyHost host-name-or-IP-address]
            {-CTMQueue schedule-queue-registration-name | -CTMQueueALL}
            [[-CTMRequestLeave] [-CTMTimeOut timeout-value]
             | [-CTMChangeServer]]
            [-CTMForce]

To Page Top

Function

This command locks schedule queues.

If a schedule queue is locked, subsequent requests and requests in the schedule queue cause errors. However, if the schedule queue is locked with the -CTMRequestLeave option specified, requests in the locked schedule queue will be processed by a J2EE application.

If the schedule queue is locked with the -CTMChangeServer option specified, J2EE applications can be replaced in online mode.

To Page Top

Arguments

-h

Displays how to use the command.

-CTMDomain CTM-domain-name

Specifies the CTM domain name of the CTM daemon for which the schedule queue is to be locked. You can specify 1 to 31 alphanumeric characters and underscores (_). Do not specify a character string that begins with CTM or ctm. If this argument is omitted, CTMDOMAIN is set.

-CTMID CTM-identifier

Specifies the CTM identifier of the CTM daemon for which the schedule queue is to be locked. You can specify 1 to 31 alphanumeric characters, periods (.), and underscores (_). Do not specify a CTM identifier that begins with CTM or ctm. Period (.) can only be specified in IP addresses. If this argument is omitted, an IP address is assumed.

For example, if the IP address of the host is 172.17.112.43, the character string 172.17.112.43 is assumed as the CTM identifier.

-CTMMyHost host-name-or-IP-address

Specifies the host name or IP address used by CTM in a node switching environment where a multi-homed host or IP address is inherited. You can specify a character string of 1 to 64 characters. If this argument is omitted, the host name acquired by the hostname command is set.

-CTMQueue schedule-queue-registration-name

Specifies the registration name of the schedule queue to be locked. You can specify 1 to 63 alphanumeric characters and underscores (_).

For a system that executes batch applications, specify a schedule group name as the registration name of the schedule queue.

-CTMQueueALL

Locks all schedule queues at the same time, including schedule queues that are already locked.

-CTMRequestLeave

Locks the schedule queue without destroying the requests retained in the schedule queue. The requests that are not destroyed will be processed by a J2EE application.

The ctmholdque command waits for the retained requests to be exported, for the amount of time specified for the -CTMTimeOut option. If the ctmrlesque command unlocks the schedule queue during this wait time, reception of requests is enabled, and then the ctmholdque command terminates normally.

-CTMTimeOut timeout-value

Specifies the time (in seconds) to wait for the schedule-queue lock processing. You can specify an integer in the range from 0 to 2147483647. If 0 is specified, there is no limit on the wait time. If this argument is omitted, 180 (seconds) is set.

-CTMChangeServer

Locks the schedule of requests to a J2EE application from the schedule queue. At this time, requests from the EJB client can be queued. The requests retained in the schedule queue are maintained until the schedule queue is unlocked by the ctmrlesque command. However, if you stop the CTM daemon, the requests retained in the schedule queue are destroyed and the stop processing continues.

If the schedule queue is locked with the -CTMChangeServer option specified, J2EE applications can be replaced in online mode because queuing of requests and the requests in the schedule queue are maintained. If J2EE applications available for scheduling exist in the same CTM domain, requests are scheduled in the schedule queue corresponding to a J2EE application that is not loaded.

The -CTMChangeServer option cannot be specified together with the -CTMRequestLeave and -CTMTimeOut options.

If you use this option with ctmstart -CTMQueueDeleteWait, which maintains requests after abnormal termination of the J2EE server, you cannot execute ctmholdque -CTMChangeServer after the J2EE server terminated abnormally.

-CTMForce

Quickly locks the schedule queue without performing communication with the CTM daemon. At this time, the retained requests are destroyed after a fixed time. However, if the -CTMRequestLeave option is specified together, the retained requests are not aborted. Note that the -CTMChangeServer option is ignored if specified together with the -CTMChangeServer option.

To Page Top

Return values

0:

The command is terminated normally.

1:

The command terminated abnormally because an error occurred during command processing. Take the corrective action indicated in the output message, and then re-execute the command.

2:

The specified schedule queue has already been locked. This value is returned only when the -CTMQueue option is specified.

To Page Top