Add Branch Session Manager page field descriptions

Last Updated : Nov 27, 2023 |

General

Name

Description

SIP Entity Name

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

  • To add an enterprise Branch Session Manager instance, in SIP Entity Name, select the Branch Session Manager SIP entity.

  • To add an edge Branch Session Manager instance, in SIP Entity Name, select the edge Branch Session Manager SIP entity.

    When you select the edge Branch Session Manager SIP entity, Session Manager:

    • Renames Management Access Point FQDN/IP to Management Access Point FQDN.

    • Displays the Network Topology and Remote Access Configuration fields.

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 the enterprise Branch 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.

Management Access Point FQDN

The FQDN of the management interface of edge Branch Session Manager.

Main CM for LSP

Main Communication Manager for the SRS associated with this Branch Session Manager. The options are:

  • Refresh: Updates the list of Communication Manager systems.

  • View/Add CM Systems: Views or adds to the list of currently provisioned Communication Manager systems.

Direct Routing to Endpoints

The direct routing to endpoints.

Maintenance Mode

The maintenance mode of Branch Session Manager.

Adaptation for Trunk Gateway

The digit conversion of the SIP trunk to the Branch Session Manager. Branch Session Manager uses the selected adaptation for routing calls to or from the Communication Manager SRS trunk gateway.

Note:

For the Communication Manager Feature Server (CM-FS) or Communication Manager Trunk Gateway (CM-TG), the adaptation from the core CM-TG is used by default. The adaptation selection overrides the default CM-TG adaptation and applies to all calls routed on the trunk gateway entity to the SRS. For Communication Manager Evolution Server (CM-ES), the default adaptation is taken from the core Communication Manager entity. The adaptation applies to calls that are routed through the gateway to the SRS and also to calls that are application-sequenced.

Network Topology

Displays the following:

  • For enterprise Branch Session ManagerEnterprise.

  • For edge Branch Session ManagerEdge Branch.

Remote Access Configuration

The remote access configuration for the edge Branch Session Manager instance.

This field is not applicable for the enterprise Branch Session Manager instance.

Security Module

Name

Description

SIP Entity IP Address

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

Network Mask

The network mask of the domain name of the server that hosts the Branch Session Manager application. The network mask is passed to the security module. The agent configures the network mask to define the subnet that the security module is to be associated with.

Default Gateway

The IP address of the default gateway.

Call Control PHB

The field that specifies the SIP traffic type of service and priority as the SIP traffic travels through the IP network. All packets leaving the security module that contain SIP signaling have the specified value in the differentiated service code point (DSCP) field of the IP header. Intervening routers may or may not treat packets containing this value with a different level of precedence. The routers must either support differentiated service 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, Branch Session Manager uses a default DSCP value of 46. This value indicates forwarding with the highest priority.

SIP Firewall Configuration

The SIP Firewall Configuration associated with the Branch Session Manager instance.

Monitoring

Note:

Regardless of the administered settings, Branch Session Manager monitors the feature server entity avaya-lsp-fs every second. The monitoring settings are important because the system uses links for failover and failback procedures on Branch Session Manager. If an additional connection exists to the SRS for the trunk gateway, these administered monitoring settings also apply.

Button

Description

Enable Monitoring

The monitoring of the administered SIP entities associated with this Branch Session Manager instance.

Proactive cycle time (secs)

The time in seconds for polling the administered SIP entities associated with this Branch 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 in seconds for when proactive monitoring detects that an administered SIP entity is unreachable and 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 Retries

The number of times that the Branch Session Manager polls a SIP entity before the SIP entity is deemed unreachable. The default value is 1. The Branch 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.

Personal Profile Manager (PPM) - Connection Settings

During normal operation, Branch Session Manager receives data from Communication Manager feature server for synchronizing Avaya SIP endpoints.

Note:

Branch Session Manager supports a feature that indicates that the Service Observe (SO) button is assigned to the SIP endpoint. The button can be activated by a registered user.

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 will transfer. 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 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

Commit

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

Cancel

Cancels the changes.