Manage server ports

This topic contains information on B2Bi Server port allocation management tasks you may need to perform after running an installation or update.

Manage the UI and REST API connection port

When you install the B2Bi Server it automatically sets the default user interface HTTP connection port to 6080. This port is also used for REST API connections from B2Bi Client environments. Use the following procedure to add a secured HTTPS connection port for the UI and REST API connection.

Add an HTTPS connection port

Once you configure an HTTPS port for the UI/REST API connection, select the browsers to connect using HTTP and HTTPS.

Note   You must not disable the HTTP connection or user authentication from the B2Bi Client environment will fail.

To add an HTTPS connection port:

  1. Log onto the UI.
  2. Click System management on the toolbar to open the System management page.
  3. Click the task Configure UI connection (near the bottom of the page) to open the Configure UI connection page.
  4. On the General tab, select UI connections made via HTTPS. Port 6443 is displayed by default; however, if neccessary, you can change the port.
  5. Optionally, select the Override SSL and TLS cipher suites option.
  6. To use this option, use the Add and Remove buttons to specify the cipher suites that are supported. If none are selected, all cipher suites are supported by default.
  7. The default order in the Available column is the preferred order of use. Once ciphers are moved to the Selected column, you can arrange the order. B2Bi uses the ciphers in the order they are listed.
  8. Use the option override option to select the level of security that suits your needs and enables communicating with others who might have different security requirements. For example, when an SSL connection is established, the client and server exchange information about the cipher suites they have in common. Then they communicate using the common cipher suite that offers the highest level of security. If they do not have a cipher suite in common, secure communication is not possible.
  9. Note Changes to this configuration are global in effect for all users who log in with HTTPS. This includes all WebTrader users (who typically are forced to use only the HTTPS URL to B2Bi).
  10. For port forwarding for the user interface, select the DMZ ports tab. You can enable port forwarding for HTTP or HTTPS, or both. This option is only available if your software license supports the DMZ nodes functionality.
  11. Click Save.
  12. Select the Personal certificates tab and click Add a certificate to open the certificate wizard.
  13. You can add a self-signed or a CA certificate. The certificate has a public-private key pair. The certificate is used to secure connections between browsers and the server.
  14. If you choose to add a self-signed certificate, you can accept all default values in the certificate wizard.
  15. After you add a certificate, the General tab displays again.
  16. Select the Personal certificates tab again. The certificate you added in the previous step is listed.
  17. If there is more than one certificate, select the certificate you want as the default and click Save.
  18. On the General tab, confirm that UI connections made via HTTPS is selected.
  19. If you are configuring HTTPS and selected Require client authentication, select the Trusted roots certificates tab and add a trusted root certificate.
  20. With this option, the server requires the user's browser to send a certificate back to the HTTPS server. The HTTPS server must trust the certificate returned by the browser client. If a browser user has a CA-issued certificate for authentication, you must at least trust the root CA certificates. If a browser user has a self-signed certificate, the user must export the certificate and public key to a file and give you the file. You then must import the certificate file.
  21. To complete the configuration you must do one of the following:
    • Restart the server. If you operate multiple computers in a cluster, restart all servers.
    • Restart all nodes and the user interface. Go to the System management page and click Stop all nodes. On the Stop all nodes page, click Restart all nodes and Yes, include the user interface. Click Stop/restart. Note that restarting the user interface ends your browser session.
  22. Inform users of the URL needed to connect from a browser to the user interface. If you use the suggested port of 6443, the URL is:
  23. https://<host>:6443/ui
  24. Where <host> is the fully-qualified domain name or IP address of the computer running the server.

Modify the integration engine port allocation range

Caution   Do not include ports from the ephemeral range in the integration port allocation range. The use of ports in this range may cause task to stop and attempt to restart, with the error "failed to bind socket: Address already in use".

During the B2Bi installation the minimum and maximum values for the range in which the installer allocates B2Bi Integration Engine ports are configured. After the installation, you can run the installer in configure mode to modify the range by changing either the minimum or maximum port range limit (or both).

Reassign specific integration engine ports

Caution   Do not assign ports from the server's ephemeral range. The use of ports in this range may cause integration engine tasks to stop and attempt to restart, with the error "failed to bind socket: Address already in use."

During B2Bi installation, and each time you run the installer in configure mode, the installer registers the port allocations to the file:

<B2Bi_shared_directory>/data/system/<host_name>/portinfo.cfg

You can open this file in an editor and individually modify the port allocations if required. You must then save the file and restart B2Bi for port allocation changes to take effect.

Note   If you later run the installer in configure mode, and reset the port allocation range, the manually modified port allocations will be lost and must be recreated.

Special procedures for port reassignment

Use the following additional procedures if you have specific port changes:

Port changes requiring running configure mode

