jpcconf port define

Format

jpcconf port define    -key service-key
                      [-lhost logical-host-name]
                      [-inst instance-name]
                      [-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.

Because port numbers are assigned automatically to the programs and services of the Performance Management products each time the services are restarted, the current port numbers may not be the same as the ones assigned in the previous session, except for the port numbers listed below, which are always used when port numbers are set automatically:

You use this command to indicate that you will set different port numbers from the ones listed above.

A specifiable port number is any integer in the range from 1024 to 65535 that is not in use as a port number in the system. If you do not specify a port number, the system uses the port number assigned by Performance Management. If you press the return key without specifying a port number, the system uses the displayed port number.

You should use the port number assigned by Performance Management unless that port number is already in use in the system. For details about the port numbers assigned by Performance Management, see C. Port Numbers.

Each number that is specified must be unique on the same device.

If a service of a Performance Management series program exists on both the logical host and the physical host of the same device, a unique port number must be assigned to the service on each host.

To indicate that you are not specifying a port number (so that the port number will be assigned automatically each time the service is restarted), enter the value 0. For the following services, the following port numbers are set:

To penetrate a firewall between PFM - Manager and PFM - Web Console, PFM - Manager and PFM - Agent, or between PFM - Manager and PFM - RM, you must set the port number to a fixed value. For details about the settings for penetrating these firewalls, see C. Port Numbers.

To Page Top

Hosts that can execute the command

• PFM - Manager

• PFM - Agent

• PFM - Base

• 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, Action Handler, and NNM Object Manager 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 Job Management Partner 1/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, for the Name Server, OpenView (between NNM and NNM Object Manager), Status Server, and View (between PFM - Web Console and View Server) services, fixed port numbers will be assigned even if you specify 0.

• To use the default port numbers that are assigned by Performance Management, specify auto as the values. However, if the default port numbers are already in use, available port numbers will be assigned automatically.

  Note that there are services for which you must not specify auto and must specify fixed port numbers. These services are listed in the following table.

  Service name#	Port number
  Name Server	22285
  OpenView (between NNM and NNM Object Manager)	22292
  Status Server	22350
  View (between PFM - Web Console and View Server)	22286

  #: The command sometimes displays names that are different from the actual service names. For these services, the displayed names are indicated in the above table.

• 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
Open View=22292
[Manager]
Master Manager=auto
Master Store=auto
Correlator=auto
 ...
[Windows]
Collector=0
Store=0
 ...
[Oracle]
[[oracle1]]
Collector=0
Store=0

To Page Top

Notes

• If you want to set port numbers for a service of a Performance Management program that is active, you must first terminate the service and then execute this command. When you finish setting the port numbers, start the service manually.

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

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

To Page Top

Return values

To Page Top

Usage example

This example specifies that the port numbers for all services of Performance Management programs will be set to fixed values:

jpcconf port define -key all

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