jpcconf agent setup

Format

jpcconf agent setup      -key service-key
                        [-noquery]

jpcconf agent setup      -key service-key
                        [-register]

jpcconf agent setup      -key service-key
                        [-unregister]

To Page Top

Function

The jpcconf agent setup command adds a new instance of PFM - Agent or PFM - RM to Performance Management systems. Information about the PFM - Agent or PFM - RM instance is registered in PFM - Manager and PFM - Base.

If PFM - Agent or PFM - RM is already registered in PFM - Manager, you do not have to execute this command. If PFM - Agent or PFM - RM is not registered yet, execute this command to manually register PFM - Agent or PFM - RM.

You can determine whether manual registration of PFM - Agent or PFM - RM is necessary by referring to the conditions described below.

When all of the following conditions apply, manually register PFM - Agent or PFM - RM in PFM - Manager:

• The PFM - Agent or PFM - RM to be installed is of a product version that is not specified in the Release Notes for PFM - Manager.

• PFM - Agent or PFM - RM is installed on a host other than PFM - Manager.

If, however, the Release Notes for PFM - Agent or PFM - RM state that it is necessary to execute this command, execute this command.

To have new information about instances of PFM - Agent or PFM - RM registered with PFM - Manager displayed in the PFM - Web Console, start the newly registered PFM - Agent or PFM - RM instance. The information is applied upon login to PFM - Web Console.

Execute this command in the following case:

Format 1

When registering PFM - Agent or PFM - RM in PFM - Manager

Format 2

When registering information about an instance of PFM - Agent or PFM - RM with PFM - Manager without starting the instance, and displaying it in PFM - Web Console

Format 3

When hiding product information in the alarms tree and reports tree of PFM - Web Console

If logical host settings have been set up for PFM - Manager, information about the new PFM - Agent or PFM - RM instance is registered for the set logical host and physical host.

To Page Top

Hosts that can execute the command

Format 1

• PFM - Manager

• PFM - Agent

• PFM - RM

Format 2 and Format 3

PFM - Manager

To Page Top

Execution permission

In Windows:

User with Administrators permissions (executed from the administrator console if 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

To Page Top

Notes

• The log information for when this command is executed is output to the common message log on the physical host, even when the setup destination is on the logical host.

• If this command's 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 you are already logged in to PFM - Web Console when you execute this command, log in to PFM - Web Console again.

To Page Top

Cautions regarding execution using Format 1

• Before executing this command, copy the setup file for the new instance of PFM - Agent or PFM - RM for which information is to be registered in the following directory on the execution host:

  • In Windows: installation-folder\setup\

  • In UNIX: /opt/jp1pc/setup/

  When performing additional setup of a new instance of PFM - Agent or PFM - RM on a host separate from that on which the original instance of PFM - Agent or PFM - RM was installed, make sure that the setup file for the new instance of PFM - Agent or PFM - RM is copied to these directories on the execution host. When using FTP to copy (transfer) files between a Windows host and UNIX host, make sure that binary mode is used.

• Before executing this command, stop all Performance Management services running on the local host. If you execute this command without stopping the services, the command will attempt to stop them. However, if the command cannot stop the services completely, an error will result. If this occurs, make sure that the services have stopped completely, and then re-execute the command.

  Additionally, if the Performance Management program services on a physical hostare stopped by executing this command, you must manually restart the Performance Management program services on the physical host after the command processing finishes, as follow:

  • In an environment powered by CentOS 7 or later versions, Linux 7 or later versions, Oracle Linux 7 or later versions, SUSE Linux 12 or later versions

    If both the automatic service start and automatic service stop features are enabled, you must ensure that the automatic service stop feature can work successfully. To do this, first execute the systemctl stop jp1_pc command and then use the systemctl start jp1_pc command to start the services.

    If the automatic features are not set as above, use the jpcspm command to start the services.

  • Environments other than above

    Use the jpcspm command to start the services.

  To check the startup status for the service, execute the jpctool service list command.

• When an attempt is made to set up an instance of PFM - Agent or PFM - RM already supported by PFM - Manager, the KAVE05944-W message is output, and setup for PFM - Manager is skipped. In this case, setup for PFM - Manager is not necessary.

To Page Top

Cautions regarding execution using Format 2 and Format 3

• It is not necessary to stop the Performance Management service.

• If the following conditions apply, registration in Format 2 cannot be performed. Use Format 1 for setup.

  • The PFM - Agent or PFM - RM to be installed is of a product version that is not specified in the Release Notes for PFM - Manager.

  • PFM - Agent or PFM - RM is installed on a host other than PFM - Manager.

• This command cannot be executed outside of a PFM - Manager host.

To Page Top

Return values

To Page Top

Usage example 1

This example sets up an instance of PFM - Agent for Oracle released after PFM - Manager.

jpcconf agent setup -key Oracle

To Page Top

Usage example 2

This example displays the information about a newly added instance of PFM - Agent for Oracle in PFM - Web Console before it starts.

jpcconf agent setup -key Oracle -register

To Page Top

Usage example 3

This example hides information regarding PFM - Agent for Oracle on PFM - Web Console.

jpcconf agent setup -key Oracle -unregister

To Page Top