NetBorder Session Controller

Description

Update a SNGMS Configuration

REST Name

update

Request

POST

URL

[server url][:port]/SAFe/sng_rest/api/update/cluster/peer/{identifier}/sngms_configuration/{identifier}

Input

Name	Data	Possible Values	Description
`ipv6_address`	Type text Default 2001:db8::99:2	Rules valid_ip[ipv6]	Base IPv6 address
`jitter/mode`	Type Enumeration Default adaptive	Rules required Values adaptive - Adaptive static - Static	Jitter Mode Jitter buffer mode to operate on. Static allocates a fixed buffer. Adaptive changes the buffer on runtime depending on the network
`vqe/tx_automatic_level_control`	Type Enumeration Default None	Rules required Values 1 - Enable 0 - Disable	Automatic 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%.
`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.
`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.
`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
`ip_address`	Type text Default 10.10.0.1	Rules required valid_ip[ipv4]	Base IPv4 address Starting IP Address to be assigned to the media modules. For every module discovered, the IP address will be incremented by 1.
`gateway`	Type text Default 10.10.0.100	Rules valid_ip[ipv4]	Default IPv4 Gateway Default Gateway to be assigned to the media modules.
`ipv6_prefix`	Type text Default 120	Rules integer greater_than[0] less_or_equal[128]	IPv6 prefix
`jitter/max_pdv_ms`	Type integer Default 100	Rules required[jitter/mode] integer greater_or_equal[20] less_or_equal[200]	Jitter Max PDV Maximum tolerated packet delay variation in milliseconds.
`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_adaptive_noise_reduction`	Type Enumeration Default None	Rules required Values 1 - Enable 0 - Disable	Adaptive 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%.
`jitter/min_delay_ms`	Type integer Default 20	Rules required[jitter/mode] integer greater_or_equal[20] less_or_equal[jitter/initial_delay_ms]	Jitter Minimal Delay Minimal delay tolerated in milliseconds.
`vqe/rx_automatic_level_control`	Type Enumeration Default None	Rules required Values 1 - Enable 0 - Disable	Automatic 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%.
`udp_end`	Type text Default 20000	Rules valid_port_number	Last UDP port Ending UDP port to be assigned to the media modules.
`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
`ext_ip_address`	Type text Default None	Rules valid_ip[ipv4]	Base External IPv4 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.
`ext_ipv6_address`	Type text Default None	Rules valid_ip[ipv6]	Base External IPv6 address
`mask`	Type text Default 255.255.255.0	Rules required valid_ip[ipv4]	IPv4 Network Mask Subnet mask to be assigned to the media modules.
`jitter/initial_delay_ms`	Type integer Default 40	Rules required[jitter/mode] integer greater_or_equal[20] less_or_equal[jitter/max_pdv_ms]	Jitter Initial Delay Initial delay (buffer size) in milliseconds.
`mode`	Type Enumeration Default hardware-hidden	Rules required Values hardware-hidden - Hardware Hidden software - Software	Transcoding Mode Sets the Transcoding Mode object(stdClass)#400 (1) { ["Software"]=> array(1) { [0]=> string(25) "Disable media interfaces." } } object(stdClass)#401 (1) { ["Hidden"]=> array(2) { [0]=> string(172) "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)." [1]=> string(69) "Do NOT plug an ethernet cable to the media ethernet port (D500/D100)." } }
`ipv6_gateway`	Type text Default 2001:db8::99:1	Rules valid_ip[ipv6]	Default IPv6 Gateway