Hitachi

JP1 Version 11 JP1/Service Level Management Description


9.12 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. 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 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 [ -c { online | standby } ] 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

-c

Specifies that the execution environment used in a cluster system is to be configured. The specification method is as follows:

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_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
manager_type = Type of SLM – Manager
master_host = Host name or IP address of the master instance of SLM – Manager
master_port = Port number of the master instance of SLM – Manager

The following table provides the details of the definition items.

Table 9‒19: Details of definition items in options file for SLM - Manager

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.

If SLM 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 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:

  • Number outside the permitted range

  • Port number that is already specified in the services file

  • Port number that is already in use

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:

  • Specification in UNC representation

  • Specification containing a network drive

  • Specification of a drive name only

  • Specification containing the SLM - Manager installation folder

  • Specification containing an SLM - UR installation folder

--

9

hdb_share_area_path#3

O#4

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 SLM 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:

  • Specification in UNC representation

  • Specification containing a network drive

  • Specification of a drive name only

  • Specification containing the SLM - Manager installation folder

  • Specification containing an SLM - UR installation folder

--

10

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.

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

11

manager_type

O#5, #6

Specify the type of SLM – Manager from the following.

Single

Single-manager configuration

Master

Master instance of SLM - Manager in the master/slave configuration

Slave

Slave instance of SLM - Manager in the master/slave configuration

The entry is not case-sensitive.

If a character string other than the above is specified, an error results.

Single

12

master_host

O#6

As information for identifying the execution environment of the master instance of SLM – Manager, set the host name or the IP address of the machine on which the master instance of SLM – Manager is installed. The jslmmgrsetup command does not check whether the value is valid.

--

13

master_port

O

Specifies the port number used for RMI communication between the master and slave instances of SLM - Manager as a single-byte number in the range from 5001 through 65535#1.. The jslmmgrsetup command will not check whether not the value is valid.

20904

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.

#4

Specification of this property is required when operating with a cluster system.

#5

Specification of this property is required for the master instance of SLM - Manager.

#6

Specification of this property is required for a slave instance of SLM - Manager.

Notes

Return value

Return value

Description

0

Setup processing terminated normally.

1

Setup processing failed.

Example

When SLM is running in a non-cluster system:

C:\Program Files\HITACHI\JP1ITSLM\mgr\bin\jslmmgrsetup C:\Users\Administrator\Desktop\jp1itslm_setup.opt

When SLM 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.

Figure 9‒1: Formula for estimating the size of the database area

[Figure]