Network Port Requirements
Lists the network port numbers and their respective protocols used by Workload XM and dependent services.
Protocols are defined as follows:
- UI Port (ui.port ), which serves the Workload XM user interface (UI) and communicates using HTTPS when TLS/SSL is enabled, otherwise it communicates using HTTP.
- API Port (api.port), which listens for REST calls to API-based servers. It communicates using HTTPS when TLS/SSL is enabled, otherwise it communications using HTTP.
- Metrics Port (webservice.port), which exposes an interface to the metrics that the Workload XM roles collect.
- GRPC Port (grpc.port), which listens for gRPC requests against the backend servers. This protocol is used for inter-role communication.
The following table lists the port numbers that must be enabled for Workload XM communication.
| Service | Web Port Number | gRCP Port Number |
|---|---|---|
| API Server | 12011, 12012 | |
| Databus API Server | 12021, 12022 | |
| Analytic Database Server | 12031 | 12032 |
| Baseline Server | 12041 | 12042 |
| Databus Server | 12051 | 12052 |
| Entities Server | 12061 | 12062 |
| Pipeline Server | 12071 | 12072 |
| Admin API Server | 12111 | 12112 |
The table below contains the complete list of services, protocols, and their default port number values.
| Service | UI Port (ui.port) | API Port (api.port) | Metrics Port (webservice.port) | gRPC Port (grpc.port) |
|---|---|---|---|---|
| Console Server | 12001 | |||
| API Server | 12012 | 12011 | ||
| Databus API Server | 12022 | 12021 | ||
| Analytic Database Server | 12031 | 12032 | ||
| Baseline Server | 12041 | 12042 | ||
| Databus Server | 12051 | 12051 | ||
| Entities Server | 12061 | 12062 | ||
| Pipelines Server | 12071 | 12072 | ||
| SDX Server | 12081 | 12082 | ||
| Admin API Server | 12111 | 12112 |
The following services are exposed service-wide:
- The Phoenix Query Server Port (phoenix.queryserver.port), which is the port for the Phoenix Query Server used by Workload XM.
- The Impala Daemon Port (impala.daemon.port), which is the port for the Impala Daemon used by Workload XM.
