Start/notes.ini Parameters/Server_Cluster_Auxiliary_Ports

Server_Cluster_Auxiliary_Ports

Parameter: Server_Cluster_Auxiliary_Ports
Short description: Additional NRPC ports used in the cluster if the primary port set via Server_Cluster_Default_Port is not reachable.

Profile

Parameter
Server_Cluster_Auxiliary_Ports
Syntax
Server_Cluster_Auxiliary_Ports=<portname> or * or comma-separated list
Default
Empty (no auxiliary port; only Server_Cluster_Default_Port is used)
Scope
Domino server (cluster member)
Category
Cluster
GUI equivalent
NOTES.INI Settings tab in the Configuration document
Related
Server_Cluster_Default_Port (primary port for cluster replication)
Available since
9.0.1 (continuously in HCL docs)

Description

  • Works in tandem with Server_Cluster_Default_Port. When the latter is set, cluster replication is primarily restricted to that port; if it fails, the auxiliary ports defined here take over.
  • Three possible values according to the HCL docs:
    • empty → no auxiliary port; behavior matches a pure Server_Cluster_Default_Port configuration.
    • * → all available server ports are tried if the primary port is unreachable.
    • Comma-separated list → only the listed ports are tried in the given order.
  • Note from the HCL docs: if Server_Cluster_Default_Port is not defined, all ports are tried by default — Server_Cluster_Auxiliary_Ports then has no effect.
  • Only affects NRPC connections between cluster members.

Example

Server_Cluster_Default_Port=ClusterPort Server_Cluster_Auxiliary_Ports=TCPIP,TCPIP2
  • Cluster replication runs primarily over ClusterPort. If the port fails, TCPIP and TCPIP2 are tried in turn.
Server_Cluster_Default_Port=ClusterPort Server_Cluster_Auxiliary_Ports=*
  • Same as above, but on failure all active server ports are checked.

Notes

  • Useful on servers with a dedicated cluster port plus additional standard ports (TCPIP, TCPIP2, ...).
  • Set directly in NOTES.INI or via the NOTES.INI Settings tab in the Configuration document.
  • Works on all supported platforms.
  • The parameter only takes effect together with a configured Server_Cluster_Default_Port.

Sources (HCL Product Documentation)