A.4 jslmmgrsetup (sets up SLM - Manager)
Function
This command creates an execution environment for SLM - Manager. It can also be used to reconfigure the execution environment for an existing SLM - Manager.
You execute this command after you have installed SLM - Manager.
The command execution results are output to the standard output and displayed in the console window.
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 SLM - Manager has been newly installed or after the execution environment for SLM - 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 SLM - Manager already exists, the command reconfigures the existing execution environment for SLM - 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 SLM - Manager are to be changed
The embedded Web server environment in the execution environment for a configured SLM - Manager is to be reconfigured
The execution environment for a configured SLM - 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 SLM - Manager execution environment is reconfigured.
Format
jslmmgrsetup absolute-path-of-options-file
Execution permission
User account that belongs to the OS's Administrators group
Storage folder
SLM-Manager-installation-folder\mgr\bin\
Arguments
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:
SLM-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-SLM-Manager manager_port=port-number-of-SLM-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_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 SLM - Manager is installed, as the information for identifying SLM - Manager's execution environment. |
-- |
2 |
manager_port |
O |
Specifies the port number used by SLM - 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_area_size#3 |
O |
Specifies the size of the embedded database area for storing the data handled by SLM - Manager. Specify an integer in the range from 5000 through 1048575 (MB). If the specified value is not within this range, an error results. This definition is ignored when the execution environment is being reconfigured. |
39000 |
- Legend:
R: Specification is required.
O: Specification is optional.
--: Not applicable
- #1
If the specified value is not within the permitted range, setup is completed, but an error occurs when the SLM - Manager service SLM - Manager Service (service name: JP1_ITSLM_MGR_Service) starts.
- #2
If the specified value is not within the permitted range, setup is completed, but an error occurs when the SLM - Manager service SLM - Manager Web Service (service name: JP1_ITSLM_MGR_Web_Service) starts.
- #3
If you are reconfiguring the execution environment for a configured SLM - Manager, do not change the existing value.
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:
SLM-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:
SLM-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 command).
If a definition item is omitted, its default value is used.
If you are reconfiguring the execution environment of a configured SLM - 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:
SLM-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\SLMSYS04
Return value
Return value |
Description |
---|---|
0 |
Setup processing terminated normally. |
1 |
Setup processing failed. |
Example
C:\Program Files\HITACHI\JP1ITSLM\mgr\bin\jslmmgrsetup C:\Users\Administrator\Desktop\jp1itslm_setup.opt