jslmmgrsetup (sets up ITSLM - Manager)
- Organization of this page
Function
This command creates an execution environment for ITSLM - Manager. It can also be used to reconfigure the execution environment for an existing ITSLM - Manager.
You execute this command after you have installed ITSLM - Manager.
The command execution results are output to the standard output and displayed in the console window. For details about the messages displayed during command execution, see 11.3 Messages.
The command performs one of the following processes, depending on the status of the execution environment at the time of command execution:
- Creates an execution environment (when there is no existing execution environment):
-
This command creates an execution environment when it is executed immediately after ITSLM - Manager has been newly installed or after the execution environment for ITSLM - Manager was discarded by unsetup processing.
- Reconfigures the existing execution environment (when an execution environment already exists):
-
If this command is executed when the execution environment for a configured ITSLM - Manager already exists, the command reconfigures the existing execution environment for ITSLM - Manager.
You reconfigure the execution environment in the following cases:
-
The host name, IP address, or port number settings in the execution environment for a configured ITSLM - Manager are to be changed
-
The embedded Web server environment in the execution environment for a configured ITSLM - Manager is to be reconfigured
-
The execution environment for a configured ITSLM - Manager is to be reconfigured after an upgrade installation was performed
Note that an RD area for the embedded database is not created when the ITSLM - Manager execution environment is reconfigured.
-
Format
jslmmgrsetup [ -c { online | standby } ] absolute-path-of-options-file
Execution permission
User account that belongs to the OS's Administrators group
Storage folder
ITSLM-Manager-installation-folder\mgr\bin\
Arguments
-c
Specifies that the execution environment used in a cluster system is to be configured. The specification method is as follows:
-
online
Specifies that the execution environment for the active system is to be configured or reconfigured.
When a new execution environment is configured for the active system, an RD area for the embedded database is created.
-
standby
Specifies that the execution environment for the standby system is to be configured or reconfigured.
When a new execution environment is configured for the standby system, an RD area for the embedded database is not created.
absolute-path-of-options-file
Specifies the absolute path for an options file that is to be created in text format. This file can be stored at any desired location. The absolute path of the options file storage location must be a maximum of 255 bytes of characters, including the file name (any name).
An options file template is stored at the following location:
ITSLM-Manager-installation-folder\mgr\template\mgr\conf\jp1itslm_setup.opt
The following shows the definitions in the options file:
manager_host=host-name-or-IP-address-of-ITSLM-Manager manager_port=port-number-of-ITSLM-Manager psb_Listen=listen-port-number-of-embedded-Web-server psb_ServerName=host-name-or-IP-address-of-embedded-Web-server psb_connector_port=port-number-of-internal-communications-port-of-embedded-Web-server psb_shutdown_port=port-number-of-completion-message-receiving-port-of-embedded-Web-server hdb_port=listen-port-number-of-embedded-database hdb_area_path=RD-area-folder-name-of-embedded-database hdb_share_area_path=path-of-shared-folder-for-creating-RD-area-for-embedded-database-when-running-in-cluster-system hdb_area_size=capacity-of-embedded-database-area
The following table provides the details of the definition items.
No. |
Definition item |
Specification |
Description |
Default value |
---|---|---|---|---|
1 |
manager_host |
R |
Specifies the host name or IP address of the host on which ITSLM - Manager is installed, as the information for identifying ITSLM - Manager's execution environment. If ITSLM is running in a cluster system, specify the logical host name or logical IP address. |
-- |
2 |
manager_port |
O |
Specifies the port number used by ITSLM - Manager, as a number in the range from 1 through 65535.#1 |
20904 |
3 |
psb_Listen |
O |
Specifies the listen port number used by the embedded Web server, as a number in the range from 1 through 65535.#2 |
20900 |
4 |
psb_ServerName |
R |
Specifies the host name or IP address of the embedded Web server. |
localhost |
5 |
psb_connector_port |
O |
Specifies the port number of the internal communications port of the embedded Web server, as a number in the range from 1 through 65535.#1 |
20901 |
6 |
psb_shutdown_port |
O |
Specifies the port number of the completion-message receiving port of the embedded Web server, as a number in the range from 1 through 65535.#1 |
20902 |
7 |
hdb_port |
O |
Specifies the listen port number used by the embedded database, as a number in the range from 5001 through 65535. An error results if any of the following numbers is specified:
Note that if an ephemeral port number (port number that can be used freely temporarily) is specified, that port number might correspond to a port number already in use. |
20903 |
8 |
hdb_area_path#3 |
R |
Specifies the absolute path of the folder storing the RD area for the embedded database. Specify a folder on the local disk as 1 to 130 characters. This value must begin with a drive name (one character from A to Z or a to z or a colon (:)) and consist of the characters A to Z, a to z, 0 to 9, underscore (_), period (.), parentheses (()), backslash (\), and space. None of the following is permitted:
|
-- |
9 |
hdb_share_area_path#3 |
CR |
Specifies the path of the shared folder in which an RD area for the embedded database is to be created when running in a cluster system. The same absolute path must be specified for both the active and standby systems. If ITSLM is running in a non-cluster system, specification of this definition item is ignored. The path must be expressed as a maximum of 110 characters. This value must begin with a drive name (one character from A to Z or a to z or a colon (:)) and consist of the characters A to Z, a to z, 0 to 9, underscore (_), period (.), parentheses (()), backslash (\), and space. None of the following is permitted:
|
-- |
10 |
hdb_area_size#3 |
O |
Specifies the size of the embedded database area for storing the data handled by ITSLM - Manager. Specify an integer in the range from 5000 through 1048575 (MB). If the specified value is not within this range, an error results. Specify for this definition a value that is equal to or greater than the value estimated in How to estimate the size of the database area below. If a large value is specified, database initialization processing will require more time at setup. This definition is ignored when the execution environment is being reconfigured. |
39000 |
Notes
-
If an error occurs during setup, eliminate the cause of the error and re-execute the command. If configuration of a new execution environment has failed and command arguments are to be changed from those used during the previous execution, first undo the setup, and then re-execute the command.
-
The options file used during setup is renamed jp1itslm_setup.opt after command execution and stored at the following location:
ITSLM-Manager-installation-folder\mgr\conf\jp1itslm_setup.opt
-
Do not execute another command, including this command, while this command is executing.
-
If the folder shown below contains a system definition file, the command renames that system definition file by adding .bk, saves it in the same folder, and then creates a new system definition file:
ITSLM-Manager-installation-folder\mgr\conf\
If a file with the same name already exists when the system definition file is saved, the existing file is overwritten. If the file save processing fails, setup fails. The values of definition items contained in the saved system definition file are inherited to the new system definition file. However, for the definition items that were specified in the system definition file when the command was executed, the specified values are set. Comments are not inherited.
-
Do not terminate setup processing by pressing Ctrl+C or closing the window. Also, in the event of an error, wait until setup is completed before proceeding.
-
Before you start the setup processing, terminate all other resident software programs, including other installers and applications (other applications include the jslmursetup and jslmurunsetup commands).
-
If setup is performed with the -c option specified in the command and any of a set of specific errors occurs during operation, the Windows services are closed by ITSLM - Manager. For details about the errors that result in a stoppage of the Windows services, see 6.1.3 Failover timing.
-
If a definition item is omitted, its default value is used.
-
If you are reconfiguring the execution environment of a configured ITSLM - Manager, make sure that you use any setup option that was used during the previous configuration.
-
If you are restoring or migrating the database, specify for the hdb_area_size definition item in the options file that is used for setting up the restored environment or target environment for migration a value that is equal to or greater than the value in the backed up environment or source environment for migration.
-
For the size of the current database area, see the following file that is created when the jslmmgrsetup command is executed:
ITSLM-Manager-installation-folder\mgr\conf\jp1itslm_setup.opt
Note that this file is updated if setup is performed again (so, if an attempt is made to change the database capacity using an erroneous method, it will no longer be possible to determine the current size).
Determine the current size from the size of the following folder that was specified in the setup file:
folder-specified-in-hdb_area_path\ITSLMSYS04
Return value
Return value |
Description |
---|---|
0 |
Setup processing terminated normally. |
1 |
Setup processing failed. |
Example
When ITSLM is running in a non-cluster system:
C:\Program Files\HITACHI\JP1ITSLM\mgr\bin\jslmmgrsetup C:\Users\Administrator\Desktop\jp1itslm_setup.opt
When ITSLM is running in a cluster system:
C:\Program Files\HITACHI\JP1ITSLM\mgr\bin\jslmmgrsetup -c online C:\Users\Administrator\Desktop\jp1itslm_setup.opt
How to estimate the size of the database area
Specify in the hdb_area_size definition item in the options file a value that is equal to or greater than the value obtained from the formula shown in the figure below.