System Manager key and value pair descriptions

Last Updated : Jan 22, 2025 |
Prolog information
Name
Description
CommunicationProfilePassword
Enter only numeric value for the communication profile password key.
There is no minimum or maximum limit of the numbers you can enter in the System Manager template, but there is a restriction when you reset password in Selfcare and Admin Portal.
CommunicationAddressDomain
Enter the communication address domain. This value is SIP domain configured on the System Manager routing domain section.
CommunicationAddressDomain_Presence
This field is mandatory if the presence profile is enabled.
PrimarySessionManager
Enter the name of Session Manager.
This key is the default access point for connecting devices associated with the communication profile to the Avaya Aura® network.
SecondarySessionManager
Enter the name of Session Manager.
If you add a secondary Session Manager, Session Manager provides continued service to SIP devices associated with the communication profile when the primary Session Manager is unavailable.
ThirdSessionManager
Enter the name of Session Manager.
When the primary or secondary Session Manager server becomes unavailable, the third Session Manager provides continued service to SIP devices associated with the communication profile.
This key is optional.
FourthSessionManager
Enter the name of Session Manager.
When the primary, secondary, or third Session Manager server becomes unavailable, the fourth Session Manager provides continued service to SIP devices associated with the communication profile.
This key is optional.
SurvivabilityServer
Specify the name of a survivability server, a SIP entity, only if the setup has an edge friendly gateway with the survivable server installed. When you enter the name of a survivability server, it provides survivability communication services for devices associated with a communication profile if the local connectivity to Session Manager instances in Aura is lost.
This key is optional.
BlockNewRegistrationWhenMaxActive
Select a value. The default value is no.
If you select yes and if an endpoint tries to register using the communication profile after the maximum number of allowed simultaneous registrations, the endpoint cannot register with Session Manager. The endpoint does not have the SIP service.
If you select no, the endpoint can register only after Session Manager cancels the registration of the oldest endpoint. The stopped endpoint does not have the SIP service.
This field is optional.
OriginationAppSequence
Enter the default value of the origination application sequence. It is an application sequence invoked when calls are routed from this user.
If you enter an origination application sequence, and if each sequence contains a Communication Manager application,Communication Manager must be the same in both the sequences.
TerminationAppSequence
Enter the default value of the termination application sequence. If you enter the termination application sequence, and if each sequence contains a Communication Manager application, Communication Manager must be the same in both the sequences.
HomeLocation
Enter the home location value that you want to configure.
When you call numbers that are not associated with an administered user, dial-plan rules that are set in System Manager are applied to complete the call based on this home location regardless of the physical location of the SIP device used to make the call.
ConferenceFactorySet
Enter the conference factory set value.
The conference factory set to enable media capability-based call routing to the conferencing SIP entities.
This key is optional.
EnableCentralizedCallLog
Select a value to enable call logs centralized.
The devices registered in MDA mode are able to view the full history irrespective of the device the call was made from.
This key is optional.
CMName
Enter the name of Communication Manager.
CMTemplateName
Enter Communication Manager template name.
The template name is used to create the endpoint. Communication Manager uses the values defined in the template if you do not provide other values.
SetType
Enter the set type of the endpoint.
Configure value based on the value configured in CMTemplateName.
SecurityCode
Enter a numeric value as the security code for authorized access to the endpoint.
VoiceMailNumber
Enter the default voicemail number.
EnhCallrInfodisplay
The Enhanced Callr-Info Display check box is used for 1- line display phone.
This key is optional.
DeleteOnUnassign
Select a value.
Select Yes to delete the endpoint if it is unassigned.
OverRideEndpointName
Select a value.
Select Yes to override endpoint name on Communication Manager with the value configured in System Manager during synchronization.
Select No to not override the endpoint name on Communication Manager with the name configured in System Manager during synchronization.
System
The value of system is the Presence SIP Entity configured on System Manager Routing SIP Entity section.
This key is mandatory if the presence profile is enabled.
ImGatewaySipEntity
Enter the ImGatewaySipEntity value.
The Presence Services instance for the user. This key is mandatory if the presence profile is enabled.
PublishViaAEsCollector
Select System Default.
This key is mandatory if Presence profile is enabled.
CMPort
The Communication Manager port is automatically populated when a station is created for SIP phones and on the set type selection.
This key is optional.
PreferredHandle
By default Admin Portal sets extension@communicationAddress as a PreferredHandle.
PrimaryFixedRegion
Enter the name of region only if Policy Based Session Manager is enabled and SessionManagerPolicyType is fixed-region.
When you specify the fixed-region, this field indicates the primary region of the Session Manager server.
SecondaryFixedRegion
Enter the name of region only if Policy Based Session Manager is enabled and SessionManagerPolicyType is fixed-region.
When you specify the fixed-region, this field indicates the secondary region of the Session Manager server.
This key is optional.
ThirdFixedRegion
Enter the name of region only if Policy Based Session Manager is enabled and SessionManagerPolicyType is fixed-region.
When you specify the fixed-region, this field indicates the third region of the Session Manager server.
This key is optional.
FourthFixedRegion
Enter the name of region only if policy based Session Manager is enabled and SessionManagerPolicyType is fixed-region.
When you specify the fixed-region, this key indicates the fourth region of the Session Manager server.
SessionManagerPolicyType
Enter the Session Manager policy type only if Policy Based Session Manager is enabled.
When you specify the fixed-region policy type, this field indicates the regions of the Session Manager server such as the primary, secondary, or third region.
This key is optional.
UserLoginDomain
Enter the user login domain name.
The unique login name given to the user. The login name format is . The login name creates your primary handle.
ThirdPartyClient
Admin Portal supports Avaya Aura® X for Zoom Workplace (ZOOM) and Avaya Cloud Office (ACO) features.
You can select the following third-party client name:
  • Avaya Cloud Office
  • Zoom Workplace