csccompostop [-h]
 -user login-user-ID
 -pass login-password
 {-csc HCSC-server-name|-cluster cluster-name}
 {-name service-ID|reception-ID|-all
 |-namelist file-name-specifying-HCSC-components}
 [-nogc]
 

Stops HCSC components.

By setting up default values for mandatory options, such as the login user ID, in the HCSC-Manager command definition file, you can omit the specification of these values in this command.

For details on how to use this command, see the following locations in the Service Platform System Setup and Operation Guide according to the purpose of use:

• 5.3.29 Stopping a user-defined reception
• 5.3.30 Stopping a service adapter
• 5.3.31 Stopping a business process

-h

Displays the usage of commands. When you specify this option, all other options are ignored even if specified.

-user login-user-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the user ID that is used to log in to HCSC-Manager.

-pass login-password ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

Specifies the password that is used to log in to HCSC-Manager.

-csc HCSC-server-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the HCSC server name of the HCSC components to be stopped.

-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the name of the cluster where the HCSC components will be stopped in a batch. An error occurs if you specify the -cluster option when the cluster type is HA.

-name service-ID|reception-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))

Specifies the service ID or reception ID of the HCSC components to be stopped. When you specify this option along with the -cluster option, all the HCSC components with the same service ID within the cluster will stop.

-all

Stops all the running HCSC components within the specified range. When you specify this option along with the -csc option, all the running HCSC components within that HCSC server will start. When you specify this option along with the -cluster option, all the running HCSC components within that cluster will stop.

The following table lists the order in which the HCSC components are stopped when you specify this option. If an error occurs during processing, the stop processing will end even if all the HCSC components are not stopped.

Stopping order	Types of HCSC components	Stopping order within HCSC components
1	User-defined reception	Ascending order of business process names and reception IDs
2	Business process	Ascending order of business process names
3	Service adapter	Ascending order of service IDs

-namelist file-name-specifying-HCSC-components ~ ((1 to 200 bytes))

Uses the HCSC component-specification file to specify the HCSC components to be stopped. Specify this file with an absolute or relative path. If the file does not exist, the command ends abnormally. For details on the HCSC component-specification file, see HCSC component-specification file.

Note that the HCSC components are stopped in the same order as that described for the -all option.

-nogc

Stops the components without generating Full GC. However, the specification of this option does not control Full GC generated automatically by JavaVM.

(1) To stop BP1 existing on the HCSC server HCSC

 
csccompostop -user admin -pass admin -csc HCSC -name BP1
 

(2) To stop all the HCSC components existing on the HCSC server HCSC in a batch

 
csccompostop -user admin -pass admin -csc HCSC -all
 

(3) To stop BP1 on each HCSC server in the cluster Cluster in a batch

 
csccompostop -user admin -pass admin -cluster Cluster -name BP1
 

(4) To stop all the HCSC components existing in the cluster Cluster in a batch

 
csccompostop -user admin -pass admin -cluster Cluster -all

(5) To stop BP1 existing on the HCSC server CSCSrv1 in a batch and without generating Full GC

 
csccompostop -user admin -pass admin -csc CSCSrv1 -name BP1 -nogc
 

(6) To stop the HCSC components specified in the HCSC component-specification file hcsccomponent.txt, from among the HCSC components on the HCSC server CSCSrv1, in a batch

 
csccompostop -user admin -pass admin -csc CSCSrv1 -namelist hcsccomponent.txt
 

Return value	Meaning
0	The command terminated normally.
1	The command terminated abnormally.
2	A communication timeout occurred.
3	An exclusion error occurred.
9	An error occurred when checking the execution permission.

• Execute this command to stop running HCSC components. If multiple HCSC components are specified, the command is executed only for the running HCSC components. The processing will be skipped for HCSC components that are not running.
• The HCSC server must be running when you execute the command.
• If an error occurs when you specify the options -cluster or -all, check the results with the cscstatus command, eliminate the cause of the error, and then re-execute the command.
• If multiple clients simultaneously execute this command for one HCSC server, a processing error (exclusion error, or abnormal end due to repeated operations for a component) might occur. If an error occurs, re-execute the command using one of the following methods:
  
  • Specify the -all option to stop HCSC components
  • Specify the -name option to stop HCSC components individually