Question & Answer
Question
What are the port numbers used by IBM Planning Analytics products?
Answer
List of ports used by Planning Analytics:
Port |
Description |
||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 5495 | The unsecured TCP/IP port number on which the Admin Server listens for client requests (if allowed in Cognos Configuration). | ||||||||||||||
| 5498 | The secured TCP/IP port number on which all TM1 components communicate with the Cognos TM1 Admin Server by using Transport Layer Security (TLS). | ||||||||||||||
| 5895 | Admin Server to REST API unsecured communication port number (tm1AdminHTTPPortNumber). Specifies the HTTP port number that is used by TM1 Admin Server to communicate with the TM1 REST API for unsecured communication (if allowed). The default value is 5895. This default value cannot be changed by using IBM Cognos Configuration. For more information, see "The TM1 Admin Server" in the TM1 REST API documentation. | ||||||||||||||
| 5898 | Admin Server to REST API secured communication port number (tm1AdminHTTPSPortNumber). Specifies the HTTPS port number that is used by TM1 Admin Server to communicate with the TM1 REST API for secured (SSL) communication. The default value is 5898. This value cannot be changed by using IBM Cognos Configuration. For more information, see "The TM1 Admin Server" in the TM1 REST API documentation. | ||||||||||||||
| <PortNumber> |
The port on which the TM1 server runs.
This parameter is used to distinguish multiple TM1 servers running on the same computer. Valid port values fall between 5001 and 65535. The default value is 12345 (already used by Planning Sample).
This parameter is set in the tm1s.cfg server configuration file.
For more information, see "PortNumber" in the Planning Analytics documentation.
|
||||||||||||||
| <HTTPPortNumber> |
Port number on which the TM1 Server listens for incoming HTTP(S) requests.
The IBM Planning Analytics TM1 Server services the REST API by using this HTTP(S) channel. The server accepts either standard HTTP or SSL secured HTTPS connections depending on the UseSSL parameter:
• If UseSSL is set to T, switching on the use of SSL, then the server accepts only HTTPS connections.
• If UseSSL is set to F, then the server accepts unsecured HTTP connections.
Valid port values fall between 5000 and 49151. The default value is 5001.
This parameter is set in the tm1s.cfg server configuration file.
For more information, see "HTTPPortNumber" in the Planning Analytics documentation.
|
||||||||||||||
| <ClientMessagePortNumber> |
TM1 Client Message port number.
This port number establishes a secondary port for client progress messages to use when a lengthy operation is waiting to be cancelled.
This parameter is defined in the tm1s.cfg server configuration file. The default value is blank.
By default, this port number is automatically and dynamically assigned when the TM1 server starts. You do not have to set ClientMessagePortNumber to a specific number unless firewalls or other network issues require the listener port to be a well-known number.
CAUTION: If a specific value is set for the ClientMessagePortNumber parameter instead of having it dynamically assigned, then ensure that unique port numbers are assigned for all the TM1 server and client message ports being used. If there are two or more servers running on the same machine that use the same port number, the message activity can cause a system conflict or hang.
For more information, see "ClientMessagePortNumber" in the Planning Analytics documentation.
|
||||||||||||||
| <LDAPPort> | Port that IBM TM1 Server uses to bind to an LDAP server. It is used if PasswordSource=LDAP in the tm1s.cfg file. The default LDAPPort is 389 (unsecured). Usually, in production, secured port 636 is used instead (LDAPS). | ||||||||||||||
| 9510 | Default port for both TM1 Application Server (depending on "IBM Cognos TM1" service) and IBM Planning Analytics Spreadsheet Services (the new TM1 Web that depends on "IBM Planning Analytics Spreadsheet Services" service). If both services are still needed on the same machine, then this default port has to be changed for one of them, and TM1 Application Web (pmpsvc) might have to be reconfigured to connect to TM1 Web. For more information, see "How to Configure TM1 Application Web to connect to TM1 Web since 2.0.9.2 ? (IBM Planning Analytics Spreadsheet Services)" | ||||||||||||||
| 53 | Docker daemon port. | ||||||||||||||
| 80 | Planning Analytics Workspace's PAGatewayHTTPPort (defined in \config\paw.ps1). This is an HTTP port that is mapped to the host by pa-gateway. The default value is 80. For more information, see "How do I change default port numbers for Planning Analytics Workspace on Windows Server 2016?" | ||||||||||||||
| 443 | Planning Analytics Workspace's PAGatewayHTTPSPort (defined in \config\paw.ps1). This is an HTTPS port that is mapped to the host by pa-gateway. The default value is 443. For more information, see "How do I change default port numbers for Planning Analytics Workspace on Windows Server 2016?" | ||||||||||||||
| 9012 | To use IBM Planning Analytics Administration on Planning Analytics Workspace Local, install and configure the Planning Analytics Administration agent wherever the IBM TM1 Server is installed. The default port of the Planning Analytics Administration agent is 9012. This port cannot be easily changed because it is hardcoded in the docker image of the container that is accessing the Administration Agent. | ||||||||||||||
| 8888 | Default admintool port. By default, the Planning Analytics Workspace administration tool is accessible on http://127.0.0.1:8888. In IBM Planning Analytics Workspace Local version 2.0.44 or later, if port 8888 is not free, Planning Analytics Workspace Local can be configured to access the Planning Analytics Workspace administration tool remotely on Windows Server. For more information, see "Access the Planning Analytics Workspace administration tool remotely on Windows Server". If a browser cannot be run on the localhost interface, Planning Analytics Workspace Local can be configured to access the Planning Analytics Workspace administration tool on another IP address. For more information, see "Access the Planning Analytics Workspace administration tool remotely on Linux" |
Firewall Settings:
- Firewall settings need to be configured accordingly and adjusted depending on multi-server distribution
- Ports used by Planning Analytics server-side components must be configured to allow inbound traffic
- Planning Analytics connects via TCP
[{"Type":"MASTER","Line of Business":{"code":"LOB10","label":"Data and AI"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSCTEW","label":"IBM Planning Analytics Local"},"ARM Category":[{"code":"a8m50000000KzJTAA0","label":"Installation and Configuration-\u003EGeneral (not component specific)"},{"code":"a8m0z000000GpMHAA0","label":"install"}],"ARM Case Number":"","Platform":[{"code":"PF033","label":"Windows"}],"Version":"All Versions"}]
Product Synonym
PA;PAW;PASS;TM1 Web;PAfE;TM1
Was this topic helpful?
Document Information
Modified date:
26 October 2023
UID
ibm16505275