Enterprise Analytics Ports

  • concept
    +
    Enterprise Analytics uses multiple TCP ports for communication between components and with Couchbase clients. You must leave these ports open to use Enterprise Analytics.

    Ports Listed by Communication Path

    The following table lists all port numbers, grouped by category of communication path.

    Table 1. All Enterprise Analytics Ports, Listed by Communication Path
    Communication Path Default Ports

    Node-local only

    Unencrypted: 9119, 21200, 21300

    Encrypted: 21250 [1], 21350 [2]

    Node-to-node

    Unencrypted: 4369, 8091, 9110-9118, 9120, 11209-11210, 21100

    Encrypted: 11206, 11207, 18091, 21150

    Client-to-node

    Unencrypted: 8091, 8095, 9123, 11210, 11280

    Encrypted: 18091, 18095, 11207

    Certain support and diagnostic requests might run against ports other than the administration port (8091). These requests execute locally on a node and do not require external access.

    Detailed Port Description

    The following table contains a detailed description of each port used by Enterprise Analytics.

    Table 2. All Enterprise Analytics Ports, Listed by Application
    Port name Default port number
    (unencrypted / encrypted)
    Description Node-to-node Client-to-node

    epmd [3]

    4369

    Erlang Port Mapper Daemon

    Yes

    No

    rest_port / ssl_rest_port

    8091 / 18091

    Cluster administration REST/HTTP traffic, including Enterprise Analytics Web Console

    Yes

    Yes

    cbas_http_port / cbas_ssl_port

    8095 / 18095

    Analytics Service REST/HTTP traffic

    No

    Yes

    cbas_admin_port

    9110

    Analytics Service

    Yes

    No

    cbas_cc_http_port

    9111

    Analytics Service

    Yes

    No

    cbas_cc_cluster_port

    9112

    Analytics Service

    Yes

    No

    cbas_cc_client_port

    9113

    Analytics Service

    Yes

    No

    cbas_cluster_port

    9115

    Analytics Service

    Yes

    No

    cbas_data_port

    9116

    Analytics Service

    Yes

    No

    cbas_result_port

    9117

    Analytics Service

    Yes

    No

    cbas_messaging_port

    9118

    Analytics Service

    Yes

    No

    cbas_auth_port

    9119

    Analytics Service

    (node-local only)

    No

    No

    cbas_replication_port

    9120

    Analytics Service

    Yes

    No

    prometheus_http_port

    9123

    Cluster management traffic and communication

    No

    Yes

    memcached_dedicated_port / memcached_dedicated_ssl_port

    11209 / 11206

    Memcached and ns_server. Used for important control-commands

    Yes

    No

    memcached_port / memcached_ssl_port

    11210 / 11207

    Memcached

    (SDK Cluster Topology & Auditing)

    Yes

    Yes

    memcached_prometheus

    11280

    Memcached

    No

    Yes

    Cluster Management Exchange

    21100 / 21150

    Cluster management traffic and communication

    Yes

    No

    Cluster Management Exchange [1]

    21200 / 21250

    Cluster management traffic and communication

    (node-local only)

    No

    No

    Cluster Management Exchange [2]

    21300 / 21350

    Cluster management traffic and communication

    (node-local only)

    No

    No

    Custom Port Mapping

    Most, but not all, port numbers used by Enterprise Analytics can be remapped from their defaults to fit the requirements of your network environment. See Table 2 for details about default ports and whether or not they can be remapped.

    Changing the port mappings requires a reset and reconfiguration of any Enterprise Analytics node.

    You should change port mappings at the time of initial node and cluster setup. The required reset and reconfiguration also deletes all data on the node.

    Change a Port Mapping

    1. Install Enterprise Analytics.

    2. Stop Enterprise Analytics.

    3. For most ports, you’ll need to edit the Enterprise Analytics static_config file. This file will be wherever you put the path to /opt/enterprise-analytics/etc/couchbase/static_config in a multi-node installation.

      vi /opt/enterprise-analytics/etc/couchbase/static_config

      If you’re remapping the CAPI port (8092 / 18092) you’ll need to edit the /opt/enterprise-analytics/etc/couchdb/default.d/capi.ini file and replace 8092 with the new port number.

    4. Add each custom port map entry on its own line, using the following format. Enclose the port name and number in braces ({}) and end each entry with a period (.):

      {port-name, port-number}.

      For example, to change the REST API port from 8091 to 9000, you would add the following line:

      {rest_port, 9000}.

      After you have added all of your custom port mappings, save the file and close your text editor.

    5. If you already configured Enterprise Analytics, you’ll need to delete the /opt/enterprise-analytics/var/lib/couchbase/config/config.dat file and files in the /opt/enterprise-analytics/var/lib/couchbase/config/chronicle/ directory to remove the old configuration.

      rm -rf /opt/enterprise-analytics/var/lib/couchbase/config/config.dat
      rm -rf /opt/enterprise-analytics/var/lib/couchbase/config/chronicle/*
    6. Start Enterprise Analytics.

    If you do not give a custom mapping to ports in the static_config file, Enterprise Analytics automatically assigns defaults. See the default port mappings in Table 2.


    1. The Cluster Management Exchange encrypted port 21250 is reserved for future use.
    2. The Cluster Management Exchange encrypted port 21350 is reserved for future use.
    3. You cannot remap this port.