In this section:

New CLI in 8.0.0R0

 

Info

Default values are enclosed in square brackets [ ].

SBX-67068 REG Relay After Multiple Consecutive 503 Responses

A new parameter preserveRcbOnRefreshRegErrResponse is introduced to the signaling registration object, to toggle preservation of the RCB on receiving error response (4xx/5xx/6xx) for Refresh Registration. This parameter helps to retain backward compatibility by controlling the behavior.

Command Syntax

% set addressContext default zone <ZONE> sipTrunkGroup <SIP_TG> signaling registration
    preserveRcbOnRefreshRegErrResponse <disabled | enabled>

Parameter Description

Parameter Description

ParameterLength/RangeDefaultDescriptionM/O
preserveRcbOnRefreshRegErrResponsen/adisabled

Enable this parameter to allow the SBC to preserve the RCB on receiving error response (4xx/5xx/6xx, except 401, 407, 408, and 7xx) for the Refresh REGISTER.

If disabled, the SBC deletes the RCB.

  • disabled (default)
  • enabled
NOTE: If the error response is any of 401, 407, 408, and 7xx, the SBC exhibits the default characteristics even if the parameter is enabled.
O
 

 

CLI Guide pages containing migrated content:

 

SBX-68167 Remove SLS from Code and Documentation

Commands and tables supporting the site license server (SLS) have been removed. The related licensing is no longer supported. In a related change, the license mode previously referred to as "legacy" has been renamed with the more descriptive term "node locked."  The term "nodeLocked" now appears in license-related table output. 

The updated command to set license mode appears below:

% set system licenseMode mode <domain | nodeLocked>

The following tables are no longer populated and are not available using show table system or show status system:

  • licenseFeatureStatus
  • licenseRequiredStatus
  • licenseServer
  • licenseServerStatus

The command to reset license status tables has been removed.

 

SBX-68182 Send 480 for per-peer policing discards of SUBSCRIBE 

A SIP Cause response code, subsEndPointRatePolicing, is added to the SipInternalCauseMapProfile under causeMap to map the sipCause status when the CAC profile is attached to IpPeer.

The sipCauseText configuration is added to internalSipCauseMapProfile to send the sipCause text in the Reason header of the SIP error response to reject the SUBSCRIBE request.

Command Syntax

Cause Map subsEndPointRatePolicing command syntax
% set profiles signaling sipCauseCodeMapping internalSipCauseMapProfile <profile_name> causeMap
    congestionPolicing sipCause <300-606>
    otherReqRatePolicing sipCause <300-606>
    regRatePolicing sipCause <300-606>
    regTGLimit sipCause <300-606>
    regTimeout sipCause <300-606>
    subsEndPointRatePolicing sipCause <300 - 606>
    subsRatePolicing sipCause <300-606>
    subsTGLimit sipCause <300-606>
subsEndPointRatePolicing command syntax
% set profiles signaling sipCauseCodeMapping internalSipCauseMapProfile <profile name> causeMap subsEndPointRatePolicing sipCause <300 - 606>
sipCauseText command syntax
% set profiles signaling sipCauseCodeMapping internalSipCauseMapProfile <profile_name> causeMap subsEndPointRatePolicing sipCauseText <0 ..127>

Command Parameters

subsEndPointRatePolicing

ParameterLength/RangeDefaultDescriptionM/O
subsEndPointRatePolicing

N/A

0Internal Sip Cause code to map SUBSCRIBE Endpoint CAC default error response.Optional

sipCauseText

ParameterLength/RangeDefaultDescriptionM/O
sipCauseText0 – 127NULLThe Internal Sip Cause text that is used in the Reason Header of the error response to reject the SUBSCRIBE Request.Optional

SBX-69038 - MSRP session multiplexing support for B2BUA

