jimalhsetup

Organization of this page

Function

This command sets up a new logical host of JP1/IM - Agent.

This command does not set up the following optional functions and data delivery function to multiple manager hosts.

OracleDB exporter
Node exporter for AIX
SAP system monitoring
SQL exporter

If you want to use these functions on a logical host, set up the system manually after using this command.

Format

jimalhsetup -h logical-hostname
            -d shared-directory
            -c {online | standby}
            -f set-up-configuration-file
            [-q]

To Page Top

Execution authority

In Windows: Administrator permissions (If the Windows UAC feature is enabled, the command must be executed from the administrator console.)

In Linux: Superuser permissions

To Page Top

Storage destination directory

For Windows: Agent-path\tools\
For Linux: /opt/jp1ima/tools/

To Page Top

Argument

-h logical-hostname

Specifies the logical host name of the target host to be set up.

-d shared-directory

Specifies the directory for the logical host to be created on the shared disk.

-c {online | standby}

Specifies the type of setup for the running system and the standby system in the cluster configuration.

online: Specifies that the running system is to be set up.
standby: Specifies that the standby system is to be set up.

To perform logical host operation in a non-clustered environment, specify online as -c option.

-f set-up-configuration-file

Specifies configuration file of the new setup command for a logical host that contains information such as:

Host information of JP1/IM - Manager to connect to
Proxy info for connecting to JP1/IM - Manager
Enabling and disabling services

The path to the file can be either full or relative to the location where the command was executed.

If you are setting up in a clustered environment, use the same setup configuration file for the running system and the standby system.

For details about configuration file, see Configuration file of the logical host new setup command (any-file-name) in Chapter 2. Definition Files.

-q

Specifies that the command argument and setup configuration file content are to be checked, and the setup command processing is to be started without user confirmation.

If you specify the -q option: Does not prompt for confirmation in the console prior to starting the new setup process (this is the same as typing "y" and pressing Enter in all challenge messages).
If you omit the -q option: Prompt the console for confirmation before starting the new setup process.

To Page Top

Return value

`0`	Normal completion
`1`	Abnormal termination

To Page Top

Log output

Output destination

- In Windows

Agent-path\logs\tools\

- In Linux

/opt/jp1ima/logs/tools/

To Page Top

Examples of use

For Windows

jimalhsetup -h LOGICALHOST01 -d c:\common\dir01 -c online -f c:\work\jpc_lhsetup.properties -q

For Linux

jimalhsetup -h LOGICALHOST01 -d /common/dir01 -c online -f /work/jpc_lhsetup.properties -q

To Page Top

Notes

Do not run this command more than once at the same time. If the command is executed at the same time, the result may be incorrect even if the command terminates normally.
Be sure to execute this command while all JP1/IM - Agent services are stopped. If it is executed while the service of JP1/IM - Agent is running, the file to be updated may be locked and file update may fail.
Be sure to execute this command without opening the definition file in a text editor or the like. If you execute the command while editing the definition file with a text editor, etc., the file to be updated may be locked and file update may fail.
If the file to be updated is locked by anti-virus software, etc., file update may fail. Make sure that the files to be updated are not subject to anti-virus software.
If the setup process is started and then terminates with an error in the middle of execution, eliminate the cause of the error, perform the procedure shown in Recovery procedure in the event of abnormal termination after the validation pass below, and then re-execute the command to complete the setup process (make sure that all files have been updated).

- Recovery procedure in the event of abnormal termination after the validation pass

If the command ends abnormality after the KNBC10117-I message is output on the console, perform the recovery operation as follows:

For Windows

Verify that the logical host service is registered in Windows.

At the command prompt, run services.msc to open management console and verify that the logical host service is registered. If it is not registered, step 2 does not need to be performed.
Deactivates the service for the logical host registered in Windows.

Release the service from Windows for the service to be used by the logical host.

To remove a logical host service, use the following command:
```
Agent-path\tools\jpc_service -off service-key -h logical-hostname
```
The following shows a sample procedure for deactivating Alertmanager service.
```
Agent-path\tools\jpc_service -off jpc_alertmanager -h logical hostname
```
Remove shared-folder.

For Linux

Verify that the logical host service is registered in systemd.

Run systemctl list-unit-files command. Verify that the logical host service is registered. If it is not registered, steps 2 to 4 are not required.
Enable the service to unregister logical host service registered with systemd.

If there is a service on a logical host whose service status is masked, to remove the service for the logical host from systemd, run the following command to enable the service:
```
/opt/jp1ima/tools/jpc_service -on service-key -h logical-hostname
```
The following example shows how to enable Alertmanager service:
```
/opt/jp1ima/tools/jpc_service -on jpc_alertmanager -h logical-hostname
```
Remove unit definition file for the logical host.

Delete the unit definition file for the logical host under /usr/lib/systemd/system.

File name to be deleted: jpc_service-name_logical-hostname.service
Refresh systemd.

Run the following command to refresh systemd:
```
# systemctl daemon-reload
```
Remove shared-directory.

To Page Top