jpctool config sync

Organization of this page

Format
Function
Hosts that can execute the command
Execution permission
Installation directory
Argument
Output of synchronization result file
Notes
Return values
Usage example
Output example

Format

jpctool  config  sync       [-noprogress]

To Page Top

Function

The jpctool config sync command synchronizes configuration information between the PFM - Manager host and PFM - Agent and PFM - RM hosts when definition information is restored by the PFM - Manager host. The configuration information that is synchronized is as follows:

Service node location information

Information on the locations, such as IP address and port number, of the PFM services on the PFM - Agent and PFM - RM hosts
Alarm information

Information on the alarms that are bound to the PFM - Agent and PFM - RM hosts
Action information

Information on the actions that are to be executed when the alarms bound to the PFM - Agent and PFM - RM hosts are issued

To Page Top

Hosts that can execute the command

PFM - Manager

To Page Top

Execution permission

In Windows:: User with Administrators permissions (When the UAC of Windows is enabled, execute this command from the administrator console.)
In UNIX:: User with root user permissions (user with uid = 0)

To Page Top

Installation directory

In Windows:: installation-folder\tools\
In UNIX:: /opt/jp1pc/tools/

To Page Top

Argument

-noprogress

If this option is specified, the command does not output the information on the progress of synchronization processing.

To Page Top

Output of synchronization result file

When the jpctool config sync command terminates, the command outputs a CSV-format synchronization result file for every host and service for which synchronization has been done. The following table overviews the synchronization result file.

Table 3‒86: Overview of the synchronization result file
Item	OS	Description
File name	--	syncresult.csv
File path	Windows	When PFM - Manager is a physical host `installation-folder\log` When PFM - Manager is a logical host `environment-directory\jp1pc\log`
File path	UNIX	When PFM - Manager is a physical host `/opt/jp1pc/log` When PFM - Manager is a logical host `environment-directory/jp1pc/log`
Permission and owner	Windows	When PFM - Manager is a physical host Permissions for `installation-folder\log` are inherited. When PFM - Manager is a logical host Permissions for `environment-directory\jp1pc\log` are inherited.
Permission and owner	UNIX	666 [rw-rw-rw-] owner/group: In case of AIX: root(0)/system(0) In case of SUSE Linux 15 or later: root(0)/root(0) In case other than above: root(0)/sys(3)
Creation timing	--	A new file is created each time the command is executed.^#
File size	--	Less than 1 megabyte

#: If a synchronization result file already exists, the existing file is discarded.

Output example of synchronization result file

The following shows an output example of a synchronization result file:

DateTime=YYYY/MM/DD HH:MM:SS
Hostname,Service ID,Sync Result,Message
hostA,0A1hostA,Success,
hostA,0S1hostA,Success,
hostA,PH1hostA,Success,
hostB,PH1hostB,Failure,Unknown service
hostB,TA1hostB,Failure,Unknown service
hostB,TS1hostB,Failure,Unknown service
hostC,7A1inst1[hostC],Failure,Host not available
hostC,7A1inst1[All@hostC],Failure,Host not available
hostC,7A1inst1[target1@hostC],Failure,Host not available
hostC,7A1inst1[target2@hostC],Failure,Host not available
hostC,7S1inst1[hostC],Failure,Host not available
hostC,PH1hostC,Failure,Host not available
hostC,TA1hostC,Failure,Host not available
hostC,TS1hostC,Failure,Host not available

The following table describes the details of the output content of the synchronization result file.

Table 3‒87: Output content of notification result file
Item	Output format	Output content	Output position
Execution date and time	`DateTime=YYYY/MM/DD` Δ`HH:MM:SS` (`YYYY` = year, `MM` = month, `DD` = day, `HH` = hour, `MM` = minute, `SS` = second)	Outputs the date and time when the command processing started in the set time zone.	First line
Label	`HostName,Service ID,Sync Result,Message`	Outputs the labels shown on the left.	Second line
Information on synchronization result for each service	`host-name,service-ID,` `synchronization-result,` `reason-message`	`host-name` Host name of the relevant service `service-ID`^# Service ID of the relevant service For the output contents of synchronization results and reason messages, see the table below.	Third line and after (This set of information is output as many times as the number of the services for which synchronization was executed.)

Legend:: Δ: Single-byte space
#: If the synchronization processing for a host fails because of a communication error, this command outputs, to said host, as many result records as the number of the services recognized by the PFM - Manager host. In each record, not null characters but a service ID is output under the Service ID label.

The following table lists the messages output under the Sync Result and Message labels in the synchronization result file when synchronization has succeeded or failed. The following table also describes the corrective action to be taken for each failure message.

