SIP Entity Details - Session Manager type field descriptions

Last Updated : Oct 04, 2023 |

Use this page to specify SIP entity details for the Session Manager type SIP entity.

General

Name

Description

Name

The SIP entity name. This name must be unique and can have between 3 and 64 characters.

IP Address Family

Depending on the IP Address Family you select,System Manager displays the following:

  • For IPv4 IP address family: IPv4 Address field.

  • For IPv6 IP address family: IPv6 Address field.

  • For Both address family: IPv4 Address and IPv6 Address fields.

    For Session Manager SIP entities, specify only IP addresses.

IPv4 Address

IPv4 address of the SIP entity

IPv6 Address

IPv6 address of the SIP entity

SIP FQDN

The Fully qualified domain name of the SIP entity.

Note:

  • It should resolve to the IP address of the Security_Module_SIP interface.

  • This FQDN should match with the Subject Alternative Name field of Session Manager SIP identity certificate under Inventory > Manage Elements > Manage Identity Certificates on the System Manager web console.

  • This field is optional and used for extended hostname validation. If provisioned, the endpoint would receive this value in the sipFqdn field in response to the PPM getHomeCapabilities request. When an endpoint establishes a TLS connection, it uses the field value to match it against the hostname provided in the Subject Alternative Name field of the Session Manager SIP identity certificate.

  • This field needs to be set in order to allow SIP connections that send FQDN instead of IP address of the Security_Module_SIP interface in the Route header.

Type

Session Manager type SIP entity.

Network Topology

If Enable Edge Topology is enabled on the Global Settings page and SIP Entity is of type Session Manager, SIP Trunk, Other, or Service Provider, Session Manager displays the Network Topology field.

Specifies the type of the Session Manager or Branch Session Manager edge topology configuration.

If SIP Entity is of type Session Manager, Session Manager displays the following options:

  • Enterprise: Specifies the entity is part of the enterprise or core network. This is the default value.

  • Edge Core: Specifies the entity is part of the enterprise or core network and also has an interface to establish connections with Edge Branch SIP entities using Session Border Controller. When you select Edge Core, Session Manager displays the SBC Public IP Address or FQDN field.

  • Edge Branch: Identifies the entity is part of a branch or private network and also has an interface to establish connections with Edge Core SIP entities using Session Border Controller. When you select Edge Branch, Session Manager displays the SBC Private IP Address or FQDN field.

If SIP Entity is of type SIP Trunk, Other, or Service Provider, Session Manager displays the following options:

  • Enterprise: Specifies the entity is part of the enterprise or core network. This is the default value.

  • Branch: Specifies the entity is part of a branch or private network. A Branch topology SIP entity can only be directly connected to a Branch Session Manager instance and not to any core Session Manager instance.

SBC Public IP Address or FQDN

The public IP address or public FQDN of Session Border Controller.

SBC Private IP Address or FQDN

The private IP address or private FQDN of Session Border Controller.

Notes

Additional notes about the SIP entity.

Location

The SIP entity location.

Outbound Proxy

The outbound proxy if the entity type is Session Manager and you want to specify a proxy.

Note:

In cases when Session Manager cannot associate with any administered routing policies, the request is sent to the SIP entity administered as an outbound proxy. If no outbound proxy is provisioned, Session Manager will proxy the request on its own.

Time Zone

The default time zone to be used for the entity.

Minimum TLS Version

Minimum allowed TLS versions for the SIP entity. The options are:

  • Use Global Setting

  • 1.0

  • 1.1

  • 1.2

  • 1.3

The default option is Use Global Setting.

Credential name

The credential name is used for TLS connection validation by searching for this string in the SIP entity identity certificate.

  • Leave this field empty if you do not want to perform the additional validation on the SIP entity identity certificate or are not using SIP TLS for connecting to the SIP entity.

  • If you want to verify that a specific string or SIP entity FQDN is present within the SIP entity identity certificate, enter that string or SIP entity FQDN using the regular expression syntax.

  • If you want to verify that the SIP entity IP address is present within the SIP entity identity certificate, enter the SIP entity IP address using the regular expression syntax.

