Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Div
classpdf6pttext
Caption
0Table
1Packet Service Profile Parameters
 

Parameter

Length/Range

Description

packetServiceProfile

N/A

Specifies a unique identifier (name) for packet service profile. You can define any name or use Default as the parameter.

aal1PayloadSize

0-999

The ATM Adaption Layer Type 1 (AAL-1) payload size (default = 47).

audioTransparency N/A

Use this object to configure Audio Transparency settings.

  • unknownCodecBitRate – The bit rate, in Kilobytes/second, required for bandwidth computation of unknown audio codecs. (range: 1-1000 KB/sec / default = 124)
  • unknownCodecPacketSize – The packet size, in milliseconds, required for Bandwidth computation of unknown audio codecs. (range: 5-100 ms / default = 10)
Note

If the bandwidth is not configured, the unknownCodecPacketSize and unknownCodecBitRate are used for the pass-through call.

codec

codecEntry1-codecEntry12

<codecEntry ID> <codec_name> – Defines the codec entry priorities and codec names. Up to 12 codec configurations are supported by SBC in PSX, ePSX and Advanced ERE deployment scenarios (see Routing and Policy Management for a description of the different routing configurations).

Note

SBC-POL-RTU license is needed to enable more than four codecs.

 

The codecEntry IDs are listed below:

  • codecEntry1 – Codec entry with a priority of "1".
  • codecEntry2 – Codec entry with a priority of "2". 
  • codecEntry3 – Codec entry with a priority of "3". 
  • codecEntry4 – Codec entry with a priority of "4".
  • codecEntry5 – Codec entry with a priority of "5".
  • codecEntry6 – Codec entry with a priority of "6".
  • codecEntry7 – Codec entry with a priority of "7".
  • codecEntry8 – Codec entry with a priority of "8".
  • codecEntry9 – Codec entry with a priority of "9".
  • codecEntry10 – Codec entry with a priority of "10".
  • codecEntry11 – Codec entry with a ptriority of "11".
  • codecEntry12 – Codec entry with a priority of "12".

For each codecEntry ID, select a codec name. Example default codec names are:

  • G711-DEFAULT (default codec)
  • G711SS-DEFAULT
  • G711_NONE
  • G723-DEFAULT
  • G723A-DEFAULT
  • G726-DEFAULT
  • G729A-DEFAULT
  • G729AB-DEFAULT

dataCalls

N/A

Data calls pertaining to restricted or unrestricted digital data.

  • initialPlayoutBufferDelay Used for G.711 only. This is the initial playout delay for calls with a data bearer channel, for example, ISDN 64K data calls. This value is configured separately from the initial playout delay for voice channels (voiceInitialPlayoutBufferDelay) so providers can trade off delay on data calls versus the likelihood of jitter causing delay changes while the playout buffer adapts. Some data bearer calls are very sensitive to delay changes (such as H.320 video conferencing), so a higher initial delay should reduce the chance of jitter bursts causing problems. (range: 5-50 / default = 50).
  • packetSize <10 | 20 | 30 | 40> – The maximum data packet size (Kilobits). 
  • preferredRtpDataPayloadType – The RTP Payload Type included in the RTP header of the data packet.
    (range: 0-127 / default = 56)
dtlsN/A

Use this object to control DTLS-SRTP and DTLS fall-back behavior in this Packet Service Profile.

  • dtlsCryptoSuiteProfile <profile name> – Name of  Crypto Suite Profile to attach to this Packet Service Profile.
  • dtlsFlags
    • allowDtlsFallback <disable | enable> – Enable flag to allow fallback to standard RTP when cryptographic attribute negotiation fails (default = disable).
    • dtlsSctpRelay <disable | enable> –  Enable flag on both legs of the call to relay DTLS/SCTP streams to the endpoint (default = disable).
    • dtlsSrtpRelay <disable | enable>Enable flag on both legs of the call to relay DTLS/SRTP audio and video streams to the endpoint. (default = disable).

    • enableDtlsSrtp <disable | enable> – Enable flag to allow Secure RTP.
Note

DTLS-SRTP relay is a licensed feature and requires an SRTP license to be installed on SBC.

