Resources | system


system

System-level configuration.


Configuration


ParameterPresenceTypeDefaultDescription
isOAMObooleanfalseThis indicates if the system is the OAM VM used to manage the VNF.
configModeOenumerationsbcThis field indicates the configuration mode on cloud
isVNFMObooleanfalseThis field indicates vnfm/non-vnfm mode.
activeConfigFileOstring
Contains the file name of the last retrieved file from the external object store service.
activeRevisionOint16
Active Configuration Revision
emergencyAndHpcCapacityReservationOint320Specifies percentage of calls to be reserved for emegency/HPC calls
ssoAuthO

SSO related configuration.
licenseModeO

The licensing mode for the application
licenseManagerO

System-level License Manager Configuration.
outOfMemoryCoredumpO


faultAvalancheControlO

System wide settings associated fault Avalanche Detection and Control feature.
protectO

Configuration related to Protect server.
adminM

Basic configuration (name, location, etc) for the system.
serverAdminO

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.
daughterBoardAdminO

The daughter board admin table describes the configuration of each daughter board.
licenseRequiredO

The licenses needed by this application
facNonBlockingEntriesO

Provides the list entries not to be blocked by application. Application won't block calls matching to these key/value pairs.
emsO

EMS specific configuration
sweActiveProfileO

Specifies the profile name that is activated in the system.
sweConfigProfileSelectionO

This table displays the configuration provisioning profile names.
sweTrafficProfilesO

This table stores different traffic profiles. Each profile is essentially a statement of the call mix presented to the SWe.
sweCodecMixProfileO

This table describes the codec mix used for a given profile.
serviceDiscoveryO

Service Discovery specific configuration
ipPolicingO

The MIB Module for IP Monitoring.
mediaProfileO

DSP Media Profile configuration
dspPadO

DSP PAD configuration - service must be restarted for new config to take effect
announcementsO

Announcement file status and statistics
dspStatusO

Status of DSP resources.
transcodeInfoO

Status of transcode resources.
mediaO

System-wide media configurations, udp port range and rtp/rtcp peer inactivity timeout.
highAvailabilityPortM

Configuration and status for the HA ethernet ports.
intervalStatisticsO

The system-wide settings for interval statistics.
fileStatisticsAdminO

Admin data of file Statistics.
policyServerO

Configures softswitch servers and client services
dsbcO

Configures Distributed SBC
networkProcessorStatisticsO

Network Processor statistics
loadBalancingServiceO

Load Balancing Service configuration
slbO

SLB specific configuration
dbmO

This defines communication interface for data traffic
clusterAdminO

Cluster specific configuration
networkSegmentTableO

Network Segment Table for the system.
realmO

The realm of this IP network.
pathCheckPathO

Path for ICMP ping mechanism
h248StatisticsO

The details statistics for H248.
virtualMediaGatewayO

The Virtual Media Gateway.
ntpM

NTP Services Management.
metaVariableDynamicO

Meta variable name and value pair table configurable by the user
securityO

The MIB Module for Security Management.
mgmtIpInterfaceGroupO

A group of management IP interfaces for the default address context.
mgmtStaticRouteO

Static IP routes for this address context.
logicalMgmtIpInterfaceO

The logical management IP interface.
ethernetPortM

Configuration for management, packet, and field-service ethernet ports.
dspResO

DSP historical interval statistics
congestionM

System congestion profile for the node.

Operational Data


ParameterDescription
configuratorThis indicates if the system is the configurator
licenseStatusThe CE license status table describes the state of license information.
softwareUpgradeStatusLive software upgrade status at any given time.
fileStatisticsStatusThe current ID of the last performance statistics written to the database
sbcPersonalityStatusPersonality of this instance
objectStoreParametersParameters used to specify an object store service to upload or download a configuration file.
niceLicenseContains whether Nice recording is allowed or not.
pdcsLicenseContains whether PDCS license is allowed or not.
sbcliLicenseContains whether SBC-LI license is allowed or not.
hardDiskStatusHard disk status on the server(s).
hardDiskUsageHard disk status on the server(s).
fanStatusFan status on the server(s).
powerSupplyStatusPower consumption/state of the server.
syncStatusThe system server synchronization status table, describes data synchronization state of various items.
standbySyncStatusThe 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.
ledStatusDisplays status of various LEDs of the server.
serverStatusThe system server status table describes the status of the server module.
daughterBoard3StatusIndicates the daughter board status on the server.
serverSoftwareUpgradeStatusThe system server software upgrade status table describes the status of the server software upgrade module.
softwareUpgradeDetailedStatusThe system software upgrade detailed status table describes the detailed status of the software upgrade module.
licenseFeatureStatusStatus information about each licensed feature
licenseNodeLockedBundleInfoShows information about all the nodeLocked licenses stored on the box
licenseDomainBundleInfoShows information about all the domain licenses stored on the box
licenseInfoThe license status for registered license features.
baseMacAddressDisplays base MAC address of servers
cpuUtilCurrentStatisticsThe CPU utilization for the current interval period.
cpuUtilIntervalStatisticsThe CPU utilization for the 'n' number of intervals.
memoryUtilCurrentStatisticsThe memory utilization for the current interval period.
memoryUtilIntervalStatisticsThe memory utilization for the 'n' number of intervals.
coredumpListList of coredumps on the server(s).
coredumpSummarySummary of coredump files on server(s).
savedConfigListList of configurations saved on the system.
bfdSessionStatsBFD session status
fipsFSM2StateFIPS finite state machine state.
dodModeStatusDoD mode status
macAddress2StatusDisplays status of MAC address of servers
gpuStatusDisplays Information of GPUs present in server
haConfigDisplays the HA port redundancy configuration.
rgStatusThe system Redundancy Group(RG) status table describes the status of the instances in RG.
cnfCpuUtilIntervalStatisticsThe CPU utilization for the 'n' number of intervals.
cnfMemoryUtilIntervalStatisticsThe memory utilization for the 'n' number of intervals.
sweProcessorCoreCapacityThis table displays the processor's capacity indices on which SWe is currently running.
sweCapacityEstimationThis table stores the populated SWe capacity for different custom traffic profiles created.
gpuTranscodeStatusCurrent GPU transcode status.
cpuTranscodeStatusCPU channels in use for GPU based codecs.
adSyncStatusDisplays AD server sync status.
databaseIntegrityDisplays data integrity of databases.
metaVariableDynamic Meta variable name and value pair table in Cloud SBC configuration management.
logicalMgmtIpInterfaceStatusThe status of the logical IP interface.
systemCongestionStatusSystem Congestion Status Table
systemCongestionCurrentStatisticsThe Ribbon System Congestion Current Statistics table.
systemCongestionIntervalStatisticsThe Ribbon System Congestion Interval Statistics table.
RESTCONF API: GET Example

curl -kisu 'admin:secret' -X GET https://{SBX-SERVER}/restconf/data/sonusSystem:system