Description

Profile

REST Name
profile
Methods
retrieve
Retrieve
Properties
Name Data Possible Values Description
outbound-proxy

Type

  • string

Default

  • None

Rules

  • valid_ip_port_domain

Outbound Proxy

Optional outbound proxy

nat-options-ping

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • false - Disable
  • true - Enable

Ping NAT Registrations

Send OPTIONS ping requests to NATed registrations.

This helps to keep firewall pinholes open even when the registration refresh timer is long

enable-3pcc

Type

  • Enumeration

Default

  • proxy

Rules

  • required

Values

  • false - Disable
  • proxy - Enable

3PCC

Enable processing of 3PCC (third party call control) to allow processing INVITE messages without an SDP

max-sip-request-length

Type

  • string

Default

  • None

Rules

  • integer
  • greater_than[0]

Maximum Sip Request URI Length

Maximum length of Request URI.

TLS/tls-version

Type

  • Enumeration

Default

  • tlsv1

Rules

  • required

Values

  • tlsv1 - TLS Version 1
  • sslv23 - SSL Version 2 & 3

TLS Version

The version being used by SSL/TLS

call-routing

Type

  • Enumeration

Default

  • sip-core-null-routing

Rules

  • required

Values

  • user-new_dialplan2 - new_dialplan2
  • user-from-loader01 - from-loader01
  • sip-core-null-routing - -- None --
  • user-new_dialplan1 - new_dialplan1

Routing Plan

XML routing plan for all incoming calls received in this SIP profile.

srtp/crypto-optional-mki-length-string

Type

  • Enumeration

Default

  • __disable__

Rules

  • required

Values

  • 1:1 - 1:1
  • __disable__ - Disable

Crypto MKI Length

The MKI length is the size of the MKI field in the SRTP packet.

TLS/tls-sip-port

Type

  • string

Default

  • 5061

Rules

  • greater_than[1024]
  • less_than[65525]
  • is_numeric

TLS Port

TCP Port required for secure SIP signalling

load-limit-reject-cause

Type

  • string

Default

  • 503

Rules

  • required[enable-load-limit]
  • sip_fail_response_code

Reject Response Code

Reject calls based on the SIP Response.

auth-all-packets

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • false - Disable
  • true - Enable

Authenticate Requests

Enable or Disable authentication on all incoming requests.

srtp/support-sdp-secure-avp

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • false - Disable
  • true - Enable

Secure AVP

Enable or disable SDP secure AVP (a=crypto in RTP/AVP).

Note: This option violates RFC 3711.

ext-rtp-ip

Type

  • string

Default

  • None

Rules

  • valid_ext_sip_ip

External RTP IP address

This is the RTP address to be advertised in the SDP for any SDP offer or answer.

If RTP is handled via exposed hardware (ie 'exposed' media mode) this parameter is ignored.

The accepted values are:

1. An IP address string such as '200.1.2.4'

2. The string 'auto-nat'

Gateway will use uPNP or NAT-PMP to discover the public IP address it should use

3. A string starting with 'stun:' followed by a host name or IP, such as: 'stun:my-stun-server.com'

Gateway will use the specified STUN server to discover the public IP address

4. A string starting with 'host:' followed by a host name, such as 'host:my-small-office.com'

Gateway will resolve the given host name to find out the IP address to use (useful for dynamic DNS)

sip-dialplan-handler

Type

  • Enumeration

Default

  • default

Rules

  • required

Values

  • default - -- None --
  • user-new_dialplan2 - new_dialplan2
  • user-new_dialplan1 - new_dialplan1
  • user-from-loader01 - from-loader01

SIP Message Handler

Advanced XML script handler for every SIP message received in this SIP profile during a call.

Warning: Note this may be very intensive if done for every single call

An alternative is only setting the channel variable "sip_dialplan_handler" for calls where you need this

You can create routing plan in the Call Routing Section.

disable-rtp-auto-adjust

Type

  • Enumeration

Default

  • true

Rules

  • required

Values

  • false - Enable
  • true - Disable

RTP Auto Adjust

This option enables the RTP auto-adjust feature used to detect RTP streams coming from hosts behind NAT.

Note that when media interfaces are enabled, an incoming RTP stream is required before outgoing RTP is sent.

inbound-media-profile

Type

  • Enumeration

Default

  • default

Rules

  • required

Values

  • default - default

Inbound Media Profile

Media profile that will be used on all incoming calls.

lync-interop

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • false - Disable
  • true - Enable

Lync Interoperability

Enable or Disable settings for Lync interoperability.

fqdn-in-contact

Type

  • string

Default

  • None

Rules

  • valid_ip_or_domain

FQDN in Contact Header

Use FQDN instead of IP address in Contact Header.

sip-ip

Type

  • Enumeration

Default

  • eth0

Rules

  • required
  • required

Values

  • eth1 - eth1 - 192.168.168.1
  • eth0 - eth0 - 10.10.0.207

SIP IP Address

IP Address being used for SIP signalling.

transport

Type

  • Enumeration

Default

  • udptcp

Rules

  • required

