cscapputil (Operating an application)
- Organization of this page
Format
cscapputil [-h]
-user login-user-ID
-pass login-password
{-mng Manager-name
|-host IP-address:port-number
-mnguser Management-user-ID [-mngpass Management-user-password]}
{-operation { start|stop|delete }
-j2ee J2EE-server-name -app application-name
|-operation list -j2ee J2EE-server-name}
Function
This command operates the applications managed by an HCSC server.
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 uCosminexus Service Platform Setup and Operation Guide according to the purpose of use:
-
7.5.3 How to recover when executing HCSC server setup and unsetup
-
7.5.4 How to recover when deploying and deleting HCSC Components
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.
-mng Manager-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))
Specifies the name (Manager name) for identifying Management Server. Specify the name of the Manager existing in the repository.
-host host-name-or-IP-address: port-number ~ <host name or IP address: character string, port number: numeric string> ((character string: at least 1 character, port number: 1 - 65535))
Specifies the host name (or IP address) and the port number of the Manager remote management function connected with a colon (:). You cannot omit the IP address and the port number together.
You can specify the -host option even if the repository does not exist. When you specify the -host option, specify the options -mnguser and -mngpass.
-mnguser Management-user-ID ~ ((at least 1 character))
Specifies the management user ID of Management Server
-mngpass Management-user-password ~ ((at least 1 character))
Specifies the management user password of Management Server. Do not specify this option if there is no password.
-operation { start|stop|delete }
Specifies an operation of the specified application.
-
start
Starts the application.
-
stop
Stops the application.
-
delete
Deletes the application.
-
list
Displays the application.
-j2ee J2EE-server-name ~ ((at least 1 character))
Specifies the logical name of the J2EE server.
-app application-name ~ ((at least 1 character))
Specifies the application name.
You can omit this option if list is specified in the -operation option. If you specify a value for this option, the value is ignored.
Examples of input
- (1) To start the application HCSCMessaging existing on the J2EE server J2EEServer
cscapputil -user admin -pass admin -host localhost:28099 -mnguser admin -j2ee J2EEServer -app HCSCMessaging -operation start
- (2) To stop the application HCSCMessaging existing on the J2EE server J2EEServer
cscapputil -user admin -pass admin -host localhost:28099 -mnguser admin -j2ee J2EEServer -app HCSCMessaging -operation stop
- (3) To delete the application HCSCMessaging existing on the J2EE server J2EEServer
cscapputil -user admin -pass admin -host localhost:28099 -mnguser admin -j2ee J2EEServer -app HCSCMessaging -operation delete
- (4) To display the applications existing on the J2EE server J2EEServer
cscapputil -user admin -pass admin -host localhost:28099 -mnguser admin -j2ee J2EEServer -operation list
Return values
|
Return value |
Meaning |
|---|---|
|
0 |
The command terminated normally. |
|
1 |
The command terminated abnormally. |
|
3 |
An exclusion error occurred. |
|
9 |
An error occurred when checking the execution permission. |
Notes
If you use this command to delete an application, the HCSC system might not operate normally. Therefore, carefully execute the operations.