Add Session Manager page field descriptions

Last Updated : Apr 08, 2026 |

General

Name

Description

SIP Entity Name

The name of the SIP Entity that you are adding as a Session Manager instance. The entity must be of the Session Manager type and in the Sync state.

Description

The description of the SIP Entity. This field is optional.

Management Access Point FQDN/IP

The FQDN or IP address of the management agent of Session Manager.

The Management Access Point FQDN/IP field accepts only IPv4 addresses even when you create Session Manager instances for entities supporting IPv6 or Both address families.

Direct Routing to Endpoints

The field to assign routing directly to endpoints.

Avaya Aura Device Services Server Pairing

The list of AADS Server to pair a Session Manager instance with an AADS node.

Note:

AADS is available only with Avaya Workplace Client 3.0.

Maintenance Mode

The maintenance mode of a Session Manager instance.

Note:

If Maintenance Mode is selected for a Session Manager instance earlier than 7.0, the Session Manager instance is in the Deny New Service state.

Security Module

Name

Description

SIP Entity IP Address

The IP address of Session Manager as specified on the SIP Entity Details page.

The system displays this field only when you select a SIP entity of address family type IPv4 or both IPv4 and IPv6.

SIP Entity IPv6 Address

The IP address of Session Manager as specified on the SIP Entity Details page.

The system displays this field only when you select a SIP entity of address family type IPv6 or both IPv4 and IPv6.

Network Mask

The network mask value. The security module configures the network mask and defines the subnet associated with the security module.

The system displays this field only when you select a SIP entity of address family type IPv4 or both IPv4 and IPv6.

IPv6 Network prefix length

The network prefix length.

This field is displayed only when you select a SIP entity of address family type IPv6 or both IPv4 and IPv6.

Default Gateway

The IP address of the default gateway.

The system displays this field only when you select a SIP entity of address family type IPv4 or both IPv4 and IPv6.

IPv6 Default Gateway

The IP address of the default gateway.

The system displays this field only when you select a SIP entity of address family type IPv6 or both IPv4 and IPv6.

Call Control PHB

The type of service and priority for SIP traffic from the security module. All packets containing SIP signaling that leave the security module have the specified value in the differentiated service code point (DSCP) field of the IP header. Intervening routers can treat packets containing this value with a different level of precedence. The routers must support the type by default or be specially configured to do so.

Different DSCP values are specified in RFCs 2597 and 2598. To be consistent with Communication Manager, Session Manager uses a default DSCP value of 46 that indicates forwarding with the highest priority.

SIP Firewall Configuration

The SIP Firewall Configuration associated with the Session Manager instance.

NIC Bonding

Note:

The NIC Bonding section appears only if the system was administered using a Session Manager version earlier than 7.0, and NIC bonding was enabled.

The NIC Bonding section does not appear for:

  • New core Session Manager instances

  • Systems that were administered before Session Manager 7.0 without NIC bonding enabled

Name

Description

Enable Bonding

The NIC bonding bifurcates the interfaces eth2 and eth3 in a bond of interfaces. This ensures that all the Network firewall rules related to SM100 agent public IP Addresses are applied on the NIC bonding interface.

Driver Monitoring Mode

The ARP Monitoring or MII Monitoring as the modes of NIC bonding. The NIC bonding driver supports the modes.

ARP Interval (secs)

The ARP link monitoring frequency. The range is 50 to 1000. The default value is 100.

ARP Target IP

The IP target of the ARP request sent to determine the status of the link to the targets. You can configure up to 3 IP Addresses for ARP monitoring.

Link Monitoring Frequency (msecs)

The period of monitoring. The range is 50 to 500. The default value is 100.

Down Delay (msecs)

The wait time for disabling a slave when a link failure is detected. The value is a multiple of the link monitoring frequency value. The range is 50 to 1000. The default value is 200.

Up Delay (msecs)

The wait time for enabling a slave after a link recovery. The value is a multiple of the link monitoring frequency value. The range is 50 to 1000. The default value is 200.

Monitoring

Name

Description

Enable SIP Monitoring

The monitoring of the SIP entities administered to this Session Manager instance. Monitoring ensures that the entities are reachable.

Proactive cycle time (secs)

The time for polling the SIP entities administered to this Session Manager. Proactive monitoring occurs as long as no outages are detected. The default is 900 seconds. The default value is used for each administered SIP entity unless overridden by the Monitoring option on the SIP Entities page for a specific entity.

Reactive cycle time (secs)

The time for monitoring if an administered SIP entity is unreachable and detecting changes to a reactive mode. Reactive monitoring continues until the SIP entity responds again. The value for reactive monitoring must be less than the value for proactive monitoring. The default value is 120 seconds. The default value is used for each administered SIP entity unless overridden by the Monitoring option on the SIP Entities page for a specific entity.

Number of Tries

The number of times that Session Manager polls a SIP entity before the SIP entity is deemed unreachable. The default value is 1. Session Manager uses the default value for each administered SIP entity unless overridden by the Monitoring options on the SIP Entities page for a specific entity.

Number of Successes

The number of times that Session Manager polls a SIP entity before marking the SIP entity link active.

You can configure a value between 1 and 10. The default value is 1.

Enable CRLF Keep Alive Monitoring

The option to enable the monitoring of SIP entity links using CRLF pings. You must enable the following SIP monitoring fields before you enable the CRLF Keep Alive Monitoring mechanism:

  • Enable SIP Monitoring

  • SIP Link Monitoring on the SIP Entity Details page

