Page History
| Page Tree | ||
|---|---|---|
|
...
...
...
...
Parameters
| Parameter Name | Required | Service Affecting | Data Type | Default Value | Possible Values | Description |
|---|
...
| customAdminState |
|---|
...
| Yes | Yes | Enum | 1 | Possible values:
|
...
|
...
| Enable or Disable this signaling group or set to Drain mode. | |||||
| Description | Yes | No | string | none | 64 - Max Length | Short description/name of the SG. |
|---|---|---|---|---|---|---|
| ProfileID | Yes | No | int | 1 | Possible values:
| SIP Profile ID. SIP profile is used for transaction timers, supported or required methods. Many SGs can share single profile. |
| Channels | Yes | Yes | int | 10 | Possible values:
|
...
| Specifies the number of SIP channels available for calls. | ||||
| ServerSelection | No | No | Enum | 0 | Possible values:
|
|---|
...
| If the selected SIP Server Table contains DNS-SRV entries, this entry is inapplicable. When Basic call is used it will use server from server table:
| |||||
| ServerClusterId | No | No | int | 0 | Possible values:
| When Basic call is used it specifies the ID of Server table (cluster) which is the next sip hop. |
|---|
...
| This is required when the SIP Mode is not Local Registrar (2). | ||||
| SipRecordingStatus | No | No | Enum | 0 |
|---|
...
Possible values:
|
...
|
...
| ||||||
| SipRecorder | No | No | int | Possible values:
| ||
|---|---|---|---|---|---|---|
| RelOnQckConnect |
...
| Yes | No | Enum |
...
| 0 | Possible values:
| Specifies whether |
...
| the channel should be released if the call is answered too soon due to Voice mail, etc.,. | |
| RelOnQckConnectTimer | No |
|---|
...
| No | int |
...
| 1000 | Possible values: |
...
|
...
| Specifies |
...
| the timer for disconnecting the forked call leg for quick connect, in milliseconds. | |
| RTPMode | Yes |
|---|
...
| No |
...
| Enum |
...
| 1 | Possible values:
|
...
|
...
|
...
| Specifies whether Audio/Fax Stream DSP Mode is supported by this Signaling Group. |
...
This option is disabled if Play Ring Back is set to Never.
| RTPProxyMode | Yes |
|---|
...
| No |
...
| Enum |
...
| 1 |
...
Possible values:
|
...
|
...
|
...
| Specifies whether Audio/Fax Stream Proxy Mode is supported by this Signaling Group. |
...
| RTPProxySrtpMode | Yes |
|---|
...
| No |
...
| Enum | 1 | Possible values: |
...
|
...
|
...
|
...
| Specifies whether Audio/Fax Stream Proxy Srtp Mode is supported by this Signaling Group. This is only valid for the SWe Edge platform. |
| RTPDirectMode | Yes |
|---|
...
| No | Enum |
...
| 1 | Possible values:
|
...
|
...
| Specifies |
...
- Auto - Ringback is determined by signaling messages.
- Always
- Ringback is played for all calls and never be cut through. - Never - Ringback will never be generated and the endpoint is responsible to provide tones.
| whether Audio/Fax Stream Direct Mode is supported by this Signaling Group. |
| VideoProxyMode |
|---|
...
| Yes | No | Enum |
...
| 1 | Possible values:
|
...
|
...
- Standard
- This option assigns first available low numbered channel. - Reverse Standard
- This option assigns last available high numbered channel. - Round Robin
- This option assigns channels based on next available from low numbered to high numbered. - Least Idle
- This option chooses channels based on the least idle channel. - Most Idle
- This option chooses channels based on the most idle channel.
| Specifies whether Video/Application Stream Proxy Mode is supported by this Signaling Group. | |||||||
| VideoDirectMode | Yes | No | Enum | 1 | Possible values:
| Specifies whether Video/Application Stream Direct Mode is supported by this Signaling Group. This is applicable only for the SBC 1000/2000 platforms. | ||
|---|---|---|---|---|---|---|---|---|
| CryptoProfileID | No | No | int | 0 | Possible values:
| Identifies a cryto profile ID used. If no crypto profile is used then this is set to 0. | ||
| MediaConfigID | Yes | No | int | 1 | Possible values:
| Specifies the Media List to be used by this Signaling Group.
| ||
| ToneTableID | No | No | int | 0 |
...
- 0 - sgdirInbound
- 1 - sgdirOutbound
- 2 - sgdirBidirectional
...
Possible values:
|
...
|
...
|
...
| Specifies |
...
the Tone Table to be used by this Signaling Group.
| ||
| ActionSetTableID |
|---|
...
| No | No | int |
...
| 0 | Possible values:
|
...
|
...
| Specifies a defined Action Set Table for this Signaling Group. | ||||
| RouteTableID | Yes | Yes | int | 1 |
|---|
...
Possible values:
|
...
|
...
| Specifies the Call Routing Table to be used by this Signalling Group. |
| RingBack |
|---|
...
| No | No |
...
| Enum |
...
| 0 | Possible values: |
- 180000 - Minimum
- 750000 - Maximum
...
| Specifies how ringback is played on a channel
| |||||
| Direction | No | No | Enum | 2 | Possible values:
| Obsolete. SIP SGs are bi-directional by default. |
|---|---|---|---|---|---|---|
| PlayCongestionTone |
...
- 0 - Minimum
- 1 - Maximum
...
- True
- all requests will be challenged for realm/user/password - False
- no request messages will be challenged
...
| No | No | Enum | 0 | Possible values:
|
...
- True
- SIP NOTIFY with CACProfile will be sent to remote server connected to this SG - False
- no SIP NOTIFY sent to remote server connected to this SG
| Specifies whether to play congestion tone when a 503 error response (that includes a reason header with Q.850 cause = 42) is received for an outbound INVITE. |
| Early183 |
|---|
...
| No | No |
...
| Enum |
...
| 0 | Possible values:
|
...
|
...
|
...
| Info |
|---|
This option is available only if Nonce Expiry is set to Limited. |
...
| Specifies whether to send a SIP 183 response immediately after receiving an Invite message. |
| AllowRefreshSDP |
|---|
| No | No | Enum |
...
| 1 | Possible values:
|
...
|
...
- eProxyRegistrationsForward
- forwards the REGISTER request after inserting it to the loacal registrar - eProxyRegistrationsProxy
- just forwards the REGISTER request (proxy mode). - eProxyRegistrationsLocal
- Maintains local registrar only. Uses registrar bindings to terminate a call. - eBasicCall
- Sends Invites to the selected Server table.
| Specifies whether to allow refresh SDP after the media has been negotiated. | |||||
| RTCPMultiplexing | No | No | Enum | 0 | Possible values:
| Used to enable and disable RTP-RTCP Multiplexing |
|---|---|---|---|---|---|---|
| MediaCodecLatch | No | No | Enum | 1 | Possible values:
| Used to enable and disable Codec LockDown |
| OutboundProxy |
...
| No | No | string | none | 256 - Max Length | Specifies the |
...
| Info |
|---|
This option is available only when Challenge Request is set to True. |
| outbound proxy which all SIP messages will be sent through. | |||
| ProxyIpVersion | Yes | No | Enum |
|---|
...
| 0 | Possible values:
|
...
|
...
|
...
| Specifies whether the FQDN should be resolved into IPv4 addresses or IPv6 addresses. |
| OutboundProxyPort |
|---|
...
| No | No | int |
...
| 5060 | Possible values:
|
...
|
...
| If an outbound proxy is configured a port number must be provided, within the range 1024 through 65535. Otherwise a 0 may be sent. |
| NoChannelAvailableId |
|---|
...
| No | No | int |
...
| 34 | Possible values: |
...
|
...
|
...
- 60 - Minimum
- 86400 - Maximum
...
| In case of "No Channel/Circuit available" release cause code, CCC is going to map this to the value configured against this entry in the signaling group. This cause code will be sent to the relevant protocol module. | |
| TimerSanitySetup | No |
|---|
...
| No | int |
...
| 180000 | Possible values: |
...
|
...
|
...
| Specifies the maximum wait timer for setup message, in milliseconds. A Call that has not received a response from the peer switch will be released after this time. This is for all call types. |
| TimerCallProceeding |
|---|
...
| No | No | int |
...
| 180000 | Possible values: |
...
|
...
| Specifies the |
...
| Info |
|---|
The default TCP/UDP is 5060 and the default for TLS is 5061 |
| call proceeding timer for INVITE message, in milliseconds. A Call that has not received a 180 ringing response from the peer switch will be released after this time. |
| ChallengeRequest |
|---|
...
| No | No | Enum | 0 | Possible values:
|
...
|
...
| Indicates whether incoming request messages is challenged for security purposes. If this option is set to true you must specify a realm and at least one entry in the Authorization Table.
|
| NotifyCACProfile |
|---|
...
| No | No |
...
| Enum | 0 | Possible values:
|
...
|
...
|
...
| Indicates whether to send NOTIFY messages with CACProfile to the remote server.
|
| NonceLifetime |
|---|
...
| No | No | int |
...
| 600 | Possible values:
|
...
|
...
Number of minutes a nonce will remain valid for a session. For a value is 0, nonce will remain forever.
|
...
The default TCP/UDP is 5060 and the default for TLS is 5061
| |
| Monitor |
|---|
...
| No | No | Enum |
...
| 2 | Possible values:
|
...
|
...
|
...
|
...
| Specifies how the SG will process REGISTER and INVITE message:
|
| AuthorizationRealm |
|---|
...
- 0 - Minimum
- 65534 - Maximum
...
| No | No | string | none |
...
| 256 - Max Length |
...
Specifies the authorization realm used to challenge request messages.
| ||
| ProxyAuthorizationTableID |
|---|
...
| No | No | int | 0 | Possible values:
|
...
|
...
| Info |
|---|
The default TCP/UDP is 5060 and the default for TLS is 5061 |
| Local authorization table if chalenging mode is enabled. |
| RegistrarID |
|---|
...
| No | No |
...
| int | 0 | Possible values:
|
...
|
...
| Registrar table attached to the SG for routing purpose or/and adding registration records. This is required when the SIP Mode is not Basic Call (3) | |||||
| RegistrarTTL | No | No | int | 600 | Possible values:
| Minimum Time to Live for inbound registrations. |
|---|---|---|---|---|---|---|
| OutboundRegistrarTTL |
...
| No | No | int |
...
| 600 | Possible values: |
...
|
...
|
...
| Time to Live for outbound registrations. | ||||||
| DSCP | Yes | No | int | 40 | Possible values:
| DSCP value to be used in the IP header of all SIP packets from the SBC, on sockets/connections associated with this SIP SG |
|---|---|---|---|---|---|---|
| SIPListenProtocolPortList |
...
| No | No |
...
| string | none | 64 - Max Length | Comma separated list of Listen Port ids. | ||
| ListenPort_1 | No | No | int | 0 | Possible values:
|
|---|
| Specifies the local listen port |
...
1 on which SG can receive message. This needs to be provided if Protocol_1 is present.
| ||
| Protocol_ |
|---|
...
| 1 | No | No | Enum | 0 | Possible values:
| Protocol type used by the listener. Currently only 1,2 and 4 are being used. This needs to be provided if ListenPort_1 is present. |
|---|---|---|---|---|---|---|
| TLSProfileID_ |
...
| 1 | No | No | int | 0 | Possible values:
| If protocol is TLS this is the of TLS profile in use. |
|---|---|---|---|---|---|---|
| LocalIP_ |
...
| 1 | No | No | string | none | 50 - Max Length | Not used in the current release. |
|---|---|---|---|---|---|---|
| ListenPort_ |
...
| 2 | No | No | int | 0 | Possible values:
| Specifies the local listen port |
|---|
...
2 on which SG can receive message. This needs to be provided if Protocol_2 is present.
| ||
| Protocol_ |
|---|
...
| 2 | No | No | Enum | 0 | Possible values:
| Protocol type used by the listener. Currently only 1,2 and 4 are being used. This needs to be provided if ListenPort_2 is present. |
|---|---|---|---|---|---|---|
| TLSProfileID_ |
...
| 2 | No | No | int | 0 | Possible values:
| If protocol is TLS this is the of TLS profile in use. |
|---|---|---|---|---|---|---|
| LocalIP_ |
...
| 2 | No | No | string | none | 50 - Max Length | Not used in the current release. |
|---|---|---|---|---|---|---|
| ListenPort_ |
...
| 3 | No | No | int | 0 | Possible values:
| Specifies the local listen port |
|---|
...
3 on which SG can receive message. This needs to be provided if Protocol_3 is present.
| ||
| Protocol_ |
|---|
...
| 3 | No | No | Enum | 0 | Possible values:
| Protocol type used by the listener. Currently only 1,2 and 4 are being used. This needs to be provided if ListenPort_3 is present. |
|---|---|---|---|---|---|---|
| TLSProfileID_ |
...
| 3 | No | No | int | 0 | Possible values:
| If protocol is TLS this is the of TLS profile in use. |
|---|---|---|---|---|---|---|
| LocalIP_ |
...
| 3 | No | No | string | none | 50 - Max Length | Not used in the current release. |
|---|
...
| ListenPort_ |
|---|
...
| 4 | No | No | int | 0 | Possible values:
|
|---|
...
| Specifies the |
...
local listen port 4 on which SG can receive message. This needs to be provided if Protocol_4 is present.
| ||
| Protocol_4 |
|---|
...
| No | No |
...
| Enum | 0 | Possible values:
|
...
| Protocol type used by the listener. Currently only 1,2 and 4 are being used. This needs to be provided if ListenPort_4 is present. | |||||
| TLSProfileID_4 | No | No | int | 0 | Possible values:
| If protocol is TLS this is the of TLS profile in use. |
|---|---|---|---|---|---|---|
| LocalIP_4 | No | No | string | none | 50 - Max Length | Not used in the current release. |
| ListenPort_5 | No | No | int |
...
| 0 | Possible values:
|
...
|
...
|
...
| Specifies |
...
- None
- Specifies that network address translation is not used. - Static NAT
- Specifies that network address translation is used.
| Note |
|---|
The only supported NAT type is symmetric NAT (port forwarding). This NAT configuration type means that packets received on a specific NAT server port are always forwarded to the same Sonus SBC port, for example, packets on the NAT public IP, port 5060 are forwarded to a private (SBC) IP, port 5060. |
the local listen port 5 on which SG can receive message. This needs to be provided if Protocol_5 is present.
| ||||||||||
| Protocol_5 | No | No | Enum | 0 | Possible values:
| Protocol type used by the listener. Currently only 1,2 and 4 are being used. This needs to be provided if ListenPort_5 is present. | ||||
|---|---|---|---|---|---|---|---|---|---|---|
| TLSProfileID_5 | No | No | int | 0 | Possible values:
| If protocol is TLS this is the of TLS profile in use. | ||||
| LocalIP_5 | No | No | string | none | 50 - Max Length | Not used in the current release. | ||||
| ListenPort_6 | No | No | int | 0 | Possible values:
| Specifies the local listen port 6 on which SG can receive message. This needs to be provided if Protocol_6 is present.
| ||||
| Protocol_6 | No | No | Enum | 0 | Possible values:
| Protocol type used by the listener. Currently only 1,2 and 4 are being used. This needs to be provided if ListenPort_6 is provided. | ||||
| TLSProfileID_6 | No | No | int | 0 | Possible values:
| If protocol is TLS this is the of TLS profile in use. | ||||
| LocalIP_6 | No | No | string | none | 50 - Max Length | Not used in the current release. | ||||
| SIPtoQ850_TableID | No | No | int | 0 | Possible values:
| Specifies the SIP to Q.850 Override Table to be used for this Signaling Group. | ||||
| Q850toSIP_TableID | No | No | int | 0 | Possible values:
| Specifies the Q.850 To SIP Override Table to be used for this Signaling Group. | ||||
| SipResponseCodes | Yes | Yes | string | 408,409,411,413,500,501,503,504,580,604,606 | 200 - Max Length | List of Response codes which can cause Failover. This is a comma separated string of the Response codes . If a call is received with any of the Response codes, the system will retry the call and do failover registration. This is only applicable when ServerSelection is "Priority: Register Active Only(4)" | ||||
| NetInterfaceSignaling | Yes | No | string | none | 64 - Max Length | Specifies the interface name followed by -1 for primary, followed by -2 for secondary IP, followed by -6 for IPv6 address. The Signaling Group will bind to this interface and use it's IP address in headers and SDP. If this field is empty (default value) then the Signaling Group will listen on all available interfaces and will auto-determine the local IP used for headers and SDP. | ||||
| NATTraversalType | Yes | No | Enum | 0 | Possible values:
| Specifies whether the Signaling Group uses a third-party entity IP address inside SIP message to support network address translation (NAT).
| ||||
| NATPublicIPAddress | No | Yes | string | none | 16 - Max Length | Specifies the public IP of the NAT server visible from Internet. The NAT server's ports must be configured to allow SIP and RTP traffic, for example: port range 5060-5061 for SIP and 16000-17000 for RTP.
| ||||
| PassthruPeerSIPRespCode | No | No | Enum | 1 | Possible values:
| This flag is used to allow the passthrough of Peer SIP Response Code. If this flag is enabled, it overrides the Q.850/SIP Mapping Tables | ||||
| SGLevelMOHService | No | Yes | Enum | 0 | Possible values:
| Configures the SG level MOH service
| ||||
| IngressSPRMessageTableList | No | No | string | none | 60 - Max Length | This is a comma-separated, ordered list of SIP Protocol Manipulation Message Table references to be used on ingress. There is a maximum of 10 entries allowed." | ||||
| EgressSPRMessageTableList | No | No | string | none | 60 - Max Length | This is a comma-separated, ordered list of SIP Protocol Manipulation Message Table references to be used on egress. There is a maximum of 10 entries allowed." | ||||
| QoEReporting | No | No | Enum | 0 | Possible values:
| Indicates if signaling group will report QoE statistics at the end of each call. This is applicable only for the SBC 1000/2000 platforms. | ||||
| VoiceQualityReporting | No | No | Enum | 0 | Possible values:
| Indicates if the signaling group will report voice quality statistics at the end of each call. This is applicable only for the SBC 1000/2000 platforms. | ||||
| RegisterKeepAlive | No | No | Enum | 1 | Possible values:
| Indicates if SIP Register messages can be used as keep alive to mark a signaling group as UP/DOWN. | ||||
| InteropMode | No | No | Enum | 0 | Possible values:
| Indicates the type of interoperation for this SG. | ||||
| AgentType | No | No | Enum | 0 | Possible values:
| Indicates the SIP Agent Type for this SG. | ||||
| RegistrantTTL | No | No | int | 3600 | Possible values:
| The timeout to use for registrants that are subject to passthrough or AD registration. Applicable when: 1. Agent Type is AccessMode, Interop Mode is BroadSoft and SIP Mode is Basic Call. Or 2. Interop Mode is set to 'Office 365 w/AD PBX' | ||||
| ADAttribute | No | No | string | pager | 500 - Max Length | Attribute name that is used as a key to search user records in the Active Directory. | ||||
| ADUpdateFrequency | No | No | string | 1 | 100 - Max Length | Controls the frequency (in days) with which SIP queries Active Directory for all the records with AD attribute populated. Only visible when Office 365 w/ AD is selected. | ||||
| ADFirstUpdateTime | No | No | string | 00:00:00 | 500 - Max Length | Specifies time of first AD query update in hh:mm:ss (24 hour format). Only visible when Office 365 w/ AD is selected. | ||||
| Office365FQDN | No | No | string | none | 1000 - Max Length | Specifies the domain suffix to be used for outbound requests to Office 365 server. | ||||
| MediaOptimization | No | No | Enum | 0 | Possible values:
| Specifies whether the local media optimization feature shall be activated or not. | ||||
| PrivateMediaSourceIp | No | No | string | none | 16 - Max Length | Specifies the private IP address used for media when the above MediaOptimization flag is set to true. | ||||
| ICESupport | Yes | No | Enum | 0 | Possible values:
| Enables/Disables Interactive Connectivity Establishment Support for media traversal involving NAT devices. When enabled, the SBC will act as an ICE agent for SIP calls. When disabled, no ICE support for a SIP call will be provided. This is applicable only for the SBC 1000/2000 platforms. | ||||
| ICEMode | No | No | Enum | 0 | Possible values:
| Indicates the ICE mode whether IceLite or IceFull.
| ||||
| InboundNATTraversalDetection | Yes | No | Enum | 0 | Possible values:
| Enables/Disables NAT traversal detection for inbound SIP/RTP packets. When enabled, inbound SIP/RTP packets will be examined to determine if they're coming from a client that's behind a NAT, and handled accordingly. When disabled, no inbound NAT detection will be done. | ||||
| InboundNATQualifiedPrefixesTableID | No | No | int | 0 | Possible values:
| The row ID of the associated SIP NAT Qualified Prefix Table. When examining SIP packets, this table determines which subnets should be treated as being behind a NAT device. If the table ID is 0, all subnets will be treated as being behind a NAT device. | ||||
| InboundSecureNATMediaLatching | No | No | Enum | 1 | Possible values:
| Enables/Disables secure media latching for inbound RTP packets. When enabled, media latching will only occur if the RTP IP address is in the same subnet as the public IP seen by SIP signaling. When disabled, no IP address security checks will be performed during RTP latching. | ||||
| InboundSecureNATMediaPrefix | No | No | string | 255.255.255.255 | 16 - Max Length | This netmask is applied to the obtained SIP signaling IP and the result is compared with the prospective RTP IP to be used for latching. If a match occurs, it's considered secure and a valid IP for latching. If a match doesn't occur, it's considered invalid for latching and discarded. Must be in dotted decimal netmask format (e.g. 255.255.255.0). | ||||
| InboundNATPeerRegistrarMaxEnabled | No | No | Enum | 0 | Possible values:
| This field enables the maximum registration time to live for inbound registrants that are behind NATs. If a client registers with an expires value larger than the Inbound NAT Peer Registrar Max TTL, the expiration will be adjusted to the Inbound NAT Peer Registrar Max TTL. | ||||
| InboundNATPeerRegistrarMaxTTL | No | No | int | 120 | Possible values:
| This field represents the maximum registration time to live (in seconds) for registrants that are behind NATs. If a client registers with an expires value larger than this value the expiration will be adjusted to this value. | ||||
| RemoteHosts | Yes | No | string | none | 2500 - Max Length | Comma separated list of remote IPs or subnet from which SG can receive requests. It is not necessary to include the SIP Server entries, if the SG has a SIP Server table. Mask is mandatory. In case of FQDN after resolving it all IPs will be added to the list. If mask is empty 255.255.255.255 is assumed. | ||||
| RemoteMasks | Yes | No | string | none | 2500 - Max Length | Comma separated list of subnet masks for the IP Addresses specified in RemoteHosts above. Mask is mandatory. In case of FQDN after resolving it all IPs will be added to the list. If mask is empty 255.255.255.255 is assumed. Mask is applied over the specified above IP in order to limit subnets intstead hosts. | ||||
| SIPReSync |
...
| Note |
|---|
The IP address specified in this field must be publicly accessible. |
| Info |
|---|
This field is available when NAT Traversal is set to Static NAT. |
...
- 0 - btFalse
- 1 - btTrue
...
- 0 - mohDisable
- 1 - mohEnable
- 2 - mohEnableNoMusic
...
- Enable
- Enable MOH feature in this SG. - Disable
- Disable MOH feature in this SG. - mohEnableNoMusic
- Enable MOH feature in this SG if no music.
...
| No | No | Enum | 0 | Possible values:
| Indicates |
...
| whether updates need to be performed when a SIP NOTIFY message is received from the BroadSoft server. This is applicable only for BroadSoft Auto Configuration feature. | ||||||
| SGBillingType | No | No | Enum | 0 | Possible values:
| |
|---|---|---|---|---|---|---|
| CustomerDomain | No |
...
| No | string | none |
...
| 256 - Max Length |
...
| This paramater is for the Customer Domain FQDN. |
Overview
Content Tools