NetBorder Session Controller

Description

Profile

REST Name

profile

Child Objects

limit: Limit
registration: Profile Registration

Methods

status: Retrieve Status
retrieve: Retrieve
list: List
create: Create
stop: Stop
update: Update
start: Start
registration: Retrieve Registrations
delete: Delete

Properties

Name	Data	Possible Values	Description
`outbound-proxy`	Type string Default None	Rules valid_ip_port_domain	Outbound Proxy Optional outbound proxy
`remove-contact-from-route`	Type Enumeration Default false	Rules required Values false - Disable true - Enable	Do not Append Contact to UAS Route By default sip call with Record-Route headers is received, any outgoing new transaction from the SBC will include the received contact header value as last Route which can break interoperability with some proxies. Setting thsi option will prevent the SBC from doing that.
`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
`auth-calls-by-network-address`	Type Enumeration Default false	Rules required Values false - Disable true - IP Address port-restricted - IP Address + Port	Network Validation ACL Network Validation ACL: object(stdClass)#700 (1) { ["IP address"]=> string(83) "Network IP address of registered endpoints will be used to validate incoming calls." } object(stdClass)#701 (1) { ["IP Address + Port"]=> string(84) "Network IP and PORT of registered endpoints will be used to validate incoming calls." }
`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.2	Rules required Values default - TLS Version 1, 1.1 & 1.2 tlsv1 - TLS Version 1 tlsv1.2 - TLS Version 1.2 sslv23 - SSL Version 2 & 3	TLS Version The version being used by SSL/TLS
`lync-interop`	Type Enumeration Default false	Rules required Values false - Disable true - Enable	Lync Interoperability Enable or disable settings for Lync interoperability.
`always-add-mode-to-sdp`	Type Enumeration Default false	Rules required Values false - Disable true - Enable	Always add media mode to outgoing SDP By default when session level media mode is equal to media line level media mode, the a= line is ommitted from the outgoing SDP. Setting this parameter to true will alter that behavior and force to always print the m= line to outgoing SDP.
`call-routing`	Type Enumeration Default __selectone__	Rules required[,in,__selectone__] required Values __selectone__ - ( Please Select One )	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 valid_port_number greater_than[1024] less_than[65525] callback_port_check[TLS/tls-sip-port]	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 This option breaks RFC 3711 and is only valid when Lync Interoperability is enabled. When this option is enabled, SDP media lines will use RTP/AVP even when SRTP is enabled and an a=crypto line will be added as usual for SRTP sessions. The standard RTP/SAVP profile will not be used for SDP secure media lines when this option is enabled.
`ingress`	Type Enumeration Default __none__	Rules required Values __none__ - ( None )	Ingress
`egress`	Type Enumeration Default __none__	Rules required Values __none__ - ( None )	Egress
`ext-rtp-ip`	Type string Default None	Rules valid_ext_sip_ip	External RTP IP address An IP address string such as '200.1.2.4' The specified IP will be used as the advertised address in the SDP payload The string 'auto-nat' Gateway will use uPNP or NAT-PMP to discover the public IP address it should use 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 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)
`strict-security`	Type Enumeration Default false	Rules required Values false - Disable true - Enable	Strict Security Enable or Disable strict security on the sip profile. When strict security is enabled on a sip profile, all traffic from non whitelisted and/or registered ip addresses, on that sip profile, will be blocked. This means that with this feature enabled you need to assign ACLs or register endpoints in order to be able to make calls through the profile.
`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.
`inbound-media-profile`	Type Enumeration Default __selectone__	Rules required[,in,__selectone__] required Values __selectone__ - ( Please Select One )	Inbound Media Profile Media profile that will be used on all incoming calls.
`allow-private-wire-info`	Type Enumeration Default true	Rules required Values false - Disable true - Enable	Allow Privite Wire Info Enable or Disable allowing private wire info messages.
`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 None	Rules required required Values	SIP IP Address IP Address being used for SIP signalling.
`rtp-ip`	Type Enumeration Default __none__	Rules required Values __none__ - (SIP Profile)	RTP IP address This is the RTP IP to be used for the RTP network connection. If left '(SIP Profile)', 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.
`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	Rules required[enable-load-limit] max_length[39] alpha_dash_space	Reject Message Reject calls based on the string provided.
`TLS/certificate`	Type Enumeration Default __none__	Rules required Values __none__ - (None)	TLS Certificate
`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
`send-display-update`	Type Enumeration Default true	Rules required Values false - Disable true - Enable	Send Display Update Send Display Update When this option is disabled, Display Caller/Callee ID Updates will not be handled
`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.
`strict-sdp-parsing`	Type Enumeration Default false	Rules required Values false - Disable true - Enable	Strict SDP Parsing Enable strict SDP parsing When this option is enabled, the SDP contents will be strictly checked for compliance with RFC 4566 and any SDP contents in SIP messages that do not conform will be rejected. For interoperability with broken equipment it's sometimes desirable to relax the parser to tolerate minor deviations from the RFC. In such cases you can disable this option.
`rtp-timeout-sec`	Type string Default 60	Rules integer greater_or_equal[0]	RTP Timeout RTP Timeout in seconds. If 0 is specified, timeout is disabled.
`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.
`srtp/force-outbound-secure-rtp`	Type Enumeration Default false	Rules required Values false - Disable true - Enable	Force outbound Secure RTP Force outbound leg INVITE to include secure rtp offer irrespective of inbound leg media. Software mode by default does not add SRTP on outbound INVITE always
`pass-callee-id`	Type Enumeration Default true	Rules required Values false - Disable true - Enable	To pass Callee ID Enable Pass callee ID Disable by setting it to false if you encounter something that your gateway for some reason hates X-headers that it is supposed to ignore. When this option is disabled, X-FS-Support header is removed from INVITE and sip messages X-FS-Support header for sip messages.
`outbound-media-profile`	Type Enumeration Default __selectone__	Rules required[,in,__selectone__] required Values __selectone__ - ( Please Select One )	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[enable-timer] is_numeric greater_or_equal[90] callback_check_session_timeout	Session Expires Value in seconds for the Session-Expires header to be used in session expiration requests.
`apply-nat-acl`	Type Enumeration Default __empty__	Rules required Values __empty__ - (None) nat.rfc1918 - RFC1918	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
`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
`max-sessions`	Type string Default None	Rules greater_than[0] less_than[10000] is_numeric	Max Concurrent SIP Sessions Maximum number of concurrent sessions that will be accepted in this profile. Unlimited if not specified.
`timer-T2`	Type string Default 4000	Rules integer greater_than[0]	SIP T2 Timer SIP T2 Timer
`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).
`allow-asymmetric-dynamic-payload-type`	Type Enumeration Default false	Rules required Values false - Disable true - Enable	Allow Asymmetric Dynamic Payload Type Allow or Disallow Asymmetric Dynamic Payload Type.
`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"
`timer-T1`	Type string Default 500	Rules integer greater_than[0]	SIP T1 Timer SIP T1 Timer
`timer-T1X64`	Type string Default 32000	Rules integer greater_than[0]	SIP T1X64 Timer SIP T1X64 Timer
`minimum-session-expires`	Type string Default 120	Rules required[enable-timer] is_numeric greater_or_equal[90]	Minimum Session Expires Value in seconds for the Min-SE header indicating the minimum acceptable value in seconds for the Session-Expires header.
`user-agent-string`	Type string Default NetBorder Session Controller	Rules required	User Agent
`fail-auth-reject-cause`	Type string Default 403	Rules greater_than[399] less_than[700] is_numeric	Failed Authorization Reject Response Code Reject cause code for failed authorization
`sip-capture`	Type Enumeration Default false	Rules required Values false - Disable true - Enable	SIP Capture Enable or Disable SIP meessage capture on HEP server. HEP server MUST be configured to be able to enable this feature
`talk-hold-events-allowed`	Type Enumeration Default true	Rules required Values false - Disable true - Enable	Support talk and hold events Enable talk and hold events When this option is enabled, talk and hold events will be advertised in Allowed-Events header for sip messages.
`domains`	Type private Default None		domains
`siprelay`	Type Enumeration Default false	Rules required Values false - Disable true - Enable	SIP Message Routing
`timer-T4`	Type string Default 4000	Rules integer greater_than[0]	SIP T4 Timer SIP T4 Timer
`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 valid_port_number callback_port_check[sip-port]	Port Port being used for SIP Signalling
`display-name`	Type string Default None	Rules alpha_dash	Display Name
`apply-register-acl`	Type listbox Default None	Rules is_array Values	ACL for Registration
`allow-malformed-headers`	Type Enumeration Default false	Rules required Values false - Disable true - Enable	Allow Malformed Headers Allow receiving malformed non-critical SIP headers available in dialplan via sip_mh_[header_name] channel variable.
`enable-timer`	Type Enumeration Default false	Rules required Values false - Disable true - Enable	SIP Session Timer Enable or Disable the SIP session timer.
`rtp-auto-local-port-renew-on-reinvite`	Type Enumeration Default false	Rules required Values false - Disable true - Enable	Renew RTP Port On ReInvite Enable/Disable Automatic Local RTP Port Renewal On ReInvite. If enabled, when a new SDP offer is received in connected state and if media line remote IP or Port has been changed, a new local port is assigned for the RTP stream.
`ext-sip-ip`	Type string Default None	Rules valid_ext_sip_ip	External SIP IP Address An IP address string such as '200.1.2.3' SIP messages in this profile will use the specified IP address in all headers such as Contact, From, etc The string 'auto-nat' Gateway will use uPNP or NAT-PMP to discover the public IP address it should use 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 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)
`fail-auth-cause-string`	Type string Default Forbidden		Failed Authorization Reject Message Reject unauthorized calls using the provided SIP response message. If left empty the default message for the given reject response code will be used.
`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.
`apply-inbound-acl`	Type listbox Default None	Rules is_array Values	ACL for Inbound Calls
`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
`siprelay-context`	Type Enumeration Default auto_create_new_smr_plan	Rules required Values auto_create_new_smr_plan - Create New Plan	Unsolicited SIP Message Routing Plan Select a Unsolicited SIP Message Routing Plan.
`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.
`siprelay-allow-methods`	Type checkbox Default None	Rules is_array Values TR87 - TR87 MESSAGE - MESSAGE NOTIFY - NOTIFY OPTIONS - OPTIONS	Siprelay Allow Methods Select Siprelay Allow Methods.
`enable-3pcc-relay-alerting`	Type Enumeration Default false	Rules required Values false - Disable true - Enable	3pcc Relay Alerting
`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.
`enable-request-dns-caching`	Type Enumeration Default false	Rules required Values false - Disable true - Enable	Request SIP DNS Caching Enable SIP DNS caching. Cached value will be used on subsequent outgoing SIP Request with the same URL