Metadata list

hidden	true

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

Image Modifiedsystem

System-level configuration.

Configuration

	Parameter	Presence	Type	Default	Description
Image Modified	isOAM	O	boolean	false	This indicates if the system is the OAM VM used to manage the VNF.
Image Modified	configMode	O	enumeration	sbc	This field indicates the configuration mode on cloud
Image Modified	isVNFM	O	boolean	false	This field indicates vnfm/non-vnfm mode.
Image Modified	activeConfigFile	O	string		Contains the file name of the last retrieved file from the external object store service.
Image Modified	activeRevision	O	int16		Active Configuration Revision
Image Modified	licenseMode	O			The licensing mode for the application
Image Modified	outOfMemoryCoredump	O
Image Modified	faultAvalancheControl	O			System wide settings associated fault Avalanche Detection and Control feature.
Image Modified	protect	O			Configuration related to Protect server.
Image Modified	admin	M			Basic configuration (name, location, etc) for the system.
Image Modified	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.
Image Modified	daughterBoardAdmin	O			The daughter board admin table describes the configuration of each daughter board.
Image Modified	licenseRequired	O			The licenses needed by this application
Image Modified	facNonBlockingEntries	O			Provides the list entries not to be blocked by application. Application won't block calls matching to these key/value pairs.
Image Modified	announcements	O			Announcement file status and statistics
Image Modified	mediaProfile	O			DSP Media Profile configuration
Image Modified	dspPad	O			DSP PAD configuration - service must be restarted for new config to take effect
Image Modified	dspStatus	O			Status of DSP resources.
Image Modified	transcodeInfo	O			Status of transcode resources.
Image Modified	ipPolicing	O			The MIB Module for IP Monitoring.
Image Modified	highAvailabilityPort	M			Configuration and status for the HA ethernet ports.
Image Modified	intervalStatistics	O			The system-wide settings for interval statistics.
Image Modified	fileStatisticsAdmin	O			Admin data of file Statistics.
Image Modified	media	O			System-wide media configurations, udp port range and rtp/rtcp peer inactivity timeout.
Image Modified	policyServer	O			Configures softswitch servers and client services
Image Modified	networkProcessorStatistics	O			Network Processor statistics
Image Modified	loadBalancingService	O			Load Balancing Service configuration
Image Modified	slb	O			SLB specific configuration
Image Modified	clusterAdmin	O			Cluster specific configuration
Image Modified	realm	O			The realm of this IP network.
Image Modified	h248Statistics	O			The details statistics for H248.
Image Modified	virtualMediaGateway	O			The Virtual Media Gateway.
Image Modified	pathCheckPath	O			Path for ICMP ping mechanism
Image Modified	dsbc	O			Configures Distributed SBC
Image Modified	ems	O			EMS specific configuration
Image Modified	sweActiveProfile	O			Specifies the profile name that is activated in the system.
Image Modified	sweConfigProfileSelection	O			This table displays the configuration provisioning profile names.
Image Modified	sweTrafficProfiles	O			This table stores different traffic profiles. Each profile is essentially a statement of the call mix presented to the SWe.
Image Modified	sweCodecMixProfile	O			This table describes the codec mix used for a given profile.
Image Modified	serviceDiscovery	O			Service Discovery specific configuration
Image Modified	ntp	M			NTP Services Management.
Image Modified	metaVariableDynamic	O			Meta variable name and value pair table configurable by the user
Image Modified	security	O			The MIB Module for Security Management.
Image Modified	mgmtIpInterfaceGroup	O			A group of management IP interfaces for the default address context.
Image Modified	mgmtStaticRoute	O			Static IP routes for this address context.
Image Modified	logicalMgmtIpInterface	O			The logical management IP interface.
Image Modified	ethernetPort	M			Configuration for management, packet, and field-service ethernet ports.
Image Modified	dspRes	O			DSP historical interval statistics
Image Modified	congestion	M			System congestion profile for the node.

Operational Data

	Parameter	Description
