SIP Entity Details field descriptions for Non-Session Manager SIP Entity types

Last Updated : Sep 22, 2022 |
The following tables contain the SIP Entity field descriptions for a Non-Session Manager SIP Entity.
Note:
Not all fields are applicable to all SIP Entity types.
Prolog information
Metadata
Keywords:

General

Name
Description
Name
SIP Entity name. The name must be unique and have between 3 and 64 characters.
IP Address Family
Depending on the IP Address Family that you select, the system displays:
  • For IPv4 IP address family: FQDN or IPv4 Address field.
  • For IPv6 IP address family: FQDN or IPv6 Address field.
  • For Both address family: FQDN or IPv4 Address and FQDN or IPv6 Address fields.
    For SIP entities other than Session Manager, if the FQDNs for IPv4 and IPv6 are separate, specify both fields with the corresponding IPv4 and IPv6 FQDNs.
    If one FQDN resolves to IPv4 and IPv6 addresses, fill the FQDN or IPv4 Address field. You can leave the FQDN or IPv6 Address field blank.
    For Session Manager SIP entities, specify only IP addresses.
Tolerance
Specifies tolerance for IPv4 and IPv6 addresses.
System Manager displays this field for all non-Session Manager SIP entities.
The system uses the address family of the connection and the tolerance level of the peer element to determine the SIP signaling constraints. Tolerance level defines the interworking function behavior of the SIP entity. If the SIP entity is non-IP tolerant, and the SIP message contains the opposite IP address family of the connection, Session Manager does one of the following:
  • Removes the IP address of the opposite address family from the message.
  • Shifts the IP address to parameters.
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. The SIP identity certificate is 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.
  • Set this field to allow SIP connections that send FQDN instead of the IP address of the Security_Module_SIP interface in the Route header.
FQDN or IPv4 Address
The fully qualified domain name or IPv4 address of the SIP Entity.
  • exampledomain.com
Other:
System Manager validates the FQDN for its correct format but does not check the existence of the specified domain name.
FQDN or IPv6 Address
The fully qualified domain name or IPv6 address of the SIP Entity.
  • exampledomain.com
This field is only required if the FQDNs for IPv4 and IPv6 addresses are separate. Specify both fields with the corresponding IPv4 and IPv6 FQDNs.
Other:
System Manager validates the FQDN for its correct format but does not check the existence of the specified domain name.
Type
Non-Session Manager type SIP Entity, such as Communication Manager, SIP trunk, or a gateway.
Note:
  • You can select the SIP Entity type as ELIN Server. This is used by third-party E911 services, which determine a user’s location based on IP address, to send the new ELIN to the Session Manager for an emergency call. The SIP Entity selected as the ELIN server should be resolved through local hostname resolution to use the primary or secondary IP address.
  • You can select SIP Entity type as Survivability Server for a B5800 Branch Gateway (or Advanced Gateway/Secure Routers and other non-PPM capable devices) for providing local 96xx/96x1 SIP survivability.
Notes
Notes about the SIP Entity.
Adaptation
Assigned adaptation.
From software release 8.0.1, you can administer multiple adaptations for a SIP Entity.
The Adaptation field is disabled when the Flexible Routing feature is enabled.
When Flexible Routing is disabled, you can use the Adaptations section to assign multiple adaptations to the SIP Entity of digit and regexp adaptation types.
Note:
Only the Name field can be edited in the Adaptations section. The additional fields are read-only and provide context to what the adapter does when ordering.
Location
The SIP Entity location. Select from a list of previously defined locations.
Time Zone
The default time zone to be used for the entity.
SIP Timer B/F (in seconds)
Amount of time the Session Manager waits for the response from the SIP Entity. The range is 1–32. The default value is 4 seconds.
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 blank 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.
  • To verify that a specific string or SIP Entity FQDN is present within the SIP Entity identity certificate, enter the string or SIP Entity FQDN using the regular expression syntax.
  • 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. Some examples are:
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.
Securable
A securable SIP Entity is one that the administrator believes does not expose the signaling and media streams of a call to unauthorized monitoring or modification. If a SIP Entity does not meet the constraints imposed on the Secured SIP entities, the SIP Entity is considered unsecured even if it is administratively marked securable.
Call Detail Recording
Call Detail Recording (CDR) settings.
If CDR is enabled on a Session Manager, a CDR record is generated for a call originating from a non-Session Manager SIP Entity depending on the following settings:
  • none: CDR is not generated for the calls involving the entity.
  • ingress: CDR is generated only for calls from the entity.
  • egress: CDR is generated only for calls to the entity.
  • both: CDR is generated for calls to or from the entity.