The CLI command, msrpMux, controls whether MSRP multiplexing (reusing the same TCP connection for multiple MSRP sessions with the same IP peer) is enabled on a SIP trunk group. MSRP multiplexing applies only to MSRP sessions established using back-to-back user agent (B2BUA) behavior. Multiplexing cannot be applied to MSRP sessions established following the RFC 6714 “Connection Establishment for Media Anchoring” (CEMA) type of handling.

% set addressContext <addressContextName> zone <zoneName> sipTrunkGroup <trunkGroupName> media msrpMux <enabled | disabled>

Command Parameter

ParameterLength/RangeDefaultDescriptionM/O
msrpMux

n/a

disabled

Enable this flag to reuse an existing TCP connection with an IP peer for multiple MSRP sessions (MSRP multiplexing). MSRP multiplexing applies only to MSRP sessions established using back-to-back user agent (B2BUA) behavior. Multiplexing cannot be applied to MSRP sessions established based on the RFC 6714 “Connection Establishment for Media Anchoring” (CEMA) type of handling. The options are:

  • disabled
  • enabled
Optional

SBX-70520 - Report licensing mode in licensing interval statistics

The following parameter is added in the callCountCurrentStatistics and callCountIntervalStatistics tables:

Parameter
Description
licenseMode

Current SBC license mode. Possible values:

  • nodeLocked
  • domain

SBX-71271 - Cloud Provisioning OAM Model

When using either the OAM or Direct Single cluster configuration mode for an SBC SWe Cloud deployment on OpenStack, the following command explicitly saves and activates a configuration revision and triggers storing the configuration revision on EMS.

Example
request system admin <system name> saveAndActivate

Additional operational data is available to support cluster configuration management:

Example
show status|table system 
   activeRevision
   configMode
   isOAM
Example
show status|table system admin <system name> 
   savedConfigurations

Command Parameters

ParameterDefaultDescription
saveAndActivaten/a

Issue this command to explicitly save and activate a configuration revision and to trigger storing the configuration revision on EMS. This action is only available in SBC SWe Cloud deployments on OpenStack.

ParameterDescription
activeRevision

Use this parameter to output the numeric identifier for the configuration revision that is currently active on an SBC SWe Cloud cluster deployment.

configMode

Use this parameter to output the configuration mode for the node. Options are:

  • oam - an OAM node in a cluster that uses the OAM configuration type.
  • managed-vm - a node, managed by an OAM node, in a cluster that uses the OAM configuration type.
  • direct-single - a node in a cluster that uses the Direct Single configuration type.
  • sbc - a non-clustered node such as a hardware-based SBC.
isOAM

Use this parameter to output whether the node is an OAM node. Options are:

  • false
  • true
ParameterDescription
savedConfigurations

Use this parameter to output a list of configuration revisions saved on the OAM node identified by revision number and a timestamp. Available only on OAM nodes.


SBX-44930 SBC SWe and CE Gateway Signaling Support (MCS)

 The parameter, ipVar is added to gwSigPort to support IP address (IPV4 or IPV6 address) configurations for gwSigPort in SBC SWe Cloud.

set addressContext <addressContext_name> zone <zone_name> gwSigPort <#>
ipInterfaceGroupName <name>
ipVar <IPv4 or IPv6 private ip>
mode <inService | outOfService>
portNumber <#>
role <primary | secondary>
state <disabled | enabled>
ParameterLength/RangeDefaultDescriptionM/O
 ipVar

1 - 255 characters

NA

Metavariable name associated with the gateway signaling port IP address. This is used to configure gateway signaling IP address in Cloud.

SBC SWe
O

SBX-51725/SBC-72926 Flexible AD Support for ERE

The following profiles are added: 

  • adProfile
  • adAttributeMapProfile
  • callParameterFilterProfile
  • callParamFilterGroupProfile

Also added are:

  • domainController
  • adManualSync
  • adSyncStatus
  • adServiceStats
  • searchAdData

Also, under numberTranslationCriteria, the following are added:

  • inDmRule
  • outDmRule
  • callParameterFilterGroupProfile

The following sections provide details on the CLI changes. 

