csccmctl (Managing definition files)
- Organization of this page
Format
csccmctl [-h]
-user login-user-ID
-pass login-password
-cluster cluster-name
-name service-ID-of-service-adapter|reception-ID
-targetfilename name-of-definition-file
[-basedir current-directory]
-operation {get|set|reset}
Function
You can use the following functions for the definition files set up in the development environment:
-
Obtaining the definition files set up in the development environment (-operation get)
-
Setting up the definition files in the operating environment (-operation set)
-
Deleting the definition files set up in the operating environment (-operation reset)
Use this command when different values are set up in the development and operating environments. The definition files set up with this command are only valid in the operating environment.
This command can only delete the definition files set up in the operating environment. You cannot delete the definition files set up in the development environment with this command. To delete the definition files set up in the development environment, delete the definition files when in the development environment.
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:
-
Usage when get is specified in the -operation option
3.1.9 Importing the HCSC component definition files into the operating environment
-
Usage when set is specified in the -operation option
3.1.10 Setting and updating the HCSC component definition files in the operating environment
-
Usage when reset is specified in the -operation option
3.1.11 Deleting the HCSC component definition files from the operating environment
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.
-cluster cluster-name ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))
Specifies the name of the cluster that has a service adapter whose service information you intend to change. If the repository has one cluster, you can omit the -cluster option from this command by specifying that cluster in the HCSC-Manager command definition file.
-name service-ID-of-service-adapter|reception-ID ~ <one-byte alphanumeric characters and underscores (_)> ((1 to 8 characters))
Specifies one of the following:
-
To set up the service adapter definition file: Service ID
-
To set up a user-defined reception definition file: Reception ID
-targetfilename name-of-definition-file ~ ((at least 1 character))
Specifies the name of the definition file you want to obtain, set, update, and delete. You can only specify the file name as a value.
An error occurs if you specify the name of a non-existent file during obtain, set, and update operations; however, no error occurs if such a name is specified during the deletion operation. The processing continues.
The length of the directory and the file path is restricted depending on the OS. Set the length of the path coupled with the current directory specified in the -basedir option so that the length does not exceed the length restricted by the OS.
-basedir current-directory ~ ((at least 1 character))
Specify the relative or absolute directory path for the definition file you want to obtain, set, and update. The specified value must be a directory. Make sure that you specify an existing directory.
If this option is not specified, the path used for executing the command is considered as the current directory.
The length of the directory and the file path is restricted depending on the OS. Set the length of the path coupled with the definition file name specified in the -targetfilename option so that the length does not exceed the length restricted by the OS.
Note that this option is ignored when the -operation reset option is specified.
-operation {get|set|reset}
Obtains, sets, or deletes a definition file that is set up in the development environment, in the operating environment. Use this option to specify settings that are different from those in the development environment.
-
get
A definition file specified in the -targetfilename option is allocated to the directory specified in the -basedir option.
If the same file name exists, the file is overwritten.
-
set
The file specified in the -targetfilename option and present in the directory specified in the -basedir option is set up in the operating environment repository. If a definition file with the same name already exists, the contents are updated.
-
reset
If the file name specified in the -targetfilename option matches with the file name of the operating environment repository specified in the -operation set option, the definition file is deleted.
Examples of input
- To set up the service adapter definition file
-
- (1) To obtain the definition file adptp1_config.xml in the operating environment
csccmctl -cluster CLS1 -name ADP1 -targetfilename adptp1_config.xml -basedir C:\tmp -operation get
- (2) To set up or update the definition file adptp1_config.xml in the operating environment
csccmctl -cluster CLS1 -name ADP1 -targetfilename adptp1_config.xml -basedir C:\tmp -operation set
- (3) To delete the settings for the definition file adptp1_config.xml from the operating environment
csccmctl -cluster CLS1 -name ADP1 -targetfilename adptp1_config.xml -operation reset
- To set up the TP1/ RPC reception definition file
-
- (1) To obtain the definition file cscurecptp1rpc.properties in the operating environment
csccmctl -cluster CLS1 -name RCP1 -targetfilename cscurecptp1rpc.properties -basedir C:\tmp -operation get
- (2) To set up or update the definition file cscurecptp1rpc.properties in the operating environment
csccmctl -cluster CLS1 -name RCP1 -targetfilename cscurecptp1rpc.properties -basedir C:\tmp -operation set
- (3) To delete the settings for the definition file cscurecptp1rpc.properties from the operating environment
csccmctl -cluster CLS1 -name RCP1 -targetfilename cscurecptp1rpc.properties -operation reset
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
Execute the options -operation set or -operation reset before you deploy the components.