Info

When a session contains DTLS-SRTP video stream or DTLS/SCTP application stream and there is no audio stream specified, SBC allows the session when the ingress and egress Packet Service Profiles (PSP) are configured as audio pass-through.

If ICE is part of session establishment in WebRTC (WRTC) scenario, the relay mechanism implemented for DTLS-SRTP and DTLS/SCTP is supported independent of ICE processing.

See Configuring SBC for WRTC for additional WebRTC configuration details.

flags

N/A

See Packet Service Profile Flags table below for flag descriptions.

honorRemotePrecedence

N/A

Flag to set precedence of audio encoding priority order of the local packet service profile over the remote peers audio encoding priority order when creating the priority order of the audio encodings that are common to both. Options are:

  • disable (default) – Applies precedence to local audio encoding priority order, local Secure RTP/RTCP settings and crypto suite priority order.
  • enable – Applies precedence to the remote peer's audio encoding priority order. For ingress call legs, also applies precedence to remote peer's Secure RTP/RTCP settings and crypto suite priority order.

mediaPacketCos

0-7

Specifies Class of Service (COS) value to be set in the IEEE 802.1D User Priority field of media packets transmitted on a call leg that uses this Packet Service Profile. This parameter only has an effect if the network interface supports 802.1Q tagged Ethernet frames. (default = 0 which is interpreted as best effort).

packetToPacketControl

N/AUse this object to define the packet-to-packet control parameters. See Packet to Packet Control Parameters table below for details.

peerAbsenceAction

N/A

  • none – (default) Inactivity detection is disabled.
  • peerAbsenceTrap – Choose this option to generate a trap if RTP inactivity is detected.
  • peerAbsenceTrapAndDisconnect – Choose this option to generate a trap and tear down the call if RTP inactivity is detected.
preferredRtpPayloadTypeForDtmfRelay

0-128

Specifies the preferred RTP payload type in the RTP header of audio packets for this encoding. (default = 128). This parameter is only used for 8 kHz clock rate. DTMF payload type of each subsequent clock rate (16 kHz, 24 kHz, etc.) is incremented by 1.

Note

Using the default value of "128" for preferredRtpPayloadTypeForDtmfRelay implies that the preferred DTMF value (from the system configurable) is used for this profile.

Note

If interworkDtmfWithoutTranscoding is enabled, ensure preferredRtpPayloadTypeForDtmfRelay is set to a valid value (96-127). If preferredRtpPayloadTypeForDtmfRelay value is invalid (set to "128"), the system may fail to pick up the value configured using "set system dspPad rtpDtmfRelay" command because DSPs are not used for the call.

qosValuesN/A

Use this object to configure the Quality of Service (QoS) DSCP value for this Packet Service Profile.

  • dtlsSctpDscp – Use this attribute to set the DSCP value in the Differentiated Services Field of the IP header for DTLS/SCTP packets that egress SBC. (range: 0-255 / default = 0)
  • msrpDscp – Use this attribute to set the DSCP value to use for egressing MSRP packets (range: 0-255 / default = 0).

rtcpOptions

N/A

Use this object to specify Real Time Control Protocol (RTCP) options for the call. RTCP is used to report network traffic congestion data. Various actions (for example call disconnect) may be taken when congestion threshold settings are exceeded. The RTCP options are:

  • rtcp
    • disable (default)
    • enable – RTCP is used for the call.
  • packetLossAction – Packet loss action to take when packet threshold is exceeded:
    • none – Take no action.
    • packetLossTrap – Generate trap.
    • packetLossTrapAndDisconnect – Generate trap and disconnect.
  • packetLossThreshold – (default = 0) Enter a value between 0-32767 to specify the packet loss threshold (number of lost packets/100,000) which will trigger a packet loss action. This parameter is required if RTCP is enabled. When set to “0”, no packet loss inactivity detection is performed. See Command Example below for an example configuration.

    Note

    Since configuring this parameter to a value less than 400 disables threshold detection, use a value in the range of 400 to 32767 to enable threshold detection.

    This setting can be used in conjunction with  mediaPeerInactivity. To set media peer inactivity timeout value, see mediaPeerInactivity parameter in Media System - CLI page.

  • terminationForPassThrough – Specifies RTCP termination behavior for pass-through calls.
    • disable – (default) RTCP is relayed between the end points for pass-through calls. 
    • enable – Enable flag (as well as rtcp flag) on one leg to terminate RTCP sessions on each leg for pass-through calls. If RTCP and RTCP termination is enabled on one leg of a pass-through call, RTCP is terminated and originated for that leg. If RTCP is enabled on both legs on the pass-through call, irrespective of terminationForPassThrough settings, RTCP is always relayed.

