Versions Compared

Key

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

Add_workflow_for_techpubs
AUTH1
JIRAIDAUTHSBX-95908
REV5
REV6
REV3
REV1

Use the Cns Group commands to configure call notification server (Cns) groups and clusters as part of the SBC's call notification feature.  Refer to Sending Unsolicited Call Notifications to Application Servers for more information on the call notification feature.

Cns Group Profile

Use the cnsGroupProfile object to specify information on a group of up to 8 servers to receive call notifications. The profile also specifies how to distribute the notifications among the servers.

Command Syntax

Code Block
% set global servers cnsGroupProfile <profile name>
     cnsGroupData <sequence: 0 - 7>
        callNotifyTGId
        remoteAddress 
        remotePort
        transport
     description
     loadDistribution <roundRobin | sequence>
     uri

Command Parameters

Caption
0Table
1cnsGroupProfile Parameters


ParameterLength/RangeDescription

<profile name>

up to 23 characters

Specifies a name for the cns group profile. The profile can specify up to 8 servers as potential recipients of call notifications. 

cnsGroupData <sequence>

0-7Specifies a sequence number for a server within the group. If the loadDistribution type is sequence, the SBC attempts to send call notifications to the servers in their specified sequence.

callNotifyTGId

up to 23 charactersSpecifies the trunk group through which the SBC sends call notifications. 

remoteAddress

up to 63 charactersSpecifies an IP address or FQDN for the server to receive call notifications.

remotePort

0-65535Specifies the number of a port to send call notifications on the server. The range is 0 - 65535. The default is 5060.

transport

  • udp
Specifies the transport type to use for sending notifications to this server. Currently the only type is UDP.

description

up to 199 charactersSpecifies an optional description of this cns group profile.

loadDistribution

  • roundRobin
  • sequence

Specifies how to distribute call notifications among the servers in this group. The options are:

  • roundRobin - to distribute among the servers in a round-robin method.
  • sequence - (default) to distribute notifications in the same sequence for every call using the order defined by the server sequence value.

uri

up to 140 charactersSpecifies the URI to use in the Request-URI of NOTIFY messages for this group of servers. 



Cns Group Cluster

Use the cnsGroupCluster object as a container for cnsGroupProfiles. The configuration of each individual callNotificationCriteria object specifies a cnsGroupCluster to specify which server or servers are the recipient of notifications when a call matches that particular set of criteria. Currently a cnsGroupCluster can contain only one cnsGroupProfile.

Command Syntax

Code Block
% set global servers cnsGroupCluster <cluster ID>
     cnsGroupClusterData <sequence: 0>
        cnsGroupId <CNS group profile name>
     description

Command Parameters

Caption
0Table
1cnsGroupCluster Parameters


ParameterLength/RangeDescription

<cluster ID>

up to 23 characters

Specifies a name for the Cns group cluster.  A Cns group cluster is included in call notification criteria to indicate the server(s) that should receive notifications when a call matches the criteria. 

cnsGroupClusterData <sequence>

currently set to 0Specifies a sequence number for a Cns group profile in the cluster. Currently a Cns group cluster can include only one Cns group profile and the sequence is set to 0 by default.

cnsGroupId

up to 23 charactersSpecifies the name of the Cns group profile to include in the cluster.

description

up to 199 charactersSpecifies an optional description for the Cns group cluster.


For command examples, refer to Configuring the SBC to Send Unsolicited Call Notifications to Application Servers.