Use this profile to configure a Call Admission Control (CAC) profile providing the ability for each SIP registered or static endpoint to have individualized limits on the number of active calls, bandwidth size, call rates, over-subscription amounts, burst sizes, etc.
SIP CAC Profile
Command Syntax
Code Block |
---|
% set profiles sipCacProfile <profile_name>
aggregateMessage
bandwidthLimit
bandwidthLimitThreshold
bandwidthVideoThreshold
callEgressAggregateEmergencyPreference
callEgressAggregatePreference
callEgressBurstSize
callEgressEmergencyPreference
callEgressRate
callEgressRatePeriod
callIngressAggregateEmergencyPreference
callIngressAggregatePreference
callIngressBurstSize
callIngressEmergencyPreference
callIngressRate
callIngressRatePeriod
callLimit
callLimitEgress
callLimitIngress
callLimitThreshold
dblAggregateRej
emergencyOversubscription
emergencyOversubscriptionEgress
emergencyOversubscriptionIngress
extendedEmergencyIpLimit
extendedEmergencyIpLimitEgress
extendedEmergencyIpLimitIngress
hpcCallLimits
message
notify
options
otherRequests
qoe
refer
response
state
subscribe |
Command Parameters
Caption |
---|
0 | Table |
---|
1 | SIP CAC Profile Parameter |
---|
3 | SIP CAC Profile Parameter |
---|
|
Parameter | Length/Range | Description |
---|
sipCacProfile
| 1-23 | <profile name> – The name of SIP Call Admission Control (CAC) profile.
Refer to the subsequent sections for SIP CAC Profile configuration options. |
|
Aggregate Message
Use this object to configure the Aggregate Message policer settings listed below.
Command Syntax
Code Block |
---|
% set profiles sipCacProfile <profile_name> aggregateMessage
egressBurstSize (1-10000)
egressRate (1-1000, unlimited)
egressRatePeriod (1-10)
ingressBurstSize (1-10000)
ingressRate (1-1000, unlimited)
ingressRatePeriod (1-10) |
Command Parameters
Caption |
---|
0 | Table |
---|
1 | Aggregate Message Parameters |
---|
3 | Aggregate Message Parameters |
---|
|
Parameter | Length/Range | Description |
---|
egressBurstSize | 1-10000 | Maximum Aggregate Message egress burst size. (default = 10) | egressRate | 1-1000, 'unlimited' | Maximum Aggregate Message egress rate. (default is 'unlimited') | egressRatePeriod | 1-10 | Aggregate Message egress rate period in seconds. (default = 1) | ingressBurstSize | 1-10000 | Maximum Aggregate Message ingress burst size. (default = 10) | ingressRate | 1-1000, 'unlimited' | Maximum Aggregate Message ingress rate. (default is 'unlimited') | ingressRatePeriod | 1-10 | Aggregate Message ingress rate period in seconds. (default = 1) |
|
Bandwith
Command Syntax
Code Block |
---|
|
% set profiles sipCacProfile <profile_name>
bandwidthLimit <0-2147483647>
bandwidthLimitThreshold <0-100>
bandwidthVideoThreshold <0-100> |
Command Parameters
Caption |
---|
0 | Table |
---|
1 | Bandwith Parameters |
---|
3 | Bandwith Parameters |
---|
|
Parameter | Length/Range | Description |
---|
bandwidthLimit
| 0-2147483647 | Maximum bandwidth (in Kbps) a peer can utilize. (default is 'unlimited') | bandwidthLimitThreshold
| 0-100 | Enter threshold value (as a percentage) to specify bandwidth utilization notification threshold. (default = 0) | bandwidthVideoThreshold | 0-100 | Enter threshold value (as a percentage of video bandwidth) to limit video streams to a specific bandwidth to prevent video calls consuming call bandwidth otherwise needed for audio calls. (default = 0) |
|
Call
Command Syntax
Code Block |
---|
|
% set profiles sipCacProfile <profile_name>
callEgressAggregateEmergencyPreference <1-10>
callEgressAggregatePreference <1-10>
callEgressBurstSize <1-500>
callEgressEmergencyPreference <disabled | enabled>
callEgressRate <1-500, unlimited>
callEgressRatePeriod <1-10>
callIngressAggregateEmergencyPreference <1-10>
callIngressAggregatePreference <1-10>
callIngressBurstSize <1-500>
callIngressEmergencyPreference <disabled | enabled>
callIngressRate <1-500, unlimited>
callIngressRatePeriod <1-10> callLimit <0-30000, unlimited>
callLimitEgress <0-30000, unlimited>
callLimitIngress <0-30000, unlimited>
callLimitThreshold <0-100> |
Command Parameters
Caption |
---|
0 | Table |
---|
1 | Call Parameters |
---|
3 | Call Parameters |
---|
|
Parameter | Length/Range | Description |
---|
callEgressAggregateEmergencyPreference
| 1-10 | Emergency call preference within the aggregate policer at Egress. (default = 10) | callEgressAggregatePreference
| 1-10 | Call preference within the aggregate policer at Egress. (default = 1) | callEgressBurstSize
| 1-500 | Maximum call burst size for calls to a registered endpoint or peer. (default = 1). | callEgressEmergencyPreference
| N/A | Emergency call preference at Egress. disabled (default)enabled
| callEgressRate
| 1-500, unlimited | Maximum egress call rate in calls per time period. (default is 'unlimited'). | callEgressRatePeriod
| 1-10 | Time period (in seconds) over which the egress call rate applies. (default = 1). | callIngressAggregateEmergencyPreference
| 1-10 | Emergency call preference within the aggregate policer at Ingress. (default = 10) | callIngressAggregatePreference
| 1-10 | Call preference within the aggregate policer at Ingress. (default = 1) | callIngressBurstSize
| 1-500 | Maximum call burst size from a peer or registered endpoint. (default = 1). | callIngressEmergencyPreference
| N/A | Emergency call preference at Ingress. disabled (default)enabled
| callIngressRate
| 1-500, unlimited | Maximum call arrival rate from a peer or registered endpoint per callIngressRatePeriod . (default is 'unlimited'). A value of "0" indicates that call rate policing is not applicable. | callIngressRatePeriod
| 1-10 | Time period (in seconds) over which the callIngressRate applies. (default = 1). | callLimit
| 0-30000, unlimited | Maximum number of active calls to and from any registered endpoint or peer (e.g. total number of ingress and egress calls). (default is 'unlimited') | callLimitEgress
| 0-30000, unlimited | Maximum number of outbound active calls. (default is 'unlimited') | callLimitIngress
| 0-30000, unlimited | Maximum number of inbound active calls. (default is 'unlimited') | callLimitThreshold
| 0-100 | Call Limit utilization notification threshold, as a percentage. (default = 0). |
|
Dynamic Black List Aggregate Reject
Use this object to Dynamically Blacklist (DBL) an endpoint based on the CAC policer reject rate using settings below.
Command Syntax
Code Block |
---|
|
% set profiles sipCacProfile <profile_name> dblAggregateRej
ingressBurstSize (1-10000)
ingressRate (1-1000, unlimited)
ingressRatePeriod (1-10) |
Command Parameters
Caption |
---|
0 | Table |
---|
1 | DBL Aggregate Reject Parameters |
---|
3 | DBL Aggregate Reject Parameters |
---|
|
Parameter | Length/Range | Description |
---|
ingressBurstSize | 1-10000 | Maximum DBL Aggregate Reject ingress burst size.(default = 1) | ingressRate | 1-1000, 'unlimited' | Maximum DBL Aggregate Reject ingress rate.(default is 'unlimited') | ingressRatePeriod
| 1-10 | DBL Aggregate Reject ingress rate period in seconds.(default = 1) |
|
Emergency Oversubscription
Command Syntax
Code Block |
---|
|
% set profiles sipCacProfile <profile_name>
emergencyOversubscription <0-1000>
emergencyOversubscriptionEgress <0-1000>
emergencyOversubscriptionIngress <0-1000> |
Command Parameters
Caption |
---|
0 | Table |
---|
1 | Emergency Oversubscription Parameters |
---|
3 | Emergency Oversubscription Parameters |
---|
|
Parameter | Length/Range | Description |
---|
emergencyOversubscription
| 0-1000 | Oversubscription of calls (as a percentage) allowed for emergency calls. (default = 0). | emergencyOversubscriptionEgress
| 0-1000 | Oversubscription of egress calls (as a percentage) allowed for emergency calls. When the baseline limit is reached, normal calls are stopped but emergency calls are allowed up to this additional percentage. (default = 10). | emergencyOversubscriptionIngress
| 0-1000 | Oversubscription of calls (as a percentage) allowed for emergency calls. When the baseline limit is reached, normal calls are stopped but emergency calls are allowed up to this additional percentage. (default = 10). |
|
Extended Emgergency IP Limit
Command Syntax
Code Block |
---|
|
% set profiles sipCacProfile <profile_name>
extendedEmergencyIpLimit <0-40000>
extendedEmergencyIpLimitEgress <0-40000>
extendedEmergencyIpLimitIngress <0-40000> |
Command Parameters
Caption |
---|
0 | Table |
---|
1 | Extended Emgergency IP Limit Parameters |
---|
3 | Extended Emgergency IP Limit Parameters |
---|
|
Parameter | Length/Range | Description |
---|
extendedEmergencyIpLimit
| 0-40000 | Additional number of emergency calls (expressed as a numeric value) allowed if call limit and emergency oversubscription quota are exhausted. (default = 0) | extendedEmergencyIpLimitEgress | 0-40000 | Additional number of emergency calls (expressed as a numeric value) allowed for egress CAC group if call limit and emergency oversubscription quota are exhausted. (default = 0) | extendedEmergencyIpLimitIngress | 0-40000 | Additional number of emergency calls (expressed as a numeric value) allowed for ingress CAC group if call limit and emergency oversubscription quota are exhausted. (default = 0) |
|
HPC Call Limits
Info |
---|
|
Before you provision the HPC call limits, ensure that a sipCacProfile exists and associates with a static IP Peer. Refer to Zone - IP Peer - CLI for configuration details. |
Use this object to provision the HPC call limits for the SIP CAC profile.
Include Page |
---|
| _GETS_Use_Note |
---|
| _GETS_Use_Note |
---|
|
Command Syntax
To configure the hpcCallLimits
in the sipCacProfile
, use the following command syntax:
Code Block |
---|
set profiles sipCacProfile <profile_name> hpcCallLimits
maxCalls <unlimited | blockAll | 1-1000>
maxIngressRate <unlimited | 1-2000>
ingressRateInterval <1-30>
bucketSize <1-4000> |
Parameter Description
The descriptions of the parameters and flags are as follows:
Caption |
---|
|
Parameters | Length/Range | Default | Description | M/O |
---|
hpcCallLimits | N/A | N/A | Use this parameter to provision the HPC call limits for the SIP CAC profile for the trunk group. | O | maxCalls | N/A | unlimited | Use this parameter to configure the maximum number of simultaneous HPC calls. blockAll unlimited (default)
<1-1000>
| O | maxIngressRate | N/A | unlimited | Use this parameter to configure the maximum rate of ingress HPC calls per interval minute. unlimited (default)<1-2000>
| O | ingressRateInterval | 1-30 | 5 | Use this parameter to configure the interval (in minutes) for the ingress rate of HPC calls. | O | bucketSize | 1-4000 | 10 | Use this parameter to limit the rate of received HPC calls. | O |
|
Command Example
To configure the hpcCallLimits
in the sipCacProfile
, use the following command example:
Code Block |
---|
% set profiles sipCacProfile testSipCacProfile hpcCallLimits maxCalls 500 maxIngressRate 50 ingressRateInterval 10 bucketSize 32
% commit |
To display the hpcCallLimits
in the sipCacProfile
, use the following command example:
Code Block |
---|
> show profiles sipCacProfile testSipCacProfile hpcCallLimits
maxCalls 500;
maxIngressRate 50;
ingressRateInterval 10;
bucketSize 32;
}
} |
Hide |
---|
Inactivity Timeout For Unregistered EndpointsCommand Syntax Code Block |
---|
% set profiles sipCacProfile <sipCacProfile name> inactivityTimeoutForUnregisteredEndpoints <1 to 1000000> |
Command Parameters Caption |
---|
0 | Table |
---|
1 | Inactivity Timeout For Unregistered Endpoints Parameters |
---|
3 | Inactivity Timeout For Unregistered Endpoints Parameters |
---|
| Parameter | Length/Range | Description |
---|
inactivityTimeoutForUnregisteredEndpoints
| 1-1000000 | <value> (default = 1000000) – Use this parameter to specify the inactivity timeout period, in minutes, before terminating non-registered endpoints.
Note: The parameter inactivityTimeoutForUnregisteredEndpoints only available for configuration after termConditionForUnregisteredEndpoints is set to "inactivitytimeout" . |
|
|
Message
Use this object to configure the MESSAGE message in a SIP CAC profile using the settings below.
Command Syntax
Code Block |
---|
% set profiles sipCacProfile <profile_name> message
egressAggregatePreference (1-10)
egressBurstSize (1-10000)
egressRate (1-1000, unlimited)
egressRatePeriod (1-10)
ingressAggregatePreference (1-10)
ingressBurstSize (1-10000)
ingressRate (1-1000, unlimited)
ingressRatePeriod (1-10) |
Command Parameters
Caption |
---|
0 | Table |
---|
1 | MESSAGE Parameters |
---|
3 | MESSAGE Parameters |
---|
|
Parameter | Length/Range | Description |
---|
egressAggregatePreference | 1-10 | MESSAGE preference within egress aggregate policer. (default = 1) | egressBurstSize | 1-10000 | Maximum MESSAGE egress burst size. (default = 1) | egressRate | 1-1000, 'unlimited' | Maximum MESSAGE egress rate. (default is 'unlimited') | egressRatePeriod | 1-10 | MESSAGE egress rate period in seconds. (default = 1) | ingressAggregatePreference | 1-10 | MESSAGE preference within ingress aggregate policer. (default = 1) | ingressBurstSize | 1-10000 | Maximum MESSAGE ingress burst size. (default = 1) | ingressRate | 1-1000, 'unlimited' | Maximum MESSAGE ingress rate. (default is 'unlimited') | ingressRatePeriod
| 1-10 | MESSAGE ingress rate period in seconds. (default = 1) |
|
Notfiy
Command Syntax
Code Block |
---|
|
% set profiles sipCacProfile <profile_name> notify
egressAggregatePreference (1-10)
egressBurstSize (1-10000)
egressRate (1-1000, unlimited)
egressRatePeriod (1-10)
ingressAggregatePreference (1-10)
ingressBurstSize (1-10000)
ingressRate (1-1000, unlimited)
ingressRatePeriod (1-10) |
Command Parameters
Caption |
---|
0 | Table |
---|
1 | NOTIFY Parameters |
---|
3 | NOTIFY Parameters |
---|
|
Parameter | Description |
---|
notify
| Use this object to configure the NOTIFY message in a SIP CAC profile. NOTE: Egress and ingress settings are the same as MESSAGE Parameters above. Simply replace MESSAGE with NOTIFY in the descriptions. |
|
Options
Command Syntax
Code Block |
---|
|
% set profiles sipCacProfile <profile_name> options
egressAggregatePreference (1-10)
egressBurstSize (1-10000)
egressRate (1-1000, unlimited)
egressRatePeriod (1-10)
ingressAggregatePreference (1-10)
ingressBurstSize (1-10000)
ingressRate (1-1000, unlimited)
ingressRatePeriod (1-10)
|
Command Parameters
Caption |
---|
0 | Table |
---|
1 | OPTIONS Parameters |
---|
3 | OPTIONS Parameters |
---|
|
Parameter | Description |
---|
options | Use this object to configure the OPTIONS message in a SIP CAC profile. NOTE: Egress and ingress settings are the same as MESSAGE Parameters above. Simply replace MESSAGE with OPTIONS in the descriptions. |
|
Other Requests
Use this object to configure the OTHER REQUESTS message in a SIP CAC profile.
Command Syntax
Code Block |
---|
|
% set profiles sipCacProfile <profile_name> otherRequests
egressAggregatePreference (1-10)
egressBurstSize (1-10000)
egressRate (1-1000, unlimited)
egressRatePeriod (1-10)
ingressAggregatePreference (1-10)
ingressBurstSize (1-10000)
ingressRate (1-1000, unlimited)
ingressRatePeriod (1-10)
|
Command Parameters
Caption |
---|
0 | Table |
---|
1 | OTHER REQUESTS Parameters |
---|
3 | OTHER REQUESTS Parameters |
---|
|
Parameter | Length/Range | Description |
---|
egressAggregatePreference | 1-10 | OTHER REQUESTS preference within egress aggregate policer. (default = 1) | egressBurstSize | 1-10000 | Maximum OTHER REQUESTS egress burst size. (default = 5) | egressRate | 1-1000, 'unlimited' | Maximum OTHER REQUESTS egress rate. (default is 'unlimited') | egressRatePeriod | 1-10 | OTHER REQUESTS egress rate period in seconds. (default = 1) | ingressAggregatePreference | 1-10 | OTHER REQUESTS preference within ingress aggregate policer. (default = 1) | ingressBurstSize | 1-10000 | Maximum OTHER REQUESTS ingress burst size. (default = 5) | ingressRate | 1-1000, 'unlimited' | Maximum OTHER REQUESTS ingress rate. (default is 'unlimited') | ingressRatePeriod
| 1-10 | OTHER REQUESTS ingress rate period in seconds. (default = 1) |
|
QOE
Use this object to configure the Quality of Service-based routing configuration.
Command Syntax
Code Block |
---|
|
% set profiles sipCacProfile <profile_name> qoe
asr
asrCriticalLimit (0-70)
defaultQosAsr (0-100)
majorQosAsrLimit (0-90)
clu
cluCriticalLimit (80-100)
minTimeToProceed (60-3600)
pgrd
defaultPgrdFactor (50-10000)
pgrdCriticalLimit (50-10000)
scru
scruCriticalLimit (80-100)
|
Command Parameters
Caption |
---|
0 | Table |
---|
1 | QOE Parameters |
---|
3 | QOE Parameters |
---|
|
Parameter | Length/Range | Description |
---|
asr | N/A | Answer Seizure Ratio (ASR) measurement. asrCriticalLimit – The critical ASR limit below which call admission stops. (range: 0-70% / default = 40)defaultQosAsr – Default ASR value to use when no calls are made for a sampling period. (range: 0-100% / default = 90)majorQosAsrLimit – The major ASR limit. When breached, an INFO log is generated and trunk group stats are incremented one value. (range: 0-90% / default = 70)
| clu cluCriticalLimit | 80-100 | <value> – Critical Call Limit Utilization (CLU) limit (as percentage) below which the trunk group or peer is marked out of service for egress calls. (default = 80)
| minTimeToProceed | 60-3600 | Minimum time to wait (in seconds) before call admission resumes after peer/trunk group KPI falls below critical threshold. (default = 60) | pgrd | N/A | Post Gateway Ringing Delay measurement. defaultPgrdFactor – Default PGRD value when no calls are made for a sampling period. (range: 50-10000 milliseconds / default = 500)pgrdCriticalLimit – Critical PGRD limit above which the trunk group is marked out of service, and not chosen for routing. (range: 50-10000 milliseconds / default = 2000)
| scru scruCriticalLimit
| 80-100 | SCRU) KPI critical limit (as percentage) above which the trunk group/peer is not chosen for routing. (default = 80) |
|
Refer
Command Syntax
Code Block |
---|
|
% set profiles sipCacProfile <profile_name> refer
egressAggregatePreference (1-10)
egressBurstSize (1-10000)
egressRate (1-1000, unlimited)
egressRatePeriod (1-10)
ingressAggregatePreference (1-10)
ingressBurstSize (1-10000)
ingressRate (1-1000, unlimited)
ingressRatePeriod (1-10)
|
Command Parameters
Caption |
---|
0 | Table |
---|
1 | REFER Parameters |
---|
3 | REFER Parameters |
---|
|
Parameter | Description |
---|
refer
| Use this object to configure the REFER message in a SIP CAC profile. NOTE: Egress and ingress settings are the same as MESSAGE Parameters above. Simply replace MESSAGE with REFER in the descriptions. |
|
Response
Command Syntax
Code Block |
---|
|
% set profiles sipCacProfile <profile_name> response
egressAggregatePreference (1-10)
egressBurstSize (1-10000)
egressRate (1-1000, unlimited)
egressRatePeriod (1-10)
ingressAggregatePreference (1-10)
ingressBurstSize (1-10000)
ingressRate (1-1000, unlimited)
ingressRatePeriod (1-10) |
Command Parameters
Caption |
---|
0 | Table |
---|
1 | RESPONSE Parameters |
---|
3 | RESPONSE Parameters |
---|
|
Parameter | Description |
---|
response
| Use this object to configure the RESPONSE message in a SIP CAC profile. NOTE: Egress and ingress settings are the same as OTHER REQUESTS Parameters above. Simply replace OTHER REQUESTS with RESPONSE in the descriptions. |
|
State
Command Syntax
Code Block |
---|
|
% set profiles sipCacProfile <profile_name> state <disabled | enabled> |
Command Parameters
Caption |
---|
0 | Table |
---|
1 | State Parameters |
---|
3 | State Parameters |
---|
|
Parameter | Description |
---|
state
| Administrative state of this SIP CAC Profile. disabled (default)enabled
NOTE: Setting a SIP CAC profile state to "disabled" does not disable SIP CAC functionality on IP Peers to which the SIP CAC profile is assigned. To disable SIP CAC functionality on a specific IP Peer, disassociate the SIP CAC profile from the IP Peer. |
|
Subscribe
Command Syntax
Code Block |
---|
|
% set profiles sipCacProfile <profile_name> subscribe
egressAggregatePreference (1-10)
egressBurstSize (1-10000)
egressRate (1-1000, unlimited)
egressRatePeriod (1-10)
ingressAggregatePreference (1-10)
ingressBurstSize (1-10000)
ingressRate (1-1000, unlimited)
ingressRatePeriod (1-10) |
Command Parameters
Caption |
---|
0 | Table |
---|
1 | SUBSCRIBE Parameters |
---|
3 | SUBSCRIBE Parameters |
---|
|
Parameter | Description |
---|
subscribe
| Use this object to configure the SUBSCRIBE message in a SIP CAC profile. NOTE: Egress and ingress settings are the same as MESSAGE Parameters above. Simply replace MESSAGE with SUBSCRIBE in the descriptions. |
|
Hide |
---|
Termination Condition For Unregistered EndpointsCommand Syntax Code Block |
---|
% set profiles sipCacProfile <sipCacProfile name> termConditionForUnregisteredEndpoints <ifneeded | inactivitytimeout | never> |
Command Parameters Caption |
---|
0 | Table |
---|
1 | Term Condition For Unregistered Endpoints Parameters |
---|
3 | Term Condition For Unregistered Endpoints Parameters |
---|
| Parameter | Description |
---|
termConditionForUnregisteredEndpoints
| Use this parameter to specify the termination condition for unregistered endpoint CACs. never – An unregistered CAC is only terminated upon receipt of a non-401/407 response for an initial INVITE from the Regsitrar/AS or from executing the cacNonRegEndPointRemoveEntry CLI command.ifneeded – An unregistered CAC is terminated if the maximum number of CACs is reached and there is a need to install a new CAC.inactivitytimeout – An unregistered CAC is terminated after a specified time of inactivity (see inactivityTimeoutForUnregisteredEndpoints .
Note: The parameter inactivityTimeoutForUnregisteredEndpoints only available for configuration after the "inactivitytimeout" option above is selected.
|
|
|
Command Examples
Code Block |
---|
|
% set profiles sipCacProfile SIPCAC_TEST state enabled
callIngressRate 78 callIngressRatePeriod 4
callIngressBurstSize 342 callEgressRate 43
callEgressRatePeriod 3 callEgressBurstSize 45 callLimit
4567 emergencyOversubscription 24
% commit
% show profiles sipCacProfile SIPCAC_TEST
state enabled;
callIngressRate 78;
callIngressRatePeriod 4;
callIngressBurstSize 342;
callEgressRate 43;
callEgressRatePeriod 3;
callEgressBurstSize 45;
callLimit 4567;
emergencyOversubscription 24; |
Code Block |
---|
|
% set profiles sipCacProfile cacProfile1 extendedEmergencyIpLimit 10 extendedEmergencyIpLimitIngress 20 extendedEmergencyIpLimitEgress 30
% commit
% show profiles sipCacProfile cacProfile1
extendedEmergencyIpLimit 10;
extendedEmergencyIpLimitIngress 20;
extendedEmergencyIpLimitEgress 30; |