jpcconf primmgr notify
- Organization of this page
Format
jpcconf primmgr notify [-noprogress]
Function
The jpcconf primmgr notify command sets the PFM - Manager on the execution host as the primary host, and notifies all the hosts in the PFM system that the PFM - Manager on the execution host will operate as the primary host. This command sends the host name of the PFM - Manager to be the primary host to only the notification destination hosts where the Status Server service is running, and sets the host name in those notification destination hosts.
Hosts that can execute the command
PFM - Manager
Execution permission
- In Windows:
-
User with Administrators permissions
- In UNIX:
-
User with root user permissions
Installation directory
- In Windows:
-
installation-folder\tools\
- In UNIX:
-
/opt/jp1pc/tools/
Argument
-noprogress
If this option is specified, the command does not output the information on the progress of notification processing.
Output of notification result file
When the jpcconf primmgr notify command terminates, the command outputs a CSV-format notification result file for every host to which the notification was sent. The following table provides an overview of the notification result file.
Item |
OS |
Description |
---|---|---|
File name |
-- |
primnotifyresult.csv |
File path |
Windows |
installation-folder\log |
UNIX |
/opt/jp1pc/log |
|
Permission and owner |
Windows |
Permissions for installation-folder\log are inherited. |
UNIX |
666 [rw-rw-rw-]
|
|
Creation timing |
-- |
A new file is created each time the command is executed.# |
File size |
-- |
Less than 1 megabyte |
- #
-
If a notification result file already exists, the existing file is discarded.
Output example of a notification result file
The following shows an output example of a notification result file:
DateTime=YYYY/MM/DD HH:MM:SS Hostname,Primary Notify Result,Message hostA,Success, hostB,Failure,Host not available hostC,Failure,Communication failure
The following table describes the details of the output content of the 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 time zone set. |
First line |
Label |
HostName,Primary Notify Result,Message |
Outputs the labels shown on the left. |
Second line |
Information on synchronization result for each service |
host-name,setting-result,reason-message |
Outputs the host name of the notification destination service as host-name. For the output contents of the setting result and reason message, see the table below. |
Third line and after (This set of information is output as many times as the number of the hosts for which notification was executed.) |
- Legend:
-
Δ: Single-byte space
The table below lists the messages output under the Primary Notify Result and Message labels in the notification result file when notification of the host name of the PFM - Manager to be the primary host has succeeded or failed. The following table also describes the corrective action to be taken for each failure message.
No. |
Notification result |
Output content |
Corrective action |
|
---|---|---|---|---|
Primary Notification Result |
Message |
|||
1 |
Notification succeeded. |
Success |
-- |
-- |
2 |
Notification failed because the notification destination host had not started or for other reasons. |
Failure |
Host not available |
Perform switching between the primary and secondary hosts individually for the host to which notification failed. |
3 |
Notification sent to the notification destination host failed because of a reason other than the above. |
Failure |
Communication failure |
Perform switching between the primary and secondary hosts individually for the host to which notification failed. |
- Legend:
-
--: None
Notes
-
The following services must be running on the PFM - Manager on the execution host:
-
Status Server service
-
Name Server service
-
Master Manager service
-
-
This command must be executed in a multiple-monitoring environment.
-
Even if the PFM - Manager on the execution host has already been set as the primary host, this command updates settings and reports the host name.
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 |
An attempt was made to execute the command on the PFM - Base host, but the command can only be executed on the PFM - Manager host. |
10 |
The command is now running. |
12 |
The command was not executed in a multiple-monitoring environment. |
100 |
The Performance Management environment is invalid. |
101 |
Not all the services required to execute the command are running. |
200 |
A memory shortage occurred. |
210 |
A disk space shortage occurred. |
211 |
A file access error occurred. |
222 |
A communication processing error occurred. |
237 |
Notification to one or more hosts failed. |
255 |
An unexpected error occurred. |
Usage example
This example specifies the PFM - Manager on the execution host as the primary host, and notifies all the hosts in the PFM system of the host name of the primary PFM - Manager host.
jpcconf primmgr notify
Output examples
The following shows an example of messages output to the standard output when the notification of the host name of the PFM - Manager to be the primary host has succeeded:
Example of standard output
KAVE06145-I The primary PFM - Manager settings were successfully specified. KAVE06147-I The program will now start notifying hosts of the primary host name. [50/50] KAVE06150-I The program successfully notified all hosts of the primary host name. KAVE06148-I The program has finished notifying hosts of the primary host name.
The following shows an example of messages output to the standard output when the notification of primary manager settings has failed:
Example of standard output
KAVE06145-I The primary PFM - Manager settings were successfully specified. KAVE06147-I The program will now start notifying hosts of the primary host name. KAVE06149-E The program failed to notify all hosts of the primary host name. (host=HostA) [50/50] KAVE06151-W The program failed to notify at least one host of the primary host name. KAVE06148-I The program has finished notifying hosts of the primary host name.