jpcconf target setup

Organization of this page

Format
Function
Hosts that can execute the command
Execution permission
Installation directory
Arguments
Format of the definition file (for the jpcconf target setup command)
Notes
Return values
Usage example
Example of executing the command in non-interactive mode

Format

Format 1

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

Format 2

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

To Page Top

Function

The jpcconf target setup command creates monitoring targets monitored by PFM - RM instances, and updates the settings.

To Page Top

Hosts that can execute the command

PFM - Manager (can only be executed on a host on which PFM - RM is installed)
PFM - RM

To Page Top

Execution permission

In Windows:: User with Administrators permissions (executed from the administrator console when Windows UAC functionality is enabled)
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 PFM - RM service key for performing monitoring target settings. A product name can also be specified when the product name display functionality is enabled.

`-inst` `instance-name`

Specifies a PFM - RM instance name for performing monitoring target settings. For instance-name, specify a string of 1 to 32 bytes, consisting of alphanumeric characters.

`-target` `monitoring-target-name`

Specifies an identifier used by PFM - RM to identify the monitoring target within the instance. For monitoring-target-name, specify a string of 1 to 32 bytes, consisting of alphanumeric characters or hyphens (-).

To create a new monitoring target name, specify a unique name within target PFM - RM instance. Names starting with a hyphen (-) or the name All cannot be specified. If the same name already exists, update the settings.

`-lhost` `logical-host-name`

Specifies the logical host name of the host on which this command is executed. For logical-host-name, specify a string of 1 to 32 bytes, consisting of alphanumeric characters with no space characters. If you omit this specification, the physical host is assumed. Wildcard characters cannot be used.

`-noquery`

If this option is specified, the command does not output any query messages that interrupt command execution, making it unnecessary for the user to respond.

To execute this command in non-interactive mode, specify this option and the -input option together.

The command behavior changes in various situations, as described below:

If specified monitoring targets already exist:

A KAVE05405-I message is output. The command updates the settings of the existing monitoring targets.
If there is already a file with the same name as the file specified for the -template option:

A KAVE05399-I message is output and the file is updated.

`-input` `definition-file-name`

Specifies the path name of the definition file from which the settings for monitoring targets will be loaded. For definition-file-name, specify a string of 1 to 250 bytes. Monitoring targets will automatically be created or updated according to the settings in the specified definition file.

If the string that you want to specify contains spaces, enclose the entire string in double quotation marks (").

To execute this command in non-interactive mode, specify this option and the -noquery option together.

`-template` `definition-file-name`

Specifies a path name of the definition file for which the template file will be generated. For definition-file-name, specify a string of 1 to 245 bytes. In the generated template file, sections and labels will be output according to the setting items for the target PFM - RM instance. Note that the values for the labels in the [Target Definitions] section will be blank. The generated file can be edited according to the environment requirements, and the edited file can be specified as an input file for the -input option.

If the string that you want to specify contains spaces, enclose the entire string in double quotation marks (").

To Page Top

Format of the definition file (for the jpcconf target 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 target PFM - RM instance.

Product ID label: Specifies the product ID of the target PFM - RM instance. For the product ID to be specified, see the Appendix that describes file name extensions in any manual of the relevant PFM - RM product.

[Target Definitions] section

Specifies the settings for the monitoring target.

Target Host label: Specifies the host name of the monitoring target.
Product-specific labels: In addition to the labels described above, you can specify instance setting items that are specific to the target product (PFM - RM). For the labels that can be specified, see the chapter on installation and setup in any manual for the relevant PFM - RM product. Note that when you specify settings such as the password in interactive mode, you might be prompted to specify 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=7
 
[Target Definitions]
Target Host=hostname
User=Administrator
Password=aaa
 ...

To Page Top

Notes

When the jpcconf target setup command is executed, the version of PFM - Manager or PFM - Base on the execution host must be 09-00 or later.
This cannot be executed on a standby node when a PFM - RM monitoring target running on a logical host environment is set.
The maximum number of monitoring targets depends on the PFM - RM instance. If a monitoring target is added when the maximum number of monitoring targets is reached, the KAVE05397-E message is output. For details about the maximum number of monitoring targets for an instance of PFM - RM, see the PFM - RM manuals.
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

`0`	The command terminated normally.
`1`	An argument specification is invalid.
`2`	The user does not have execution permission for the command.
`5`	The specified service key was not found.
`6`	The definition file contains errors.
`10`	The command is being executed.
`11`	The user canceled the processing.
`100`	The Performance Management environment is invalid.
`102`	The specified logical host name has not been set up.
`109`	An attempt to report monitoring target settings to PFM - RM failed.
`200`	A memory shortage occurred.
`210`	A disk space shortage occurred.
`211`	A file or directory cannot be accessed.
`230`	Execution of an internal command failed.
`255`	An unexpected error occurred.

To Page Top

Usage example

This example adds the new monitoring target targetname1 to the PFM - RM for Platform instance inst1.

jpcconf target setup -key RMPlatform -inst inst1 -target targetname1

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.

Example 1

This example outputs the RMPlatformTemplate.txt file as the template file for the PFM - RM for Platform definition file.

# jpcconf target setup -key RMPlatform -template RMPlatformTemplate.txt

Example 2

This example automatically creates target01 through target03 as new monitoring targets in PFM - RM for platform.

This example assumes that the user has prepared definition files RMPlatformTarget01.txt, RMPlatformTarget02.txt, and RMPlatformTarget03.txt by editing the RMPlatformTemplate.txt file output in Example 1 according to the individual instance environments.

# jpcconf target setup -key RMPlatform -inst inst01 -target target01 -input RMPlatformTarget01.txt -noquery
# jpcconf target setup -key RMPlatform -inst inst01 -target target02 -input RMPlatformTarget02.txt -noquery
# jpcconf target setup -key RMPlatform -inst inst01 -target target03 -input RMPlatformTarget03.txt -noquery

To Page Top