secureRtpRtcp

N/A

Specifies whether secure RTP Real Time Control Protocol (SRTP) is enabled for the call:

  • cryptoSuiteProfile <profile name> – A unique identifier for the Cryptographic Suite Profile.
  • flags – Possible values are disable/enable. The default value of each flag below is "disable".
    • allowFallback – Enable flag to allow fallback to standard RTP/RTCP when crypto attribute negotiation fails.
    • allowPassthru – Enable flag to allow SBC to pass-through SRTP media without authenticating, decrypting, or encrypting it internally. SBC will prioritize SRTP pass-through media over terminated SRTP media. When this flag is disabled, SBC terminates all SRTP and SRTCP media for authentication, encryption, or decryption.

      Note

      To use this flag, enableSrtp flag must be enabled.

    • enableSrtp – Enable this flag to enable secure RTP/RTCP.
    • resetEncDecROCOnDecKeyChange – Enable flag to reset Roll Over Counter for both encryption and decryption when decryption key changes.
    • resetROCOnKeyChange – Enable flag to reset the SRTP Roll Over Counter when the session key changes.
    • updateCryptoKeysOnModify – For an SRTP call, if this flag is enabled in Packet Service Profile and call leg mode is changed from sendonly/inactive/recvonly to sendrecv, the SBC generates a new set of crypto attributes.

sendRoutePSPPrecedence

N/A

Use this flag to allow audio encoding order preference in outgoing messages only.

  • disable (default)
  • enable

silenceFactor

N/A

The percentage of call time that silence is expected. This parameter is used to reduce expected call bandwidth. (range: 0-50 / default = 40).

silenceInsertionDescriptor

N/A

Use this object to define the Silence Insertion Descriptor (SID) attributes.

  • g711SidRtpPayloadType – Specifies the G.711 Silence Insertion Descriptor (SID) RTP payloadType. (range: 0-127 / default = 19).
  • heartbeat – By default, this flag is enabled to allow SID packets to be sent within a minimal interval during a silence period (at least one SID packet must be sent within a SID maximum packet time frame).
    • disable
    • enable (default)

t38

N/A

Use this object to specify T.38 data rate attributes using following parameters:

  • dataRateManagementType:
    • type1LocalGenerationOfTcf – Type 1 data rate management requires that the Training Check Frame (TCF) training signal is generated locally by the receiving gateway. Data rate management is performed by the emitting gateway based on training results from both PSTN connections. Type 1 is used for TCP implementations and is optionally used with UDP implementations.
    • type2TransferOfTcf – (default) Type 2 data rate management requires that the TCF is transferred from the sending gateway to the receiving gateway rather than having the receiving gateway generate it locally. Speed selection is done by the gateways in the same way as they would on a regular PSTN connection. Data rate management type 2 requires the use of UDP and is not recommended for use with TCP.
  • ecm – Use this flag to allocate DSP resources, when available, for T.38 Error Correction Mode (ECM) calls.
    • disable – (default) use normal resource allocation.
    • enable
  • lowSpeedNumberOfRedundantPackets – This field specifies the number of redundant IFP messages sent in a UDP packet for T.38 low speed fax transmission, and applies only if the T.38 error correction type is redundancy. (range: 0-2 / default = 1).
  • maxBitRate – Use this object to select the T.38 Maximum Bit Rate which controls and manipulates bits 11, 12, 13, and 14 in the DIS command received by the SBC from either the TDM circuit interface or the T.38 packet interface:
    • 2.4Kbits_s – For modem type ITU-T V.27ter fall-back mode.
    • 4.8Kbits_s – For modem type ITU-T V.27ter.
    • 9.6Kbits_s – For modem types ITU-T V.27ter and V.29.
    • 14.4Kbits_s – (default) For modem types ITU-T V.27ter, V.29, and V.17. This setting is used to constrain the type of modem modulation schemes.
  • numberOfRedundantPackets – Use this parameter for high-speed fax relay to specify the number of redundant Internet Facsimile Protocol (IFP) messages sent in a User Datagram Packet (UDP) for fax transmission. (range: 0-2 / default = 1).
  • protocolVersion Use this parameter to specify the T.38 Fax protocol version to use.
    • 0 (default)
    • 3 