Table 3‒88: Output contents of synchronization result file and corrective actions
No.	Synchronization result	Output content		Corrective action
No.	Synchronization result	Sync Result	Message	Corrective action
1	Synchronization succeeded.	Success	--	--
2	Synchronization with Action Handler service failed because PFM - Base version was earlier than 10-00-10.	Failure	Incompatible version	Restart the Action Handler service indicated in the output message.
3	Synchronization with a target service failed because the target service had been deleted.	Failure	Service not exist	To adjust the environment of PFM - Agent and PFM - RM hosts to the environment recognized by PFM - Manager host, create and start the service indicated in the output message on the PFM - Agent and PFM - RM hosts.
3		Failure	Service not exist	To adjust the PFM - Agent and PFM - RM hosts to the environment recognized by PFM - Manager host to the actual environment of PFM - Agent and PFM - RM hosts, perform the following steps: If alarm tables are bound to the target service, unbind all the alarm tables with the `jpctool` `alarm` `unbind` command or by an operation from PFM - Web Console. If an alarm definition specifies the target service as an action execution service, change the specification of the action execution service in the alarm definition with the `jpctool` `alarm` `import` command or by an operation from PFM - Web Console. Execute the `jpctool` `service` `delete` command on the PFM - Manager host.
4	Synchronization with an added service failed because the added service was not recognized by PFM - Manager.	Failure	Unknown service	To adjust the environment of PFM - Agent and PFM - RM hosts to the environment recognized by PFM - Manager host, delete the service indicated in the output message from the PFM - Agent and PFM - RM hosts.
4		Failure	Unknown service	To adjust the PFM - Agent and PFM - RM hosts to the environment recognized by PFM - Manager host to the actual environment of PFM - Agent and PFM - RM hosts, restart the service indicated in the output message.
5	Synchronization with a target host failed because the target host could not communicate.	Failure	Host not available	To adjust the environment of PFM - Agent and PFM - RM hosts to the environment recognized by PFM - Manager host, restart all services on the host indicated in the output message.
5		Failure	Host not available	To adjust the PFM - Agent and PFM - RM hosts to the environment recognized by PFM - Manager host to the actual environment of PFM - Agent and PFM - RM hosts, perform the following steps: If alarm tables are bound to the target service, unbind all the alarm tables with the `jpctool` `alarm` `unbind` command or by an operation from PFM - Web Console. If an alarm definition specifies the target service as an action execution service, change the specification of the action execution service in the alarm definition with the `jpctool` `alarm` `import` command or by an operation from PFM - Web Console. Execute the `jpctool` `service` `delete` command on the PFM - Manager host.
6	Synchronization with a target failed for reasons other than those, such as communication error, described in items 2 to 5.	Failure	Synchronization failure	Restart the host or service indicated in the output message.
7	Synchronization result is unknown because the target service did not respond even though it could communicate.	Failure	No response	Restart the service indicated in the output message.
8	Synchronization with a PFM - Agent or PFM - RM host failed because said host was not recognized by the PFM - Manager host when configuration information was restored.	--	--	To identify a host that is not recognized by the PFM - Manager host but exists in the actual environment, compare your own list of PFM - Agent and PFM - RM hosts with the synchronization result files output by the command. Then, restart all services on the identified host.

Legend:: --: None

To Page Top

Notes

This command will terminate normally if it is executed when there are no PFM - Agent and PFM - RM hosts connected to the PFM - Manager host and the PFM - Manager recognizes no services.
If the Name Server or Master Manager service stops while this command is being executed, or if execution of this command is interrupted by a signal or by pressing Ctrl+C, execution of this command stops. If execution of this command stops in the middle of synchronization processing, re-execute this command.
The jpctool config sync command must not be executed concurrently with this command.
The synchronization processing might take a long time if the system environment is large.

A rough rule of thumb for synchronization processing time is 14 seconds for each of the PFM - Agent and PFM - RM hosts that are monitored by the PFM - Manager host.

Provided that the PFM - Manager host is monitoring a total of 2,500 PFM - Agent and PFM - RM hosts (the maximum allowable number of monitored hosts in a system), the rough estimate of total processing time is about 584 minutes.
You can interrupt execution of this command by pressing Ctrl+C or by other methods. If execution of this command is interrupted, a KAVE05227-E message will be output.

To Page Top

Return values

`0`	The command terminated normally.
`1`	The command line format is invalid.
`2`	The user does not have execution permission for the command.
`5`	PFM - Manager has not been installed.
`12`	The command is now running.
`100`	The Performance Management environment is invalid.
`101`	Some or all the services, including the Name Server service, required to execute the command are not running.
`200`	A memory shortage occurred.
`210`	A disk space shortage occurred.
`211`	The specified file or directory cannot be accessed.
`222`	A communication processing error occurred.
`237`	Synchronization of one or more items of service information failed.
`255`	An unexpected error occurred.

To Page Top

Usage example

This example synchronizes configuration information between the PFM - Manager host and PFM - Agent and PFM - RM hosts.

jpctool config sync

To Page Top

Output example

The following shows an example of messages output to the standard output when the synchronization between the PFM - Manager host and PFM - Agent and PFM - RM hosts has failed:

Example of standard output

KAVE06117-I Synchronization of configuration information will now start.
[50/50]
KAVE06121-W A service exists that could not be synchronized because it does not support synchronization.
KAVE06132-I Evaluation of the synchronization results will now start.
KAVE06133-I Evaluation of the synchronization results ended normally.
KAVE06118-I Synchronization of configuration information ended normally.

To Page Top