adProfile

the adProfile is added to the CLI. 

The SBC uses three configurations uses to sync data from remote server that are configured in the AD Profile:

 

  • Manual Sync – A request based CLI option is provided to trigger a manual sync request. As a precondition, the AD Profile sync attribute should be enabled. Manual Sync will not change any of the delayedSync or syncInterval logic. syncInterval will kick in only after a successful sync due to delayed sync.

  • Delayed Sync – This is a date and time string parameter. This value should always be greater than current system time during configuration. So, when the system time is equal to the configured date and time, the SBC will trigger to fetch the data from the remote AD server. As a precondition, AD Profile sync attribute must be enabled. If delayedSync fails to sync, then the SBC retries the sync operation after 1 minute of the failure. To stop the syncing operation, the user can disable the sync parameter in the AD Profile.

  • Sync Interval – The value is in the range of 60 minutes to 43200 minutes (30 Days) . This is triggered only after a successful sync due to delayed sync configuration. This syncInterval will trigger sync operation in regular intervals.

Command Syntax

adProfile Command Syntax
% set profiles adProfile <DEFAULT_AD_PROFILE> sync <disable/enable> delayedSync <Time> syncInterval <time> applyNormalization <disable/enable> adServerList <list> dcServer <server name>

Command Parameters

adProfile Parameters

Flexible ParameterLength/RangeDefaultDescriptionM/O
adProfileNADEFAULT_AD_PROFILEAD Profile nameM
adServerList1 - 32NAConfigure AD servers to sync dataM
applyNormalizationdisable/enabledisableNormalize the data received from AD ServerO
delayedSyncNANA

Delayed sync for the specified duration. Format: YYYY-MM-DDTHH:MM:SS.

The date and time value should be greater than the current system time.

M
syncdisable/enabledisableEnabling or disabling of sync operation with AD serverO
syncInterval60 - 4320060Input the Periodic Sync Interval Timer in MinutesM

  • A new parameter, blkListAlgRetryAfterMethods is added to SIP ARS profile. These are added to the existing syntax below:

set profiles services sipArsProfile <Profilename> blkListAlgRetryAfterMethods <sip-invite | sip-register |sip-subscribe |sip-notify | sip-options>
  • Two new parameters are added to SIP Trunk Group configuration: localSurvivabilityState and allowLocalRegistration. These are added to the existing syntax below:

    Note

    Enable allowLocalRegistration  towards Access side not towards AS side and localSurvivableState on both sides (Access and AS).

    Ensure localSurvivableState is enabled so that allowLocalRegistration can be enabled.

Local Survivable Mode for Calls and Registrations
set addressContext <name> zone <name> sipTrunkGroup <name> services localSurvivability localSurvivableState <enable | disable >
set addressContext <name> zone <name> sipTrunkGroup <name> services localSurvivability allowLocalRegistration <enable | disable >

Command Parameters

ParameterLength/RangeDefaultDescriptionM/O
 localSurvivableState


disabled

Enable this flag to activate local call routing.

The SBC switches to localSurvivableMode if it is enabled.

The options include:

  • disabled
  • enabled
O
allowLocalRegistration disabled

Enable this flag to allow local registration when the ARS blacklist the Applicatiotn Server (AS).

If allowLocalRegistration configuration is enabled towards Access side, the SBC handles new registration requests locally.

If allowLocalRegistration configuration is enabled, the SBC accepts the registration request without authentication and locally respond with a 200OK.

The options include:

  • disabled
  • enabled
M
blkListAlgRetryAfterMethods NA

Use this parameter to specify the SIP request types to retry after blacklist algorithm.

The options include:

  • sip-register 
  • sip-subscribe
  • sip-invite 
  • sip-notify 
  • sip-options
M

CLI Examples

Local Survivable Mode for Calls and Registrations
set addressContext default zone ZONE_IN sipTrunkGroup Ingress_TG services localSurvivability localSurvivableState enabled
set addressContext default zone ZONE_IN sipTrunkGroup Ingress_TG services localSurvivability  allowLocalRegistration enabled

