NetBorder Session Controller

Description

REST Name

update

Request

POST

URL

[server url][:port]/SAFe/sng_rest/api/update/sngms/configuration

Input

Name	Data	Possible Values	Description
`enable_media_interface`	Type Enumeration Default true	Rules required Values true - Enable false - Disable	Enable/Disable Media Interfaces Option to enable/disable media interfaces from being used with the system.
`interfaces`	Type checkbox Default __empty__	Rules required[enable_media_interface] required[,in,__empty__] is_array Values eth0 - eth0	Detect Media Interfaces Select from a list of interfaces to detect media modules. Media modules will only be detected on selected interfaces. All other media module information will be removed.
`individual-ip`	Type Enumeration Default false	Rules required Values true - Exposed false - Hidden	IP Mode Sets whether the transcoding modules are exposed on the external network. Hidden - All media interfaces will be hidden and protected from the external network. Signaling and media will flow together thru the primary network interfaces (ie, eth0 and eth1). Do NOT plug an ethernet cable to the media ethernet port (D500/D100). Exposed - All media interfaces will be exposed in the network. Media will flow thru the media ethernet port only. You must connect an ethernet cable to the media ethernet port (D500/D100)
`ip_address`	Type text Default 10.10.0.1	Rules required valid_ip	Base IP address Starting IP Address to be assigned to the media modules. For every module discovered, the IP address will be incremented by 1.
`vlan_id`	Type string Default None	Rules greater_than[0] less_than[4097]	VLAN Identifier Specify the VLAN identifier that will be used on all media modules discovered.
`ext_ip_address`	Type text Default None	Rules valid_ip	Base External IP address This is the starting IP address that system will use in the SDP offer or answer. For every module discovered, the IP address will be incremented by 1. If not specified, system will use the assigned IP address to the media module(default behavior). When system is behind a firewall (ie: DMZ or port-forwarding) with RTP ports being forwarded to the media module, it may be desirable to specify this parameter to an IP address that will be mapped by the firewall port-forwarding capabilities to the IP address of the media module. If not set when working under a DMZ or port-forwarding scenario, calls may end up not having audio.
`mask`	Type text Default 255.255.255.0	Rules required[individual-ip] valid_ip	Network Mask Subnet mask to be assigned to the media modules.
`gateway`	Type text Default 10.10.0.100	Rules valid_ip	Default Gateway Default Gateway to be assigned to the media modules.
`udp_begin`	Type text Default 10000	Rules required valid_port_number greater_or_equal[5004]	First UDP port Starting UDP port to be assigned to the media modules.
`udp_end`	Type text Default 20000	Rules valid_port_number	Last UDP port Ending UDP port to be assigned to the media modules.
`vqe/acoustic_echo`	Type Enumeration Default None	Rules required Values 1 - Enable 0 - Disable	Acoustic Echo Cancellation Enable acoustic echo cancellation for all media sessions. This reduces echo on calls but increases the possibility of double-talk clipping. Use this value for situations where the echo path is highly non-linear. Note that enabling this feature will reduce your call capacity in about 35%.
`vqe/rx_adaptative_noise_reduction`	Type Enumeration Default None	Rules required Values 1 - Enable 0 - Disable	Adaptative Noise Reduction Enable Adaptive Noise Reduction for all media sessions. This removes the noise present while leaving voice intact. Note that enabling this feature will reduce your call capacity in about 35%.
`vqe/rx_automatic_level_control`	Type Enumeration Default None	Rules required Values 1 - Enable 0 - Disable	Adaptative Level Control (RX) Enable RX Automatic Level Control for all media sessions. Using the level threshold limit specified in Automatic Level Control Target, dBm0 level is being filtered. Note that enabling this feature will reduce your call capacity in about 15%.
`vqe/rx_automatic_level_control_target_dbm0`	Type integer Default -21	Rules required[vqe/rx_automatic_level_control] integer greater_or_equal[-42] less_or_equal[-6]	Target
`vqe/tx_automatic_level_control`	Type Enumeration Default None	Rules required Values 1 - Enable 0 - Disable	Adaptative Level Control (TX) Enable TX Automatic Level Control for all media sessions. Using the level threshold limit specified in Automatic Level Control Target, dBm0 level is being filtered. Note that enabling this feature will reduce your call capacity in about 15%.
`vqe/tx_automatic_level_control_target_dbm0`	Type integer Default -21	Rules required[vqe/tx_automatic_level_control] integer greater_or_equal[-42] less_or_equal[-6]	Target