Sangoma's Vega Enterprise SBC and NetBorder Session Controller (NSC) are advanced and flexible Session Border Controllers that allow you to interconnect different SIP networks securely to perform SIP trunking and general SIP call routing with its advanced XML-based routing engine or the friendly call routing Web UI.
The NetBorder Session Controller REST API allows you to provision and manage Sangoma's SBC without making use of the front end Web UI. You can add, edit and remove SIP trunks, profiles, domains, users with ease. You can use the programming language of your preference to automate provisioning of the SBC and integrate the SBC with other applications or business logic and processes in your company. In NSC 2.2 virtually all components can be configured through the REST API.
""
[ "The Auditor module takes care of enabling, disabling and otherwise configuring audit points to raise alarms on different system conditions such as CPU load, memory, call quality, etc." ]
[
"Alert when Media Firewall logs critical messages.",
{
"Critical Messages": [
"Enable/Disable Critical Messages audit point."
]
},
{
"Severity": "Select the severity level."
}
][
"Alert when Media Firewall logs error messages.",
{
"Error Messages": [
"Enable/Disable Error Messages audit point."
]
},
{
"Severity": "Select the severity level."
}
][
"Alert when Media Firewall logs warning messages.",
{
"Warning Messages": [
"Enable/Disable Warning Messages audit point."
]
},
{
"Severity": "Select the severity level."
}
]"mediamon/service/restart"
[
"Alert when the media firewall service memory or CPU usage is higher than the specified value.",
{
"Media Firewall": [
"Enable/Disable Media Firewall audit point."
]
},
{
"Severity": "Select the severity level."
},
{
"Memory": [
"Memory Usage threshold for Media Firewall."
]
},
{
"Cpu": [
"CPU Usage threshold for Media Firewall."
]
}
]{
"composite_parent": "mediamon/service/action",
"default": "false",
"value": {
"false": "Disable",
"true": "Enable"
},
"label": "Restart",
"field": "mediamon/service/restart",
"rules": "required|in_list[true,false]",
"type": "dropdown"
}[
"Alert when the monitor service memory or CPU usage is higher than the specified value.",
{
"Monitor": [
"Enable/Disable Monitor audit point."
]
},
{
"Severity": "Select the severity level."
},
{
"Memory": [
"Memory Usage threshold for Monitor."
]
},
{
"Cpu": [
"CPU Usage threshold for Monitor."
]
}
][
"Alert when the SQL Server service memory or CPU usage is higher than the specified value.",
{
"SQL Server": [
"Enable/Disable SQL Server audit point."
]
},
{
"Severity": "Select the severity level."
},
{
"Memory": [
"Memory Usage threshold for SQL Server."
]
},
{
"Cpu": [
"CPU Usage threshold for SQL Server."
]
}
]{
"composite_parent": "mysqld/service/action",
"default": "true",
"value": {
"false": "Disable",
"true": "Enable"
},
"label": "Restart",
"field": "mysqld/service/restart",
"rules": "required|in_list[true,false]",
"type": "dropdown"
}{
"composite": [
"nsc/directory/core-dump/level"
],
"group": "nsc/directory/core-dump/action",
"default": "alert",
"value": {
"false": "Disable",
"alert": "Enable"
},
"label": "Core Dump",
"field": "nsc/directory/core-dump/action",
"rules": "required|in_list[false,alert]",
"type": "dropdown"
}{
"composite_parent": "nsc/directory/core-dump/action",
"default": "critical",
"value": {
"info": "Information",
"critical": "Critical",
"error": "Error"
},
"label": "Severity",
"field": "nsc/directory/core-dump/level",
"rules": "required|in_list[info,error,critical]",
"type": "dropdown"
}[
"Alert when NSC transcoding capacity percentage is lower than the specified value.",
{
"Transcoding Capacity %": [
"Enable/Disable Transcoding Capacity % audit point."
]
},
{
"Severity": "Select the severity level."
}
]{
"field": "nsc/log/core-dump/action",
"label": "Core Dump",
"type": "dropdown",
"default": "alert",
"value": {
"false": "Disable",
"alert": "Enable"
},
"rules": "required|in_list[false,alert]",
"help": [
"Alert when NSC produces a core dump.",
{
"Core Dump": [
"Enable/Disable Core Dump audit point."
]
},
{
"Severity": "Select the severity level."
}
],
"composite": [
"nsc/log/core-dump/level"
],
"group": "nsc/log/core-dump/action",
"category_setting": "expanded",
"category": "Vega Session Controller"
}{
"field": "nsc/log/core-dump/level",
"label": "Severity",
"type": "dropdown",
"default": "critical",
"value": {
"info": "Information",
"error": "Error",
"critical": "Critical"
},
"rules": "required|in_list[info,error,critical]",
"composite_parent": "nsc/log/core-dump/action"
}[
"Alert when NSC logs critical messages.",
{
"Critical Messages": [
"Enable/Disable Critical Messages audit point."
]
},
{
"Severity": "Select the severity level."
}
][
"Alert when NSC logs error messages.",
{
"Error Messages": [
"Enable/Disable Error Messages audit point."
]
},
{
"Severity": "Select the severity level."
}
][
"Alert when NSC logs warning messages.",
{
"Warning Messages": [
"Enable/Disable Warning Messages audit point."
]
},
{
"Severity": "Select the severity level."
}
]"nsc/service/restart"
[
"Alert when the NSC service memory or CPU usage is higher than the specified value.",
{
"Vega Session Controller": [
"Enable/Disable Vega Session Controller audit point."
]
},
{
"Severity": "Select the severity level."
},
{
"Memory": [
"Memory Usage threshold for Vega Session Controller."
]
},
{
"Cpu": [
"CPU Usage threshold for Vega Session Controller."
]
}
]{
"composite_parent": "nsc/service/action",
"default": "false",
"value": {
"false": "Disable",
"true": "Enable"
},
"label": "Restart",
"field": "nsc/service/restart",
"rules": "required|in_list[true,false]",
"type": "dropdown"
}[
"Alert when NSC call load exceeds the specified value.",
{
"Call Capacity %": [
"Enable/Disable Call Capacity % audit point."
]
},
{
"Severity": "Select the severity level."
}
][
"Alert when NSC trunk availability percentage is lower than the specified value.",
{
"Trunk Availability %": [
"Enable/Disable Trunk Availability % audit point."
]
},
{
"Severity": "Select the severity level."
}
][
"Alert when the jitter, packet loss or RTT values are higher than the specified values.",
{
"Call Quality": [
"Enable/Disable Call Quality audit point."
]
},
{
"Severity": "Select the severity level."
}
][
"Alert when RTCP monitor logs critical messages.",
{
"Critical Messages": [
"Enable/Disable Critical Messages audit point."
]
},
{
"Severity": "Select the severity level."
}
][
"Alert when RTCP monitor logs error messages.",
{
"Error Messages": [
"Enable/Disable Error Messages audit point."
]
},
{
"Severity": "Select the severity level."
}
][
"Alert when RTCP monitor logs warning messages.",
{
"Warning Messages": [
"Enable/Disable Warning Messages audit point."
]
},
{
"Severity": "Select the severity level."
}
]"rtcpmon/service/restart"
[
"Alert when the RTCP monitor service memory or CPU usage is higher than the specified value.",
{
"RTCP Monitor": [
"Enable/Disable RTCP Monitor audit point."
]
},
{
"Severity": "Select the severity level."
},
{
"Memory": [
"Memory Usage threshold for RTCP Monitor."
]
},
{
"Cpu": [
"CPU Usage threshold for RTCP Monitor."
]
}
]{
"composite_parent": "rtcpmon/service/action",
"default": "false",
"value": {
"false": "Disable",
"true": "Enable"
},
"label": "Restart",
"field": "rtcpmon/service/restart",
"rules": "required|in_list[true,false]",
"type": "dropdown"
}[
"Alert when SIP security monitor logs critical messages.",
{
"Critical Messages": [
"Enable/Disable Critical Messages audit point."
]
},
{
"Severity": "Select the severity level."
}
][
"Alert when SIP security monitor logs error messages.",
{
"Error Messages": [
"Enable/Disable Error Messages audit point."
]
},
{
"Severity": "Select the severity level."
}
][
"Alert when SIP security monitor logs warning messages.",
{
"Warning Messages": [
"Enable/Disable Warning Messages audit point."
]
},
{
"Severity": "Select the severity level."
}
]"sipsecmon/service/restart"
[
"Alert when the SIP security monitor service memory or CPU usage is higher than the specified value.",
{
"SIP Security Monitor": [
"Enable/Disable SIP Security Monitor audit point."
]
},
{
"Severity": "Select the severity level."
},
{
"Memory": [
"Memory Usage threshold for SIP Security Monitor."
]
},
{
"Cpu": [
"CPU Usage threshold for SIP Security Monitor."
]
}
]{
"composite_parent": "sipsecmon/service/action",
"default": "false",
"value": {
"false": "Disable",
"true": "Enable"
},
"label": "Restart",
"field": "sipsecmon/service/restart",
"rules": "required|in_list[true,false]",
"type": "dropdown"
}[
"Alert when the percentages of CPU usage are higher than the specified values for User,System and Wait.",
{
"CPU Usage %": [
"Enable/Disable CPU Usage % audit point."
]
},
{
"Severity": "Select the severity level."
},
{
"User": [
"CPU Usage threshold for user."
]
},
{
"System": [
"CPU Usage threshold for system."
]
},
{
"Wait": [
"CPU Usage threshold for wait."
]
}
][
"Alert when the /root partition usage percentages are higher than the specified value.",
{
"File System Usage % (root)": [
"Enable/Disable File System Usage % (root) audit point."
]
},
{
"Severity": "Select the severity level."
}
]"File System Usage %"
"File System Usage % (root)"
{
"field": "system/filesystem/var/action",
"label": "File System Usage % (var)",
"type": "dropdown",
"default": "alert",
"value": {
"false": "Disable",
"alert": "Enable"
},
"rules": "required|in_list[false,alert]",
"help": [
"Alert when the /var partition usage percentages are higher than the specified value.",
{
"File System Usage % (var)": [
"Enable/Disable File System Usage % (var) audit point."
]
},
{
"Severity": "Select the severity level."
}
],
"composite": [
"system/filesystem/var/level",
"system/filesystem/var/limit"
],
"group": "system/filesystem/var/action",
"category_setting": "expanded",
"category": "System"
}{
"field": "system/filesystem/var/level",
"label": "Severity",
"type": "dropdown",
"default": "critical",
"value": {
"info": "Information",
"error": "Error",
"critical": "Critical"
},
"rules": "required|in_list[info,error,critical]",
"composite_parent": "system/filesystem/var/action"
}{
"field": "system/filesystem/var/limit",
"label": "Limit",
"type": "text",
"default": "75",
"size": "5",
"rules": "integer|greater_or_equal[0]|less_or_equal[100]",
"composite_parent": "system/filesystem/var/action"
}"75"
"1.0"
"integer|greater_or_equal[0]|less_or_equal[100]"
"decimal|greater_than[0]"
"75"
"2.0"
"integer|greater_or_equal[0]|less_or_equal[100]"
"decimal|greater_than[0]"
"75"
"1.0"
"integer|greater_or_equal[0]|less_or_equal[100]"
"decimal|greater_than[0]"
[
"Alert when system load averages are higher than the specified values for the past 1, 5, and 15 minutes.",
" Your system have 2 cpu.",
{
"Load Average": [
"Enable/Disable Load Average audit point."
]
},
{
"Severity": "Select the severity level."
},
{
"1min": [
"System load average threshold for 1min."
]
},
{
"5min": [
"System load average threshold for 5min."
]
},
{
"15min": [
"System load average threshold for 15min."
]
}
][
"Alert when the percentages of total memory are higher than the specified values.",
{
"Memory Usage %": [
"Enable/Disable Memory Usage % audit point."
]
},
{
"Severity": "Select the severity level."
}
][
"Alert when the RAID status is abnormal.",
{
"RAID Status": [
"Enable/Disable RAID Status audit point."
]
},
{
"Severity": "Select the severity level."
}
][
"Alert when the WEB server service memory or CPU usage is higher than the specified value.",
{
"Web Server": [
"Enable/Disable Web Server audit point."
]
},
{
"Severity": "Select the severity level."
},
{
"Memory": [
"Memory Usage threshold for Web Server."
]
},
{
"Cpu": [
"CPU Usage threshold for Web Server."
]
}
]{
"composite_parent": "webconfig/service/action",
"default": "true",
"value": {
"false": "Disable",
"true": "Enable"
},
"label": "Restart",
"field": "webconfig/service/restart",
"rules": "required|in_list[true,false]",
"type": "dropdown"
}""
[ "The Call Admission Control module takes care of creating policies for call admission based on IP address or SIP URI." ]
""
[]
"is_array|in_list["
""
[ "The CDR module takes care of configuring the CDR service and allows you to retrieve CDR data as well." ]
""
[ "The Certificate module takes care of administering CA and Server TLS/SSL certificates." ]
""
[ "The Core configuration module takes care of the SBC settings such as log level, sessions per second, etc." ]
""
[ "The Directory module takes care of administering domain user credentials and other misc settings of users and domains such as upper registration." ]
"required[forward-registration]"
"required[forward-registration]|valid_port_number"
"default"
"__none__"
"required|in_list[default]"
"required|in_list[__none__,default]"
"( SIP Profile Default )"
"default dialplan"
"default"
""
[ "The Load Balancing module takes care of creating lists of resources and setting balancing preferences for those resources." ]
"required[,in,none]|required|in_list[]"
"required[,in,none]|in_list[]"
""
[ "The ENUM module takes care of the ENUM configuration settings." ]
{
"object": {
"configuration": {
"singleton": true,
"description": "Configuration",
"dynamic": false,
"pagination": false,
"base_path": "/NSC/local/software/firewall/configuration",
"configurable": true,
"methods": {
"retrieve": {
"request": "GET",
"name": "Retrieve"
},
"update": {
"request": "POST",
"name": "Update"
}
},
"global_methods": false,
"class": {
"extif": {
"default": "eth0 ",
"field": "extif",
"size": 70,
"type": "text",
"label": "External Interface List"
}
},
"name": "Configuration"
}
},
"name": "IP Firewall",
"description": ""
}""
[ "The Hardware module takes care of configuring hardware such as transcoding network adapters." ]
"required[individual-ip]|is_numeric"
"required|valid_port_number|greater_or_equal[5004]"
"required[individual-ip]|is_numeric"
"required|valid_port_number"
""
[ "The Header Manipulation module takes care of administering SIP header manipulation rules.", "", "Advanced header manipulation allows you write your own XML rules.", "Basic header manipulation allows you to create structured rules that are serialized to XML by the backend." ]
{
"field": "action/1/log/name",
"label": "Level",
"type": "dropdown",
"default": "DEBUG",
"value": {
"DEBUG": "Debug",
"INFO": "Info",
"NOTICE": "Notice",
"WARNING": "Warning",
"ERR": "Error",
"CRIT": "Critical",
"ALERT": "Alert"
},
"rules": "required[,in,__selectone__]|in_list[DEBUG,INFO,NOTICE,WARNING,ERR,CRIT,ALERT]",
"style": "width:190px;",
"label_style": "width:60px;",
"composite_style": "display: none;",
"composite_parent": "action/1/type"
}{
"field": "action/1/log/value",
"label": "Message",
"type": "text",
"default": "",
"size": 40,
"style": "width:206px;",
"label_style": "width:65px;",
"composite_style": "display: none;",
"rules": "required",
"composite_parent": "action/1/type"
}"action/1/log/name"
"action/1/log/value"
"none"
"__none__"
"( Please Select One )"
"Log"
"(Please Select One)"
{
"field": "action/2/log/name",
"label": "Level",
"type": "dropdown",
"default": "DEBUG",
"value": {
"DEBUG": "Debug",
"INFO": "Info",
"NOTICE": "Notice",
"WARNING": "Warning",
"ERR": "Error",
"CRIT": "Critical",
"ALERT": "Alert"
},
"rules": "required[,in,__selectone__]|in_list[DEBUG,INFO,NOTICE,WARNING,ERR,CRIT,ALERT]",
"style": "width:190px;",
"label_style": "width:60px;",
"composite_style": "display: none;",
"composite_parent": "action/2/type"
}{
"field": "action/2/log/value",
"label": "Message",
"type": "text",
"default": "",
"size": 40,
"style": "width:206px;",
"label_style": "width:65px;",
"composite_style": "display: none;",
"rules": "required",
"composite_parent": "action/2/type"
}"action/2/log/name"
"action/2/log/value"
"none"
"__none__"
"( Please Select One )"
"Log"
"(Please Select One)"
{
"field": "action/3/log/name",
"label": "Level",
"type": "dropdown",
"default": "DEBUG",
"value": {
"DEBUG": "Debug",
"INFO": "Info",
"NOTICE": "Notice",
"WARNING": "Warning",
"ERR": "Error",
"CRIT": "Critical",
"ALERT": "Alert"
},
"rules": "required[,in,__selectone__]|in_list[DEBUG,INFO,NOTICE,WARNING,ERR,CRIT,ALERT]",
"style": "width:190px;",
"label_style": "width:60px;",
"composite_style": "display: none;",
"composite_parent": "action/3/type"
}{
"field": "action/3/log/value",
"label": "Message",
"type": "text",
"default": "",
"size": 40,
"style": "width:206px;",
"label_style": "width:65px;",
"composite_style": "display: none;",
"rules": "required",
"composite_parent": "action/3/type"
}"action/3/log/name"
"action/3/log/value"
"none"
"__none__"
"( Please Select One )"
"Log"
"(Please Select One)"
{
"field": "action/4/log/name",
"label": "Level",
"type": "dropdown",
"default": "DEBUG",
"value": {
"DEBUG": "Debug",
"INFO": "Info",
"NOTICE": "Notice",
"WARNING": "Warning",
"ERR": "Error",
"CRIT": "Critical",
"ALERT": "Alert"
},
"rules": "required[,in,__selectone__]|in_list[DEBUG,INFO,NOTICE,WARNING,ERR,CRIT,ALERT]",
"style": "width:190px;",
"label_style": "width:60px;",
"composite_style": "display: none;",
"composite_parent": "action/4/type"
}{
"field": "action/4/log/value",
"label": "Message",
"type": "text",
"default": "",
"size": 40,
"style": "width:206px;",
"label_style": "width:65px;",
"composite_style": "display: none;",
"rules": "required",
"composite_parent": "action/4/type"
}"action/4/log/name"
"action/4/log/value"
"none"
"__none__"
"( Please Select One )"
"Log"
"(Please Select One)"
{
"field": "action/5/log/name",
"label": "Level",
"type": "dropdown",
"default": "DEBUG",
"value": {
"DEBUG": "Debug",
"INFO": "Info",
"NOTICE": "Notice",
"WARNING": "Warning",
"ERR": "Error",
"CRIT": "Critical",
"ALERT": "Alert"
},
"rules": "required[,in,__selectone__]|in_list[DEBUG,INFO,NOTICE,WARNING,ERR,CRIT,ALERT]",
"style": "width:190px;",
"label_style": "width:60px;",
"composite_style": "display: none;",
"composite_parent": "action/5/type"
}{
"field": "action/5/log/value",
"label": "Message",
"type": "text",
"default": "",
"size": 40,
"style": "width:206px;",
"label_style": "width:65px;",
"composite_style": "display: none;",
"rules": "required",
"composite_parent": "action/5/type"
}"action/5/log/name"
"action/5/log/value"
"none"
"__none__"
"( Please Select One )"
"Log"
"(Please Select One)"
{
"field": "anti-action/1/log/name",
"label": "Level",
"type": "dropdown",
"default": "DEBUG",
"value": {
"DEBUG": "Debug",
"INFO": "Info",
"NOTICE": "Notice",
"WARNING": "Warning",
"ERR": "Error",
"CRIT": "Critical",
"ALERT": "Alert"
},
"rules": "required[,in,__selectone__]|in_list[DEBUG,INFO,NOTICE,WARNING,ERR,CRIT,ALERT]",
"style": "width:190px;",
"label_style": "width:60px;",
"composite_style": "display: none;",
"composite_parent": "anti-action/1/type"
}{
"field": "anti-action/1/log/value",
"label": "Message",
"type": "text",
"default": "",
"size": 40,
"style": "width:206px;",
"label_style": "width:65px;",
"composite_style": "display: none;",
"rules": "required",
"composite_parent": "anti-action/1/type"
}"anti-action/1/log/name"
"anti-action/1/log/value"
"none"
"__none__"
"( Please Select One )"
"Log"
"(Please Select One)"
{
"field": "anti-action/2/log/name",
"label": "Level",
"type": "dropdown",
"default": "DEBUG",
"value": {
"DEBUG": "Debug",
"INFO": "Info",
"NOTICE": "Notice",
"WARNING": "Warning",
"ERR": "Error",
"CRIT": "Critical",
"ALERT": "Alert"
},
"rules": "required[,in,__selectone__]|in_list[DEBUG,INFO,NOTICE,WARNING,ERR,CRIT,ALERT]",
"style": "width:190px;",
"label_style": "width:60px;",
"composite_style": "display: none;",
"composite_parent": "anti-action/2/type"
}{
"field": "anti-action/2/log/value",
"label": "Message",
"type": "text",
"default": "",
"size": 40,
"style": "width:206px;",
"label_style": "width:65px;",
"composite_style": "display: none;",
"rules": "required",
"composite_parent": "anti-action/2/type"
}"anti-action/2/log/name"
"anti-action/2/log/value"
"none"
"__none__"
"( Please Select One )"
"Log"
"(Please Select One)"
{
"field": "anti-action/3/log/name",
"label": "Level",
"type": "dropdown",
"default": "DEBUG",
"value": {
"DEBUG": "Debug",
"INFO": "Info",
"NOTICE": "Notice",
"WARNING": "Warning",
"ERR": "Error",
"CRIT": "Critical",
"ALERT": "Alert"
},
"rules": "required[,in,__selectone__]|in_list[DEBUG,INFO,NOTICE,WARNING,ERR,CRIT,ALERT]",
"style": "width:190px;",
"label_style": "width:60px;",
"composite_style": "display: none;",
"composite_parent": "anti-action/3/type"
}{
"field": "anti-action/3/log/value",
"label": "Message",
"type": "text",
"default": "",
"size": 40,
"style": "width:206px;",
"label_style": "width:65px;",
"composite_style": "display: none;",
"rules": "required",
"composite_parent": "anti-action/3/type"
}"anti-action/3/log/name"
"anti-action/3/log/value"
"none"
"__none__"
"( Please Select One )"
"Log"
"(Please Select One)"
{
"field": "anti-action/4/log/name",
"label": "Level",
"type": "dropdown",
"default": "DEBUG",
"value": {
"DEBUG": "Debug",
"INFO": "Info",
"NOTICE": "Notice",
"WARNING": "Warning",
"ERR": "Error",
"CRIT": "Critical",
"ALERT": "Alert"
},
"rules": "required[,in,__selectone__]|in_list[DEBUG,INFO,NOTICE,WARNING,ERR,CRIT,ALERT]",
"style": "width:190px;",
"label_style": "width:60px;",
"composite_style": "display: none;",
"composite_parent": "anti-action/4/type"
}{
"field": "anti-action/4/log/value",
"label": "Message",
"type": "text",
"default": "",
"size": 40,
"style": "width:206px;",
"label_style": "width:65px;",
"composite_style": "display: none;",
"rules": "required",
"composite_parent": "anti-action/4/type"
}"anti-action/4/log/name"
"anti-action/4/log/value"
"none"
"__none__"
"( Please Select One )"
"Log"
"(Please Select One)"
{
"field": "anti-action/5/log/name",
"label": "Level",
"type": "dropdown",
"default": "DEBUG",
"value": {
"DEBUG": "Debug",
"INFO": "Info",
"NOTICE": "Notice",
"WARNING": "Warning",
"ERR": "Error",
"CRIT": "Critical",
"ALERT": "Alert"
},
"rules": "required[,in,__selectone__]|in_list[DEBUG,INFO,NOTICE,WARNING,ERR,CRIT,ALERT]",
"style": "width:190px;",
"label_style": "width:60px;",
"composite_style": "display: none;",
"composite_parent": "anti-action/5/type"
}{
"field": "anti-action/5/log/value",
"label": "Message",
"type": "text",
"default": "",
"size": 40,
"style": "width:206px;",
"label_style": "width:65px;",
"composite_style": "display: none;",
"rules": "required",
"composite_parent": "anti-action/5/type"
}"anti-action/5/log/name"
"anti-action/5/log/value"
"none"
"__none__"
"( Please Select One )"
"Log"
"(Please Select One)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please Select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please Select one)"
{
"style": "width:190px;",
"composite_parent": "condition/1/type",
"default": "${alert_info}",
"composite_style": "display: none;",
"value": {
"${sip_invite_route_uri}": "Route",
"${sip_invite_to_params}": "To: Parameters",
"${sip_invite_from_uri}": "From: URI",
"${sip_invite_params}": "R-URI Parameters",
"${sip_invite_full_to}": "To",
"${sip_invite_cseq}": "CSeq",
"${sip_invite_full_from}": "From",
"${sip_invite_full_via}": "Via",
"${sip_invite_contact_params}": "Contact: Parameters",
"${sip_invite_from_params}": "From: Parameters",
"${sip_invite_req_uri}": "Request URI",
"${max_forwards}": "Max-Forwards",
"${alert_info}": "Alert-Info",
"${sip_invite_to_uri}": "To: URI",
"${sip_contact_user}": "Contact: User",
"${sip_invite_call_id}": "Call-ID",
"${sip_from_display}": "From: Display"
},
"label": "Name",
"field": "condition/1/invite_header/name",
"rules": "required[,in,none]|required|in_list[${alert_info},${sip_invite_cseq},${sip_invite_call_id},${sip_invite_contact_params},${sip_contact_user},${sip_invite_full_from},${sip_from_display},${sip_invite_from_params},${sip_invite_from_uri},${max_forwards},${sip_invite_params},${sip_invite_req_uri},${sip_invite_route_uri},${sip_invite_full_to},${sip_invite_to_params},${sip_invite_to_uri},${sip_invite_full_via}]",
"label_style": "width:60px;",
"type": "dropdown"
}{
"style": "width:206px;",
"composite_parent": "condition/1/type",
"default": "",
"composite_style": "display: none;",
"label": "Expression",
"field": "condition/1/invite_header/value",
"rules": "required",
"label_style": "width:65px;",
"type": "text",
"size": 40
}"condition/1/invite_header/name"
"condition/1/invite_header/value"
"none"
"__none__"
"( Please Select One )"
"SIP INVITE Header"
"(Please Select One)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please Select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please Select one)"
{
"style": "width:190px;",
"composite_parent": "condition/2/type",
"default": "${alert_info}",
"composite_style": "display: none;",
"value": {
"${sip_invite_route_uri}": "Route",
"${sip_invite_to_params}": "To: Parameters",
"${sip_invite_from_uri}": "From: URI",
"${sip_invite_params}": "R-URI Parameters",
"${sip_invite_full_to}": "To",
"${sip_invite_cseq}": "CSeq",
"${sip_invite_full_from}": "From",
"${sip_invite_full_via}": "Via",
"${sip_invite_contact_params}": "Contact: Parameters",
"${sip_invite_from_params}": "From: Parameters",
"${sip_invite_req_uri}": "Request URI",
"${max_forwards}": "Max-Forwards",
"${alert_info}": "Alert-Info",
"${sip_invite_to_uri}": "To: URI",
"${sip_contact_user}": "Contact: User",
"${sip_invite_call_id}": "Call-ID",
"${sip_from_display}": "From: Display"
},
"label": "Name",
"field": "condition/2/invite_header/name",
"rules": "required[,in,none]|required|in_list[${alert_info},${sip_invite_cseq},${sip_invite_call_id},${sip_invite_contact_params},${sip_contact_user},${sip_invite_full_from},${sip_from_display},${sip_invite_from_params},${sip_invite_from_uri},${max_forwards},${sip_invite_params},${sip_invite_req_uri},${sip_invite_route_uri},${sip_invite_full_to},${sip_invite_to_params},${sip_invite_to_uri},${sip_invite_full_via}]",
"label_style": "width:60px;",
"type": "dropdown"
}{
"style": "width:206px;",
"composite_parent": "condition/2/type",
"default": "",
"composite_style": "display: none;",
"label": "Expression",
"field": "condition/2/invite_header/value",
"rules": "required",
"label_style": "width:65px;",
"type": "text",
"size": 40
}"condition/2/invite_header/name"
"condition/2/invite_header/value"
"none"
"__none__"
"( Please Select One )"
"SIP INVITE Header"
"(Please Select One)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please Select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please Select one)"
{
"style": "width:190px;",
"composite_parent": "condition/3/type",
"default": "${alert_info}",
"composite_style": "display: none;",
"value": {
"${sip_invite_route_uri}": "Route",
"${sip_invite_to_params}": "To: Parameters",
"${sip_invite_from_uri}": "From: URI",
"${sip_invite_params}": "R-URI Parameters",
"${sip_invite_full_to}": "To",
"${sip_invite_cseq}": "CSeq",
"${sip_invite_full_from}": "From",
"${sip_invite_full_via}": "Via",
"${sip_invite_contact_params}": "Contact: Parameters",
"${sip_invite_from_params}": "From: Parameters",
"${sip_invite_req_uri}": "Request URI",
"${max_forwards}": "Max-Forwards",
"${alert_info}": "Alert-Info",
"${sip_invite_to_uri}": "To: URI",
"${sip_contact_user}": "Contact: User",
"${sip_invite_call_id}": "Call-ID",
"${sip_from_display}": "From: Display"
},
"label": "Name",
"field": "condition/3/invite_header/name",
"rules": "required[,in,none]|required|in_list[${alert_info},${sip_invite_cseq},${sip_invite_call_id},${sip_invite_contact_params},${sip_contact_user},${sip_invite_full_from},${sip_from_display},${sip_invite_from_params},${sip_invite_from_uri},${max_forwards},${sip_invite_params},${sip_invite_req_uri},${sip_invite_route_uri},${sip_invite_full_to},${sip_invite_to_params},${sip_invite_to_uri},${sip_invite_full_via}]",
"label_style": "width:60px;",
"type": "dropdown"
}{
"style": "width:206px;",
"composite_parent": "condition/3/type",
"default": "",
"composite_style": "display: none;",
"label": "Expression",
"field": "condition/3/invite_header/value",
"rules": "required",
"label_style": "width:65px;",
"type": "text",
"size": 40
}"condition/3/invite_header/name"
"condition/3/invite_header/value"
"none"
"__none__"
"( Please Select One )"
"SIP INVITE Header"
"(Please Select One)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please Select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please Select one)"
{
"style": "width:190px;",
"composite_parent": "condition/4/type",
"default": "${alert_info}",
"composite_style": "display: none;",
"value": {
"${sip_invite_route_uri}": "Route",
"${sip_invite_to_params}": "To: Parameters",
"${sip_invite_from_uri}": "From: URI",
"${sip_invite_params}": "R-URI Parameters",
"${sip_invite_full_to}": "To",
"${sip_invite_cseq}": "CSeq",
"${sip_invite_full_from}": "From",
"${sip_invite_full_via}": "Via",
"${sip_invite_contact_params}": "Contact: Parameters",
"${sip_invite_from_params}": "From: Parameters",
"${sip_invite_req_uri}": "Request URI",
"${max_forwards}": "Max-Forwards",
"${alert_info}": "Alert-Info",
"${sip_invite_to_uri}": "To: URI",
"${sip_contact_user}": "Contact: User",
"${sip_invite_call_id}": "Call-ID",
"${sip_from_display}": "From: Display"
},
"label": "Name",
"field": "condition/4/invite_header/name",
"rules": "required[,in,none]|required|in_list[${alert_info},${sip_invite_cseq},${sip_invite_call_id},${sip_invite_contact_params},${sip_contact_user},${sip_invite_full_from},${sip_from_display},${sip_invite_from_params},${sip_invite_from_uri},${max_forwards},${sip_invite_params},${sip_invite_req_uri},${sip_invite_route_uri},${sip_invite_full_to},${sip_invite_to_params},${sip_invite_to_uri},${sip_invite_full_via}]",
"label_style": "width:60px;",
"type": "dropdown"
}{
"style": "width:206px;",
"composite_parent": "condition/4/type",
"default": "",
"composite_style": "display: none;",
"label": "Expression",
"field": "condition/4/invite_header/value",
"rules": "required",
"label_style": "width:65px;",
"type": "text",
"size": 40
}"condition/4/invite_header/name"
"condition/4/invite_header/value"
"none"
"__none__"
"( Please Select One )"
"SIP INVITE Header"
"(Please Select One)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please Select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please Select one)"
{
"style": "width:190px;",
"composite_parent": "condition/5/type",
"default": "${alert_info}",
"composite_style": "display: none;",
"value": {
"${sip_invite_route_uri}": "Route",
"${sip_invite_to_params}": "To: Parameters",
"${sip_invite_from_uri}": "From: URI",
"${sip_invite_params}": "R-URI Parameters",
"${sip_invite_full_to}": "To",
"${sip_invite_cseq}": "CSeq",
"${sip_invite_full_from}": "From",
"${sip_invite_full_via}": "Via",
"${sip_invite_contact_params}": "Contact: Parameters",
"${sip_invite_from_params}": "From: Parameters",
"${sip_invite_req_uri}": "Request URI",
"${max_forwards}": "Max-Forwards",
"${alert_info}": "Alert-Info",
"${sip_invite_to_uri}": "To: URI",
"${sip_contact_user}": "Contact: User",
"${sip_invite_call_id}": "Call-ID",
"${sip_from_display}": "From: Display"
},
"label": "Name",
"field": "condition/5/invite_header/name",
"rules": "required[,in,none]|required|in_list[${alert_info},${sip_invite_cseq},${sip_invite_call_id},${sip_invite_contact_params},${sip_contact_user},${sip_invite_full_from},${sip_from_display},${sip_invite_from_params},${sip_invite_from_uri},${max_forwards},${sip_invite_params},${sip_invite_req_uri},${sip_invite_route_uri},${sip_invite_full_to},${sip_invite_to_params},${sip_invite_to_uri},${sip_invite_full_via}]",
"label_style": "width:60px;",
"type": "dropdown"
}{
"style": "width:206px;",
"composite_parent": "condition/5/type",
"default": "",
"composite_style": "display: none;",
"label": "Expression",
"field": "condition/5/invite_header/value",
"rules": "required",
"label_style": "width:65px;",
"type": "text",
"size": 40
}"condition/5/invite_header/name"
"condition/5/invite_header/value"
"none"
"__none__"
"( Please Select One )"
"SIP INVITE Header"
"(Please Select One)"
""
[ "The LCR module takes care of configuring the least cost routing engine." ]
"callback_check_binding_name[binding_name]|required|in_list[none]"
"callback_check_binding_name[binding_name]|in_list[none]"
""
[ "The Media module allows you to configure codecs preferences." ]
"iLBC@15200b@20i"
"iLBC@13330b@30i"
""
[ "The Media Firewall module allows you to configure settings of the media firewall service." ]
""
[ "The monitor module allows you to [TBD] ..." ]
{
"name": "Event",
"dynamic": true,
"base_path": false,
"singleton": true,
"readonly": true,
"methods": {
"status": {
"name": "Status",
"description": "Status",
"request": "GET"
},
"history": {
"name": "History",
"description": "Status",
"request": "GET"
}
},
"description": "Event",
"configurable": true,
"pagination": false,
"global_methods": false
}""
[ "The Network module allows you to configure network settings such as routes." ]
"required|in_list[eth0]"
"required|in_list[eth0,eth1]"
"eth1"
true
false
""
[ "The Notifier module allows you to configure SMTP settings to receive email notifications and add notification rules and preferences." ]
"Enable/Disable Email notification."
"SMTP user account password."
[ "SMTP server port.", "Non-encrypted connection usually uses port 25 or 587.", "Secure (SSL) connection usually uses port 465." ]
"valid_port_number"
[ "SMTP server address.", "Use IP address or FQDN.", "To enable secure(SSL) connection please add ssl:// prefix." ]
"required|ssl_ip_or_domain"
"SMTP user account identifier."
[]
"email"
"Select the action type of the notifications."
"Select the service that need to send notifications."
"All Services"
"( All Services )"
""
[]
"Select the severity level need to send notifications."
"required[,in,__empty__]"
"required[,in,__empty__]|in_list[info,error,critical]"
"Select the users to receive the notifications."
"All Users"
"( All Users )"
"The Application module manages the system startup mode, configuration and licensing."
"The Application module takes care of the SBC system startup, configuration and licensing."
{
"product": {
"default": "Vega Session Controller",
"field": "product",
"type": "text",
"disabled": "disabled",
"label": "Product"
},
"name": {
"default": "Sangoma Technologies",
"field": "name",
"type": "text",
"disabled": "disabled",
"label": "Name"
},
"email": {
"default": "devadmin@sangoma.com",
"field": "email",
"type": "text",
"disabled": "disabled",
"label": "Email"
}
}null
{
"field": "web_session_timeout",
"label": "Web Session Timeout",
"type": "text",
"default": "5",
"size": 8,
"rules": "required|is_natural|greater_than[0]",
"help": "Time in minutes for web session to expire."
}"148"
"113"
"1"
"2"
"2.1.0-148"
"2.2.0-113"
"dev"
"DEV"
""
[ "The RADIUS module allows you to configure RADIUS protocol settings for authentication and authorization, VSAs, etc." ]
{
"field": "acct-port",
"label": "RADIUS Accounting Port",
"type": "string",
"default": "1813",
"size": 10,
"rules": "required[enable-accounting]|valid_port_number",
"help": "The port being used for RADIUS Server Accounting."
}{
"field": "auth_port",
"label": "Authentication Port",
"type": "string",
"default": "1812",
"size": 10,
"rules": "required|valid_port_number",
"help": "The authentication and authorization port of the RADIUS Server."
}{
"field": "authserver",
"label": "RADIUS Server Address",
"type": "string",
"default": "localhost",
"size": 50,
"rules": "required|valid_ip_or_domain",
"help": "The domain name or IP address of the RADIUS Server."
}{
"field": "bindaddr",
"label": "Bind Local IP address",
"type": "dropdown",
"default": "eth0",
"value": {
"eth0": "eth0 - 10.20.1.35"
},
"rules": "required|in_list[eth0]",
"help": "IP Address from which RADIUS packets have been sent to.."
}{
"field": "default_realm",
"label": "Authentication Realm",
"type": "string",
"default": "",
"size": 60,
"rules": "valid_ip_or_domain",
"help": "Default authentication realm to append all usernames. The realm identifies where the receiving RADIUS server should forward the AAA requests."
}{
"field": "enable-accounting",
"label": "RADIUS Server Accounting",
"type": "dropdown",
"default": "false",
"value": {
"true": "Enable",
"false": "Disable"
},
"rules": "required|in_list[true,false]",
"help": "Enable or Disable RADIUS accounting service.",
"group": "accounting"
}{
"help": "Decision on whether this VSA is used as an input Radius request or an output Radius response.",
"default": "in",
"value": {
"out": "Response",
"in": "Request"
},
"label": "VSA in Radius Message",
"field": "radius-message",
"rules": "required|in_list[in,out]",
"type": "dropdown"
}{
"field": "radius_retries",
"label": "Request Retries",
"type": "string",
"default": "3",
"size": 10,
"rules": "required|greater_than[0]|less_than[20]",
"help": "Number of times to retry the RADIUS server in seconds."
}{
"field": "radius_timeout",
"label": "RADIUS Timeout",
"type": "string",
"default": "10",
"size": 10,
"help": "Time to wait for a reply from the RADIUS server",
"rules": "required|greater_than[3]|less_than[180]"
}{
"field": "shared-secret",
"label": "RADIUS Shared Secret",
"type": "string",
"default": "testing123",
"size": 60,
"rules": "required|alpha-dash",
"help": "Encryption password used by the RADIUS Server"
}{
"help": "Radius vendor ID required for VSA. Example: 0 is default, 9 is for Cisco",
"default": "",
"label": "VSA Vendor ID",
"field": "vendor-id",
"rules": "required|greater_than[-1]|less_than[16777215]",
"type": "string",
"size": ""
}{
"help": "VSA ID within this vendor's scope in this vendor specified attribute.",
"default": "",
"label": "VSA ID",
"field": "vsa-id",
"rules": "required|greater_than[-1]|less_than[65535]",
"type": "string",
"size": 10
}{
"help": "The VSA value which is based on the VSA value chosen. If the you chose Direct String Input, the VSA value entered in this text box will be forwarded directly to the Radius server. If you chose Channel Variable, the value inputted in the VSA Value field will be the variable used in the Radius message.",
"default": "",
"label": "VSA Value",
"field": "vsa-value",
"rules": "required|alpha-dash",
"type": "string",
"size": 60
}{
"help": "The VSA value type that will be used in the Radius message.",
"default": "0",
"value": [
"Direct String Input",
"Channel Variable"
],
"label": "VSA Value Type",
"field": "vsa-value-type",
"rules": "required|in_list[0,1]",
"type": "dropdown"
}true
"VSA in Radius Message"
"VSA in RADIUS Message"
"The VSA value type that will be used in the Radius message."
"The VSA value type that will be used in the RADIUS message."
"Vsas"
"VSAs"
"Create a RADIUS Vsas"
"Create a RADIUS VSAs"
"Delete a RADIUS Vsas"
"Delete a RADIUS VSAs"
"Retrieve a RADIUS Vsas"
"Retrieve a RADIUS VSAs"
"Update a RADIUS Vsas"
"Update a RADIUS VSAs"
"Vsas"
"VSAs"
""
[ "The RAID module provides information about RAID status." ]
""
[ "The REST module configures REST API access control and other miscelaneous settings." ]
"FDA4C8684758714994D5BB59A30D6805"
"07CBB770A76FB294CDE2EB946ECA0C89"
""
[ "The Routing module takes care of configuring advanced and basic routing rules." ]
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
{
"field": "action/1/record/name",
"label": "Profile",
"type": "dropdown",
"default": "__selectone__",
"value": {
"__selectone__": "( Please Select One )"
},
"rules": "required[,in,__selectone__]|in_list[__selectone__]",
"style": "width:190px;",
"label_style": "width:60px;",
"composite_style": "display: none;",
"composite_parent": "action/1/type"
}"required[,in,none]|required|in_list[default]"
"required[,in,__selectone__]|in_list[default]"
"action/1/trace_call/name"
"action/1/trace_call/value"
"action/1/record/name"
"action/1/record/value"
"none"
"__none__"
"( Please Select One )"
"(Please Select One)"
"Record"
"Trace Call"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
{
"field": "action/2/record/name",
"label": "Profile",
"type": "dropdown",
"default": "__selectone__",
"value": {
"__selectone__": "( Please Select One )"
},
"rules": "required[,in,__selectone__]|in_list[__selectone__]",
"style": "width:190px;",
"label_style": "width:60px;",
"composite_style": "display: none;",
"composite_parent": "action/2/type"
}"required[,in,none]|required|in_list[default]"
"required[,in,__selectone__]|in_list[default]"
"action/2/trace_call/name"
"action/2/trace_call/value"
"action/2/record/name"
"action/2/record/value"
"none"
"__none__"
"( Please Select One )"
"(Please Select One)"
"Record"
"Trace Call"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
{
"field": "action/3/record/name",
"label": "Profile",
"type": "dropdown",
"default": "__selectone__",
"value": {
"__selectone__": "( Please Select One )"
},
"rules": "required[,in,__selectone__]|in_list[__selectone__]",
"style": "width:190px;",
"label_style": "width:60px;",
"composite_style": "display: none;",
"composite_parent": "action/3/type"
}"required[,in,none]|required|in_list[default]"
"required[,in,__selectone__]|in_list[default]"
"action/3/trace_call/name"
"action/3/trace_call/value"
"action/3/record/name"
"action/3/record/value"
"none"
"__none__"
"( Please Select One )"
"(Please Select One)"
"Record"
"Trace Call"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
{
"field": "action/4/record/name",
"label": "Profile",
"type": "dropdown",
"default": "__selectone__",
"value": {
"__selectone__": "( Please Select One )"
},
"rules": "required[,in,__selectone__]|in_list[__selectone__]",
"style": "width:190px;",
"label_style": "width:60px;",
"composite_style": "display: none;",
"composite_parent": "action/4/type"
}"required[,in,none]|required|in_list[default]"
"required[,in,__selectone__]|in_list[default]"
"action/4/trace_call/name"
"action/4/trace_call/value"
"action/4/record/name"
"action/4/record/value"
"none"
"__none__"
"( Please Select One )"
"(Please Select One)"
"Record"
"Trace Call"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
{
"field": "action/5/record/name",
"label": "Profile",
"type": "dropdown",
"default": "__selectone__",
"value": {
"__selectone__": "( Please Select One )"
},
"rules": "required[,in,__selectone__]|in_list[__selectone__]",
"style": "width:190px;",
"label_style": "width:60px;",
"composite_style": "display: none;",
"composite_parent": "action/5/type"
}"required[,in,none]|required|in_list[default]"
"required[,in,__selectone__]|in_list[default]"
"action/5/trace_call/name"
"action/5/trace_call/value"
"action/5/record/name"
"action/5/record/value"
"none"
"__none__"
"( Please Select One )"
"(Please Select One)"
"Record"
"Trace Call"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
{
"field": "anti-action/1/record/name",
"label": "Profile",
"type": "dropdown",
"default": "__selectone__",
"value": {
"__selectone__": "( Please Select One )"
},
"rules": "required[,in,__selectone__]|in_list[__selectone__]",
"style": "width:190px;",
"label_style": "width:60px;",
"composite_style": "display: none;",
"composite_parent": "anti-action/1/type"
}"required[,in,none]|required|in_list[default]"
"required[,in,__selectone__]|in_list[default]"
"anti-action/1/trace_call/name"
"anti-action/1/trace_call/value"
"anti-action/1/record/name"
"anti-action/1/record/value"
"none"
"__none__"
"( Please Select One )"
"(Please Select One)"
"Record"
"Trace Call"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
{
"field": "anti-action/2/record/name",
"label": "Profile",
"type": "dropdown",
"default": "__selectone__",
"value": {
"__selectone__": "( Please Select One )"
},
"rules": "required[,in,__selectone__]|in_list[__selectone__]",
"style": "width:190px;",
"label_style": "width:60px;",
"composite_style": "display: none;",
"composite_parent": "anti-action/2/type"
}"required[,in,none]|required|in_list[default]"
"required[,in,__selectone__]|in_list[default]"
"anti-action/2/trace_call/name"
"anti-action/2/trace_call/value"
"anti-action/2/record/name"
"anti-action/2/record/value"
"none"
"__none__"
"( Please Select One )"
"(Please Select One)"
"Record"
"Trace Call"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
{
"field": "anti-action/3/record/name",
"label": "Profile",
"type": "dropdown",
"default": "__selectone__",
"value": {
"__selectone__": "( Please Select One )"
},
"rules": "required[,in,__selectone__]|in_list[__selectone__]",
"style": "width:190px;",
"label_style": "width:60px;",
"composite_style": "display: none;",
"composite_parent": "anti-action/3/type"
}"required[,in,none]|required|in_list[default]"
"required[,in,__selectone__]|in_list[default]"
"anti-action/3/trace_call/name"
"anti-action/3/trace_call/value"
"anti-action/3/record/name"
"anti-action/3/record/value"
"none"
"__none__"
"( Please Select One )"
"(Please Select One)"
"Record"
"Trace Call"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
{
"field": "anti-action/4/record/name",
"label": "Profile",
"type": "dropdown",
"default": "__selectone__",
"value": {
"__selectone__": "( Please Select One )"
},
"rules": "required[,in,__selectone__]|in_list[__selectone__]",
"style": "width:190px;",
"label_style": "width:60px;",
"composite_style": "display: none;",
"composite_parent": "anti-action/4/type"
}"required[,in,none]|required|in_list[default]"
"required[,in,__selectone__]|in_list[default]"
"anti-action/4/trace_call/name"
"anti-action/4/trace_call/value"
"anti-action/4/record/name"
"anti-action/4/record/value"
"none"
"__none__"
"( Please Select One )"
"(Please Select One)"
"Record"
"Trace Call"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please select one)"
{
"field": "anti-action/5/record/name",
"label": "Profile",
"type": "dropdown",
"default": "__selectone__",
"value": {
"__selectone__": "( Please Select One )"
},
"rules": "required[,in,__selectone__]|in_list[__selectone__]",
"style": "width:190px;",
"label_style": "width:60px;",
"composite_style": "display: none;",
"composite_parent": "anti-action/5/type"
}"required[,in,none]|required|in_list[default]"
"required[,in,__selectone__]|in_list[default]"
"anti-action/5/trace_call/name"
"anti-action/5/trace_call/value"
"anti-action/5/record/name"
"anti-action/5/record/value"
"none"
"__none__"
"( Please Select One )"
"(Please Select One)"
"Record"
"Trace Call"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please Select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please Select one)"
"none"
"__none__"
"( Please Select One )"
"(Please Select One)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please Select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please Select one)"
"none"
"__none__"
"( Please Select One )"
"(Please Select One)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please Select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please Select one)"
"none"
"__none__"
"( Please Select One )"
"(Please Select One)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please Select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please Select one)"
"none"
"__none__"
"( Please Select One )"
"(Please Select One)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please Select one)"
"none"
"__selectone__"
"required[,in,none]|required|in_list[none]"
"required[,in,__selectone__]|in_list[__selectone__]"
"( Please Select One )"
"(Please Select one)"
"none"
"__none__"
"( Please Select One )"
"(Please Select One)"
""
[ "The RTCP Monitor module allows you to configure settings of the RTCP Monitor service and download RTCP report data." ]
""
[ "The SIP module takes care of the administration of SIP profiles, trunks and channels." ]
"required|in_list[default]"
"required[,in,__selectone__]|in_list[default]"
"none"
"__none__"
"required|in_list[none]"
"required|in_list[__none__]"
"( None )"
"(None)"
"required|in_list[default]"
"required[,in,__selectone__]|in_list[default]"
"none"
"__none__"
"required|in_list[none]"
"required|in_list[__none__]"
"( None )"
"(None)"
"required[enable-load-limit]|max_length[39]|alpha_dash_space"
"required|in_list[default]"
"required[,in,__selectone__]|in_list[default]"
{
"field": "rtp-auto-local-port-renew-on-reinvite",
"label": "Renew RTP Port On ReInvite",
"type": "dropdown",
"default": "false",
"value": {
"true": "Enable",
"false": "Disable"
},
"rules": "required|in_list[true,false]",
"help": [
"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."
]
}"required|required|in_list[eth0]"
"required|in_list[eth0]"
"eth0 - 10.20.1.26"
"eth0 - 10.20.1.35"
"required|integer|greater_than[0]|callback_port_check[sip-port]"
"required|valid_port_number|callback_port_check[sip-port]"
{
"name": "SIPREC",
"description": "",
"object": {
"profile": {
"name": "SIPREC profile",
"base_path": "/NSC/local/software/siprec/profile",
"dynamic": true,
"has_child": false,
"methods": {
"create": {
"name": "Create",
"description": "Create a SIPREC profile",
"request": "POST"
},
"retrieve": {
"name": "Retrieve",
"description": "Retrieve a SIPREC profile",
"request": "GET"
},
"update": {
"name": "Update",
"description": "Update a SIPREC profile",
"request": "POST"
},
"delete": {
"name": "Delete",
"description": "Delete a SIPREC profile",
"request": "POST"
},
"list": {
"name": "List",
"description": [
"List profile."
],
"request": "GET"
}
},
"description": "SIPREC profile",
"configurable": true,
"pagination": false,
"global_methods": false,
"class": {
"type": {
"field": "type",
"label": "Type",
"type": "dropdown",
"default": "failover",
"value": {
"failover": "Failover",
"high-availability": "High Availability"
},
"rules": "required|in_list[failover,high-availability]"
},
"originator_direction": {
"field": "originator_direction",
"label": "Originator Recording Direction",
"type": "dropdown",
"default": "RX",
"value": {
"RX": "RX",
"TX": "TX",
"RXTX_SEPARATE": "Separate",
"RXTX_MIXED": "Mixed"
},
"rules": "required|in_list[RX,TX,RXTX_SEPARATE,RXTX_MIXED]",
"help": "This parameter controls which stream direction should be recorded on the session on which recording have been initiated."
},
"peer_direction": {
"field": "peer_direction",
"label": "Peer Recording Direction",
"type": "dropdown",
"default": "NONE",
"value": {
"NONE": "None",
"RX": "RX",
"TX": "TX",
"RXTX_SEPARATE": "Separate",
"RXTX_MIXED": "Mixed"
},
"rules": "required|in_list[NONE,RX,TX,RXTX_SEPARATE,RXTX_MIXED]",
"help": "This parameter controls which stream direction should be recorded on the peer of session on which recording have been initiated. When set to NONE peer session recording is disabled."
},
"record_on_hold": {
"field": "record_on_hold",
"label": "Record Music On Hold",
"type": "dropdown",
"default": "false",
"value": {
"true": "Enable",
"false": "Disable"
},
"rules": "required|in_list[true,false]",
"help": "When set to Enabled, recording will not be paused when the recorded session goes on-hold."
},
"srs_user": {
"field": "srs_user",
"label": "Recording Server User Part",
"type": "string",
"default": "srs",
"size": 50,
"rules": "required|valid_sip_uri_user_part",
"help": "String representing the sip contact user part to use for the IINVITE messages sent to the srs."
},
"gateways": {
"field": "gateways",
"label": "Gateway List",
"type": "listbox",
"default": [],
"size": 10,
"value": [],
"rules": "is_array|in_list["
}
}
}
}
}""
[ "The SIP Security Monitor module allows you to configure settings for this service." ]
"1) NULL = No account filtering will be perfomed."
"1) Empty = No account filtering will be perfomed."
"1) NULL = No source IP/Network filtering will be performed."
"1) Empty = No source IP/Network filtering will be performed."
"1) NULL = No user agent filtering will be perfomed."
"1) Empty = No user agent filtering will be perfomed."
"1) NULL = No account filtering will be perfomed."
"1) Empty = No account filtering will be perfomed."
"1) NULL = No source IP/Network filtering will be performed."
"1) Empty = No source IP/Network filtering will be performed."
"1) NULL = No user agent filtering will be perfomed."
"1) Empty = No user agent filtering will be perfomed."
""
[ "The Media Server module provides with an interface to discover media server interfaces (DSPs) and configure their settings." ]
"required[enable_media_interface]|required[,in,__empty__]"
"required[enable_media_interface]|required[,in,__empty__]|in_list[eth0]"
"14000"
"10000"
"required|is_numeric"
"required|valid_port_number|greater_or_equal[5004]"
"17999"
"20000"
"required[individual-ip]|is_numeric"
"valid_port_number"
""
[ "The SNMP module configure settings for the SNMP service such as version, transport, IP information etc." ]
{
"field": "interface",
"label": "Network Interface",
"type": "dropdown",
"default": "all",
"value": {
"all": "All interfaces",
"eth0": "eth0 - 10.20.1.35"
},
"rules": "required|in_list[all,eth0]",
"help": "Select interface that SNMP listens on.",
"category_setting": "expanded",
"category": "Network Configuration"
}{
"category": "Network Configuration",
"help": "Select interface that snmpd listens on.",
"default": "all",
"value": {
"all": "All interfaces",
"10.20.1.26": "eth0 - 10.20.1.26"
},
"label": "Network Interface",
"field": "ip",
"rules": "required|in_list[all,10.20.1.26]",
"category_setting": "expanded",
"type": "dropdown"
}"roview"
"ro"
""
[ "The SSH module takes care of configuring the SSH service." ]
"Select interface that sshd listens on."
"Select interface that secure shell listens on."
"eth0 - 10.20.1.26"
"eth0 - 10.20.1.35"
"Port number that sshd listens on."
"Port number that secure shell listens on."
""
[ "The System module configures miscelaneous system-wide configuration settings such as creating and removing users." ]
{
"name": "OS",
"dynamic": true,
"base_path": false,
"singleton": true,
"readonly": true,
"configurable": false,
"methods": {
"status": {
"name": "Status",
"description": "Status",
"request": "GET"
}
},
"description": "OS",
"pagination": false,
"global_methods": false
}{
"name": "Service",
"dynamic": true,
"base_path": false,
"singleton": true,
"readonly": true,
"methods": {
"status": {
"name": "Status",
"description": "Status",
"request": "GET"
}
},
"description": "Service",
"configurable": true,
"pagination": false,
"global_methods": false
}"default@mtl-iso64-test.sangoma.local"
"root@mtl-xteam-deploy-NSC-2-2-dev"
""
[ "The Update module allows you to update the SBC operating system software." ]
{
"object": {
"configuration": {
"singleton": true,
"description": "Configuration",
"dynamic": false,
"pagination": false,
"base_path": "/NSC/local/software/watchdog/configuration",
"configurable": true,
"methods": {
"retrieve": {
"request": "GET",
"name": "Retrieve"
},
"update": {
"request": "POST",
"name": "Update"
}
},
"global_methods": false,
"class": {
"max-load-1": {
"category": "Load Average",
"help": "Port number that snmpd listens on.",
"default": "0",
"label": "Max (1 min)",
"field": "max-load-1",
"rules": "integer|greater_than[2]|less_than[100]",
"category_setting": "expanded",
"type": "text",
"size": 10
},
"max-temperature": {
"category": "Temperature",
"help": "Port number that snmpd listens on.",
"default": "0",
"label": "Max",
"field": "max-temperature",
"rules": "integer|greater_than[2]|less_than[100]",
"category_setting": "expanded",
"type": "text",
"size": 10
},
"max-load-15": {
"help": "Port number that snmpd listens on.",
"default": "0",
"label": "Max (15 min)",
"field": "max-load-15",
"rules": "integer|greater_than[2]|less_than[100]",
"type": "text",
"size": 10
},
"min-memory": {
"category": "Memory",
"help": "Port number that snmpd listens on.",
"default": "0",
"label": "Min Free",
"field": "min-memory",
"rules": "integer|greater_than[2]|less_than[100]",
"category_setting": "expanded",
"type": "text",
"size": 10
},
"max-load-5": {
"help": "Port number that snmpd listens on.",
"default": "0",
"label": "Max (5 min)",
"field": "max-load-5",
"rules": "integer|greater_than[2]|less_than[100]",
"type": "text",
"size": 10
}
},
"name": "Configuration"
}
},
"name": "Watchdog",
"description": ""
}""
[ "The Web Server module allows you to configure miscelaneous preferences for the web server serving the SBC web gui and REST API calls." ]
"Select Interface that httpd listens on."
"Select interface that web server listens on."
"eth0 - 10.20.1.26"
"eth0 - 10.20.1.35"