Metadata list | ||
---|---|---|
| ||
||Product on coverpage|SBC Core|
||Product Release|10.x|
||Document Title|REST API Reference Guide - system|
||Document Number|550-xxxx|
||Document Revision|01.01|
||Filename|system_01| |
|
Parameter | Presence | Type | Default | Description | |
---|---|---|---|---|---|
![]() | isOAM | O | boolean | false | This indicates if the system is the OAM VM used to manage the VNF. |
![]() | configMode | O | enumeration | sbc | This field indicates the configuration mode on cloud |
![]() | isVNFM | O | boolean | false | This field indicates vnfm/non-vnfm mode. |
![]() | activeConfigFile | O | string | Contains the file name of the last retrieved file from the external object store service. | |
![]() | activeRevision | O | int16 | Active Configuration Revision | |
![]() | licenseMode | O | The licensing mode for the application | ||
![]() | outOfMemoryCoredump | O | |||
![]() |
...
faultAvalancheControl | O | System wide settings associated fault Avalanche Detection and Control feature. | |||
![]() | protect | O | Configuration related to Protect server. | ||
![]() | admin | M | Basic configuration (name, location, etc) for the system. | ||
![]() | serverAdmin | O | The serverAdmin table describes the configuration of each server module. A server module can be a standalone server or a server card in a chassis based system. | ||
![]() | daughterBoardAdmin | O | The daughter board admin table describes the configuration of each daughter board. | ||
![]() | licenseRequired | O | The licenses needed by this application | ||
![]() |
...
...
Provides the list entries not to be blocked by application. Application won't block calls matching to these key/value pairs. | ||
![]() |
...
...
Announcement file status and statistics | |||||
![]() | mediaProfile | O | DSP Media Profile configuration | ||
![]() | dspPad | O | DSP PAD configuration - service must be restarted for new config to take effect | ||
![]() |
...
...
Status of DSP resources. | ||
![]() |
...
transcodeInfo | O | Status of |
...
transcode resources. |
![]() |
...
...
The MIB Module for IP Monitoring. | |||||
![]() | highAvailabilityPort | M | Configuration and status for the HA ethernet ports. | ||
![]() | intervalStatistics | O | The system-wide settings for interval statistics. | ||
![]() | fileStatisticsAdmin | O | Admin data of file Statistics. | ||
![]() | media | O | System-wide media configurations, udp port range and rtp/rtcp peer inactivity timeout. | ||
![]() | policyServer | O | Configures softswitch servers and client services | ||
![]() |
...
networkProcessorStatistics | O | Network Processor statistics | |||
![]() | loadBalancingService | O | Load Balancing Service configuration | ||
![]() | slb | O | SLB specific configuration | ||
![]() | clusterAdmin | O | Cluster specific configuration | ||
![]() | realm | O | The realm of this IP network. | ||
![]() | h248Statistics | O | The details statistics for H248. | ||
![]() | virtualMediaGateway | O | The Virtual Media Gateway. | ||
![]() | pathCheckPath | O | Path for ICMP ping mechanism | ||
![]() | dsbc | O | Configures Distributed SBC | ||
![]() | ems | O | EMS specific configuration | ||
![]() | sweActiveProfile | O | Specifies the profile name that is activated in the system. | ||
![]() | sweConfigProfileSelection | O | This table displays the configuration provisioning profile names. | ||
![]() | sweTrafficProfiles | O | This table stores different traffic profiles. Each profile is essentially a statement of the call mix presented to the SWe. | ||
![]() | sweCodecMixProfile | O | This table describes the codec mix used for a given profile. | ||
![]() | serviceDiscovery | O | Service Discovery specific configuration | ||
![]() | ntp | M | NTP Services Management. | ||
![]() | metaVariableDynamic | O | Meta variable name and value pair table configurable by the user | ||
![]() | security | O | The MIB Module for Security Management. | ||
![]() | mgmtIpInterfaceGroup | O | A group of management IP interfaces for the default address context. | ||
![]() | mgmtStaticRoute | O | Static IP routes for this address context. | ||
![]() | logicalMgmtIpInterface | O | The logical management IP interface. | ||
![]() | ethernetPort | M | Configuration for management, packet, and field-service ethernet ports. |
...
...
![]() | dspRes | O | DSP historical interval statistics | ||
![]() | congestion | M | System congestion profile for the node. |
Parameter | Description | |
---|---|---|
![]() | configurator | This indicates if the system is the configurator |
![]() | licenseStatus | The CE license status table describes the state of license information. |
![]() | softwareUpgradeStatus | Live software upgrade status at any given time. |
![]() | fileStatisticsStatus | The current ID of the last performance statistics written to the database |
![]() | sbcPersonalityStatus | Personality of this instance |
![]() | objectStoreParameters | Parameters used to specify an object store service to upload or download a configuration file. |
![]() | niceLicense | Contains whether Nice recording is allowed or not. |
![]() | pdcsLicense | Contains whether PDCS license is allowed or not. |
![]() | sbcliLicense | Contains whether SBC-LI license is allowed or not. |
![]() | hardDiskStatus | Hard disk status on the server(s). |
![]() | hardDiskUsage | Hard disk status on the server(s). |
![]() | fanStatus | Fan status on the server(s). |
![]() | powerSupplyStatus | Power consumption/state of the server. |
![]() | syncStatus | The system server synchronization status table, describes data synchronization state of various items. |
![]() | standbySyncStatus | The standby server synchronization status table. This table is used for N:1 redundancy where a standby server support N active servers. It describes data synchronization state of various items. |
![]() | ledStatus | Displays status of various LEDs of the server. |
![]() | serverStatus | The system server status table describes the status of the server module. |
![]() | daughterBoard3Status | Indicates the daughter board status on the server. |
![]() | serverSoftwareUpgradeStatus | The system server software upgrade status table describes the status of the server software upgrade module. |
![]() | softwareUpgradeDetailedStatus | The system software upgrade detailed status table describes the detailed status of the software upgrade module. |
![]() |
...
licenseFeatureStatus | Status information about each licensed feature |
![]() |
...
licenseNodeLockedBundleInfo | Shows information about all the |
...
nodeLocked licenses stored on the box |
![]() |
...
licenseDomainBundleInfo | Shows information about all the |
...
domain licenses stored on the box | ||
![]() | licenseInfo | The license status for registered license features. |
![]() | baseMacAddress | Displays base MAC address of servers |
![]() | cpuUtilCurrentStatistics | The CPU utilization for the current interval period. |
![]() | cpuUtilIntervalStatistics | The CPU utilization for the 'n' number of intervals. |
![]() | memoryUtilCurrentStatistics | The memory utilization for the current interval period. |
![]() | memoryUtilIntervalStatistics | The memory utilization for the 'n' number of intervals. |
![]() | coredumpList | List of coredumps on the server(s). |
![]() | coredumpSummary | Summary of coredump files on server(s). |
![]() | savedConfigList | List of configurations saved on the system. |
![]() | bfdSessionStats | BFD session status |
![]() | fipsFSM2State | FIPS finite state machine state. |
![]() | dodModeStatus | DoD mode status |
![]() | macAddress2Status | Displays status of MAC address of servers |
![]() |
...
gpuStatus | Displays Information of GPUs present in server |
...
![]() | haConfig | Displays the HA port redundancy configuration. |
![]() | rgStatus | The system Redundancy Group(RG) status table describes the status of the instances in RG. |
![]() | gpuTranscodeStatus | Current GPU transcode status. |
![]() | cpuTranscodeStatus | Current CPU transcode status. |
![]() | adSyncStatus | Displays AD server sync status. |
![]() | databaseIntegrity | Displays data integrity of databases. |
![]() | sweProcessorCoreCapacity | This table displays the processor's capacity indices on which SWe is currently running. |
![]() | sweCapacityEstimation | This table stores the populated SWe capacity for different custom traffic profiles created. |
![]() | metaVariable | Dynamic Meta variable name and value pair table in Cloud SBC configuration management. |
![]() | logicalMgmtIpInterfaceStatus | The status of the logical IP interface |
...
. | ||
![]() | systemCongestionStatus | System Congestion Status Table |
![]() | systemCongestionCurrentStatistics | The Sonus System Congestion Current Statistics table. |
![]() | systemCongestionIntervalStatistics | The Sonus System Congestion Interval Statistics table. |
REST API: GET Example |
---|
curl -kisu 'admin:secret' -X GET https://{SBX-SERVER}/api/config/system |