Values

  • tls - TLS
  • udptcptls - UDP+TCP+TLS
  • udp - UDP
  • udptcp - UDP+TCP
  • tcp - TCP

Transport

Transport type being used for SIP.

load-limit-cause-string

Type

  • string

Default

  • Service Unavailable

Reject Message

Reject calls based on the string provided.

TLS/certificate

Type

  • upload

Default

  • None

TLS Certificate

TLS/SSL certificate that will be used with this specific sip profile. Must be a valid PEM file.

enable-load-limit

Type

  • Enumeration

Default

  • true

Rules

  • required

Values

  • false - Disable
  • true - Enable

Enable Load Limiting

Enable or Disable Load Limiting on this SIP Profile

rtcp-audio-interval-msec

Type

  • string

Default

  • 5000

Rules

  • integer
  • greater_or_equal[100]
  • less_or_equal[5000]

RTCP Interval

RTCP reports interval in msec.

inbound-bypass-media

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • false - Disable
  • true - Enable

Inbound Bypass Media

Disable SDP parsing and bypass the SDP offer/answer payloads for incoming calls (This disables transcoding)

enable-100rel

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • false - Disable
  • true - Enable

100 Reliability

SIP provisional message reliability.

accept-blind-auth

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • false - Disable
  • true - Enable

Accept Blind Authentication

Warning: If set to enable, all authentication requests will be granted without checking.

outbound-media-profile

Type

  • Enumeration

Default

  • default

Rules

  • required

Values

  • default - default

Outbound Media Profile

Media profile that will be used on all outgoing calls.

full-id-in-dialplan

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • false - Disable
  • true - Enable

Always Use Full Identification

Always use user@domain format when routing the call.

auth-calls

Type

  • Enumeration

Default

  • true

Rules

  • required

Values

  • false - Disable
  • true - Enable

Authenticate Calls

Enable or Disable authentication on all incoming calls.

session-timeout

Type

  • string

Default

  • 1800

Rules

  • required[timer]
  • is_numeric

Session Expires

Time in seconds for a specific session to expire.

max-sessions

Type

  • string

Default

  • None

Rules

  • greater_than[0]
  • less_than[10000]
  • is_numeric

Max Concurrent Sessions

Maximum number of concurrent sessions that will be accepted in this profile. Unlimited if not specified.

srtp/crypto-optional-lifetime

Type

  • Enumeration

Default

  • __disable__

Rules

  • required

Values

  • 2^48 - High
  • 2^16 - Low
  • 2^31 - Medium
  • __disable__ - Disable

Crypto Life Time

Number of packets the SRTP crypto master key is valid for (RFC4568 lifetime optional sdp parameter).

TLS/enable-secure-media

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • false - Disable
  • true - Enable

Secure RTP

Enable or Disable Secure RTP.

TLS/tls-verify-policy

Type

  • Enumeration

Default

  • out

Rules

  • required

Values

  • all - Incoming and Outgoing
  • out - Outgoing
  • none - No Verification
  • in - Incoming

Certificate Verification Policy

Enable certificate verification policy on incoming, outgoing, or all connections. Can be disabled by selecting No Verification

sip-trace

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • false - Disable
  • true - Enable

SIP Trace

Enable or Disable SIP messages tracing.

notify-refer-on-final-rsp

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • false - Disable
  • true - Enable

Notify REFER on Final Response

Whether to determine REFER result base on final response. This applies only if a new call leg is created to the referee.

TLS/tls-verify-date

Type

  • Enumeration

Default

  • true

Rules

  • required

Values

  • false - Disable
  • true - Enable

Certificate Date Verification

Enable or Disable certificate date verification.

manual-redirect

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • false - Disable
  • true - Enable

Manual Redirect Routing

If enabled, all SIP 30X responses (Redirect Responses) will cause a new routing request to your dialplan.

If disabled, the SBC will try to follow the Redirect request as-is automatically

The routing plan used is determined by the contents of the channel variable "sip_redirect_context"

apply-nat-acl

Type

  • Enumeration

Default

  • __empty__

Rules

  • required

Values

  • nat.auto - RFC1918
  • __empty__ - -- None --

NAT ACL

Apply a given network ACL to the host IP of the Contact: header in SIP requests to determine if a host is behind NAT

minimum-session-expires

Type

  • string

Default

  • 1800

Rules

  • required[timer]
  • is_numeric

Minimum Session Expires

Minimum number of sessions that can be expired.

user-agent-string

Type

  • string

Default

  • NetBorder Session Controller

Rules

  • required

User Agent

rtp-tos-value

Type

  • string

Default

  • None

Rules

  • greater_than[-1]
  • less_than[256]

RTP TOS Value

DiffServ integer value (0-255) for the RTP packets (this is the old TOS IP header value). You can use this to set TOS values as well.

sip-port

Type

  • string

Default

  • 5060

Rules

  • required
  • integer
  • greater_than[0]

Port

Port being used for SIP Signalling

rtp-ip

Type

  • string

Default

  • None

Rules

  • valid_ip

RTP IP address

This is the RTP IP to be used for the RTP network connection. For this field the only accepted value is an IP address string such as '192.168.100.51'.