When you select the checkbox, the Enable CRLF Keep Alive Monitoring option displays a list with the following options:

  • Use Session Manager Configuration: Uses the Session Manager configuration to determine whether to monitor SIP entity links. This is the default selection in the list.

    You can select this option only if SIP Link Monitoring on the SIP Entity Details page is configured to Use Session Manager Configuration or Link Monitoring Enabled.

  • CRLF Monitoring Enabled: Overrides the Session Manager configuration and uses the CRLF monitoring option to monitor SIP entity links.

    You can select this option only if SIP Link Monitoring on the SIP Entity Details page is configured to Link Monitoring Enabled.

  • CRLF Monitoring Disabled: Disables the CRLF-based monitoring of SIP entity links.

    You can select this option only if SIP Link Monitoring on the SIP Entity Details page is configured to Link Monitoring Enabled or Link Monitoring Disabled.

The Enable CRLF Keep Alive Monitoring option is disabled by default.

CRLF Ping Interval (secs)

The time that the Enable CRLF Keep Alive Monitoring option waits before pinging the SIP entity link again.

The default value is 120 seconds. You can set a value between 1 and 900 seconds.

CDR

Name

Description

Enable CDR

The CDR activation at the system level for the Session Manager instance. You can then use the Call Detail Recording menu to individually control call detail recording for specific SIP entities.

User

The user login name for CDR access.

Password

The password for CDR access.

An external CDR processing adjunct uses this password for connecting to Session Manager and to transferring generated CDR files.

Confirm Password

The confirmation of the password.

Data File Format

The format of the CDR data file.

The options are:

  • Standard Flat File (default): Applicable for Session Manager 6.3.4 and earlier releases.

  • Enhanced Flat File: Applicable for Session Manager 6.3.4 and later releases.

  • Enhanced XML File: Applicable for Session Manager 6.3.4 and later releases.

  • IPv6 Standard Flat File: Applicable for Session Manager 7.1.2 and later releases.

  • IPv6 Enhanced Flat File: Applicable for Session Manager 7.1.2 and later releases.

For URE calls, you must select the Enhanced Flat File or Enhanced XML File formats.

Include User to User Calls

The CDR records inclusion for user-to-user calls. User-to-user calls are SIP calls that originate and terminate at Session Manager instances that the same System Manager manages.

Include Incomplete Calls

The CDR records inclusion for one of the following types of incomplete calls:

  • Incoming or outgoing calls that are unanswered.

  • Incoming or outgoing calls that do not have enough media resources to complete the call.

  • Other incoming and outgoing calls not completed for other reasons.

  • At a SIP level, the call receives any non-2xx response to the initial INVITE associated with that call.

Do not Include Forwarded / Picked up Calls

Call Detail Records (CDRs) do not include the forwarded or answering extension.

Example call flow:

Extension 81437 dials 81433.

Extension 81433 has active call forwarding to 81430.

As a result, extension 81430 rings and answers the call.

During a call forwarding or call pickup event, the call connection continues within the original SIP dialog. Because Session Manager establishes only one SIP dialog for the entire call flow, it cannot differentiate between the originally dialed destination and the final answering destination.

As a result, Session Manager generates only one CDR entry. This entry reflects the original calling and dialed parties (81437 and 81433) but does not detect or log the final destination (81430).

To obtain complete call flow details, including information about all participating extensions such as forwarded-to numbers, see the Call Detail Recording details in the Avaya Aura® Communication Manager Feature Description and Implementation.

Personal Profile Manager (PPM) - Connection Settings

Note:

Session Manager supports a feature that indicates that Service Observe (SO) is assigned to the SIP endpoint. Registered users can activate the button.

Name

Description

Limited PPM client connection

The limited mode for the PPM client connection. The default value is Enabled.

Maximum Connection per PPM client

The maximum number of connections per PPM client. The valid values are integers between 1 and 10. The default value is 3.

PPM Packet Rate Limiting

The limiting value for the PPM packet rate. The default is Enabled.

PPM Packet Rate Limiting Threshold

The number of packets per second that the PPM connection transfers. This value is applied per PPM client. The range is 1 to 500. The default value is 200.

Event Server

Name

Description

Clear Subscription on Notification Failure

The option to remove the subscription or not when NOTIFY failures occur. The default value is No.

Alarming and Logging

Name

Description

Enable Load Factor Alarm Threshold Override

The option to enable overriding the global setting Load Factor Alarm Threshold value for the specific Session Manager.

Load Factor Alarm Threshold (80 - 150)

The factor after which Session Manager generates an alarm when a Session Manager profile exceeds its defined load factor.

Enable Syslog Server 1

The option to configure the first Syslog server.

Transport

The options are:

  • TCP

  • TLS Server Certificate Authentication

  • TLS Mutual Authentication

  • UDP

IP or FQDN

The FQDN or IP address of the remote Syslog server.

Port

The port of the remote Syslog server.

Enable Syslog Server 2

The option to configure the second Syslog server.

Enable Log Retention Override

The option to enable overriding of the global setting Log Retention time for the specific Session Manager.

Log Retention (days)

The number of days to retain the log.

Note:

This is a mandatory field and can accept the number of days from 1 - 180.

Button

Description

Cancel

Cancels the operation.

Commit

Saves the added SIP entity as a Session Manager instance with the selected configuration options.