To view the status of the local survivability state and allow local registration, execute the command:

show addressContext default zone ZONE_IN sipTrunkGroup Ingress_TG services localSurvivability
localSurvivabilityState enabled;
allowLocalRegistration  enabled;
[ok]

To set the methods to be used for retry-after blacklist algorithm, execute the command:

set profiles services sipArsProfile Sip_ARS_Profile_Name blkListAlgRetryAfterMethods 
Possible completions:
sip-invite sip-notify sip-options sip-register sip-subscribe

To view the method of blacklisting with retry-after in SIP ARS Profile, execute the following command:

show details profiles services sipArsProfile Sip_ARS_Profile_Name
blkListAlgorithms              timeouts,retryafter;
blkListAlgTimeoutsType         sip-invite;
blkListAlgTimeoutsNumTimeouts  1;
blkListAlgTimeoutsDuration     1;
blkListAlgNoRetryAfterNum503   1;
blkListAlgNoRetryAfterDuration 1;
blkListAlgRetryAfterMethods    sip-register;
blkListAlgRetryAfterType       sip-503;
midDialogArsScreenLevel        never;
recoveryAlgorithm              probe;
recoveryAlgTimerDuration       1;
recoveryAlgProbeMethod         sip-options;
recoveryAlgProbeInterval       1;
recoveryAlgProbeNumResponses   1;
recoveryAlgProbeDuration       1;
[ok]

The following is an example command of how to create an AD Profile.

set profiles adProfile DEFAULT_AD_PROFILE sync enable syncInterval 1440 delayedSync 2019-03-07T23:59:00 adServerList 1 dcServer ADSERVER1


The following example shows how to trigger manual sync:

request system admin <systemName> adManualSync

domainController

The domainController object is added to the CLI. The domainController configuration needs to be completed to fetch the data from the remote server. The domainController entity holds data related to the remote Active Directory Server.

Command Syntax

The following command shows how to create a domain controller.

domainController Command Syntax
% set global servers domainController <server name> description <description> userName <username> password <password> primaryIP <x.x.x.x> ldapQueryCriteria <criteria> searchScope <search scope> 


Command Parameters

domainController Parameters

Flexible ParameterLength/RangeDefaultDescriptionM/O
domainController1 - 23NADomain Controller nameM
description1 - 23NA

Active Directory Domain Controller Description

O
ldapQueryCriteria1 - 127NAData will be fetched based on this query criteriaM
password1 - 127NAActive Directory Domain Controller PasswordM
primaryIPNANAPrimary IP Address Of The Domain ControllerM
remotePort1 - 65535389Remote Server PortO
searchScope1 - 127NAScope of the Active Directory from where data shall be fetchedM
secondaryIPNANA

Secondary IP Address Of The Domain Controller

O
useTLSdisable/enabledisableIf enabled, TLS shall be used for communication with this domain controllerO
userName1 - 127NAActive Directory Domain Controller UsernameM
Command Example

Configure the ACL rule and management interface static route for the domain controller’s IP. This is to ensure that the management interface is used to send the LDAP query and packets from the AD server are allowed reach the application. The following is an example:

set global servers domainController adaserver userName rbbn password ribbon1 searchScope CN=Users,dc=sonusqa,dc=net ldapQueryCriteria cn=* primaryIP 10.50.10.20

adAttributeMapProfile

The adAttributeMapProfile is added to the CLI. This profile allows the user to configure flexible AD attributes. For each attribute there is an AD attribute identified. This AD attribute identified is used as referenced in all other entities. 

Command Syntax

The following command is used to create the AD Attribute Map Profile.

adAttributeMapProfile Command Syntax
% set profiles adAttributeMapProfile <DEFAULT_AD_ATTRIBUTE_PROFILE > adAttributeList  <adAttribute> adAttributeName  <adAttributeName>

Command Parameters

