Cluster Editor page field descriptions

Last Updated : Nov 11, 2025 |
When you click New or Edit on the Cluster Administration screen, the Cluster Editor screen opens. You can edit the cluster attributes only when all reachable nodes in the cluster are in the Deny New Service mode.
Prolog information
Metadata
Keywords:

General tab

Name
Description
Cluster Profile
The types of clusters. The options are:
  • Context Store: Product-specific cluster profile for Context Store Snap-in. This profile requires at least two Avaya Breeze® platform servers.
  • Core Platform: Closed cluster that supports up to 10 Avaya Breeze® platform servers. Snap-ins that might be installed on this cluster profile include Presence Services and Call Park and Page.
  • Engagement Assistant Speech: Product-specific cluster profile for Engagement Assistant Snap-in.
  • General Purpose: General purpose cluster profile. This profile requires at least one Avaya Breeze® platform server.
  • General Purpose Large: Open cluster that supports up to five Avaya Breeze® platform servers. This cluster profile mainly supports the Engagement Call Control solution.
  • Work Assignment: Deprecated. Do not use this option.
  • Customer Engagement: A cluster profile for Avaya contact center snap-ins. Use when instructed by the appropriate Avaya product installation guides.
Cluster Name
The unique name that you assign to the cluster.
The cluster name is case sensitive. You can create clusters with the same name but different casing.
Cluster Group
The cluster group number that you assign to the cluster. You can enter a value from 1 to 10.
This optional field is only used to configure attributes for multiple snap-ins.
Cluster IPv4
The unique IPv4 address assigned to the cluster. The IP address is used for HTTP load balancing. This field is mandatory if you select the Load balancer check box.
Leave this field blank for a single-node cluster.
Cluster IPv6
The unique IPv6 address assigned to the cluster. The IP address is used for HTTP load balancing. This field is mandatory if you select the Load balancer check box.
Leave this field blank for a single-node cluster.
Cluster Fully Qualified Domain Name
The unique FQDN that you assign to the cluster.
Enable Cluster Database
The check box to enable a cluster database.
Note:
You cannot clear the check box if snap-ins are installed on the cluster that require a cluster database.
Enable Database Auto Switchover
The check box to enable automatic switchover of clusters with two or more servers in a high availability database scenario.
If you do not select this check box, you must manually enable the standby server to take over whenever the active server is down.
Description
The cluster description.

Cluster Attributes

Name
Description
Pre-3.8.1 Cluster
Clear this attribute if the cluster has Avaya Breeze® platform R3.8.1 or later installed. Select this attribute only if the cluster has an earlier version of Avaya Breeze® platform installed.
Authorization Service Address
The FQDN or IP address of the cluster on which the Authorization Service is running.
Use secure connection for centralized logging
Check box to ensure that connections to the Centralized Logging destination are secure. This field is only available for the Customer Engagement profile.
Centralized logging destination
The destination for centralized logging: Breeze Cluster or External Server. This field is only available for the Customer Engagement profile.
Breeze cluster as destination for centralized logging
The Avaya Breeze® platform cluster on which you installed the centralized logging snap-in.
This field is only available for the Customer Engagement profile. Configure this field if you set Breeze Cluster as the value for Centralized logging destination.
External destination for centralized logging
The IP address or FQDN of the destination server on which you configured centralized logging.
This field is only available for the Customer Engagement profile. Configure this field if you set External Server as the value for Centralized logging destination.
Default SMS Connector Service
The default SMS connector when multiple SMS connectors are installed in a cluster.
You can override the default by creating an implicit user pattern that matches the sending SMS number and assigning an SMS connector to that implicit user.
The URL of the announcement to play during failover
The URL of the announcement that is played during a failover.
Additional Java options used by GSC
The additional Java options used by GSC. This option is only available for the Customer Engagement profile.
Grid Heap Size
The size of the grid heap. This option is only available for the Customer Engagement profile.
Grid Heap Size for LU
The size of the grid heap for LU. This option is only available for the Customer Engagement profile.
Grid LRMI Selector Threads
The grid LRMI selector threads. This option is only available for the Customer Engagement profile.
Grid Password
The internal grid password.
Cluster requires a grid
The check box to specify whether the cluster requires a grid.
This field is only available for the Core Platform profile.
When you edit this attribute, Avaya Breeze® platform displays the following warning message: Ensure that all Avaya Breeze® server restarts are complete before placing the cluster into Accept New Service state.
Use secure grid
The check box to secure grid communication.
Note:
Enabling or disabling Use secure grid:
After enabling or disabling Use secure grid, wait 10 minutes after committing the change before rebooting the cluster. A reboot is not required for this change to take effect. However, if you plan to reboot the cluster for other reasons, do not reboot immediately. The 10-minute wait allows internal reconfiguration to complete and ensures cluster stability.
Recovery in case of service inaccessibility:
If service URLs become inaccessible "404 – Not Found", even though System Manager shows the cluster as healthy, it indicates that the cluster was rebooted before the secure grid internal reconfiguration completed.
To recover:
  • Revert the Use secure grid setting in Cluster Editor.
  • A reboot is not required.
  • The cluster will recover automatically once the setting is reverted.
    For more information on using the Use secure grid communication option, see the solution documentation.
