jpcconf port define

Format

jpcconf port define    -key service-key
                      [-lhost logical-host-name]
                      [-inst instance-name]
                      [-only]
                      [-input definition-file-name]
                      [-noquery]

jpcconf port define    -key service-key
                      [-lhost logical-host-name]
                      [-inst instance-name]
                      -template definition-file-name
                      [-noquery]

To Page Top

Function

The jpcconf port define command sets the port numbers that are used with Performance Management.

The port numbers assigned by Performance Management are classified into fixed port numbers and preferential port numbers, and the settings that can be specified in the command differ according to the service type. For details about the port numbers assigned by Performance Management, see Appendix C. Port Numbers.

Also, you can execute the jpcconf port define command to display the port numbers that are set currently.If you press the return key without specifying a port number, the system uses the displayed port number.

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

To Page Top

Format of the definition file (for the jpcconf port define 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. Invalid section and label names are ignored.

[Common Definitions] section

Specifies the basic information in the definition file. This section and all labels in this section are required.

Definition File Version label

Specifies the version of the definition file. Specify the constant 0001.

[component-name] section

Use this section to specify the port numbers that you want to set.

For component-name, specify the name of a component that contains the services for which you want to set port numbers. You can specify multiple [component-name] sections (with different component-name values).

If you specify multiple [component-name] sections with the same component-name value, only the section specified first takes effect.

The values that can be specified for component-name are as follows:

• Common

  Specify Common when you want to set the port numbers that will be used by the Name Server, Status Server, and Action Handler services.

• Manager

  Specify Manager when you want to set the port numbers that will be used by PFM - Manager services.

• PFM - Agent or PFM - RM product name

  Specify the name of a PFM - Agent or PFM - RM product when you want to set the port number that will be used by a PFM - Agent or PFM - RM product. For product names that can be specified, see the chapter on the Performance Management functionality in the JP1/Performance Management Planning and Configuration Guide.

Subsection with an instance name

To specify port numbers that will be used in a PFM - Agent or PFM - RM instance environment, specify them in this subsection. You can specify this subsection only if the specified component is a PFM - Agent or PFM - RM that has multiple instances.

If you specify multiple subsections with the same name in a [component-name] section, the subsection specified first takes effect.

Label with a service name

Specify a label with the name of a service for which you want to set a port number.

If you specify multiple labels with the same name in a section or subsection, the label specified first takes effect.

• If you want a port number to be dynamically assigned each time the service is restarted, specify 0 as the value. However, those ports assigned a fixed number by Performance Management will be assigned a port number even if you specify 0.

• To use the default port numbers that are assigned by Performance Management, specify auto as the values. However, you cannot specify auto for ports that are assigned a fixed number by Performance Management.

• When you specify port numbers, select port numbers that are in the range from 1024 through 65535 and are not currently used within the system.

• If you do not change port numbers, specify nothing for these values.

If you specify a value that is outside the range from 1024 through 65535 or specify a value that includes non-numeric characters (except auto), the processing for the relevant services will be skipped.

The following table lists and describes component names, service names, and values that can be specified for [component-name] sections and service-name labels.

The following shows an example of specifying settings in the definition file.

[Common Definitions]
Definition File Version=0001
 
[Common]
Name Server=22285
Status Server=22350
[Manager]
Master Manager=auto
Master Store=auto
Correlator=auto
 ...
[Windows]
Collector=0
Store=0
 ...
[Oracle]
[[oracle1]]
Collector=0
Store=0

To Page Top

Notes

• Earlier than 11-01

  Before you execute this command to set port numbers, make sure that no Performance Management program services are running on the local host. When you finish setting the port numbers, start the services manually.

• 11-01 or later

  Before you execute this command to set port numbers, you might need to stop Performance Management program services. The services to be stopped differ depending on whether you specify the -only option, as shown below.

  If you set the port numbers without the -only option specified

  Stop all services running on the local host.

  If you set the port numbers with the -only option specified

  Stop the services specified by the -key and -inst options.

  When you finish setting the port numbers, manually restart the services that you stopped.

• If the -noquery option is omitted and 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 host are 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.

• If you terminate this command during execution by pressing the Ctrl + C keys, the port numbers will not be set correctly. In this case, re-execute the command to set the port numbers again.

• Make sure that you set the same port number for the Name Server service on all hosts in the Performance Management system.

  Similarly, for the Status Server service, make sure that you set the same port number on all hosts in the Performance Management system.

  Also, for other PFM services, use the same correspondence between port numbers and service names throughout the Performance Management system to avoid confusion.

• Use the fixed port number or preferential port number assigned by Performance Management unless the same port number exists within the host.

• This command automatically edits the services file of the operating system.

• This command edits only the local services file at the host where the command is executed. For UNIX, if you are managing the services file using NIS or NIS+, you must manually apply to the NIS server a port number added to the local services file.

• When you enter a port number, the command displays the value that is contained in the services file at the host where the command is executed. In an NIS or NIS+ environment, if the port number information managed by the NIS server does not match the information in the services file of the NIS client, the displayed information may not be the actual value used by the service.

• If command 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.

• 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 an invalid value is specified for Definition File Version. 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.

• If the -input option is specified, the command processes only the port numbers of the services specified by the -key option and the -input option. Similarly, if the -only option is specified together with the -input option, the command does not process the port number of the Name Server service in the definition file. Even if the definition file contains sections, subsections, or labels that are not processed by the command, no errors occur.

• In an environment in which an overwrite install was done from a version earlier than 11-00 to version 11-0 or later, if the -template option is specified, the OpenView service (the service for NNM linkage) will be included in the definition file that is output. In that case, delete the OpenView service line from the definition file.

  If you do not delete the line, and then read the definition file with the -input option, the OpenView service port number will be set in the services file. In that case, edit the services file and delete the OpenView service line. However, even if the OpenView service is set, it will not affect the behavior of Performance Management.

  To prevent the OpenView service line from being output to the definition file, see the description in the notes on migration (version 11-00 or later) in the appendix of the JP1/Performance Management Planning and Configuration Guide.

• In Linux, if you use this command to display the Status Server port number, or use the jpcconf port define command to set the Status Server port number to 22350, the following message is sometimes output.

  jpcconf port define : KAVE05918-W The specified port number is in use by another.

  If this happens, /etc/services might contain the following:

  CodeMeter 22350/tcp

  The above text is added to the services file on installation of the OS, regardless of whether the described product is installed. For this reason, confirm whether the applicable product is used, and if it is not used, comment out this text.

  If the applicable product is used, or if the port number is registered for a different product, ensure that port number conflicts do not occur within the server.

  For details about port numbers and change methods used by PFM - Manager, see sections that describe port number settngs and changing the port number settings in the manual JP1/Performance Management Planning and Configuration Guide.

To Page Top

Return values

To Page Top

Usage example

jpcconf port define -key all

# jpcconf port define -key Oracle -only

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.

# jpcconf port define -key Windows -template AgentPort01.txt
# jpcconf port define -key Oracle -template AgentPort02.txt

# jpcconf port define -key Windows -input AgentPort01.txt -noquery
# jpcconf port define -key Oracle -input AgentPort02.txt -noquery

To Page Top