Note:

The IP Address is searched by default when any string is configured in the Credential Name.

The credential name is a regular expression string and follows Perl version 5.8 syntax. For example:

For www.sipentity.domain.com, enter the string www\.sipentity\.domain\.com.

For 192.14.11.22, enter the string 192\.14\.11\.22. You can search for a subset of the string or create a wild card search. For example, to look for domain.com as a substring, enter the string domain\.com.

Monitoring

Name

Description

SIP Link Monitoring

Selects the process for SIP Link monitoring.

The options are:

  • Use Session Manager Configuration: If you choose this option, SIP monitoring parameters defined on the Session Manager Administration page of the monitoring Session Manager is applied.

  • Link Monitoring Enabled: When you click this option, System Manager displays the following fields: Proactive Monitoring Interval (in seconds), Reactive Monitoring Interval (in seconds), Number of Tries, and Number of Successes. Use this option to override the SIP monitoring parameters defined on the Session Manager Administration page of the monitoring Session Manager.

  • Link Monitoring Disabled.

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 on the Session Manager Administration page.

  • SIP Link Monitoring on the SIP Entity Details page.

When you select the Enable CRLF Keep Alive Monitoring option, System Manager 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.

Proactive Monitoring Interval (in seconds)

Session Manager uses this value for polling the administered SIP entities. Monitoring ensures that the entities are still reachable. Proactive monitoring occurs as long as no outages are detected. A value between 1 and 9000 is required. The default is 900 seconds.

Reactive Monitoring Interval (in seconds)

This value is used when proactive monitoring detects that an administered SIP entity is not reachable and changes to a reactive mode. Reactive monitoring continues till the SIP entity responds again. Typically, the value for reactive monitoring should be less than the value for proactive monitoring. A value between 1 and 900 is required. The default is 120 seconds.

Number of Tries

Specifies the number of times Session Manager polls a SIP entity before the SIP entity link is deemed down. A value between 0 and 15 is required. The default is 1. This parameter applies to proactive monitoring.

Number of Successes

Specifies the number of times Session Manager polls a SIP entity before the SIP entity link is deemed up. A value between 0 and 15 is required. The default is 1. This parameter applies to reactive monitoring.

CRLF Ping Interval (in seconds)

Specifies the ping interval between 1 and 900 seconds. The default value of the ping interval is 120 seconds.

Entity Links

Button

Description

Add

Adds the selected entity link.

Remove

Removes the selected entity link.

Name

Description

Name

System auto-populates this field based on the name specified on the SIP Entity Details General section.

SIP Entity 1

Select a SIP entity from the list. This entity must always be a Session Manager instance.

Protocol

The protocol to use for the entity link.

Port

The port to use for SIP entity 1. The default port for TCP and UDP is 5060. The default port for TLS is 5061.

SIP Entity 2

Select a SIP entity from the list. This entity need not be a Session Manager entity.

Port

The port to use for SIP entity 2.

IP Address Family

The address family type of the entity link.

The options are:

  • IPv4

  • IPv6

Connection Policy

Specifies the policy to use for the entity link. The choices are:

  • Trusted.

  • Trusted HA: Connection policy for high availability clustered hosts such as Avaya Aura® Contact Center. It is identical to the Trusted Connection Policy except that the TCP Keep Alive window value is 3 seconds.

  • Untrusted.

  • endpt conc: connection policy for the SIP Entities hosting endpoint concentrators.

Note:

The system should not use the global TLS policy for SIP when establishing connection policy for the SIP Entities hosting endpoint concentrators.

Deny New Service

Denies new service for the associated entity link.

Failover Ports

Session Manager permits assignment of failover group ports if the IP Address Family field is set to IPv6 or Both. If a failover group is already present for the primary and secondary Session Manager, you cannot change the IP address family of the related SIP entity.