Grid Thread Stack Size
The size of the grid thread stack. This option is only available for the Customer Engagement profile.
Http or Https limit on connections per client
The maximum number of HTTP or HTTPS connections at a given time per client.
For General Purpose Large clusters, this value must be greater than 3.
Http or Https traffic rate limit in bytes/sec per client
The rate limit on the HTTP or HTTPS traffic served for each connection.
For General Purpose Large clusters, this value must be greater than 300,000 bytes for each second.
HTTP Load Balancer backend server max failure response timeout period (seconds)
The maximum timeout period of the failure response of the HTTP Load Balancer backend server. The default value is 15 seconds.
Max number of failure responses from HTTP Load Balancer backend server
The maximum number of failure responses from the HTTP Load Balancer backend server. The default value is 2.
Network connection timeout to HTTP Load Balancer backend server (seconds)
The network connection timeout period from the HTTP Load Balancer backend server. The default value is 10 seconds.
Only allow secure web communications
The check box to enable only HTTPS requests. By default, this check box is selected.
Hung Thread Detection Threshold (seconds)
Available only with the Customer Engagement cluster profile. Causes a Java core to be generated when a thread has been running longer than the administered value. The default value should be sufficient in most cases.  When an application causes a thread to be in use for a longer period of time, such as a complex database request, and the expected completion time is expected to be long, then changing this value will reduce or eliminate the Java Cores.  Increasing this value will mask any hung threads that would have been detected at a lower interval. Modification of this value requires a cluster reboot for the change to take effect.
Is load balancer enabled
The check box to enable load balancing for the cluster. Use load balancing if you want to scale the HTTP services without targeting a particular Avaya Breeze® platform server.
Is session affinity enabled
The check box to enable session affinity for the cluster. With session affinity, a particular client is always served by the same backend server.
Trusted addresses for converting to use X-Real-IP for session affinity
Trusted addresses that are known to send correct replacement addresses. With this, Avaya Breeze® platform load balancer can use the real client IP when an HTTP request traverses through reverse proxies such as Avaya Session Border Controller for Enterprise. The header that is used to identify the real client IP address is X-Real-IP.
Default call provider for Make Call
The call provider used for Make Call, a call that is initiated (Make Call) from an Avaya Breeze® platform snap-in. The default value is SIP, which corresponds to using SIP to connect to Avaya Aura® for call processing. If ZangCallConnector is loaded, you can install and use ZangCallConnector for making or initiating calls.
Default Identity for special make call cases
The default identity that is used for calls generating from Avaya Breeze® platform. If a user does not specify an identity, then Breeze uses the value in this field.
The maximum number of Avaya Breeze Servers allowed in Cluster
The maximum number of Avaya Breeze® platform servers that you can add to a cluster.
Media server monitoring period (seconds)
The period of polling. Each Avaya Aura® Media Server is periodically polled from each Avaya Breeze® platform that communicates with the Avaya Aura® Media Server to determine active status and normal function. When certain interactions with an Avaya Aura® Media Server are not functioning normally, the polling period is approximately 1/3 of this value.
Media server shuffle out timer (seconds)
The duration that Avaya Breeze® platform waits after all media operations are complete before shuffling Avaya Aura® Media Server out of the media path. All cluster profiles that support SIP call processing display this cluster attribute. The default value is 3 seconds.
Select AAMS by caller location - Priority 1
The check box to configure the cluster to select the Avaya Aura® Media Server based on the caller location as the first priority.
Select AAMS by Breeze server location - Priority 2
The check box to configure the cluster to select the Avaya Aura® Media Server based on the Avaya Breeze® platform location if the Select AAMS by caller location - Priority 1 criteria is not met or its check box is disabled.
Select any AAMS - Priority 3
The check box to configure the cluster to select the Avaya Aura® Media Server if the Select AAMS by caller location - Priority 1 and Select AAMS by Breeze server location - Priority 2 criteria are not met or their check boxes are disabled.
Avaya Aura® Media Server - Media Preservation Time (minutes)
The amount of time that Avaya Aura® Media Server should wait before terminating an audio or video stream after a failure is detected in the call signaling path.
Media IP version to retry in case of ANAT failure
Select an option from the drop-down list.
Retry IPv4 media in case of IPv6 failure
Check box to try IPv4 media if IPv6 fails.
Retry IPv6 media in case of IPv4 failure
Check box to try IPv6 media if IPv4 fails.
H.264 Video profile_idc
The H.264 video profile:
  • CB(Constrained Baseline profile-42)
  • H(High profile-64)
Avaya Aura® Media Server - User Id for RESTful TLS authentication
The user ID configured on the Avaya Aura® Media Server for basic authentication for REST signaling.
Avaya Aura® Media Server - Password for RESTful TLS authentication
The password configured on the Avaya Aura® Media Server for basic authentication of REST signaling.
Minimum TLS Version for Non-SIP Traffic
The TLS version that is used for incoming HTTP requests to Avaya Breeze® platform.
By default, Avaya Breeze® platform uses the value of the Minimum TLS version field set in the System Manager configuration.
  • If the value of the Minimum TLS Version field is TLSv1.1, Avaya Breeze® platform uses TLSv1.2.
  • If the value of the Minimum TLS Version field is SSLv3, Avaya Breeze® platform uses TLSv1.0.