If left empty the same IP address used for the signaling will be used for RTP.

If RTP is handled via exposed hardware (ie 'exposed' media mode) this parameter is ignored.

enable-timer

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • false - Disable
  • true - Enable

SIP Session Timer

Enable or Disable the SIP session timer.

ext-sip-ip

Type

  • string

Default

  • None

Rules

  • valid_ext_sip_ip

External SIP IP Address

The accepted values are:

1. An IP address string such as '200.1.2.3'

All SIP requests in this profile will use the specified IP address

2. The string 'auto-nat'

Gateway will use uPNP or NAT-PMP to discover the public IP address it should use

3. A string starting with 'stun:' followed by a host name or IP, such as: 'stun:my-stun-server.com'

Gateway will use the specified STUN server to discover the public IP address

4. A string starting with 'host:' followed by a host name, such as 'host:my-small-office.com'

Gateway will resolve the given host name to find out the IP address to use (useful for dynamic DNS)

aggressive-nat-detection

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • false - Disable
  • true - Enable

Aggressive NAT Detection

This option enables aggressive NAT detection by examining the Via headers of requests

It will determine if a given device is behind NAT if the network IP/Port from which the request was received differs from the IP/Port combination in the SIP Via: header.

It also will determine if a given device is behind NAT if the Via: header contains the 'received' parameter, regardless of what it contains.

load-limit-low-threshold

Type

  • string

Default

  • 80

Rules

  • required[enable-load-limit]
  • greater_than[0]
  • less_than[100]
  • is_numeric

CPU Low Threshold

CPU usage percentage amount that NSC will resume accepting calls. It is recommended this be 90% of the high threshold

load-limit-high-threshold

Type

  • string

Default

  • 90

Rules

  • required[enable-load-limit]
  • greater_than[0]
  • less_than[100]
  • is_numeric

CPU High Threshold

CPU usage percentage amount that NSC will start rejecting calls.

ignore-183nosdp

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • false - Disable
  • true - Enable

Ignore 183 without SDP

Enable or Disable ignoring 183 messages without a specific SDP.

srtp/require-secure-rtp

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • false - Disable
  • true - Enable

Require Only Secure RTP

Require inbound leg INVITE to include secure rtp offer.

TLS/tls-passphrase

Type

  • string

Default

  • None

Rules

  • alpha_dash

TLS Passphrase

If this SIP Profile is using a private key with a passphrase, you can enter the passphrase here.

NDLB-force-rport

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • false - Enable
  • safe - Auto Force
  • disabled - Disable
  • server-only - Server Only
  • client-only - Client Only
  • true - Force Always

Symmetric Response Routing

Controls RFC3581 (Symmetric Response Routing) behavior

If 'Enable' is selected, RFC3581 will be followed according to the specification

Selecting any of the other options is only advisable when this SIP profile will be used to connect

with user agents that are known to have issues with RFC3581 or lack support for it (ie: Polycom)

and they are known to be behind some sort of firewall or NAT device (ie remote employees)

If 'Disable' is selected, RFC3581 support will be completely disabled

Outbound requests will not contain the Via rport parameter and responses will be routed back

to the port specified in the topmost Via header of the request even if the rport Via parameter

was specified in the request by the client (this helps with devices that have problems processing or

ignoring the Via rport parameter or when you want to disable the RFC3581 behavior even if

a client requests it or a server supports it)

If 'Force Always' is selected, RFC3581 support will be always forced even if client does not request it

Outbound requests will contain the Via rport parameter and UDP responses

will be routed back to the network source port of the client even when no Via rport parameter was

specified in the request by the client. This effectively forces RFC3581 behavior even if not requested

This is non-RFC compliant but helps with devices behind NAT that do not implement RFC3581 but still

need the SBC to provide that functionality to route responses through NAT or firewall devices

* This option may break communications if used when requests come through a SIP proxy

or user agents that are not behind a firewall or NAT device

If 'Auto Force' is selected, RFC3581 support will be forced on particular user agents known to be problematic

This option is equivalent to 'Force' except that it will force it only for inbound requests with a User-Agent

header such as Polycom or other known problematic user agents without RFC3581 support

* This option may break communications if used when requests come through a SIP proxy

If 'Client Only' is selected, RFC3581 behavior is followed only for outbound requests

Outbound requests will contain the Via rport parameter and responses will still be routed

back to the port specified in the topmost Via header of the request (non-RFC3581 behavior)

even if the rport Via parameter was specified in the request by the client

This is non-RFC complaint but helps with clients that have issues/bugs with their RFC3581

This effecitvely disabling RFC3581 for inbound requests only

If 'Server Only' is selected, RFC3581 behavior is followed only for inbound requests

Outbound requests will not contain the Via rport parameter but responses will be routed

back to the network source port when the client specifies the Via rport parameter in their request

This is effectively disabling RFC3581 for outbound requests only

sip-tos-value

Type

  • string

Default

  • None

Rules

  • greater_than[-1]
  • less_than[256]

SIP TOS Value

DiffServ integer value (0-255) for the signaling packets (this is the old TOS IP header value). You can use this to set TOS values as well.