Name

Description

IPv4 TCP Failover port

The TCP failover port of the SIP entity.

IPv4 TLS Failover port

The TLS failover port of the SIP entity.

Note:

  • Each Session Manager instance that becomes a failover group member, must designate one failover port per transport type that it supports. Far-end Session Manager instance and failover group peers use this port to forward all call preservation traffic to the Session Manager instance over the transport type.

  • If Session Manager is a member of a Failover group, then changing these port values results in automatically updating the SIP Entity 1 port value of any entity links that have this Session Manager as SIP Entity 1. The update ensures that the SIP Entity 1 port of the entity links matches the new value of TCP Failover port if the link has transport protocol TCP or the value of TLS Failover port if the transport protocol is TLS. These updates ensure the correct functioning of call preservation routing behavior.

IPv6 TCP Failover port

The TCP failover port of the SIP entity.

The IPv6 failover port must be between 1024 and 65535.

You cannot delete an IPv6 TCP failover port if a Session Manager is connected to a SIP entity which is part of a failover group.

IPv6 TLS Failover port

The TLS failover port of the SIP entity.

Note:

  • Each Session Manager instance that becomes a failover group member, must designate one failover port per transport type that it supports. Far-end Session Manager instance and failover group peers use this port to forward all call preservation traffic to the Session Manager instance over the transport type.

  • If Session Manager is a member of a Failover group, then changing these port values results in automatically updating the SIP Entity 1 port value of any entity links that have this Session Manager as SIP Entity 1. The update ensures that the SIP Entity 1 port of the entity links matches the new value of TCP Failover port if the link has transport protocol TCP or the value of TLS Failover port if the transport protocol is TLS. These updates ensure the correct functioning of call preservation routing behavior.

  • You cannot delete an IPv6 TLS failover port if a Session Manager is connected to the SIP entity which is part of a failover group.

Listen Ports

Button

Description

Add

Adds the selected port.

Remove

Removes the selected port.

Name

Description

Listen Ports

Adds a Session Manager listening port for each desired transport type and domain name for the endpoints in the customer network. Session Manager listens for endpoint connections (or datagrams in the case of UDP) on the ports administered in the Listen Ports field.

This field is also used for establishing the default domain name associated with incoming requests that contain an IP addresses (not domain) in the R-URI and P-Asserted-Identity headers. This default domain will be associated with such requests whether they originate from endpoints or SIP entities.

For security reasons, make sure to administer only those ports and transports that the SIP endpoints will connect within the customer network.

The IPv6 failover listen port and the listen port must not have different protocols on the same port number.

Note:

These ports are returned in redirection response (301/302) to SIP Register request or HTTP/PPM getHomeServer and getHomeCapabilities responses to the requests received from the SIP users, based on the domain in the incoming request.

Protocol

The protocol that the SIP entity uses. The options are:

  • TCP

  • TLS

  • UDP

Default Domain

The domain of the SIP entity.

Endpoint

The listen port for SIP endpoints.

Note:

You can select only one entry per transport protocol per domain as the endpoint listen port.

IP Address Family

The address family type of the listen port.

The options are:

  • IPv4

  • IPv6

  • Both

If the SIP Entity IP address family is IPv4 or IPv6, the IP Address Family field displays a default value of IPv4 or IPv6.

Notes

Additional notes about the port and port parameters.

SIP Responses to an OPTIONS Request

Button

Description

Add

Adds SIP responses that signify whether the SIP entity is up or down.

Remove

Removes the selected SIP response.

Name

Description

Response Code & Reason Phrase

Three-digit SIP response code and optional reason code signifying whether the SIP entity is up or down.

Mark Entity Up/Down

The up or down state of the SIP entity in response to an OPTIONS request as per the administered Response Code & Reason Phrase.

Notes

Additional notes about the responses.

Button

Description

Commit

Saves the SIP entity and distributes it to the Session Managers in the enterprise.

Cancel

Cancels the creation or modification of the SIP entity.