If two entities are involved in a call, the CDR settings are combined to determine whether a record should be generated. For instance, if the Session Manager routes a call from entity1 to entity2, and the CDR setting of entity1 is none but the CDR setting of entity2 is ingress or both then a record is generated.
CDRs are captured under the /data/home/CDR_User/ directory.
CommProfile Type Preference
This field is visible for the SIP Entity type Other only and displays a list of all the administered CommProfile types that can be used with this SIP Entity type.

Adaptations

Name
Description
Order
Click the arrows next to the Order field to define the execution order of the adapters. The ordering is based on ingress and egress administration for each adapter.
Name
Displays the name of the assigned adaptation.
Module Name
Displays the module name.
State
The state of the adaptation.
The options are:
  • Enabled
  • Disabled
  • Test-only
Type
Displays the adaptation type.
Note
Displays any note provided while creating a digit or regex adaptation.

Loop Detection

Name
Description
Loop Detection Mode
The default value is On.
The On value activates Loop Detection monitoring for all the Entity Links associated with the SIP Entity.
The Off value deactivates Loop Detection monitoring for all the Entity Links associated with the SIP Entity.
The Test Only value allows the administrator to test and change the settings without rejecting the live calls.
Loop Count Threshold
The default value is 5. The allowed range is 2 to 10,000.
Loop Detection Interval (in msec)
The default value is 200 milliseconds. The allowed range is 10 to 10,000 milliseconds.

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.
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 if no outages are detected. A value between 1 and 9000 seconds is required. The default value 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 seconds is required. The default value is 120 seconds.
Number of Tries
Specifies the number of times the Session Manager polls a SIP Entity before the SIP Entity is considered unreachable. A value between 0 and 15 is required. The default is 1.
Number of Successes
Specifies the number of times the Session Manager polls a SIP Entity before the SIP Entity is considered reachable. A value between 0 and 15 is required. The default 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 on the Session Manager Administration page.
  • SIP Link Monitoring on the SIP Entity Details page.
Important:
CRLF must not be enabled for Communication Manager type of SIP Entity.
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.
CRLF Ping Interval (in seconds)
Specifies the ping interval between 1 and 900 seconds. The default value of the ping interval is 120 seconds.
Supports Call Admission Control
Enable or disable CAC management for the SIP Entity. If enabled, the Session Manager does not perform CAC on outgoing calls.
Shared Bandwidth Manager
Enable or disable the Shared Bandwidth attribute for this SIP Entity. If you select this option, you must also specify one or two Session Manager instances that support the PUBLISH API to this SIP Entity.
Primary Session Manager Bandwidth Association
Primary Session Manager instances that support the PUBLISH API to this SIP Entity.
Backup Session Manager Bandwidth Association
Backup Session Manager instances that support the PUBLISH API to this SIP Entity, if the primary fails.

Entity Links

Name
Description
Override Port & Transport with DNS SRV
Select this option to override Local Host Name Resolution or DNS routing.
  • If you select this option, the transport and port information is determined using DNS information. You must administer entity links for each transport protocol used to connect to or from the remote entity.
  • If you do not select this option, the transport and port information is determined using the data administered in the Entity Link table. However, FQDNs are resolved to IP addresses using a DNS server and the Local Hostname Resolution table entries, and only the port and transport data is derived from the Entity Link table.
Button
Description
Add
Add the selected entity link.
Remove
Remove 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.
Protocol
Protocol to use for the entity link. The options are:
Port
Port to use for SIP Entity 1. The range is 1 to 65535.
SIP Entity 2
Select a SIP Entity from the list.
Port
Port to use for SIP Entity 2. The range is 1 to 65535.
Note:
If you select the Override Port & Transport with DNS SRV option, the port identified in the DNS SRV or LHNR is used.
IP Address Family
The IP address family type of the entity link.
The options are:
  • IPv4
  • IPv6
Connection Policy
Specifies the policy to use for the entity link.
  • Trusted.
  • Trusted HA: connection policy for high availability clustered hosts such as Avaya Aura® Contact Center. This policy 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.
Deny New Service
Deny new service for the associated entity link.

SIP Responses to an OPTIONS Request

Button
Description
Add
Add SIP responses that signify whether the SIP Entity is up or down.
Remove
Remove the selected SIP response.
Name
Description
Response Code & Reason Phrase
SIP response code and optional reason code signifying that the SIP Entity is up or down.
Mark Entity Up/Down
Mark the SIP Entity as up or down when it responds to an OPTIONS request according to the administered Response Code & Reason Phrase.
Notes
Optional notes about the responses.
Button
Description
Commit
Save the SIP Entity and distribute the information to the Session Manager instances in the enterprise.
Cancel
Cancel the creation or modification of the SIP Entity.