Minimum TLS Version for SIP Call Traffic
The TLS version that is used for SIP calls intercepting Avaya Breeze® platform.
By default, Avaya Breeze® platform uses the value of the Minimum TLS version field set in the System Manager configuration.
  • If the value of the Minimum TLS Version field is TLSv1.1, Avaya Breeze® platform uses TLSv1.2.
  • If the value of the Minimum TLS Version field is SSLv3, Avaya Breeze® platform uses TLSv1.0.
Platform Space Container Heap Size (MB)
The size of the platform space container heap in MB. This option is only available for the Customer Engagement profile.
List of optional snap-ins including version
The list of optional snap-ins for a specific cluster profile type. The version of each optional snap-in is also included.
This attribute applies to the Core Platform and Work Assignment cluster profiles only.
List of required snap-ins including minimum version
The list of required snap-ins for a specific cluster profile type. The minimum required version of each snap-in is also included.
Reverse Proxy URL (protocol://FQDN) used to access the cluster
Use this field to specify the URL of a reverse proxy deployed in front of the Avaya Breeze® platform cluster. Login-related redirections from adopting services or snap-ins use the URL specified in this field instead of the default Avaya Breeze® platform cluster FQDN.
Currently, a limitation exists. When this field is configured, if a user attempts to log in using the cluster FQDN, further redirections are forced to happen through the proxy URL instead of the cluster FQDN.
Default SIP Domain
The default SIP domain for the cluster. If an Avaya Breeze® platform snap-in does not include a domain in the addresses that the snap-in sends to the Call Manipulation API, the snap-in appends this domain to the address.
Use secure signaling for platform initiated SIP calls
The check box to use secure signaling to initiate WebRTC Connect calls, calls from snap-ins to individuals for playing announcements, and for snap-ins that initiate two-party calls.
This attribute is not applicable for call intercept scenarios.
Preferred Minimum Session Refresh Interval (secs)
The minimum periodic refresh interval for the SIP session.
Use early pre-answer media?
The cluster attribute that defines the pre-answer media mode. Select the check box to use the Early pre-answer mode. Choose this setting to send a 183 session progress response in the early media phase.
If you do not select this check box, Avaya Breeze® platform selects the Connected pre-answer mode. This is the default setting. Connected setting sends a 200 OK SIP response in the early media phase.
This field is applicable for the General Purpose and General Purpose Large clusters only.
Use short replication interval?
The check box to use a short replication interval.
Work Flow Engine name
The name of the Engagement Designer snap-in Workflow Engine. This field is applicable only for the General Purpose cluster.
Limit on the memory (GB) to allocate for base processes
The field to set a limit on the memory allocated for base processes.
Note:
Do not change the value of this field unless recommended by snap-ins.
Percent of memory to allocate base processes
The percentage of memory to allocate for base processes.
Note:
Do not change the value of this field unless recommended by snap-ins.
Percent of memory to allocate for WAS
The percentage of memory to allocate for WAS.
Note:
Do not change the value of this field unless recommended by snap-ins.
Limit on the memory (GB) to allocate for WAS
The field to set a limit on the memory allocated for WAS.
Note:
Do not change the value of this field unless recommended by snap-ins.

Servers tab

This tab has the following columns in two tables: Assigned Servers and Unassigned Servers. When you add a server to a cluster, the system displays the server in the Assigned Servers table for that cluster.
Name
Description
Name
The name of the Avaya Breeze® platform server.
Version
The version of the Avaya Breeze® platform server.
Description
The description of the Avaya Breeze® platform server.

Services tab

Name
Description
Name
The name of the snap-in that might already be installed in a cluster, or available in the database.
Version
The snap-in version.
Action Pending
The actions that are pending for the snap-in. If no actions are pending, the system displays None.
Uninstall
If you select a snap-in and click Uninstall, then the snap-in is removed from the cluster after all activity ceases.
Force Uninstall
If you select a snap-in and click Force Uninstall, the snap-in is forcefully removed from the cluster without waiting to complete any pending actions.
TLS Version
The TLS version of the snap-in.
Button
Description
Select TLS Version for Selected Snap-in
Selects the TLS version of the snap-in. The acceptable values are:
  • Default
  • TLS v1.0
  • TLS v1.2
  • TLS v1.3
If you select Default, the Avaya Breeze® platform uses the the Minimum TLS Version field value set in the System Manager global configuration.
You can change the TLS version of multiple snap-ins at a time.

Reliable Eventing Groups tab

Name
Description
Group
The name of the Reliable Eventing group available in the database.
Button
Description
Commit
Adds the cluster or saves the changes to the cluster attributes.
Cancel
Cancels your action and displays the previous page.
Related links
Cluster administration field descriptions