cscutil (Various operations)

Format

cscutil [-h]
-user login-user-ID
-pass login-password
{-mng Manager-name
|-host IP-address:port-number -mnguser Management-user-ID
[-mngpass Management-user-password]}
-target {server|compo|compo_urecp|request_service}
-operation {start|stop|get_setup_info|get_info
|get_bp_info|get_adapter_info|set_info|delete_info}
{-props property|-propfile property-file-name}
[-binary file-name]

Function

This command enables you to perform the following operations:

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.

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 identifier name for Manager. Specify the name of 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 to 65535))

Specifies the host name (or IP address) and the port number of the Manager remote management function concatenated with colons (:). The IP address and the port number cannot be simultaneously omitted.

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 Manager.

-mngpass Management-user-password ~ ((at least 1 character))

Specifies the password for the management user ID of Manager. You can specify this option only when a password has been set for the Manager user ID you intend to change.

-target {server|compo|compo_urecp|request_service}

Specifies the target of the operations to be executed.

-operation {start|stop|get_setup_info|get_info|get_bp_info|get_adapter_info}

Specifies the operations to be executed.

The following table lists and describes the operations that can be executed depending on the values in the options -target and -operation.

Table 5-8 Operations that can be executed depending on the values in the options -target and -operation

-target option-operation optionOperations
serverstartStarts HCSC servers
compostartStarts business processes
compostartStarts service adapters
request_servicestartStarts standard receptions
request_servicestopStops standard receptions
compostopStops service adapters
compostopStops business processes
serverstopStops HCSC servers
serverget_setup_infoObtains the HCSC server setup information
serverget_infoObtainsthe HCSC server information
compoget_bp_infoObtains the business process information
compoget_adapter_infoObtains the service adapter information
compo_urecpget_infoObtains the user-defined reception information

-props property ~ ((0 or more characters))

Specifies the arguments for the specified operation target and operations in the format key-value=specified-value. Enclose the specified value within double quotation marks (").

However, do not specify the following characters in the key values and specified values. If such characters are specified, the operations become uncertain.

Also, to specify multiple arguments, demarcate the arguments with commas (,).

(Example) -props "J2EESrvName=name-of-J2EE-server-on-which-HCSC-server-is-set-up, CSCSrvName=name-of-HCSC-server-to-be-started"

Table 5-9 Properties that can be specified in the -props option for the operation target and operations

Operation-target-operationProperty specified with -props
Starting HCSC serversserverstart
  • J2EESrvName = Name of the J2EE server on which the HCSC server is set up
  • CSCSrvName = Name of the HCSC server to be started
Starting business processescompostart
  • AdapterName = Service ID of the business process to be started
  • ServiceKind = Adapter type
    bp: Business process
  • J2EESrvName = Name of the J2EE server on which the adapter will be started
  • CSCSrvName = Name of the HCSC server on which the adapter will be started
Starting service adapterscompostart
  • AdapterName = Service ID of the service adapter to be started
  • ServiceKind = Adapter type
    serviceAdapter: Service adapter
  • J2EESrvName = Name of the J2EE server on which the adapter will be started
  • CSCSrvName = Name of the HCSC server on which the adapter will be started
Starting standard receptionsrequest_servicestart
  • J2EESrvName = Name of the J2EE server on which the HCSC server is running
  • CSCSrvName = Name of the HCSC server that can receive requests
Stopping standard receptionsrequest_servicestop
  • J2EESrvName = Name of the J2EE server to be imported
  • CSCSrvName = Name of the HCSC server for which requests will be controlled
  • ForceFlag = Forced termination flag
    NORMAL_OPTION: Normal termination
    WAIT_OPTION: Planned termination
    FORCE_OPTION: Forced termination
Stopping service adapterscompostop
  • J2EESrvName = Name of the J2EE server for which the adapter will be stopped
  • CSCSrvName = Name of the HCSC server for which the adapter will be stopped
  • AdapterName = Service ID of the service adapter to be stopped
Stopping business processescompostop
  • J2EESrvName = Name of the J2EE server for which the adapter will be stopped
  • CSCSrvName = Name of the HCSC server for which the adapter will be stopped
  • AdapterName = Service ID of the business process to be stopped
Stopping HCSC serversserverstop
  • J2EESrvName = Name of the J2EE server on which the HCSC server is set up
  • CSCSrvName = Name of the HCSC server to be stopped
  • ForceFlag = Forced termination flag
    false: Normal termination
    true: Forced termination
Obtaining the HCSC server setup informationserverget_setup_info
  • CSCSrvName = Name of the HCSC server
Obtaining the HCSC server informationserverget_info
  • CSCSrvName = Name of the HCSC server for which the status is to be displayed
Obtaining the business process informationcompoget_bp_info
  • CSCSrvName = Name of the HCSC server
  • AdapterName = Service ID of the business process
Obtaining the adapter informationcompoget_adapter_info
  • CSCSrvName = Name of the HCSC server
  • AdapterName = Service ID of the service adapter
Obtaining the user-defined reception informationcompo_urecpget_info
  • CSCSrvName = Name of the HCSC server for which the user-defined reception information is to be obtained

-propfile property-file-name ~ ((1 to 200 bytes))

Specifies the name of the property file containing arguments, expressed as an absolute or relative path. Specify the property file name in the J2SE property file format.

-binary file-name ~ ((1 to 200 bytes))

Specifies the name of the binary file, expressed as an absolute or relative path. This option is defined for further use.

Examples of input

(1) To start the HCSC server HCSC

cscutil -user admin -pass admin -mng Manager -target server -operation start -props "CSCSrvName=HCSC, J2EESrvName=J2EEServer"

(2) To start the HCSC server HCSC by using the property file cscutil.properties

cscutil -user admin -pass admin -host 10.209.13.165:9001 -mnguser admin -mngpass admin -target server -operation start -propfile cscutil.properties

Contents of cscutil.properties

CSCSrvName=HCSC
J2EESrvName=J2EEServer

Return values

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

Notes