Data privacy notice

 

When this content is loaded, usage information is transmitted to Vimeo and may be processed there.

 

             

Cluster properties

Modified on Fri, 14 Jul, 2023 at 2:20 PM

The file cluster.properties stores several settings related to clustering.

You should edit these settings via the user interface. Please note that some of these properties may be stored encrypted.


 Property Default value Encrypted Explanation
cluster.group.nameXFC-CLUSTERnoAn identifier for the cluster network.
cluster.node.name(generated from local inet address, time etc.)noAn identifier for the master server.
cluster.node.typeMASTERnoWhether this server is a master server or a backup (failover) server. Allowed values are MASTER and FAILOVER.
cluster.activefalsenoActivates or deactivates the cluster mode.
cluster.protocol.file(empty string)noPath to the file on the file system with a JGroups XML configuration.
cluster.protocol.typeUDPnoThe network protocol, either UDP or TCP.
cluster.config.extendedfalsenoWhether to apply the advanced settings (type of protocol and its configuration, eg. IP addresses and ports).
cluster.udp.bind.adr(local host address)noBind address when using UDP.
cluster.udp.bind.port7600noBind port when using UDP.
cluster.udp.external.usefalsenoWhether an external address and port is used for UDP.
cluster.udp.external.adr(same as cluster.udp.bind.adr)noThe external address when using UDP.
cluster.udp.external.port(same as cluster.udp.bind.port)noThe external port when using UDP.
cluster.udp.mcast.adr228.8.8.8noMulticast address when using UDP.
cluster.udp.mcast.port7600noMulticast port when using UDP.
cluster.tcp.bind.adr(local host address)noBind address when using TCP.
cluster.tcp.bind.port7600noBind port when using TCP.
cluster.tcp.external.usefalsenoWhether an external address and port is used for TCP.
cluster.tcp.external.adr(same as cluster.tcp.bind.adr)noExternal address when using TCP.
cluster.tcp.external.port(same as cluster.tcp.bind.port)noExternal port when using TCP.
cluster.tcp.initial.hosts(empty list)noFor discovering other cluster servers in the network. Required only when the protocol is set to TCP. A list of all expected cluster servers that are to be a part of the network. Multiple values are specified by using the same key on several lines. 
cluster.discovery.timeout0noThe number of milliseconds to wait for the connection to another server of the cluster to be established successfully. When set to 0, there is no timeout limit.
cluster.tcp.merge3.minInterval1000noFor TCP connections: minimum time in milliseconds before sending an info message to other member in the cluster. A cluster server periodically broadcasts its address and name to so that each server can discover the other servers in the cluster group. Must not be a negative number.
cluster.tcp.merge3.maxInterval30000noFor TCP connections: maximum time in milliseconds before sending an info message to other member in the cluster. AA cluster server periodically broadcasts its address and name to so that each server can discover the other servers in the cluster group. Must be a number greater than 0.
cluster.tcp.fdall.interval3000noFor TCP connections: Interval in milliseconds at which a HEARTBEAT is sent to other servers in the cluster. The cluster uses failure detection based on simple heartbeat protocol. Must be a number greater than 0.
cluster.tcp.fdall.timeout5000noFor TCP connections: Timeout in milliseconds after which a cluster server is suspected to be dead or not working anymore. Must not be a negative number.
cluster.tcp.gms.attempts6noFor TCP connections: When a server wishes to join a cluster, the number of join attempts before we give up and become a singleton. 0 means never give up.
cluster.tcp.gms.timeout10000noFor TCP connections: When a server wishes to join a cluster, the join timeout in milliseconds for a single join attempt. Must not be a negative number.
cluster.udp.merge3.minInterval1000noFor UDP connections: minimum time in milliseconds before sending an info message to other member in the cluster. A cluster server periodically broadcasts its address and name to so that each server can discover the other servers in the cluster group. Must not be a negative number.
cluster.udp.merge3.maxInterval30000noFor UDP connections: maximum time in milliseconds before sending an info message to other member in the cluster. A cluster server periodically broadcasts its address and name to so that each server can discover the other servers in the cluster group. Must be a number greater than 0.
cluster.udp.fdall.interval3000noFor UDP connections: Interval in milliseconds at which a HEARTBEAT is sent to other servers in the cluster. The cluster uses failure detection based on simple heartbeat protocol. Must be a number greater than 0.
cluster.udp.fdall.timeout5000noFor UDP connections: Timeout in milliseconds after which a cluster server is suspected to be dead or not working anymore. Must not be a negative number.
cluster.udp.gms.attempts6noFor UDP connections: When a server wishes to join a cluster, the number of join attempts before we give up and become a singleton. 0 means never give up.
cluster.udp.gms.timeout10000noFor TCP connections: When a server wishes to join a cluster, the join timeout in milliseconds for a single join attempt. Must not be a negative number.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article