adAttributeMapProfile Parameters

 Flexible ParameterLength/RangeDefaultDescriptionM/O
adAttributeMapProfile

NA

DEFAULT_AD_ATTRIBUTE_PROFILE

Ad attribute map profile name

M
adAttributeList1 - 32NAAd attribute sequence to be mapped with attribute nameM
adAttributeName1- 63NAAd attribute nameM
Command Example

The following is an example of how to create an AD Attribute Map Profile:

set profiles adAttributeMapProfile DEFAULT_AD_ATTRIBUTE_PROFILE adAttributeList adAttribute1 adAttributeName cn 
commit 
set profiles adAttributeMapProfile DEFAULT_AD_ATTRIBUTE_PROFILE adAttributeList adAttribute2 adAttributeName telephoneNumber 
commit 
set profiles adAttributeMapProfile DEFAULT_AD_ATTRIBUTE_PROFILE adAttributeList adAttribute3 adAttributeName mobile 
commit 
set profiles adAttributeMapProfile DEFAULT_AD_ATTRIBUTE_PROFILE adAttributeList adAttribute4 adAttributeName unixHomeDirectoryNumber 
commit

With the above configuration in the SBC, adAttribute1 refers to cn in all other entities like dmPm criteria, dmPm Rule and Call Parameter Filter Profile. Similarly adAttribute2 refers to telephoneNumber, and so on.

If any changes are made in this profile, and the data has already successfully synchronized before the modification, then perform a synchronization using either the manual sync command or wait until the syncInterval timer starts and synchronizes the data. Until synchronization is performed, the new modified data is not used, thus call failures can occur.

callParameterFilterProfile

The callParameterFilterProfile is added to the CLI. 

Command Syntax

callParameterFilterProfile Command Syntax
% set profiles callParameterFilterProfile <CPFP Name> callParameterFilterProfileData <sequence id> adAttributes <attributes> operation < type > adCpe <CPE Type>

Command Parameters

callParameterFilterProfile Parameters

Flexible ParameterLength/RangeDefaultDescriptionM/O
callParameterFilterProfile 1 - 23NACall Parameter Profile nameM
callParameterFilterProfileData0 - 256NASequence Number for Call Parameter Filter ProfileM
description1 - 199NADescription of the Call Parameter Filter ProfileO
adAttributes<1 - 32>NAActive Directory attributes listM
operationNANAAD operations for Call Parameter Filter ProfileM
adCpeNANAAD CPE typeO
Command Example

The following is an example of how to configure the Call Parameter Filter Profile:

Example
set profiles callParameterFilterProfile Test callParameterFilterProfileData 45 adAttributes adAttribute3 operation = adCpe callingNumber

 

callParamFilterGroupProfile

The callParamFilterGroupProfile is added to the CLI. 

Command Syntax

callParamFilterGroupProfile Command Syntax
% set profiles callParamFilterGroupProfile <CPFGP Name> description <desn> callParamFilterGroupProfileData <sequence id> callParamFilterProfile <CPFP Name>


Command Parameters

callParamFilterGroupProfile Parameters

Flexible ParameterLength/RangeDefaultDescriptionM/O
callParamFilterGroupProfile 1 - 23NACall Parameter Filter Profile Group nameM
description1 - 199NADescription of the Call Parameter Filter Group ProfileO
callParamFilterGroupProfileData0 - 256NAData rows for Call Parameter Filter Group ProfileM
callParamFilterProfileNANATo attach call parameter profile IDM
Command Example

The following is an example of how to configure the Call Parameter Filter Group Profile:

Example
set profiles callParamFilterGroupProfile CPFP_Group  callParamFilterGroupProfileData 110 callParamFilterProfile Test

adService

 

adService is added to the CLI. 

Command Syntax 

adService Command Syntax
% set global servers adService <Service Name> priority <Num>
% set global servers adService  < Service Name> criteria triggerCriteria <criteria>
% set global servers adService  < Service Name> flags active <enable/disable>