typeOfService

0-255

Use this object to Use this parameter to set six most significant bits of Type of Service byte in an IP header for DSCP marking of MSRP packets. Default value is 0.

videoCalls

N/A

Use this object to define video call parameters.

  • audioOnlyIfVideoIsPrevented– By default, this flag is enabled to allow call to continue with the audio only portion if the video cannot be established for any reason.
    • disable
    • enable (default)
  • codecListProfile – Name of the Codec List profile used to store precedence and purge lists of video codec MIME sub-types.
  • ieee8021QVLanCos – IEEE-802 1Q VLAN Class of Service. (range: 0-7 / default = 0)
  • ipv4Tos – IPv4 type of service. (range: 0-255 / default = 0)
  • ipv6TrafficClass – IPv6 traffic class. (range: 0-255 / default = 0)
Note

ipv6TrafficClass is not supported with H.323 calls.

  • maxVideoBandwith – The maximum allowable session bandwidth (in kbps) for a call that includes video streams. This value Includes the bandwidth for all streams in the call (audio, video, BFCP, and so on). If "0" is set as the value, video calls are not allowed; and only audio calls can be set up following the normal allocation process (range: 0-50000 kbps / default = 10).
  • videoBandwidthReductionFactor – The amount, as a percentage, to reduce the session bandwidth allocation for calls that include video streams. This setting only affects the internal allocation of bandwidth used for the calls (does not affect the signaling). For example: if the reduction factor is "20", the bandwidth allocated for calls is reduced by 20%. In other words, if the normal bandwidth allocation for calls is 1000 kbps, a 20% reduction equates to a new 800 kbps bandwidth. (range: 0-100 / default = 0).

voiceInitialPlayoutBufferDelay

1-50

The delay (in milliseconds) by the initial playout buffer required to absorb the maximum expected data packet delay across the network. Must be in increments of 1 ms. (default = 10).

Flags

Caption
0Table
1Packet Service Profile Flags
3Packet Service Profile Flags
 
ParameterDescription

HDCodecPreferred

Note

This flag only applies when

Spacevars
0product
is configured with ePSX and/or external PSX.

Enable flag to set HD codecs as preferred codec over non-HD codecs even if transcoding is required. When flag is disabled, continue with existing PSP/IPSP behavior.

  • disabled (default)
  • enabled

When enabled, the following behavior is exhibited:

If...Then...
the ingress Offer contains any valid HD codecsHD codecs are sorted to the top of the list while sending out the Offer.
all NB codecs are presentSBC reorders the codec entries with NB first, followed by HD codecs.

 

Codec selection priority from Answer message:

  1. HD-HD pass-through
  2. HD-HD transcoding
  3. NB-NB pass-through
  4. NB-NB transcoding
  5. HD-NB transcoding

 

Note

If forceRoutePSPOrder flag is enabled, this flag does not affect the ordering of outgoing offer.

Note

The flag transcoderFreeTransparency overrides this flag. If  transcoderFreeTransparency is enabled, this flag is ignored.

MatchOfferedCodecGroupIfNbOnly

Enable this flag to allow the SBC to send only NB in outgoing offer if only NB is received in the ingress offer. Otherwise, do nothing. While sending the offer, this flag becomes is ignored if either HD-only or (HD+NB) is received in incoming offer.

If this flag is disabled, the SBC uses existing behavior.

  • disable (default)
  • enable
Note

The flag transcoderFreeTransparency overrides this flag. If transcoderFreeTransparency is enabled, this flag is ignored.

digitDetectSendEnabled

Enable this flag to allow digit detection for pass-through calls on digits sent to the network.

  • disable (default)
  • enable
Note

If interworking without DSP resources is desired for this Packet Service Profile, this flag must be enabled.


disallowDataCallsEnable flag to disallow data calls.
  • disable (default)
  • enable
dscpPassthrough

When enabled on both the Ingress and Egress call leg, the DSCP value in the IP header of the media packets is transparently passed through the system. Once media is received from the peer, any value set in the typeOfService field on the Packet Service Profile has no effect when dscpPassthrough is configured on both legs for the associated call.

  • disable (default)
  • enable

forceRoutePSPOrder

Enable this flag to send the outgoing offer in the same order as egress route Packet Service Profile irrespective of HD/NB priorities.

  • disable (default)
  • enable
Note

If this flag is enabled, HDCodecPreferred flag does not affect the ordering of outgoing offer.

Note

The flag transcoderFreeTransparency overrides this flag. If  transcoderFreeTransparency is enabled, this flag is ignored.

interworkDtmfWithoutTranscoding

Enable flag to interwork DTMF with out-of-band RFC2833 without the use of transcoding (DSP resources).

  • disable (default)
  • enable
Note

If interworkDtmfWithoutTranscoding is enabled, ensure preferredRtpPayloadTypeForDtmfRelay is set to a valid value (96-127). If preferredRtpPayloadTypeForDtmfRelay value is invalid (set to "128"), the system may fail to pick up the value configured using "set system dspPad rtpDtmfRelay" command because DSPs are not used for the call.


mediaLockDownForPassThroughTBD
policeOnHeaviestAudioCodec

When enabled, SBC reserves the worst case common codec bandwidth on trunk groups and interfaces, but polices on maximum bandwidth for all codecs from Offer or Answer in a pass-through call.

  • disable (default)
  • enable

 

Note

This configuration applies to all pass-through calls. It works independently from the Audio Transparency feature and reserveBwForPreferredAudioCommonCodec flag.

preferNBPassthruOverHDTranscode

Enable this flag to allow the SBC to choose NB-NB pass-through over HD-HD transcoded call.

When disabled, the SBC prefers HD-HD transcoded call over NB-NB pass-through.

  • disable (default)
  • enable
Info
This flag is valid only if HDCodecPreferred flag is enabled, and is applied when selecting a codec from answer.
Note

The flag transcoderFreeTransparency overrides this flag. If  transcoderFreeTransparency is enabled, this flag is ignored.

reserveBwForPreferredAudioCommonCodec

By default, the SBC reserves the worst case common audio codec bandwidth for pass-through calls on trunk groups and IP interfaces, and polices the same bandwidth. Use this flag to reserve the bandwidth associated with the preferred common codec and police on the worst case codec. This flag applies to both known and unknown codecs, and can be used independently or in conjunction with Audio Transparency feature.

  • disable (default)
  • enable
Note

This flag is active for a call when both the PSPs have this flag enabled. If this flag is disabled in any of the PSPs, the flag is not applied.


 ssrcRandomize

Enable flag to generate a new SSRC (using a random value) along with a new time stamp on a new RTP stream whenever a resource is reactivated (due to change in codec, etc.). SSRC randomization reduces the probability of collision in large groups and simplifies the process of group sampling that depends on uniform distribution of SSRCs.

  • disable (default)
  • enable 
useDirectMedia

Enable flag to use direct media as needed.

  • disable (default)
  • enable

validatePeerSupportForDtmfEvents

Flag to validate peer support for DTMF events. Enable this flag for all peer devices that support RFC 4733.

  • disable (default) – 
    Spacevars
    0product
    does not validate the presence of DTMF events in the offer or answer from the peer. If DTMF relay is enabled, 
    Spacevars
    0product
    transmits DTMF digits received from the other leg to this peer using the named event RTP payload.
  • enable – 
    Spacevars
    0product
    validates the presence of DTMF events in the offer or answer from peers that support RFC 4733. If DTMF Relay is enabled and events 0-15 are received (with no other combination or subset of events), 
    Spacevars
    0product
    forwards the events in the egress leg to this peer using the named event RTP payload. When 
    Spacevars
    0product
    is configured for a pass-through call and it receives DTMF events other than 0-15 from the ingress peer, it does not offer any DTMF events to the egress endpoint.

Packet to Packet Control Parameters

Caption
0Table
1Packet to Packet Control Parameters
3Packet to Packet Control Parameters
 

ParameterDescription
codecsAllowedForTranscoding

 Use this parameter to specify codecs allowed for transcoding, and which leg to apply them to.

    • otherLeg <codec> (see codec list below)
    • thisLeg <codec> (see codec list below)

Codec list:

amr  | efr |  evrc | g711a | g711u | g722 | g726 | g729 | g7221 | g7222 | g7231 | ilbc | opus | t38

 

conditionsInAdditionToNoCommonCodec

 The 

Spacevars
0product
performs transcoding when any of the specified conditions are met, including no common codec on ingress and egress legs.

  • applyFaxToneTreatment– Apply fax tone treatment.
    • disable (default)
    • enable
  •  different2833PayloadType– Enable this option to allow SBC to transcode media when RFC2833 payload type received from ingress is different from the preferred DTMF payload type configured in egress PSP.
    • disable (default)
    • enable
  • differentDtmfRelay – Enable this flag to perform transcoding when the ingress and egress call legs use different DTMF relay methods.
    • disable (default)
    • enable
  • differentPacketSize Enable this flag to perform transcoding when the ingress and egress call legs use different packet sizes.
    • disable (default)
    • enable
  • differentSilenceSuppression Enable this flag to perform transcoding when the ingress and egress call legs use different silence suppression methods.
    • disable (default)
    • enable
  • honorAnswerPreference– The SBC triggers a new offer towards the other side when an answer is received for a re-INVITE from this side. The re-INVITE generated on the other side carries all possible codecs in Route Packet Service Profile that causes the most preferred codec of the other side peer to be modified. Enable this Honor Answer Preference (HAP) flag to lock down the most preferred codec towards the peer irrespective of re-INVITE received for mid-call modification from this side. (See the table below describing SBC behavior when this flag is enabled/disabled).
    • disable (default)
    • enable
  • honorOfferPreference Enable this Honor Offer Preference (HOP) flag to honor the codec preference of the peer's offer when the 'Honor Remote Preference' flag on the PSX is enabled.  This option is available only when transcode = conditional. (See honorAnswerPreference vs. honorOfferPreference table below describing SBC behavior when this flag is enabled/disabled).
    • disable (default)
    • enable
transcodeTranscode options:
    • conditional (default)
    • determinedByPspForOtherLeg
    • only
    • transcoderFreeTransparency (NOTE:  If using this option, you must also set lateMediaSupport to ‘passthru’ ( see sipTrunkGroup media - CLI))

...

Caption
0Table
1honorAnswerPreference vs. honorOfferPreference
3honorAnswerPreference vs. honorOfferPreference
 
HOP Flag StateHAP Flag StateSBC Behavior
enabledisableThe SBC selects a codec order of precedence in the offered SDP, irrespective of whether it is a pass-through or transcoded codec (if transcoding is defined for that codec). The SBC as part of media lock-down may send a re-INVITE to egress peer. Note that the preference on the answerer side is given to a pass-through codec.
enableenableThe SBC gives preference to HAP over HOP in case of conflict. The Honor Remote Preference (HRP) flag on the answerer leg decides the preference order. Based on that preference list, the SBC selects a codec with highest preference from answer SDP that can be used even if it requires transcoding. Note that this may cause the selection of a codec on the other side leg not to be honored. This happens in case of a pass-through call.
disableenableThe SBC gives preference to answerer codec order that is created based on HRP flag. The most preferred codec is chosen as received in the answer SDP, irrespective of whether it is a pass-through or a transcoded codec (if transcoding is defined for that codec).

Anchor
example
example
Command Examples

...