Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Resources | system


Image Modifiedsystem

System-level configuration.


Configuration


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

SSO related configuration.
Image Modified
licenseModeO

The licensing mode for the application
Image Modified
licenseManagerO

System-level License Manager Configuration.
Image Modified
outOfMemoryCoredumpO


Image Modified
faultAvalancheControlO

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

Configuration related to Protect server.
Image Modified
adminM

Basic configuration (name, location, etc) for the system.
Image Modified
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.
Image Modified
daughterBoardAdminO

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

The licenses needed by this application
Image Modified
facNonBlockingEntriesO

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

EMS specific configuration
Image Modified
sweActiveProfileO

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

This table displays the configuration provisioning profile names.
Image Modified
sweTrafficProfilesO

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

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

Service Discovery specific configuration
Image Modified
ipPolicingO

The MIB Module for IP Monitoring.
Image Modified
mediaProfileO

DSP Media Profile configuration
Image Modified
dspPadO

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

Announcement file status and statistics
Image Modified
dspStatusO

Status of DSP resources.
Image Modified
transcodeInfoO

Status of transcode resources.
Image Modified
mediaO

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

Configuration and status for the HA ethernet ports.
Image Modified
intervalStatisticsO

The system-wide settings for interval statistics.
Image Modified
fileStatisticsAdminO

Admin data of file Statistics.
Image Modified
policyServerO

Configures softswitch servers and client services
Image Modified
dsbcO

Configures Distributed SBC
Image Modified
networkProcessorStatisticsO

Network Processor statistics
Image Modified
loadBalancingServiceO

Load Balancing Service configuration
Image Modified
slbO

SLB specific configuration
Image Modified
dbmO

This defines communication interface for data traffic
Image Modified
clusterAdminO

Cluster specific configuration
Image Modified
networkSegmentTableO

Network Segment Table for the system.
Image Modified
realmO

The realm of this IP network.
Image Modified
pathCheckPathO

Path for ICMP ping mechanism
Image Modified
h248StatisticsO

The details statistics for H248.
Image Modified
virtualMediaGatewayO

The Virtual Media Gateway.
Image Modified
ntpM

NTP Services Management.
Image Modified
metaVariableDynamicO

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

The MIB Module for Security Management.
Image Modified
mgmtIpInterfaceGroupO

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

Static IP routes for this address context.
Image Modified
logicalMgmtIpInterfaceO

The logical management IP interface.
Image Modified
ethernetPortM

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

DSP historical interval statistics
Image Modified
congestionM

System congestion profile for the node.

Operational Data


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


RESTCONF API: GET Example

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