Command Parameters

adService Command Parameters

Flexible ParameterLength/RangeDefaultDescriptionM/O
adService1-23NAAD Service name used for AD service trigger.M
Command Example

The following is an example of how to Create Ad Service and associate trigger criteria:

Example
set global servers adService ADSERV1 priority 10
set global servers adService ADSERV1  criteria triggerCriteria Test
set global servers adService ADSERV1  flags active enable


adManualSync

adManualSync is added to the CLI. 

Command Syntax

adManualSync Command Syntax
% request system admin <System Name> adManualSync

Command Parameters

adManualSync Command Parameters

Flexible ParameterLength/RangeDefaultDescriptionM/O
adManualSyncNA NAThis is a request to Sync with AD Server to fetch subscriber data.O
Command Example

The following is an example of how to request manual sync:

Example
request system admin TICKS adManualSync

adSyncStatus

adSyncStatus is added to the CLI. 

Command Syntax

adSyncStatus Command Syntax
% show status system adSyncStatus

Command Parameters

adSyncStatus Command Parameters

Flexible ParameterLength/RangeDefaultDescriptionM/O
adSyncStatusNA NADisplays AD server sync statusO
Command Example

The following is an example of how to show sync status:

Example
show status system adSyncStatus


adServiceStats

adServiceStats is added to the CLI. 

Command Syntax

adServiceStats Command Syntax
% show status global policyServer adServiceStats

Command Parameters

adServiceStats Command Parameters

Flexible ParameterLength/RangeDefaultDescriptionM/O
adServiceStatsNA NADisplays AD Service StatsO
Command Example

The following is an example of how to show AD service stats/counter for success and failed call:

Example
show status global policyServer adServiceStats

Example of table format:

Example
show table global policyServer adServiceStats

searchAdData

searchAdData is added to the CLI. 

Command Syntax

searchAdData Command Syntax
% request system admin <System Name> searchAdData adAttributeIdentifier < AD adAttribute> searchString <search data>

Command Parameters

searchAdData Command Parameters

Flexible ParameterLength/RangeDefaultDescriptionM/O
searchAdDataNA NASearches the local AD databaseO
adAttributeIdentifier<1 - 32>NAAD Attribute IdentifierM
searchString1 - 64NAA request to Search StringM
Command Example

The following is an example of how to search AD Data: 

Example
request system admin TITAS searchAdData adAttributeIdentifier adAttribute2 searchString 8067100197

numberTranslationCriteria

inDmRule, outDmRule, and callParameterFilterGroupProfile are added under numberTranslationCriteria.

Command Syntax

% set profiles digitParameterHandling numberTranslationCriteria <Criteria Name> trunkGroup <TG Name> <GatewayName> <National> <Country> lookupType AD callParameterFilterGroupProfile <CPFPG Id> InDmRule <inDmPmRule Id> outDmRule <outDmPmRule Id>

Command Parameters

numberTranslationCriteria Command Parameters

Flexible ParameterLength/RangeDefaultDescriptionM/O
inDmRule NA NAThis dm pm rule is performed before fetching the data from local database.O
outDmRule NA NA This dm pm rule is performed after fetching the data from local database.O
callParameterFilterGroupProfile 1 - 23NACall Parameter Filter Profile Group nameM
Command Example

The following is an example of how to configure adInDmRuleadOutDmRule, and callParameterFilterGroupProfile.

Example
set profiles digitParameterHandling numberTranslationCriteria POCNTC1 trunkGroup TG_SIPART_IAD TITAS Sonus_NULL Sonus_NULL lookupType AD callParameterFilterGroupProfile POCCPFPG1 outDmRule POCDMPMRULE1 inDmRule POCINDMRULE1

SBX-63318 /SBX-53949  Secure Remote Syslog for TCP Support

The SBC provides an option to provision a new parameter Rsyslog Profile. This profile uses local and remote certificates imported to the SBC and generates the three certificate files required for the rsyslog.conf file to support communication for Rsyslog.

