Database Management

Change the default ports in DPA

This article provides steps to change the default ports in DPA.

First published date

10/9/2018 3:11 AM

Last published date

6/7/2021 7:41 PM

Overview

This article provides steps to change the default ports in DPA.  

Environment:

  • O/S Type for DPA Application server: Linux or windows 

Product section

Database Performance Analyzer

Resolution

You can change the Three ports that DPA uses for the tomcat web application :

  • Server port: Used by Tomcat to listen for shutdown messages. The default is 8127.
  • Connector port: DPA listens for all other HTTP requests on this port. The default is 8123.  This is the port number used in the DPA URL in the browser:  http://<host>:<connectorPort>
  • Connector port for HTTPS : DPA listens for all other HTTPS requests on this port. The default is 8124.  This is the port number used in the DPA URL in the browser:  https://<host>:<connectorPort>

Each port must be:

  • Unique. The same port cannot be used as Server and Connector.
  • Available. Each port must not used by another process, including other DPA installations.
  • Note: The shutdown port (default 8127) does not need to be opened on a firewall, but it needs to be available (not in use).
  • Connection ports that are in use for HTTP and HTTPS need to not be blocked by a firewall.

You can configure DPA to use available ports with these steps:

  1. Edit the <installDir>/iwc/tomcat/conf/server.xml file.
  2. Change the ports listed in the file for any connection that you need to change.
    <Server port="8127" shutdown="SHUTDOWN">
    
      <Service name="Catalina">
        <Listener className="com.confio.ignite.config.DpaServerLifecycleListener"/>
    
    
        <!-- HTTP connector -->
        <Connector port="8123" maxHttpHeaderSize="20480" URIEncoding="UTF-8" compression="on"
                   compressionMinSize="2048" compressableMimeType="text/html,text/xml,text/csv,text/css,application/javascript"
        />
    
        <!-- HTTPS/SSL connector -->
        <!-- Note: AIX requires algorithm="ibmX509" attribute to be present in the connector -->
        <Connector port="8124" maxHttpHeaderSize="20480" URIEncoding="UTF-8" scheme="https" secure="true" SSLEnabled="true"
                   clientAuth="false" useServerCipherSuitesOrder="true" compression="on"
                   compressionMinSize="2048" compressableMimeType="text/html,text/xml,text/csv,text/css,application/javascript"
                   keystoreFile="conf/.keystore"
                   sslEnabledProtocols="TLSv1.2+TLSv1.3"
                   ciphers="HIGH:!SHA1:!SHA256:!SHA384:!RSA:!DHE"
        />
    
        <Engine name="Catalina" defaultHost="localhost">
          <Host name="localhost" appBase="webapps" />
        </Engine>
      </Service>
    </Server>
  3. Restart DPA. 
    1. On Windows installations this is a restart of the service "Ignite PI Server." 
    2. On Linux installations this is a run of shutdown.sh and then startup.sh in [DPA Home].