jpcconf port list
- Organization of this page
Format
jpcconf port list -key service-key [-lhost logical-host-name] [-inst instance-name]
Function
The jpcconf port list command displays the port numbers that are used with Performance Management.
The following information is displayed:
Item |
Description |
---|---|
Component |
Service name. The displayed names indicate the following:
|
ServiceID |
Service ID |
Services |
Name of the service that uses the port number. If this information is undefined, undef is displayed. |
Port |
Port number. If this information is undefined, undef is displayed. |
Host Name |
Host name |
Hosts that can execute the command
-
PFM - Manager
-
PFM - Agent
-
PFM - Base
-
PFM - RM
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
Installation directory
- In Windows:
-
installation-folder\tools\
- In UNIX:
-
/opt/jp1pc/tools/
Arguments
-key service-key
Specifies the service key of the service whose port numbers are to be the subject of this execution of the command. You can specify the following in service-key:
-
all: Specifies the port numbers of all programs of the Performance Management products.
-
Manager or mgr: Specifies the port numbers that are used with the PFM - Manager services (excluding the Status Server and Action Handler services), the NNM Object Manager service, and between PFM - Web Console and the View Server service.
-
Product name or agtX: Specifies the port numbers that are used with the specified PFM - Agent or PFM - RM service, and the Name Server service.
-
AH or act: Specifies the port numbers that are used with the Action Handler service and the Name Server service.
-
View or view: Specifies the port numbers that are used between the PFM - Web Console and View Server services.
-
StatSvr or stat: Specifies the port numbers that are used with the Status Server service and the Name Server service.
Product name or agtX indicates the service key for the particular PFM - Agent or PFM - RM. For details about the service key of the PFM - Agent or PFM - RM service, see the naming rules described in the appendix of the Job Management Partner 1/Performance Management Planning and Configuration Guide.
-lhost logical-host-name
Specifies the host name of the logical host whose logical environment port numbers are to be displayed.
For logical-host-name, specify a string of 1 to 32 bytes, consisting of alphanumeric characters with no space characters and no periods (.).
For logical-host-name, you cannot specify localhost, an IP address, or a host name beginning with a hyphen (-).
-inst instance-name
Specifies the instance name of the instance whose port numbers are to be displayed. This option is applicable only to a PFM - Agent or PFM - RM that has an instance environment. For instance-name, specify a string of 1 to 32 bytes, consisting of alphanumeric characters.
You can use the jpcconf inst list command to check the instance names that can be specified.
Notes
-
Services do not need to be stopped when this command is executed.
-
To avoid confusion during operations, you should use consistent conventions for the correspondence between port numbers and service names over the entire Performance Management system.
-
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, ignore the return value when the command was interrupted by the Ctrl + C keys or by a signal.
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 |
The specified service key was not found. |
7 |
The specified service key was not found at the logical host. |
10 |
The command is being executed. |
100 |
The Performance Management environment is invalid. |
102 |
The specified instance was not found. |
106 |
Port number has not been registered in the services file. |
200 |
A memory shortage occurred. |
210 |
A disk space shortage occurred. |
211 |
File cannot be accessed. |
255 |
An unexpected error occurred. |
Usage example
This example displays the information about the port numbers for all services of Performance Management programs:
jpcconf port list -key all
The following shows an example of the output: