In this section:
Default values are enclosed in square brackets [ ].
% set profiles media packetServiceProfile <DEFAULT> applicationStream maxNonRtpBandwidth <0...50000>
% set profiles media packetServiceProfile <DEFAULT> qosValues applicationDscp <0...63>
maxNonRtpBandwidth Command Parameters
Parameter | Length/Range | Default | Description | M/O |
---|---|---|---|---|
maxNonRtpBandwidth | <0...50000> | 0 | maximum application bandwidth | M |
applicationDscp Command Parameters
Parameter | Length/Range | Default | Description | M/O |
---|---|---|---|---|
applicationDscp | <0...63> | 0 | Attribute for configuring qosValues for Application media type. | O |
show profiles media codecEntry EVS codec evs; packetSize <20 | 40 | 60 | 80 | 100>; preferredRtpPayloadType <0 - 127>; dtmf { relay <relay_type>; removeDigits <disable | enable>; } useCompactHeader <0 | 1>; partialRedundancy < -1 | 0 | 2 | 3 | 5 | 7 >; EVSAMRWBIOModeSupport <0 | 1>; supportAsymmetricBitRate <0 | 1>; maxChannels <1 - 6>; minBitRate <5.9 | 7.2 | 8 | 9.6 | 13.2 | 16.4 | 24.4 | 32 | 48 | 64 | 96 | 128>; maxBitRate <5.9 | 7.2 | 8 | 9.6 | 13.2 | 16.4 | 24.4 | 32 | 48 | 64 | 96 | 128>;
Codec Entry Flags
Parameter | Length/Range | Default | Description | M/O |
---|---|---|---|---|
| 0 / 1 | 0 (False) | Support Asymmetric Bit rates (br-send, br-recv) If the value is FALSE, and if the offer or answer contains br-send or br-recv, the payload is rejected. If the value is TRUE, the SBC accepts the offer/answer with br-send != br-recv and relays them to the other leg. If transcoding, the SBC passes this info to the DSP for transcoding. Note that the SBC never sends asymmetric bit rates in its offer. | O |
maxChannels | 1-6 | 1 | Indicates the number of channels that are supported for passthrough. If the received channel count is more than this, the payload will be rejected. Note that for transcoding only 1 channel is supported. | O |
EVSAMRWBIOModeSupport | 0/1 | 0 (False) | Support EVS-AMR-WB-IO Mode If set to FALSE, the EVS codec in the offer/answer with evs-mode-switch=1 is dropped. If set to TRUE, the SBC accepts the offer with evs-mode-switch=1 and pass it on to the other leg. If transcoding, the SBC passes this information along with the corresponding AMR-WB parameters to DSP. Note that the SBC does not offer this mode in the SDP offer but if the SDP offer/answer has evs-mode-switch=1, the SBC would transcode to the codec on the other leg to EVS-AMR-WB-IO mode. | O |
partialRedundancy | -1, 0, 2,3,5,7 | -1 | Initial value for the Partial redundancy offset in channel aware mode | O |
useCompactHeader | 0/1 | 0 (False) | This flag is used to force the SBC to use Compact header format for the EVS packets. SBC sends hf-only=0 in offer/answer. SBC would use Header-full format when this flag is disabled or when peer explicitly negotiates hf_only=1. | O |
% set profiles media packetServiceProfile <unique_profile_name> packetToPacketControl codecsAllowedForTranscoding otherLeg <amr | efr | evrc | evs | g711a | g711u | g722 | g726 | g729 | g7221 | g7222 | g7231 | ilbc | opus | silk | t38> thisLeg <amr | efr | evrc | evs | g711a | g711u | g722 | g726 | g729 | g7221 | g7222 | g7231 | ilbc | opus | silk | t38>
Use the following command to set and configure the bfd
parameter in an ipInterface
.
You can only configure the ceName
when you initially create the BFD session.
set addressContext <addressContext_name> ipInterfaceGroup <lif_group_name> ipInterface <IP_interface_name> bfd <bfd_session_name> remoteIp <remote_IP_address> remotePort <remote_port_number> requiredMinRxInterval <1-50> desiredMinTxInterval <1-50> ceName <ceName> state <disabled | enabled>
bfd Parameters
Parameter | Length/Range | Default | Description | M/O |
---|---|---|---|---|
bfd | 24 | N/A |
| M |
ceName | 1-255 | N/A |
If you do not configure this parameter, the BFD session is up on the active node after a switchover. | O |
desiredMinTxInterval | 1-50 | 1 |
| M |
remoteIp | N/A | N/A |
| M |
remotePort | 0-65535 | 3784 | <remote_port_number> - Configure this parameter with the remote port of the BFD session. | M |
requiredMinRxInterval | 1-50 | 1 | <1-50> - Configure this parameter with the required minimum (in seconds) of the received interval. | M |
state | N/A | disabled | Use this flag to enable or disable the administrative state of the BFD session.
| M |
You can only modify the bfd
parameters when the bfd state
is disabled
.
bfdStatus Parameters
Parameter | Length/Range | Description | M/O |
---|---|---|---|
bfdStatus | 24 |
| M |
bfdOperState | N/A | The operational state of the BFD session on a LIF. You cannot configure this flag.
| M |
Use the following command to configure the ocspStapling
flag in the ocspProfile
.
set profiles security ocspProfile <profile name> ocspStapling <disabled | enabled>
Use the following command to configure the ocspResponseCachingTimer
parameter in the ocspProfile
.
set profiles security ocspProfile <profile name> ocspResponseCachingTimer <1-30>
ocspProfile Command Parameters
Parameter | Length/Range | Default | Description | M/O |
---|---|---|---|---|
ocspStapling | N/A | disabled | Use this flag to enable or disable OCSP stapling. OCSP stapling allows you to provide the validity information of your security certificate.
The Unable to show "metadata-from": No such page "_space_variables" disables this flag if the ocspProfile state flag is disabled . | O |
ocspResponseCachingTimer | 1-30 | 1 | The Unable to show "metadata-from": No such page "_space_variables" deletes the OCSP cached response when this timer expires. | O |
The SBC provisions the internalSipCauseMapProfile
to attach at the trunk group level. In addition, SBC can attach the internalSipCauseMapProfile
profile to the signaling zone level. If the trunk group is in a disabled or out-of-service state, the SBC does not use this profile.
There no new parameters added. Instead, new values that are listed in the table are added.
Create the internalSipCauseMapProfile
and map causeMap
to the sipcause
by executing the command:
set profiles signaling sipCauseCodeMapping internalSipCauseMapProfile <internalSipCauseMapProfile> causeMap <causemap> sipCause Possible completions: <SIP Cause value for a given Internal cause> Enter value in range of 300-606>
Attach the internalSipCauseMapProfile
profile to the trunk group by executing the command:
% set addressContext default zone <ZONE_INGRESS> sipTrunkGroup <SipTRunkGroup1> signaling causeCodeMapping Possible completions: cpcSipCauseMappingProfile - The name of the CPC to SIP mapping profile. sipCpcCauseMappingProfile - The name of the SIP to CPC cause mapping profile . sipInternalCauseMappingProfile - The name of internal cause to SIP mapping profile useNonDefaultCauseCodeforARSBlackList - When enabled uses cause code 168 for mapping profile mapping profile % set addressContext default zone <ZONE_INGRESS> sipTrunkGroup <SipTRunkGroup> signaling causeCodeMapping sipInternalCauseMappingProfile <sipInternalCauseMappingProfile>
Attach the sipInternalCauseMappingProfile
profile to the zone
by executing the command:
% set addressContext default zone <ZONE_INGRESS> causeCodeMapping Possible completions: sipInternalCauseMappingProfile - The name of internal cause to SIP mapping profile % set addressContext default zone <ZONE_INGRESS> causeCodeMapping sipInternalCauseMappingProfile <sipInternalCauseMappingProfile>
The SBC uses the existing profile InternalSipCauseMapProfile
to define the new mapping entries of internal errors/failures to the SIP response code.
View the mapping entries by executing the command:
show profiles signaling sipCauseCodeMapping internalSipCauseMapProfile <internalSipCauseMapProfile>
To overcome adding one rule at a time for a new group, the CLI command "aaarule-display-generatecl
i" to display the applicable rules for an existing group and get an equivalent output in a file containing CLI commands. The user then edits this file to define the new set of rules and source the updated file in CLI to assign rules to the new custom group.
aaarule-display-generatecli
To create new rules, refer to Local Authentication - CLI
Create the new rules for the custom group by executing the command:
aaarule-display-generatecli -h usage: [--help|-h] [--administrator|-a] [--operator|-o] [--fieldService|-f] [--guest|-g] [--calea|-c] [--securityAuditor|-s] [--group <new group name>] --display|-cli --help|-h: Help for usage --administrator|-a: Prints Administrator rules --operator|-o: Prints Operator rules --fieldService|-f: Prints Field Service rules --guest|-g: Prints Guest rules --calea|-c: Prints Calea rules --securityAuditor|-s: Prints Security Auditor rules --cli: CLI output for any of the specified groups. At least one group must be given in argument. --display: Display rules for any of the specified groups. At least one group must be given in argument. --group: New group name. The rules will be applied to this group. Else the name will be derived from default group
The options allow you to display and/or create CLI output files for one or more groups at a time. The user group name is required and/or display (--display) or a cli (--cli) option as mandatory parameters.
If the –cli option is given, the SBC stores the CLI output in the user home directory and can modify it.
The SBC Core provides new global configurations to enable generating CDRs in Q-SBC format, to enable checksum validation of the CDR files, and to specify call duration rounding policy. A user must have admin privileges to configure these options.
The configuration options added to support generating CDRs in Q-SBC format have the following syntax.
% set oam accounting qSbcCdr admin addChecksum < disabled | enabled > callDurationRoundUp <enabled | disabled> checksumKey <key> state <disabled | enabled>
Parameter | Length/range | Description |
---|---|---|
addChecksum | n/a | Enable this flag to add checksum validation to the Q-SBC format CDR file. When enabled, the SBC inserts a file header into each CDR log file and then executes the HMAC-MD5 hashing algorithm to generate a checksum for the file, using an operator-configured, private shared key. The SBC converts the resulting binary output from the algorithm to a text format that is consistent with the rest of the CDR file and appends it as the last line in the CDR log file. The options are:
Note: To enable this option, you must also configure a |
| n/a | Enable this flag to have the SBC round up to the next second in Q-SBC CDR call duration fields 3 and 6 if the call duration includes any part of a second. When disabled the SBC rounds down if the partial second duration is less than 500 milliseconds. The options are:
|
| 16 to 64 characters | Specifies the checksum key to use when generating the CDR file checksum. The key value can contain upper/lower case characters and digits only. |
| n/a | When enabled, the SBC generate CDR files in Q-SBC format. When disabled, the CDR file format is the standard SBC Core (former Sonus) CDR format. The options are:
If the SBC is configured to generate intermediate CDRs, a switch of CDR formats to either format type will generate an intermediate CDR for each active call. Ribbon recommends that you change the state value prior to deployment or in a maintenance window. |
SWe traffic profiles support four parameters when creating custom SWe traffic profiles. These parameters provide additional options to characterize the anticipated call mix for a SWe system.
% set system SweTrafficProfiles <profile name> mediaCostFactor <media factor> rxPPSFactor <Rx PPS factor> sigCostFactor <signaling factor> txPPSFactor <Tx PPS factor>
The following table describes the new parameters added to SWe traffic profiles.
Parameter | Length/Range | Default | Description |
---|---|---|---|
mediaCostFactor | 0.0001 to 100 | 1.0 | Use this parameter to specify a media cost factor to use during capacity estimation. This factor affects the media plane estimation,such as crypto session and pass-through session estimation. |
sigCostFactor | 0.0001 to 100 | 1.0 | Use this parameter to specify a signaling cost factor to use during capacity estimation. This factor affects the signaling plane estimation, such as cps estimation. |
rxPPSFactor | 1.0 to 100 | 1.0 | Use this parameter to specify a received (rx) PPS factor to use during capacity estimation. |
txPPSFactor | 1.0 to 100 | 1.0 | Use this parameter to specify a transmitted (tx) PPS factor to use during capacity estimation. Use the Rx/Tx parameters for scenarios such as SIPREC where the received/transmitted PPS may not be the same (asymmetric). |
For SBC SWe cluster deployments operating in OAM configuration mode, new command parameters provide additional options for managing configuration changes when using the CLI.
The request system admin
command supports three new parameters to manage configuration changes on the OAM node and a new show
utility that outputs configuration change information in the form of transaction logs.
The following statements show the syntax for the new request
command options for managing configuration on the OAM node.
> request system admin <SYSTEM NAME> discardCandidateConfiguration restoreRevision revision <revision number> viewConfigurationChanges revision <revision number>
The following statements show the syntax for the new show utils
command options for listing the candidate configuration or changes for a specific revision.
> show utils transactionLog revision <revision number>
request system admin
Parameter | Description |
---|---|
| Issue this |
| Issue this request command along with a specific, prior configuration revision number to revert to that configuration. The OAM nodes and the SBC nodes automatically restart when you restore a prior configuration. |
| The behavior of this request command depends on whether you provide an optional revision number. Issue this Specify a revision number to list the configuration changes associated with the specified revision. Note that viewing of configuration related to lawful intercept (LI) is restricted to authorized users and therefore output is filtered accordingly. LI-related changes are not present in the output shown to users that lack LI privileges. Similarly, users with only LI privileges can see only LI-related configuration changes. |
show utils
Parameter | Description |
---|---|
| Use the transaction log utility without specifying a revision number to list the candidate configuration changes that have been committed on the an OAM node, but not yet activated on the managed SBC nodes with the saveAndActivate command.Specify a revision number to list the configuration changes associated with the specified revision. Note that viewing of configuration related to lawful intercept (LI) is restricted to authorized users and therefore output is filtered accordingly. LI-related changes are not present in the output shown to users that lack LI privileges. Similarly, users with only LI privileges can see only LI-related configuration changes. |
Corresponding to the consolidation of HA models, the mgmtMode keyword is replaced with haMode. Options for the types of haMode are changed to haMode1to1 and haModeNto1 from the previous options of "centralized" and "distributed."
> show table system admin <system name> haMode <haMode1to1 | haModeNto1>
Only the clusterComm
parameters under system
clusterAdmin
remain user-configurable and these options apply only to M-SBC instances within a distributed SBC deployment. The clusterAdmin
options listed below are no longer visible in the CLI.
% set system clusterAdmin dataComm discoveryComm seedFqdn seedIpAddress state