cscrcptnstop (Stopping standard receptions and user-defined receptions)
- Organization of this page
Format
cscrcptnstop [-h]
-user login-user-ID
-pass login-password
{-csc HCSC-server-name|-cluster cluster-name}
[{-standard|-userdef}]
[-stopfg {normal|wait|force}]
[-nogc]
Function
Stops a reception (standard receptions and user-defined receptions).
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 Setup and Operation Guide according to the purpose of use:
-
5.3.33 Terminating the Standard Reception
-
5.3.34 Stopping the user -defined reception
Arguments
-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 name of the HCSC server for stopping the reception.
-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))
Specifies the name of the cluster for stopping the receptions in a batch. An error occurs if you specify the -cluster option when the cluster type is HA.
-standard
Stops only the standard receptions. If both -standard and -userdef are not specified, all the receptions will be stopped.
-userdef
Stops all the user-defined receptions. Use the csccompostop command to stop the user-defined receptions individually. If both -standard and -userdef are not specified, all the receptions will be stopped.
-stopfg {normal|wait|force}
Specifies the stop option for the standard receptions. This definition is ignored if the -userdef option is specified. The default value is normal.
-
normal
Specify this option to normally stop a standard reception.
-
wait
Specify this option to stop a standard reception in a planned manner.
-
force
Specify this option to forcefully stop a standard reception.
-nogc
Stops the receptions without generating Full GC. However, the specification of this option does not control Full GC generated automatically by Java VM.
Examples of input
- (1) To stop the receptions for the HCSC server HCSC
cscrcptnstop -user admin -pass admin -csc HCSC
- (2) To stop the receptions for each HCSC server in the cluster Cluster in a batch
cscrcptnstop -user admin -pass admin -cluster Cluster
- (3) To stop the receptions under the HCSC server CSCSrv1 in a batch, and without generating Full GC
cscrcptnstop -user admin -pass admin -csc CSCSrv1 -nogc
Return values
|
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. |
Notes
-
Execute this command for the running receptions.
-
The HCSC server must be running when you execute the command.
-
If an error occurs when you specify the -cluster option, 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.