NetBorder Session Controller

Description

Media Interface Modules

REST Name

sngms_module

Methods

list: List
create: Create
retrieve: Retrieve
update: Update
delete: Delete

Properties

Name	Data	Possible Values	Description
`ipv6_address`	Type text Default None	Rules valid_ip[ipv6]	IPv6 address
`jitter/mode`	Type Enumeration Default static	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%.
`gateway`	Type text Default None	Rules valid_ip[ipv4]	IPv4 Gateway Default IPv4 gateway of this particular module.
`vlan_id`	Type string Default None	Rules greater_than[0] less_than[4097]	VLAN Identifier (Optional) Identifies which VLAN this module is part of. If the VLAN ID was entered in the Media Interface, it does not need to be entered here unless the VLAN ID is different. A VLAN ID is not required, and will be ignored, when the Media Interfaces are set to Hidden.
`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 None	Rules required[enable] valid_ip_array[ipv4]	IPv4 address IPv4 address of this particular module.
`version`	Type string Default None		Version
`ipv6_prefix`	Type text Default None	Rules integer greater_than[0] less_or_equal[128]	IPv6 prefix
`ifname`	Type string Default None		Interface
`udp_begin`	Type text Default 14000	Rules required valid_port_number greater_or_equal[5004]	First UDP port Starting UDP port being used by this module
`enable`	Type Enumeration Default true	Rules required Values false - Disable true - Enable	Enable Enable/Disable this particular module.
`jitter/max_pdv_ms`	Type integer Default None		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 None		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%.
`mac`	Type string Default default		MAC Address
`udp_end`	Type text Default 16000	Rules required valid_port_number	Last UDP port Ending UDP port being used by this module.
`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]	External IPv4 address Optional parameter. IPv4 address used by gateway in the SDP offer or answer. If not specified, gateway uses the assigned IP address to the media interface(default behavior). When gateway is behind a firewall (ie: DMZ or port-forwarding) with RTP ports being forwarded to the media interface, it may be desirable to specify this parameter to an IP address that will be mapped by the firewall port-forwarding capabilities to the internal IP address of the media interface, 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]	External IPv6 address
`mask`	Type text Default None	Rules required[enable] valid_ip[ipv4]	IPv4 Network Mask Subnet Mask of this particular module
`jitter/initial_delay_ms`	Type integer Default None		Jitter Initial Delay Initial delay (buffer size) in milliseconds.
`ipv6_gateway`	Type text Default None	Rules valid_ip[ipv6]	IPv6 Gateway