If you modified any of the following port allocations in portinfo.cfg, you must run the B2Bi Server installer in configure mode without selecting the Configure Port Range option:

    • Integratorcsrestservice
    • Integratorcsclusterservice
    • Integratorcsinternallcomm
    • Integratorcsbackupservice
  • Port changes requiring modification of the xib.properties file

    In cases where you modify any of the following port allocations in portinfo.cfg:

    • Integratorcfgserver
    • Integratortracer
    • Integratormdimporter

    ...you must:

    1. Stop B2Bi.
    2. Go to <B2Bi_shared_directory>\data\system and open the file b2bi.properties in a text editor.
    3. Add the modified ports with their new values to b2bi.properties and save the file.
    4. Start B2Bi for the changes to take effect.

    Add integration engine pool ports

    The integration engine in B2Bi uses porter pool ports for internal communications related to task execution. These ports are created at installation and registered in the file:

    <B2Bi_shared_directory>/data/system/<host_name>/portinfo.cfg.

    If you require additional porter pool ports (for example for integration engine HME processing engines or other tasks) you can add them, using the following steps.

    1. Add new entries in the portinfo.cfg file. For example:
    2. Integratorpool301=9201

      Integratorpool302=9202

      Integratorpool303=9203

      Integratorpool304=9204

      Integratorpool305=9205

      Integratorpool306=9206

      Integratorpool307=9207

      Integratorpool308=9208

      Integratorpool309=9209

      Integratorpool310=9210

      Integratorpool311=9211

    3. Run the B2Bi Server installer in configure mode.
    Caution   For this port allocation modification:
    • Select only the Axway Integrator and Axway B2Bi Server options in the installer. Do not select the "Axway Interchange" option in this screen.
    • On the Port Range Allocation page, do not select the option, Configure Port Range. If you select this option your portinfo.cfg modifications will be lost.
    • Do not assign ports from the server's ephemeral range. The use of ports in this range may cause tasks to stop and attempt to restart, with the error "failed to bind socket: Address already in use".

    Manage Client/Server connections

    Several of the applications of the B2Bi Client environment require connections to the B2Bi Server environment. For example, Mapping Services connects to the B2Bi Server to deploy map containers, and Integration Services connects to deploy flow configurations.

    Do you have a firewall

    If you have a firewall in place between the B2Bi Client and B2Bi Server environment, you must configure the firewall to specifically allow access to the ports discussed in this topic.

    Default port integration engine allocations

    The following table lists the default ports that the B2Bi Server installer allocates for server access and that you need to know for B2Bi Client application connections. Keep in mind that the defaults may be changed for any of the following reasons:

    • The default ports may be occupied by another application before the installation or upgrade of B2Bi Server.
    • An alternative port range for the B2Bi Server Integration Engine ports may have been selected during the installation, or by running the installer in configure mode.
    • A B2Bi Server administrator may have manually changed some port allocations.
    Client tool Port name in portinfo.cfg Default
    Mapping Services
    • Integratorbroadcastagent
    • Integratormdimporter
    • Integratordmsimulator
    • 8844
    • 8842
    • 8846
    B2Bi Client tools interface
    • Integratorsysman
    • Integratorsysmanpool1
    • Integratorsysmanpool2
    • Integratorsysmanpool3
    • 8837
    • 8838
    • 8839
    • 8840
    B2Bi Integration Services
    • Integratorbroadcastagent
    • Integratorb2bidplserver
    • 8844
    • 8865

    The B2Bi Client System Profile Manager connects to the B2Bi Server Integration Engine to exchange information on Integration Engine tasks. The connection ports for these exchanges must be specified from the System Profile Manager user interface using values that are indicated in the following table:

    Integration Engine Task Enter port value...
    Map Service Task

    Enter Integratorb2bimapservice

  • When you enter this value, the Map Service Task uses the Integratorb2bimapservice port value that is registered in the portinfo.cfg file.
  • MFP Task

    Enter Integratorb2bmfpserver

  • When you enter this value, the MFP Server Task uses the Integratorb2bmfpserver port value that is registered in the portinfo.cfg file.
  • Get integration engine port allocation information

    Consult with the B2Bi Server administrator to identify the values attributed to the B2Bi Server ports you need for access. The list of B2Bi Server integration engine port allocations can be found in the portinfo.cfg file located in <B2Bi_shared_directory>/data/system/<host_name>.

    Resolve port conflicts

    In some cases, another application installed on your platform may take over a port that has been assigned to the B2Bi Server, creating operational issues for B2Bi.

    To resolve this type of port conflict there are two options:

    Option 1: Run the B2Bi Server installer in configure mode

    Procedure:

    1. Stop B2Bi.
    2. Start the B2Bi Server installer in configure mode.
    3. On the Select products page, select the B2Bi products to configure. For port range modification, select only the Axway Integrator and Axway B2Bi Server options. Do not select the "Axway Interchange" option in this screen.
    4. On the Port Range Allocation page, select the option, Configure Port Range.
    5. Enter minimum and maximum port range values that provide a sufficient number of free ports. Then complete the configuration sequence by paging through the configuration and clicking Configure.
    6. Restart B2Bi.

    Result: When you run this configuration modification, the B2Bi Server installer shifts the port allocation range, avoiding any ports in the selected range that are currently occupied by other applications. Every time the installer encounters an occupied port, it shifts the subsequent B2Bi Server port allocations upwards.

    Option 2: Manually modify port allocations in portinfo.cfg

    1. Stop B2Bi.
    2. Go to <B2Bi_shared_directory>/data/system/<host_name> and open portinfo.cfg in a text editor.
    3. Manually set the port values to the preferred values.
    4. Do not assign ports from the server's ephemeral range. The use of ports in this range may cause tasks to stop and attempt to restart, with the error "failed to bind socket: Address already in use.
    5. If you modified any of the following port allocations in portinfo.cfg, you must run the B2Bi Server installer in configure mode without selecting the Configure Port Range option:
      • Integratorcsrestservice
      • Integratorcsclusterservice
      • Integratorcsinternallcomm
      • Integratorcsbackupservice
    6. If you modified any of the following port allocations in portinfo.cfg, you must stop B2Bi, add the modified ports to <B2Bi_shared_directory>\data\system\b2bi.properties and restart B2Bi:
      • Integratorcfgserver
      • Integratortracer
      • Integratormdimporter

    Related Links