jpcconf ha setup

Organization of this page

Format
Function
Hosts that can execute the command
Execution permission
Installation directory
Arguments
Notes
Return values
Usage example

Format

jpcconf ha setup    -key service-key
                    -lhost logical-host-name
                   [-d environment-directory-name]

To Page Top

Function

The jpcconf ha setup command creates a Performance Management logical host environment.

Executing this command sets up a logical host environment.

This command can be executed only for a Performance Management product that supports logical host operation. PFM - Manager supports logical host operation. For details about the logical host operation of a particular PFM - Agent or PFM - RM, see the chapter in the relevant PFM - Agent or PFM - RM manuals that describes cluster system operations.

To Page Top

Hosts that can execute the command

PFM - Manager
PFM - Agent
PFM - RM

To Page Top

Execution permission

In Windows:: User with Administrators permissions
In UNIX:: User with root user permissions

To Page Top

Installation directory

In Windows:

installation-folder\tools\

In UNIX:

/opt/jp1pc/tools/

To Page Top

Arguments

`-key` `service-key`

Specifies the service key of the Performance Management program for which a logical host environment is to be created. A product name can also be specified when the product name display functionality is enabled.

You can specify the following in service-key:

all: Specifies all Performance Management services installed on the current node that support logical host operation.
Manager or mgr: Specifies the PFM - Manager services (including the Action Handler service).
Service key of a PFM - Agent or PFM - RM service: Specifies a particular PFM - Agent or PFM - RM service (including the Action Handler service). For details about the service key of the PFM - Agent or PFM - RM service, see the naming rules described in the appendix of the JP1/Performance Management Planning and Configuration Guide.

AH or act (service key of the Action Handler service) cannot be specified.

When one of the following values is specified for the service key, the logical host environment settings for the Performance Management program service are displayed:

Manager or mgr
Service key of the PFM - Agent service
Service key of the PFM - RM service

Specifying all in service-key creates a logical host environment for all Performance Management services installed on the current node that support logical host operation. Specifying the service key of a Performance Management service that does not support logical host operation results in an error.

Executing this command creates automatically a logical host environment in which there is one Action Handler service for each logical host.

`-lhost` `logical-host-name`

Specifies a logical host name for the logical host environment being created.

For logical-host-name, specify a string of 1 to 32 bytes, consisting of alphanumeric characters. The space character and the following symbols cannot be specified:

/ \ : ; * ? ' " < > | & = ,

For logical-host-name, you cannot specify localhost, an IP address, or a host name beginning with a hyphen (-).

The specified logical host name is used as the host name when a Performance Management service on the logical host is communicating.

`-d` `environment-directory-name`

Specifies the directory in which the execution environment of the logical host is to be created. This is the name of the directory that will store the files of the logical host environment. Specify a directory on a shared disk that manages the cluster software for inheriting files when a failover occurs. If you specify a directory that does not exist, an error occurs, and no processing will be executed. You must always specify this directory name when you create a new logical host environment. You can omit this option when you are adding services to an existing logical host environment.

For environment-directory-name, specify a string 1 to 80 bytes, consisting of alphanumeric characters and symbols. However, the following symbols cannot be specified:

; , * ? ' " < > |

A relative path cannot be used; you must use the absolute path.

Executing this command creates the jp1pc directory in the specified directory and creates a logical host environment file in that directory.

Only one environment directory can be specified on a logical host. To set up multiple Performance Management services on a single logical host, you must use the same directory.

In a UNIX environment, space characters cannot be specified. To specify a directory name that contains spaces in a Windows environment, enclose the entire directory name in double quotation marks (").

To Page Top

Notes

Because the logical host environment file is created on a shared disk, before you execute this command to create a new logical host environment you must place the shared disk online (mount the disk in UNIX). If you specify a directory that does not exist, the command results in an error and the creation request will be canceled. In this case, the logical host environment will not be created. Note that, even when a shared disk is not mounted, if a directory having the same name exists on the same layer on the local disk, an environment is created under the specified directory on the local disk.
Before you execute this command, stop all Performance Management services, including the physical host and each logical host on the node.
In a Windows environment, the upper-directory access permissions are passed to the jp1pc directory created in the environment directory and all files in the logical host environment.
If command execution is interrupted by pressing the Ctrl + C keys or by a signal, a predefined return value is not returned. Therefore, you should ignore the return value when the command was interrupted by the Ctrl + C keys or by a signal.
When you create a logical host environment for PFM - Manager, the health check function of PFM - Manager in the logical host environment is disabled (default) regardless of the setting of the health check function (enabled or disabled) specified for PFM - Manager in the physical host environment. If you want to use the health check function of PFM - Manager in the logical host environment, you must set up the health check function again for that environment.
When the functionality for setting monitoring-host names is used (the value of Get Host Mode in the Common Section section of the jpccomm.ini file is 1 or 2), the same name as the host name set for the monitoring host name cannot be set for the logical host name.
If you will create a logical host environment for PFM - Manager when the monitoring suspension function is enabled, before you execute this command, resume the monitoring by all Performance Management programs, including the Performance Management programs for the physical and logical hosts on the node.
If you create a logical host environment for PFM - Agent when the monitoring suspension function is enabled, the monitoring suspension settings for the physical host environment are not inherited.

To Page Top

Return values

`0`	The command terminated normally.
Other values	The command terminated abnormally.

To Page Top

Usage example

This example sets up a logical host environment for PFM - Manager, with jp1-ha1 as the logical host name and S:\jp1 as the environment directory name:

jpcconf ha setup -key Manager -lhost jp1-ha1 -d S:\jp1

To Page Top