3.2.3 Notes on installing and uninstalling JP1/Base
-
Before installation, terminate all resident applications, including virus check software. If you do not do so, installation might fail.
-
You need administrator permissions to perform installation, setup, or uninstallation. In an environment for which UAC is enabled, an ordinary user must be granted such permissions to perform these operations. Additionally, even if UAC is not enabled for the environment, log on as a user who belongs to the Administrators group to perform these operations.
-
Do not set the startup type to disabled for the services below if you perform installations, perform uninstallations, or apply corrective patches. If the type is set to disabled, then the operations stated above might fail.
-
Application Experience service
-
Windows Modules Installer service
-
-
The following message dialog box may appear if you attempt to overwrite or uninstall this product while it is running.
The setup must update files or services that cannot be updated while the system is running. If you choose to continue, a reboot will be required to complete the setup.
If this dialog appears, aborts the operation by clicking the Cancel button, close all running JP1/Base services and applications currently using JP1/Base, and then retry the operation.
-
Do not install this product at a path that contains any of the 3rd or 4th level JIS characters.
-
Restart the computer if the system requests a restart after any of the following:
-
When installing for the first time
-
When performing an overwrite installation
-
When performing an upgrade installation
-
- Organization of this subsection
(1) Installation
-
Do not install JP1/Base in a folder in which another program product is installed.
-
The highest-level folder (JP1Base), its subfolders, and files created by JP1/Base inherit the permissions the user assigns to the installation folder. We recommend that permissions are assigned to the installation folder as follows:
-
Administrators group and SYSTEM account: Full Control
-
Users account: Read & Execute
-
-
If the JP1/Base installer displays a dialog box that asks you whether to replace the msvcrt.dll file, always choose Restart to replace the file and to restart the system after installing JP1/Base. If you choose Ignore to leave the old version of the msvcrt.dll file on the host, JP1/Base might not operate correctly (for example, the time of an event might be incorrect).
If installation of another product causes JP1/Base to operate incorrectly, reinstall JP1/Base.
-
When you install JP1/Base, the paths for the bin folder and the bin\ext folder of JP1/Base are automatically added to the PATH environment variable. JP1/Base cannot be installed if this would cause the length of the PATH environment variable to exceed the maximum permitted by the operating system. In this situation, remove unwanted paths from the PATH environment variable and repeat the installation process.
-
If several paths are in the PATH environment variable, paths are prioritized according to the order in which they are specified. If the path to the bin folder of JP1/Base is specified later than that of the bin folder for JP1/AJS3 - View or JP1/IM - View in the PATH environment variable, products such as JP1/IM - Manager and JP1/AJS3 that have JP1/Base as a prerequisite might not operate correctly. Make sure that the path for the JP1/Base bin folder appears before the JP1/AJS3 - View and JP1/IM - View bin folder in the PATH environment variable.
-
When you install this product for the first time and select the installation folder from the screen, a folder named "Hitachi" is created under "system-drive:\Program Files(x86)". The folder name starts with uppercase "H" and is followed by lowercase letters, regardless of the combination of uppercase and lowercase letters that you specify.
For example, the folder name is "Hitachi" even if you specify "HITACHI" or "hitachi".
Use of the folder name "Hitachi" does not cause any problems with operations, so you can continue to use it without any problem occurring.
-
Do not include symbols (; # '% and so on) in the installation folder name; otherwise, JP1/Base will not work properly.
-
The drive on which this product is to be installed must be the local drive. Do not use a network drive.
-
Before installation, stop the following programs. After installation, if the OS requests that you restart the computer, do so by following the instructions.
-
All JP1/Base services
-
All services for the products based on JP1/Base
-
Applications using JP1 events
-
Service for the integrated trace function (HNTRLib2)
-
-
When installing this product or executing the command jp1bshasetup, Windows Defender might output warning messages. These warning messages, however, are output due to the registration of services and may be safely ignored.
-
If the path at which this product is installed meets the following conditions, profiles cannot be collected or applied properly in IM Configuration Management:
- (a) The path of the installation folder includes either left or right parentheses, but does not include a space character.
-
Example: C:\ProgramFiles(x86)\Hitachi\JP1Base\
- (b) The path of the installation folder includes special characters.
-
Example: C:\JP1@\Program Files (x86)\Hitachi\JP1Base\
Example: C:\JP1&\Program Files (x86)\Hitachi\JP1Base\
Example: C:\JP1^\Program Files (x86)\Hitachi\JP1Base\
When using IM Configuration Management, do not install this product in the types of paths shown above. We have confirmed that there are no problems installing JP1/Base in the following path:
Example: C:\Program Files (x86)\Hitachi\JP1Base\
(2) Re-installation
-
If you are performing an overwrite installation of JP1/Base, be sure to shut down all services beginning with the words JP1/Base, and quit all programs currently accessing the JP1/Base event service.
-
When uninstalling JP1/Base and then reinstalling it, you must first uninstall JP1/Base and all products that require it. Then, reinstall JP1/Base and then the products that require it.
-
JP1/IM - Manager
Uninstall both JP1/Base and JP1/IM - Manager, and then reinstall JP1/Base and JP1/IM - Manager.
-
JP1/AJS
Uninstall both JP1/Base and JP1/AJS and then reinstall JP1/Base and JP1/AJS.
-
JP1/AJS2 for Mainframe
Stop the services for JP1/AJS2 for Mainframe and then uninstall JP1/Base. Reinstall JP1/Base and then re-set up JP1/AJS2 for Mainframe.
-
JP1/Power Monitor
Uninstall JP1/Power Monitor before uninstalling JP1/Base. Next, reinstall JP1/Base and JP1/Power Monitor.
-
-
If reinstalling JP1/Base after forcibly uninstalling it without uninstalling the product that requires JP1/Base, it is necessary to restore the common definition information other than JP1/Base that has been backed up. For the procedure to restore backed-up common definition information, see (10) Procedure for restoring common definition information of a JP1 product that requires JP1/Base.
-
At a host running JP1/Base and JP1/IM - Manager, if you uninstall JP1/Base and then reinstall it in a folder that differs from the previous installation folder, JP1/IM - Manager will not operate correctly.
If you want to reinstall JP1/Base in a different folder, first uninstall JP1/IM - Manager, delete its installation folder, and then reinstall JP1/IM - Manager.
(3) Setting the Windows environment
When you install JP1/Base, the path of the Hitachi common folder is set in the PATH environment variable as the path of the JP1/Base bin folder and Hitachi Network Objectplaza Trace Library (HNTRLib2) as follows:
- Path of the Hitachi common folder
-
HNTRLib2 for 32bit
system-drive\Program files (x86)\Common Files\HITACHI
HNTRLib2 for 64bit
system-drive\Program files\Common Files\HITACHI
In addition, the port numbers listed in C. List of Port Numbers are added to the services file.
(4) Uninstallation
-
If any of the following products is installed, the KAVA1870-E message is output, and uninstallation cannot be performed.
-
JP1/AJS3 - Manager
-
JP1/AJS3 - Agent
-
JP1/AJS3 - Agent Minimal Edition
-
JP1/AJS3 - WOA
-
JP1/Power Monitor
-
JP1/IM2 - Manager
-
JP1/IM2 - View
-
JP1/IM2 - EG
-
-
If you uninstall only JP1/AJS after JP1/AJS and JP1/Base are installed, the event service might not start up. In this case, you should remove the include ajs-conf parameter lines or change them to comments (add # to the beginning of the lines) in the event server settings file (conf).
-
The following installer log file is created. Delete this log file after the installation ends normally.
Windows-installation-folder\Temp\HCDINST\product-model-name[_{1|2|3|4|5}].LOG
-
When you uninstall JP1/Base, the path of the JP1/Base bin folder is removed from the PATH environment variable and the port numbers that were added to the services file are removed. The service jp1imcmda is not deleted from systems where JP1/IM - View is also installed. Manually delete any remaining settings for which you have no further need. However, take care not to delete the service jp1imcmda if JP1/IM - View is installed on the system. Take particular care not to delete the path for the Hitachi common folder, which is used by a number of products other than the Hitachi Network Objectplaza Trace Library (HNTRLib2).
-
When you uninstall JP1/Base, the program folder may remain in the Start menu. Remove the program folder if no longer required, referring to the Windows help.
-
Before uninstalling JP1/Base, confirm that no product for which JP1/Base is a prerequisite is currently installed.
(5) Overwrite installation
Note the following points if you are installing JP1/Base in an environment running an earlier version of a JP1 program:
-
The storage format of the command execution log (ISAM) files has changed in Version 8. If you are using JP1/IM and you upgraded to JP1/Base Version 8 or later by overwriting JP1/Base 07-51 or earlier, make sure that you execute the jcocmdconv command before you recommence JP1/IM operation.
The jcocmdconv command migrates the command execution log (ISAM) files accumulated in a previous version of JP1/Base to the file format used in Version 8 or later. If you do not execute this command, you will not be able to access the command execution logs accumulated in Version 7 or earlier. During cluster operation, while the shared disk can be accessed, execute the jcocmdconv command once only (specifying the logical host) on either the primary or secondary node.
For details on the jcocmdconv command, see jcocmdconv in 15. Commands.
A command execution log is created only in JP1/Base on the manager host (on which JP1/IM is also installed).
-
In Version 9, the save-rep flag has been added to the options parameter in the event server settings file (conf). Setting this flag saves the duplication prevention table of the event database into the file. If this flag is not set, the duplication prevention table is saved to memory. In this case, if the event server is restarted, the table is deleted, and then re-created, causing the database to take longer to receive JP1 events forwarded from other hosts. We recommend that you set the save-rep flag for the event server that receives JP1 events forwarded from other hosts.
If you perform an overwrite installation from JP1/Base 08-00 or earlier, this flag will not be set. In this case, you must perform the following procedure to create the duplication prevention table in the file.
To create this table in the file:
-
Add the save-rep flag to the options parameter in the event server settings file.
For details on the event server settings file, see Event server settings file in 16. Definition Files.
-
Execute the jevdbmkrep command.
For details on the jevdbmkrep command, see jevdbmkrep in 15. Commands.
-
Start the event server.
-
-
The log-file trap startup definition file (jevlog_start.conf) is new in version 10-00. If you link with version 10-00 or later of JP1/IM, you can use the IM configuration management feature with this file to control the starting and stopping of log file traps.
If you intend to use IM configuration management to control the starting and stopping of log file traps, and have defined the startup of a log file trap in the start sequence definition file (JP1SVPRM.DAT), use the following procedure to migrate the definition to the log-file trap startup definition file:
-
From the start sequence definition file, delete the startup definition for the log file trap.
-
In the log-file trap startup definition file, enter the settings for the log file trap that you want to stop and start.
For details on the log-file trap startup definition file, see Log-file trap startup definition file in 16. Definition Files.
Note the following when migrating these definitions:
-
You must specify the name of the log-file trap startup definition file in the -f option of the jevlogstart command.
-
Do not specify a monitoring target name or log-file trap action definition file name that is already being used by another log file trap. If the name is already in use, choose another.
-
-
In version 11-00, the menu item names displayed when you select Programs and then JP1_Base from the Windows Start menu have been changed. If you upgrade JP1/Base from version 10-50 or earlier as an overwrite installation, the menu item names change as follows:
Menu item names in 10-50 or earlier
Menu item names in 11-00 or later
setup
JP1_Base Setup
Administrator Console
JP1_Base Console
Note: You can change menu item names as you like.
-
In versions 11-50 or later, the number of records in the command execution log file (initial setting is 20,000 records) may be insufficient in case of a large-scale system (1,024 or more agents) to use JP1/IM - Manager's remote commands or automated actions, and therefore we recommend that you expand the setting of the number of records.
If the function for automatically re-organizing the command execution log file is enabled however, the amount of time required for startup might increase in proportion to the file size. Therefore, confirm beforehand that the newly specified number of records does not hinder operation. For details, see 4.9 Function for automatically re-organizing the command execution log file.
-
An overwrite installation of JP1/Base may require a restart.
-
Before overwrite-installing JP1/Base, stop the products based on JP1/Base.
-
Before overwrite-installing JP1/Base, stop the products that use HNTRLib2.
You can use the hntr2getname command to acquire information about which products are using HNTRLib2. Start the command prompt, execute following commands:
cd system-drive\Program Files\Hitachi\HNTRLib2\bin\ hntr2getname
-
If you are performing an overwrite installation of JP1/Base, be sure to shut down all services beginning with the words JP1/Base, and quit all programs currently accessing the JP1/Base event service.
-
If there is only one FQDN format event server name in the Event server index file for the JP1/Base physical host and you call the JP1 event acquisition function, add the definition of * (indicating that the event server name runs on local host) as event-server-name. (This works on JP1/Base version 12-10 or later.) If you do not add the definition mentioned above, the JP1 event acquisition function fails.
For details, see Event server settings file of 16. Definition Files.
-
When upgrading to 13-00 or a later version of JP1/Base from 12-50 or an earlier version by performing an overwrite installation, files and folders used by functions linking products using JP1/SES events will be kept. These files and folders have no effect on the operation of JP1/Base.
(6) Language settings in Windows
-
Verify that all the language settings are uniformly set to Japanese, English, or Chinese (simplified), and then install the product.
-
For Windows Server 2016:
Contents
Setting
Language setting
System locale
Control Panel - Region - Administrative - Change system locale - Region settings
Language for non-Unicode programs
Format for languages and regions
Control Panel - Region - Format
Format
Control Panel - Region - Location
Home location
-
For Windows Server 2022, Windows Server 2019:
Contents
Setting
Language setting
System locale
Control Panel - Region - Administrative - Change system locale - Region settings
Language for non-Unicode programs
Format for languages and regions
Control Panel - Region - Format
Format
Setting - Region
Region and Regional format
- Note
-
Selecting the Beta: Use Unicode UTF-8 for worldwide language support check box may cause text to appear garbled. This check box appears by opening the Control Panel, navigating from the Region dialog box to the Administrative tab, and clicking Change system locale in Language for non-Unicode programs.
-
-
After changing the language setting, select Control Panel, open the Region window, then click the Administrative tab. In the Welcome screen and new user accounts area, select the Copy settings check box to copy the settings, and then restart the operating system.
-
Install JP1/Base.
(7) Notes on upgrading JP1/Base
JP1/Base can be upgraded by an overwrite installation. Definitions are inherited from the previous version, but note the following points.
If you manually reorganized the previous version's program folder, it will not be removed when you perform an upgrade installation. Remove the old program folder if no longer required after finishing the upgrade.
(8) Notes on performing installation using disk replication
This is a Hitachi program product that supports the installation of replicated disks by JP1/ServerConductor/Deployment Manager and Hitachi Compute Systems Manager Deployment Manager Plug-in, or replication functionality that uses image files provided by virtualized platforms.
When performing disk replication installation, we recommend that you replicate the default settings of each JP1/Base definition file after installation and setup.
However, if you change the settings and then use the same settings in the target replication hosts, note the following points.
(a) Precautions for before replication
- Setting the user management functionality
-
If Administrator privileges are specified for the OS user for user mapping, re-specify the settings after the replication.
- Setting the processing environment of the event service
-
Do not set IP addresses or host names for each parameter in the event server index file, the event server settings file, or the API settings file.
- Deleting definition information for system configurations
-
When defining the target replication host under the system configuration in JP1/IM, delete the previously set configuration information by using the jbsrt_del command.
(b) Precautions for after replication
- Initializing the event database
-
JP1 events might remain in the event database if you restart the computer with an internally generated host name at the time of disk replication installation. Initialize the event database before operation starts.
For operational procedures, see the JP1/ServerConductor/Deployment Manager User's Guide and Hitachi Compute Systems Manager Deployment Manager Plug-in User's Guide. For details about the replication functionality of virtualized platforms, see the product manual.
(9) Notes on the silent installation functionality
This software product can be installed by using the silent installation functionality.
- Execute the following command:
Drive-of-supplied-media:\_OWNEXE\HPPSINST.BAT /Drive-of-supplied-media:\_PPDIR\PCC2A2C6LDL\DISK1 /"full-path-of-installation-destination"
- Notes on performing silent installation
-
-
To execute the contents of supplied media directly from a hard drive, copy the contents of the supplied media to a directory on the hard drive whose path does not include any spaces. Then, compare the copied files to the original files (at the binary level, for example) to ensure that they are the same.
-
Check the return value of the execution result to verify that the installation ended successfully. For details on return values, see descriptions on the silent installation in documents published on the JP1 website.
-
(10) Procedure for restoring common definition information of a JP1 product that requires JP1/Base
The following describes the procedure for restoring common definition information when reinstalling JP1/Base without uninstalling the JP1 product that requires JP1/Base.
Note: Do not start the JP1/Base service or other JP1 product service during the restore procedure.
And execute the following command to backup the common definition information of all JP1 products in case of performing incorrect procedure to restore the common definition information.
-
Physical host:
jbsgetcnf > backup-file-name
-
Logical host:
jbsgetcnf -h logical-host-name > backup-file-name
-
Back up JP1/Base.
For details on backups, see 3.5.2 Backup and recovery (in Windows).
If JP1/IM - Manager is installed, backup the command execution log (ISAM) file. For details about the backup of command execution log (ISAM) file, see the manual JP1/Integrated Management 3 - Manager Administration Guide (Database backup and recovery).
Collect the log data before you perform the procedure to restore the common definition information in case the integrated trace log is deleted. For details on collecting log data, see 18.4 How to collect data.
-
Check the output destination of the common definition information backup file.
Check whether there is sufficient free disk space (1 + 0.4 x number-of-logical-hosts [MB] or more) for the output destination of the common definition information backup file (Windows-installation-folder\Temp\). And check whether the common definition information backup file and output folder have not been locked by applications like editor. And also check for the access permission.
If there is insufficient free disk space, the common definition information backup file will not be output correctly. For example, the file size of the common definition information backup becomes 0 byte.
If folder or file has been locked by some application or if you do not have access permission, error message KAVA1871-E will be output during the uninstallation.
-
Set the JP1_BASE_UNINST_FORCE system environment variable to 1.
-
Uninstall JP1/Base.
In the Control Panel, click Programs and Features and uninstall JP1/Base.
Uninstallation can be performed even if the prerequisite products of JP1/Base are installed.
During the uninstallation, common definition information excluding JP1/Base is output as the common definition information backup file.
-
Physical host: Windows-installation-folder\Temp\JP1_COMDEF\comdef_JP1_DEFAULT.conf
-
Logical host: Windows-installation-folder\Temp\JP1_COMDEF\comdef_logical-host-name.conf
-
-
Clear the setting of the JP1_BASE_UNINST_FORCE environment variable.
-
Restart the system.
Restart the system to disable the JP1/Base operating environment.
-
Delete user files.
Use Windows Explorer to delete the JP1/Base files and folders.
-
Reinstall JP1/Base.
For details on install, see 3.2.1 Installing JP1/Base.
You cannot change the installation folder.
-
Re-set up JP1/Base.
If you are operating in a cluster, create a logical host.
The logical host name (Uppercase/Lowercase) and shared folder name cannot be changed.
Recover the adapter command configuration file (installation-folder\plugin\conf\*.conf) from the backup in step 1.
If JP1/IM - Manager is installed, recover the command execution log (ISAM) file from the backup in step 1.
Recover the event database from the backup in step 1. For details on recovering the event database, see 3.5.2(4)(a) When the forwarding settings file is not configured to forward JP1 events to other hosts.
Build the JP1/Base environment.
-
When recovering the JP1/Base environment:
Recover the JP1/Base other definition files, common definition information, and jp1hosts2 information from the backup in step 1.
For details on recovery, see 3.5.2 (3) Recovering JP1/Base setup information.
-
When rebuilding JP1/Base environment:
Perform JP1/Base setup again.
For details on setup, see 3.4 JP1/Base setup.
And also, perform other settings as necessary.
If you have set up JP1/Base in the setup of another product, set it up again.
-
-
Execute the jbssetcnf command using the common definition information backup file output in step 4.
Restore the common definitions for JP1 products excluding JP1/Base. Execute the command for the physical host and all logical hosts.
jbssetcnf common-definition-information-backup-file-name
-
Delete the common definition information backup file output folder that is created in step 4.
Delete the common definition information backup file output folder (Windows-installation-folder\Temp\JP1_COMDEF\).