This is the schema for the DAT configuration used in conjunction with the Template Wizard functionality in the UI.
Various settings can be overwritten here to customize the common policies created/re-used during creation.
If a setting description is not noted here, check the corresponding Configuration API OpenAPI schema document or the
Avaya Session Border Controller Administration Guide for more information. When in doubt, the Administration Guide
should be considered the most up to date information.
Note: All configuration fields are optional and will default to the default value defined in the Configuration API.
Check the Configuration API OpenAPI schema document for more information.
Changelog:
options section to customize TLS client profile for trunk server / remote worker.encryption definition.pAssertedIdentity/pPreferredIdentity.This is the schema version this DAT file conforms to.
This file defines the schema for version 1 of the DAT file spec, so this should be set to 1.
Specific value:1 General information about this DAT file.
No Additional PropertiesThe name of this DAT file. This is used as the default DAT name on import if no name is specified.
"Avaya Trunk"
An optional variant name for this DAT file.
"Standard"
An optional version for this DAT file.
1
An optional changelog for this DAT file.
"# 1.0\n** Added support for X feature\n** Added support for Y feature\n\n# 0.9\n** Added support for A feature\n** Added support for B feature\n"
Denotes how the media rules are set up for remote worker configurations. If enabled only one side of a call leg will use SRTP, otherwise both sides will use SRTP.
Customize the TLS CA certificate verification depth for this entity (trunk server or remote worker configuration).
Customize the TLS Cipher Suite used by the TLS client profile for this entity (trunk server or remote worker configuration).
If not provided, the default cipher suite is used (this varies depending on SBCE release).
General UI parameters including pre-populating certain fields.
No Additional PropertiesPre-populate fields associated with the DAT file (remote worker or trunk server).
No Additional PropertiesPre-populate trunk server parameters.
No Additional PropertiesValue used to pre-populate the server address associated with the trunk server.
Value used to pre-populate the server port associated with the trunk server.
Value used to pre-populate the transport associated with the trunk server.
Value used to pre-populate the TLS CA list associated with the trunk server.
Note: The DAT file does not support adding custom certificates and any CA certificates selected here must
already exist on the system.
A TLS CA certificate installed on the system.
Rule and profile information associated with this DAT file.
Note: While this property is required, none of the child properties are required.
This means that an empty configuration object is completely valid.
Denote this rule applies to video traffic entering the enterprise network.
Denote this rule applies to video traffic originating from within the enterprise network.
The maximum number of application sessions that can be active for an endpoint.
Additional application requests are blocked when this threshold is exceeded.
The maximum number of concurrent application sessions that can be active for the selected application type.
Additional application requests are blocked when this threshold is exceeded.
Denote this rule applies to audio traffic entering the enterprise network.
Denote this rule applies to audio traffic originating from within the enterprise network.
The maximum number of application sessions that can be active for an endpoint.
Additional application requests are blocked when this threshold is exceeded.
The maximum number of concurrent application sessions that can be active for the selected application type.
Additional application requests are blocked when this threshold is exceeded.
CDR option type applicable for the application rule.
The options for call duration are:
If true, the CDR file contains data about media statistics.
If true, RTCP Keep-Alive feature is enabled.
The most preferred encryption method for media traffic. Valid values are:
Note: Up to 3 values are allowed.
Indicates whether RTCP uses encryption.
MKI is the master key identifier. Specifies the master key of the SRTP session and is stored in the SRTP context.
You can derive other session keys from this master key after the lifetime expires.
Indicates whether media from encrypted endpoints can flow to unencrypted endpoints and vice versa.
Ensure this option is enabled for the media rules in both the endpoint flows.
Enable this setting unless you want to enforce end-to-end encryption.
Specifies the time interval after which session keys are generated. These keys are not passed in signaling.
Session keys are based on MKI. Currently, Avaya SBCE does not support the interworking of different lifetime values.
You can leave this field blank to match any value.
If true, codec prioritization will be enabled.
Force codecs to be prioritized according to the defined priority order.
Specifies that the media matched by this media rule must transcode traffic when possible.
Specifies that the media matched by this media rule must use transrating to reduce the bit rate of the media.
If true, codec prioritization will be enabled.
Force codecs to be prioritized according to the defined priority order.
Set the Media Silencing settings for this Media Rule.
No Additional PropertiesIndicates whether Avaya SBCE detects media packets from both legs of a call within the set time. If no media
packets are detected, Avaya SBCE sends an incident report to the Syslog, and the call is disconnected.
Indicates the period (in seconds) within which the media silencing feature processes media packets from both
legs of a call. If no media packets are detected in this period, Avaya SBCE sends an incident report to the
Syslog or the call is terminated.
Set the Alternate Network Address Types (ANAT) settings for this Media Rule.
No Additional PropertiesSpecifies whether ANAT semantics are enabled for SDP to permit alternate network addresses for media streams.
ANAT semantics are useful in environments with IPv4 and IPv6 hosts.
Specifies the order of preference for the ANAT IPv4 and Dual Stack.
Specifies that the remote party must be given ANAT preference to answer the 200 OK response offer,
irrespective of the ANAT preference configured on Avaya SBCE.
Indicates whether Binary Floor Control Protocol (BFCP) is used in a people and content telepresence scenario
to control the content channel. Content information is passed as a video stream and is controlled by the BFCP
channel. It enables the moderator to release floor control to participants and vice versa to give control of
the content channel to various participants. The system works on sending a token on the BFCP control
signaling. The moderator allows or denies the access to the token. Avaya SBCE can support one BFCP channel for
multiple video content channels.
Indicates whether Far End Camera Control (FECC) is enabled. It provides mixed encryption support for audio,
main video, and FECC . In the media path, using an RTP payload type sends control signaling to control the far
end camera. The FECC channel facilitates setting up the signaling for the media path, and control signals are
sent on this path using the RTP payload type of a particular codec type (H.224).
Enables support for Interactive Connectivity Establishment (ICE) used when connecting with Microsoft Teams.
Set the Local Media Optimization settings for this Media Rule.
Refer to the Avaya Session Border Controller for Enterprise Administration Guide for more information.
These values are only used if ICE Gateway Support is enabled.
Use this option to set the site name used within the X-MS message header
Use this option to set the domain name used within the X-MS message header.
Select one of the following actions as required:
Set the Quality of Service settings for this Media Rule.
Refer to the Avaya Session Border Controller for Enterprise Administration Guide for more information.
No Additional PropertiesThis value is required when audioPrecedence is OTHER, otherwise it is ignored.
^([0-1]){3}$ This value is required when videoPrecedence is OTHER, otherwise it is ignored.
^([0-1]){4}$ This value is required when audioTos is OTHER, otherwise it is ignored.
^([0-1]){6}$ This value is required when videoTos is OTHER, otherwise it is ignored.
^([0-1]){3}$ This value is required when audio is OTHER, otherwise it is ignored.
^([0-1]){6}$ This value is required when video is OTHER, otherwise it is ignored.
^([0-1]){6}$ Indicates the standard to be used to provide HOLD support. The options are:
NONERFC2543 - c=0.0.0.0RFC3264 - a=send onlyMICROSOFT_TEAMSThe MICROSOFT_TEAMS option is required for Microsoft Teams deployments to
handle the hold/resume feature of Microsoft Teams. It enforces the Microsoft
Teams side to send the “a=inactive” message. When this option is set, none of
the following messages are sent towards Microsoft Teams: “a=sendonly”,
“a=recvonly”, or “c=0.0.0.0”.
In addition, when you select the MICROSOFT_TEAMS option, a Feature Flag is set
in the Call Detail Record (CDR) by Avaya SBCE. The Feature Flag is the 35th
field in the CDR and is set to a value of 8. The Feature Flag identifies the call
in CDR as a Microsoft Teams call.
Determines how 180 Ringing messages are handled.
Determines how 181 Call Forwarding messages are handled.
Same definition as handling180Determines how 182 Queued messages are handled.
Same definition as handling180Determines how 183 Session Progress messages are handled.
Same definition as handling180Indicates whether Avaya SBCE passes or consumes the REFER message.
When an endpoint invokes a supplementary service, such as a call transfer,
the endpoint generates and sends an in-dialog REFER request to Avaya
SBCE through the enterprise call server. Avaya SBCE applies URI-based
routing to the new INVITE message triggered towards the transfer target.
Refer Handling feature works in either of the following two modes:
When configuring a profile to use with Microsoft Teams, enable the Refer
Handling option.
Name of the URI group to use for REFER handling.
Indicates whether Avaya SBCE passes or consumes the REFER message.
When an endpoint invokes a supplementary service, such as a call transfer,
the endpoint generates and sends an in-dialog REFER request to Avaya
SBCE through the enterprise call server. Avaya SBCE applies URI-based
routing to the new INVITE message triggered towards the transfer target.
Refer Handling feature works in either of the following two modes:
When configuring a profile to use with Microsoft Teams, enable the Refer
Handling option.
Indicates whether the Avaya SBCE security device will handle the
3xx Redirection Response messages.
Indicates whether the Avaya SBCE security device supports diversion headers.
Indicates whether the Avaya SBCE security device processes delayed SDP packets.
Note: The features Media Unanchoring and Delayed SDP Handling cannot both be enabled for a call. For more
information about administering those features, see Administering Avaya Session Border Controller for
Enterprise.
Indicates whether Provisional Response Acknowledgement (PRACK) handling is enabled. When called party sends
provisional requests with 100 rel option in the Require header, called party must receive PRACK message in the
response to ensure end to end successful communication. If the trunk or call server does not send 100 rel
option in the supported header for the initial INVITE request then by selecting Prack Handling, Avaya SBCE
sends the PRACK for that particular trunk or call server to the called party.
Indicates whether a PRACK message is permitted in an 18x record route header.
Indicates whether Avaya SBCE security device. supports the T.38 FAX Relay standard.
Indicates the URI scheme that the Avaya SBCE security device will use.
Indicates the header format used by the Avaya SBCE security device.
Indicates whether privacy is used between the Avaya SBCE security device and the SIP server.
Specifies the user name to be used for privacy authentication.
Specifies the Privacy Header to be used during privacy sessions.
Indicates that Avaya SBCE rewrites the FROM header in a trusted SIP
message with the P-Asserted-ID value.
This field is used for maintaining privacy for the FROM header. Trunk servers usually Accept SIP INVITE with
P-Asserted-ID. For some Trunk servers, Avaya SBCE inserts this header into the FROM header, insert the
header in Passerted ID and change From as Anonymous user, and send out the request.
Indicates that Avaya SBCE uses the P-Preferred-ID during private sessions.
Specifies the minimum value for the SIP min-SE timer. The Min-SE timer is used for a SIP refresh
(Re-Invite/Update) session as the minimum session expire time value.
The time range is 90 to 86400 seconds.
Specifies the initial request retransmission interval. This interval corresponds to
Timer T1 in RFC 3261. This timer is used when sending a request over UDP.
The time range is 50 to 1000 milliseconds.
Specifies the maximum retransmission interval for non-INVITE requests. This
interval is for non-INVITE requests and corresponds to Timer T2 in RFC 3261.
The time range is 200 to 8000 milliseconds.
Specifies the Transaction Expiration timer. The default value for this field is 32
seconds.
Any request that the server sends times out if the server does not receive a
response within the time set as the Transaction Expiration time. To use alternate
routing, you must set a shorter transaction expiration value than the default value of
32 seconds.
The time range is 1 to 64 seconds.
Specifies the transaction expiration time for an INVITE transaction after what
receives a provisional response.
The time range is 180 to 300 seconds.
Specifies the maximum time after which the server sends the routing request again.
The time range is 2 to 32 seconds.
Directs the Avaya SBCE security device to record route information. The
options are:
Directs the Avaya SBCE security device to use endpoint IP while looking for Avaya SBCE internal SIP context.
Directs the Avaya SBCE security device to use functionality specific to different environments.
Directs the Avaya SBCE security device to copy SIP Diversion header from 3xx messages to SIP Request messages
while 3xx handling is enabled on Avaya SBCE security device.
Specifies the diversion condition.
Specifies the Avaya SBCE security device to add SIP Diversion header on the SIP Invite message.
Directs the Avaya SBCE security device to use far-end firewall functionality.
Directs the Avaya SBCE security device to use SIP Via header port to route response.
Enable this feature for calls made by Mobile Extension (MOBX) users that are calling through a Mobile Service
Provider (MSP) serviced by an Avaya SBCE system. The Avaya SBCE can terminate these mobile calls to a PSTN
user through SIP-PRI gateways or to a user connected to an Avaya private network communication server.
Use this option to allow Avaya SBCE to filter the reinvite messages coming from an Avaya private network
communication server to the MSP. The ReINVITE handling config
These options define whether and how RFC 2833 DTMF touch-tone signals are converted to SIP messages. When
conversion occurs, the DTMF signals and SIP messages are sent in parallel in the call path to support
signaling devices that require either DTMF signals (such as an IVR) or SIP messages (such as SIP trunks). You
must have interworking profiles for both inbound calls (always set to None) and outbound calls (using one of
the options defined below). You must define the profiles for the servers.
Note: DTMF signal conversion to SIP messages will not happen when a registered user is involved in the call.
Important: Avaya recommends that for deployments where personal data protection based on GDPR requirements are
critical, you should not use DTMF interworking. For more information about Avaya SBCE support for GDPR, see
Avaya Session Border Controller for Enterprise Overview and Specification.
Avaya SBCE uses the RFC 2833 Relay & SIP Info or RFC 2833 & SIP Notify options to fork the incoming RFC 2833
DTMF touch-tone signals and SIP Info or SIP Notify messages to carry the DTMF signals in SIP signaling
messages. The MOBX URI group configuration is required to configure these DTMF options.
MOBX calls use standard mobile user features that invoke RFC 2833 DTMF touch-tone signals, such as digits for
an IVR. Avaya SBCE must pass the original DTMF touch-tone signals to a media gateway or endpoint in parallel
with sending the SIP Notify or SIP Info messages to an Avaya private network communication server. Any server
configured on Avaya SBCE that supports MOBX users on a Mobile Service Provider (MSP) must also have a URI
group configured that identifies the MSP users.
Set the header rules to create with this Topology Hiding Profile.
The name of the header to change.
The criteria to match in the header to change.
The data to replace the header with.
The value to overwrite the header with. This is only applied if action is set to OVERWRITE, it is
otherwise ignored.
"10.0.0.1"
"domain.com"