Command Syntax

The set command creates a new profile, assigns the local and remote certificates to the profile and generates the three Certificate files required for Rsyslog:

Example
set profiles security RsyslogProfile <profile_name> clientCertName localCert serverCaCertName remoteCert

Command Parameters

ParameterLength/RangeDefaultDescriptionM/O

RsyslogTlsProfile

NANA

The name of the RsyslogTls profile.

M

Command examples

set profiles security RsyslogTlsProfile rlog
Possible completions:
  clientCertName   - The name of client Certificate referred by this Rsyslog-TLS profile.
  serverCaCertName - The name of server CA Certificate referred by this Rsyslog-TLS profile
show profiles security RsyslogTlsProfile
RsyslogTlsProfile rSyslogprofile {
    clientCertName   localCert;
    serverCaCertName remoteCACert;
}
[ok]
show system security pki
certificate localCert {
    state    enabled;
    fileName localCert.pem;
    type     local-internal;
}
certificate remoteCACert {
    state    enabled;
    fileName rootCA.der;
    type     remote;
}
certificate defaultSBCCert {
    state      enabled;
    fileName   sonuscert.p12;
    passPhrase $7$DibBrv9m1udynmteAN7fg48KXCD0O8/v;
    type       local;
}
certificate defaultDtlsSBCCert {
    state      enabled;
    fileName   defaultDtlsCert.p12;
    passPhrase $7$dbJlv+/Ds4mYQqJvIiOv/gl5ZdVCSOfV;
    type       local;
}
[ok]

SBX-73680 Local Survivable Mode for Calls and Registrations

  • A new parameter, blkListAlgRetryAfterMethods is added to SIP ARS profile. These are added to the existing syntax below:

set profiles services sipArsProfile <Profilename> blkListAlgRetryAfterMethods <sip-invite | sip-register |sip-subscribe |sip-notify | sip-options>
  • Two new parameters are added to SIP Trunk Group configuration: localSurvivabilityState and allowLocalRegistration. These are added to the existing syntax below:

    Note

    Enable allowLocalRegistration  towards Access side not towards AS side and localSurvivableState on both sides (Access and AS).

    Ensure localSurvivableState is enabled so that allowLocalRegistration can be enabled.

Local Survivable Mode for Calls and Registrations
set addressContext <name> zone <name> sipTrunkGroup <name> services localSurvivability localSurvivableState <enable | disable >
set addressContext <name> zone <name> sipTrunkGroup <name> services localSurvivability allowLocalRegistration <enable | disable >

Command Parameters

ParameterLength/RangeDefaultDescriptionM/O
 localSurvivableState


disabled

Enable this flag to activate local call routing.

The SBC switches to localSurvivableMode if it is enabled.

The options include:

  • disabled
  • enabled
O
allowLocalRegistration disabled

Enable this flag to allow local registration when the ARS blacklist the Applicatiotn Server (AS).

If allowLocalRegistration configuration is enabled towards Access side, the SBC handles new registration requests locally.

If allowLocalRegistration configuration is enabled, the SBC accepts the registration request without authentication and locally respond with a 200OK.

The options include:

  • disabled
  • enabled
M
blkListAlgRetryAfterMethods NA

Use this parameter to specify the SIP request types to retry after blacklist algorithm.

The options include:

  • sip-register 
  • sip-subscribe
  • sip-invite 
  • sip-notify 
  • sip-options
M

CLI Examples

Local Survivable Mode for Calls and Registrations
set addressContext default zone ZONE_IN sipTrunkGroup Ingress_TG services localSurvivability localSurvivableState enabled
set addressContext default zone ZONE_IN sipTrunkGroup Ingress_TG services localSurvivability  allowLocalRegistration enabled

To view the status of the local survivability state and allow local registration, execute the command:

show addressContext default zone ZONE_IN sipTrunkGroup Ingress_TG services localSurvivability
localSurvivabilityState enabled;
allowLocalRegistration  enabled;
[ok]

