cscutil (Various operations)

Organization of this page

Format
Function
Arguments
Examples of input
Return values
Notes

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}
 {-props property|-propfile property-file-name}
 [-binary file-name]

To Page Top

Function

This command enables you to perform the following operations:

Start and stop HCSC servers
Obtain the HCSC server setup information and HCSC server information
Start and stop business processes and service adapters, and obtain information
Start and stop standard receptions
Obtain user-defined reception information

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.

The following table describes the values to be specified in the -target and -operation options for each operation.

Table 5‒9: Operations that can be performed according to the values in the -target and -operation options
Operations	-target option	-operation option
Starting HCSC servers	`server`	`start`
Starting business processes	`compo`	`start`
Starting service adapters	`compo`	`start`
Starting standard receptions	`request_service`	`start`
Stopping standard receptions	`request_service`	`stop`
Stopping service adapters	`compo`	`stop`
Stopping business processes	`compo`	`stop`
Stopping HCSC servers	`server`	`stop`
Obtaining the HCSC server setup information	`server`	`get_setup_info`
Obtaining the HCSC server information	`server`	`get_info`
Obtaining the business process information	`compo`	`get_bp_info`
Obtaining the service adapter information	`compo`	`get_adapter_info`
Obtaining the user-defined reception information	`compo_urecp`	`get_info`

To Page Top

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.

server

Specifies an HCSC server as the target of the operations to be executed.
compo

Specifies a business process or a service adapter as the target of the operations to be executed.
compo_urecp

Specifies a user-defined reception as the target of the operations to be executed.
request_service

Specifies a standard reception as 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.

start

Specify this option to start the specified operation target.
stop

Specify this option to stop the specified operation target.
get_setup_info

Specify this option to obtain the setup information for the specified HCSC server.
get_info

Specify this option to obtain the information for the specified HCSC server.
get_bp_info

Specify this option to obtain the information for the specified business process.
get_adapter_info

Specify this option to obtain the information for the specified service adapter.

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

Specifies the properties for the specified -target (operation target) and -operation (operations) options in the key-value=specified-value format. 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.

Double quotation mark (")
Equal sign (=)
Comma (,)

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"

The following table describes the specifications in the -target, -operation, and -props options appropriate for the operations.

Table 5‒10: Specifications in the -target (operation target), -operation (operations), and -props options appropriate for the operations
Operation	`-target`	`-operation`	Property specified with `-props`
Starting HCSC servers	`server`	`start`	`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 processes	`compo`	`start`	`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 adapters	`compo`	`start`	`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 receptions	`request_service`	`start`	`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 receptions	`request_service`	`stop`	`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 adapters	`compo`	`stop`	`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 processes	`compo`	`stop`	`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 servers	`server`	`stop`	`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 information	`server`	`get_setup_info`	`CSCSrvName` = Name of the HCSC server
Obtaining the HCSC server information	`server`	`get_info`	`CSCSrvName` = Name of the HCSC server for which the status is to be displayed
Obtaining the business process information	`compo`	`get_bp_info`	`CSCSrvName` = Name of the HCSC server `AdapterName` = Service ID of the business process
Obtaining the service adapter information	`compo`	`get_adapter_info`	`CSCSrvName` = Name of the HCSC server `AdapterName` = Service ID of the service adapter
Obtaining the user-defined reception information	`compo_urecp`	`get_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.

To Page Top

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

To Page Top

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.

To Page Top

Notes

When you execute the cscutil command, you can concurrently execute multiple referencing functions (such as referencing the HCSC server information).
Only one operating function (such as starting an HCSC server or stopping a service adapter) can be executed at a time.

To Page Top

cscutil (Various operations)

Format

Function

Arguments

-h

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

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

-mng Manager-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

-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))

-mnguser Management-user-ID ~ ((at least 1 character))

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

-target {server|compo|compo_urecp|request_service}

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

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

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

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

Examples of input

Return values

Notes

`-h`

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

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

`-mng` `Manager-name` ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 16 characters))

`-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))

`-mnguser` `Management-user-ID` ~ ((at least 1 character))

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

`-target {server|compo|compo_urecp|request_service}`

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

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

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

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