jpcconf host hostmode

Organization of this page

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

Format

Format 1

jpcconf host hostmode   -mode {uname|hostname|alias
                        -aliasname alias-name}
                        -d backup-directory-name
                        [-dbconvert {convert|delete}]

Format 2

jpcconf host hostmode     -display

To Page Top

Function

The following explains each format for the jpcconf host hostmode command.

Format 1: This changes the method for acquiring the monitoring host name on the physical host environment. Note that when this command is executed, all definition information and performance information is carried over.
Format 2: This displays the monitoring host name and the method for acquiring the monitoring host name.

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 (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

`-mode {uname|hostname|alias}`

Specifies the method for acquiring the monitoring host name on the physical host environment. The following table shows the correspondence between the specified option and the method for acquiring the monitoring host name.

Table 3‒21: Method for acquiring the monitoring host name
`-mode` option	Description
`uname`	The `uname -n` command is used to obtain the monitoring host name.
`hostname`	The `hostname` command is used to obtain the monitoring host name.
`alias`	The alias name is used for the monitoring host name.

`-aliasname` `alias-name`

This specifies the alias name. This option can be specified when alias is specified for the -mode option. For alias-name, specify a string of 1 to 32 bytes, consisting of alphanumeric characters. localhost, IP addresses, and a logical host name on the same device cannot be specified.

`-d` `backup-directory-name`

This specifies the backup destination directory. Specify an existing directory. Note that you cannot specify a subdirectory of the directory that contains the Store database for Agent Store or RM Store. For backup-directory-name, specify a string 1 to 130 bytes, consisting of alphanumeric characters, symbols, and space characters. However, the following symbols cannot be specified:

; , * ? ' " < > |

If the file name contains spaces, enclose the entire name in double quotation marks (").

In directory-name, specify an empty directory that contains no files or directories.

`-dbconvert {convert|delete}`

Specifies how performance data is carried over. If nothing is specified, convert is set.

If convert is specified, the host name information for the key field is converted to a new host name, and data is carried over.

If delete is specified, the Store database is deleted, and data is not carried over. However, information about event data managed by PFM - Manager is not deleted, and carried over.

`-display`

Specifies that the method for acquiring the monitoring host name and information about the host name are to be displayed.

To Page Top

Notes

When the jpcconf host hostmode command is executed, the version of PFM - Manager or PFM - Base on the execution host must be 09-00 or later, and the version of all instances of PFM - Agent must be 08-00 or later.

If PFM - Agent 07-00 or earlier is installed, the settings for the function for setting monitoring-host names must be reverted beforehand. The following shows how to revert the settings for each OS:
- In Windows:
  
  Execute the jpcconf host hostmode -mode hostname -d d:\backup^# command.
- In UNIX:
  
  Execute the jpcconf host hostmode -mode uname -d /home/backup^# command.
#

The backup destination directory is optional.

The following table shows the required version combinations for PFM - Manager, PFM - Base, and PFM - Agent on the execution host, for executing the jpcconf host hostmode command.

Table 3‒22: Whether the jpcconf host hostmode command can be used based on product combination on the execution host
Version of PFM - Manager and PFM - Base		Version of PFM - Agent		No PFM - Agent
Version of PFM - Manager and PFM - Base		08-00 or later	07-00 or earlier	No PFM - Agent
PFM - Manager	08-11 or earlier	No	No	No
PFM - Manager	09-00 or later	Yes	No	Yes
PFM - Base	08-11 or earlier	No	No	No
PFM - Base	09-00 or later	Yes	No	Yes

Legend:

Yes: The jpcconf host hostmode command can be executed.

No: The jpcconf host hostmode command cannot be executed.

When the jpcconf host hostmode command is executed in Format 1, all services for the specified host need to be stopped.
The directory specified for the -d option of the jpcconf host hostmode command must have free space that is as large as the total size of the following databases: The Store databases for PFM - Agent and PFM - RM on the specified host and the database in the import directory. If the directories that contain these databases have been changed from the default directories, use the sizes of the databases in the directories actually used for calculation.
Do not execute any other commands while the jpcconf host hostmode command is executing. If another command is executed, the jpcconf host hostmode command or the other command might fail to execute.

If the jpcconf host hostmode command fails with a KAVE05183-E message, use the following procedure to correct the error:

Check the message that was output immediately before the above message, and remove the cause of the error.

Check whether a KAVE05172-I message was output when the command failed.

If the message was output, use the backup data in the backup directory to restore the backup source data.

The table below shows the types of data that are backed up. Restore these types of data from the data in the backup destination directories. In Windows, replace a slash (/) with a backslash (\) in the table.

Category	Backup source	Backup destination
Store database	The Store directory of the Agent product	For a multi-instance agent: `backup-directory/agtX`^#1`/instance/store` For a single-instance agent: `backup-directory/agtX`^#1`/store`
Definition file	`installation-directory/jpcns.ini`	`backup-directory/jpcns.ini`
	`installation-directory/jpcns_backup.ini`	`backup-directory/jpcns_backup.ini`
	`installation-directory/jpccomm.ini`	`backup-directory/jpccomm.ini`
	`installation-directory/agtX`^#1`/agent/agtlist.ini`^#2	`backup-directory/agtX`^#1`/agent/agtlist.ini`^#2
	`installation-directory/agtX`^#1`/store/stolist.ini`^#2	`backup-directory/agtX`^#1`/store/stolist.ini`^#2
	`installation-directory/bin/statsvr/restart.ini`	`backup-directory/bin/statsvr/restart.ini`
	`installation-directory/sys/jp1sysEvent.ini`	`backup-directory/sys/jp1sysEvent.ini`

#1: The agtX item indicates the Agent product's service key. For the service key of an Agent product, see any manual of that Agent product.

#2: This data is backed up only for a multi-instance agent.

Re-execute the command.

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.
`4`	The Performance Management service is running at the executing host.
`10`	The command is being executed.
`11`	The user or the system canceled processing.
`100`	The Performance Management environment is invalid.
`102`	The specified logical host name has not been set up.
`200`	A memory shortage occurred.
`210`	A disk space shortage occurred.
`211`	A file or directory cannot be accessed.
`220`	A host name specified in the service configuration information file is invalid.
`222`	A communication error occurred.
`223`	A communication processing timeout error occurred.
`255`	An unexpected error occurred.

To Page Top

Usage example 1

This example changes the method for acquiring the monitoring host name so that it is acquired by using the hostname command.

jpcconf host hostmode -mode hostname -d d:\backup -dbconvert convert

To Page Top

Usage example 2

This example changes the method for acquiring the monitoring host name so that the alias name is used.

jpcconf host hostmode -mode alias -aliasname aliasA -d d:\backup -dbconvert convert

To Page Top

Usage example 3

This example displays the monitoring host name and the method for acquiring the monitoring host name. The method for acquiring the monitoring host name is shown for the displayed hostmode, and the monitoring host name is shown for the displayed hostname. The alias name is shown for the displayed aliasname.

jpcconf host hostmode -display

Display examples

When using the hostname command as the method for acquiring the monitoring host name:
```
hostmode  : hostname
hostname  : hostA
```
When using the alias name for the monitoring host name:
```
hostmode  : alias
aliasname : aliasA
```

To Page Top