To set the methods to be used for retry-after blacklist algorithm, execute the command:

set profiles services sipArsProfile Sip_ARS_Profile_Name blkListAlgRetryAfterMethods 
Possible completions:
sip-invite sip-notify sip-options sip-register sip-subscribe

To view the method of blacklisting with retry-after in SIP ARS Profile, execute the following command:

show details profiles services sipArsProfile Sip_ARS_Profile_Name
blkListAlgorithms              timeouts,retryafter;
blkListAlgTimeoutsType         sip-invite;
blkListAlgTimeoutsNumTimeouts  1;
blkListAlgTimeoutsDuration     1;
blkListAlgNoRetryAfterNum503   1;
blkListAlgNoRetryAfterDuration 1;
blkListAlgRetryAfterMethods    sip-register;
blkListAlgRetryAfterType       sip-503;
midDialogArsScreenLevel        never;
recoveryAlgorithm              probe;
recoveryAlgTimerDuration       1;
recoveryAlgProbeMethod         sip-options;
recoveryAlgProbeInterval       1;
recoveryAlgProbeNumResponses   1;
recoveryAlgProbeDuration       1;
[ok]

Deprecated CLI

Deprecated CLI

Command / CLI Object ImpactedDeprecated CLIEffective Release
show table systemCongestionStatussystemCongestionMemLevel4.2.6R0
set system congestion"static" option4.2.6R0
set system congestion adaptive MCLevel"mc0" level4.2.6R0
set profiles system overloadProfilestaticMode parameter4.2.6R0
set profiles system overloadProfile "memory" option for setDuration, clearDuration, setThreshold, clearThreshold configurations4.2.6R0
set system adminmanagementIpVersion5.0.0R0
request system admin commandcommitSoftwareUpgrade5.0.0R0
show status system serverSoftwareUpgradeStatus
"committed" option5.0.0R0
show status addressContext <addressContext name> sipSubCountStatistics sipSubCountTotal5.0.5R0
request system admin <system Name> revertSoftwareUpgrade
revertSoftwareUpgrade
5.0.0R0
request system admin <system Name> commitSoftwareUpgrade
commitSoftwareUpgrade
5.0.0R0
H.323 IP Signaling Profile commonIpAttributes flags
  • addPChargingFuncAddr
  • disableMediaLockDown
  • fromHeaderAnonymisation
  • sendRTCPBandwidthInfo
  • sendRtcpPortInSdp
  • terminalPortabilityInterworking
  • usePsxRouteforRegisteredInvite
5.1.0R0
Packet Service ProfilemediaLockDownForPassThrough5.1.0R0
interceptCallDataChannelStatistics
  • primaryTcpChannelStatus.
  • secondaryTcpChannnelStatus.
  • DSRSuccess
  • DSRFailures
5.1.0R0
show table global siprecStatussiprecStatus6.2.0R0
show status system
  • licenseLocalBundleInfo
  • licenseMode
7.0.0R0
show table system
  • licenseLocalBundleInfo
  • licenseMode
7.0.0R0
set system
  • licenseMode
7.0.0R0
eventLog typeAdmin
  • syslogRemoteHost
  • syslogRemoteProtocol
  • syslogRemotePort
7.1.0R0
set system licenseMode mode
  • legacy option is replaced with nodeLocked
  • network option is deprecated
8.0.0R0
request system resetLicenseStats
  • resetLicenseFeatureStats
  • resetLicenseServerStats
8.0.0R0
show table system
  • licenseFeatureStatus
  • licenseRequiredStatus
  • licenseServer
  • licenseServerStatus
8.0.0R0
show status system
  • licenseFeatureStatus
  • licenseServerStatus
8.0.0R0
set system clusterAdmin
  • clusterComm These options are now available only for M-SBC SBC SWe cloud deployments. It is no longer available for other types of SBC deployments
8.0.0R0
 

 

  • No labels