Image Modified	configurator	This indicates if the system is the configurator
Image Modified	licenseStatus	The CE license status table describes the state of license information.
Image Modified	softwareUpgradeStatus	Live software upgrade status at any given time.
Image Modified	fileStatisticsStatus	The current ID of the last performance statistics written to the database
Image Modified	sbcPersonalityStatus	Personality of this instance
Image Modified	objectStoreParameters	Parameters used to specify an object store service to upload or download a configuration file.
Image Modified	niceLicense	Contains whether Nice recording is allowed or not.
Image Modified	pdcsLicense	Contains whether PDCS license is allowed or not.
Image Modified	sbcliLicense	Contains whether SBC-LI license is allowed or not.
Image Modified	hardDiskStatus	Hard disk status on the server(s).
Image Modified	hardDiskUsage	Hard disk status on the server(s).
Image Modified	fanStatus	Fan status on the server(s).
Image Modified	powerSupplyStatus	Power consumption/state of the server.
Image Modified	syncStatus	The system server synchronization status table, describes data synchronization state of various items.
Image Modified	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.
Image Modified	ledStatus	Displays status of various LEDs of the server.
Image Modified	serverStatus	The system server status table describes the status of the server module.
Image Modified	daughterBoard3Status	Indicates the daughter board status on the server.
Image Modified	serverSoftwareUpgradeStatus	The system server software upgrade status table describes the status of the server software upgrade module.
Image Modified	softwareUpgradeDetailedStatus	The system software upgrade detailed status table describes the detailed status of the software upgrade module.
Image Modified	licenseFeatureStatus	Status information about each licensed feature
Image Modified	licenseNodeLockedBundleInfo	Shows information about all the nodeLocked licenses stored on the box
Image Modified	licenseDomainBundleInfo	Shows information about all the domain licenses stored on the box
Image Modified	licenseInfo	The license status for registered license features.
Image Modified	baseMacAddress	Displays base MAC address of servers
Image Modified	cpuUtilCurrentStatistics	The CPU utilization for the current interval period.
Image Modified	cpuUtilIntervalStatistics	The CPU utilization for the 'n' number of intervals.
Image Modified	memoryUtilCurrentStatistics	The memory utilization for the current interval period.
Image Modified	memoryUtilIntervalStatistics	The memory utilization for the 'n' number of intervals.
Image Modified	coredumpList	List of coredumps on the server(s).
Image Modified	coredumpSummary	Summary of coredump files on server(s).
Image Modified	savedConfigList	List of configurations saved on the system.
Image Modified	bfdSessionStats	BFD session status
Image Modified	fipsFSM2State	FIPS finite state machine state.
Image Modified	dodModeStatus	DoD mode status
Image Modified	macAddress2Status	Displays status of MAC address of servers
Image Modified	gpuStatus	Displays Information of GPUs present in server
Image Modified	haConfig	Displays the HA port redundancy configuration.
Image Modified	rgStatus	The system Redundancy Group(RG) status table describes the status of the instances in RG.
Image Modified	gpuTranscodeStatus	Current GPU transcode status.
Image Modified	cpuTranscodeStatus	Current CPU transcode status.
Image Modified	adSyncStatus	Displays AD server sync status.
Image Modified	databaseIntegrity	Displays data integrity of databases.
Image Modified	sweProcessorCoreCapacity	This table displays the processor's capacity indices on which SWe is currently running.
Image Modified	sweCapacityEstimation	This table stores the populated SWe capacity for different custom traffic profiles created.
Image Modified	metaVariable	Dynamic Meta variable name and value pair table in Cloud SBC configuration management.
Image Modified	logicalMgmtIpInterfaceStatus	The status of the logical IP interface.
Image Modified	systemCongestionStatus	System Congestion Status Table
Image Modified	systemCongestionCurrentStatistics	The Sonus System Congestion Current Statistics table.
Image Modified	systemCongestionIntervalStatistics	The Sonus System Congestion Interval Statistics table.

REST API: GET Example
curl -kisu 'admin:secret' -X GET https://{SBX-SERVER}/api/config/system

Space shortcuts

Page tree

Versions Compared

Old Version 9

New Version Current

Key

Image Modifiedsystem

Configuration

Operational Data

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 9

New Version Current

Key

Image Modifiedsystem

Configuration

Operational Data