jpcconf inst setup

Format

jpcconf inst setup    -key service-key
                     [-lhost logical-host-name]
                      -inst instance-name
                     [-input definition-file-name]
                     [-noquery]

jpcconf inst setup    -key service-key
                      -template definition-file-name
                     [-noquery]

To Page Top

Function

The jpcconf inst setup command creates or updates an instance environment for a PFM - Agent or PFM - RM that can start multiple services on a single host. In the case of a PFM - Agent or PFM - RM that can start an instance, execution of this command is required.

Executing this command creates or updates the following directories that contain, among other items, the setup file for the instance environment:

• In Windows:

  • installation-folder\xxxx^#\agent\instance-name\

  • installation-folder\xxxx^#\store\instance-name\

• In UNIX:

  • /opt/jp1pc/xxxx^#/store/instance-name/

  • /opt/jp1pc/xxxx^#/agent/instance-name/

#

xxxx denotes the service key of a PFM - Agent or PFM - RM. For details about the service key, see the naming rules described in the appendix of the JP1/Performance Management Planning and Configuration Guide.

To Page Top

Hosts that can execute the command

• 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

To Page Top

Format of the definition file (for the jpcconf inst setup command)

The definition file is a text file consisting of sections and labels described below. The label names and values are specified in name=value format.

All the described sections and labels are required. If values are not specified, the command will assume that they are omitted. Invalid section and label names are ignored.

[Common Definitions] section

Specifies the basic information in the definition file.

Definition File Version label

Specifies the version of the definition file. Specify the constant 0001.

[Product Information] section

Specifies the information about the target product (PFM - Agent or PFM - RM).

Product ID label

Specifies the product ID of the target product (PFM - Agent or PFM - RM). For the product ID to be specified, see the Appendix that describes file name extensions in any manual of the relevant PFM - Agent or PFM - RM product.

[Instance Definitions] section

Specifies the settings of the instance environment.

Store Version label

Specifies the Store version of the instance environment. Specify either 1.0 or 2.0.

If the version of the target PFM - Agent product is 07-00 or earlier or if the target product is PFM - RM, you do not need to specify this label. If this label is specified, it is ignored in this case.

Product-specific labels

In addition to the labels described above, you can specify instance setting items that are specific to the target product (PFM - Agent or PFM - RM). For the labels that can be specified, see the chapter on installation and setup in any manual for the relevant PFM - Agent or PFM - RM product. Note that when you specify settings such as the password in interactive mode, you might be prompted to enter the same values again for confirmation. However, you only have to specify these values once in the definition file.

The following shows an example of specifying settings in the definition file.

[Common Definitions]
Definition File Version=0001
 
[Product Information]
Product ID=O
 
[Instance Definitions]
Store Version=2.0
oracle_sid=ORCL
oracle_home=/home/oracle
 ...

To Page Top

Notes

• You must specify the arguments in the order they appear in Format.

• If the service with the specified instance name is active when you update the instance environment, stop the service and then execute this command. After the update processing is completed, manually start the service.

• 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.

• If the definition file includes confidential information such as passwords, save the file in a secured and safe place, and delete the file when the file is no longer needed. If you need to transfer the definition file between hosts, use SFTP communication (FTP communication through an SSH tunnel) or other safe means that are secure against sniffing.

• When you execute the command with the -input option, the command execution is interrupted if the definition file does not contain all necessary labels or invalid values are specified for necessary labels in the definition file. If you add the -noquery option to automatically execute the command in a batch or script file, confirm that the settings in the definition file are correct beforehand. If the command is automatically executed, you can check whether the command terminates normally with a message or return value that is output.

To Page Top

Return values

To Page Top

Usage example

This example creates an execution environment for the instance named SDC:

jpcconf inst setup -key Oracle -inst SDC

To Page Top

Example of executing the command in non-interactive mode

If the -noquery, -input, and -template options are specified, setup can be performed without any queries output from Performance Management. The following shows usage examples.

# jpcconf inst setup -key Oracle -template OracleTemplate01.txt

# jpcconf inst setup -key Oracle -inst inst01 -input OracleInst01.txt -noquery
# jpcconf inst setup -key Oracle -inst inst02 -input OracleInst02.txt -noquery
# jpcconf inst setup -key Oracle -inst inst03 -input OracleInst03.txt -noquery

To Page Top