Note

Network-wide licensing using a site license server (SLS) has been discontinued and is no longer available on SBC 8.0 or later releases.

In this section:

 

Common Call Statistics Terminology
Stable CallsCalls that are established and fully stable (connected and media cut-through type of calls) and will survive a fail-over. This excludes calls in establishing, clearing and updating states which will not survive a fail-over.
Active CallsA snapshot of total number of active calls on the SBC at the point of execution of the status command. This count reflects the actual live calls on the box independent of the state of the call (setup, stable, updating or clearing).
Call AttemptsAccumulative number of attempted calls on this system since the last reboot/start-up, including calls where a setup was sent/received, uncompleted calls (calls failed, busy, not answered, etc.) and calls completed (answered).
Call CompletionsAccumulative number of calls completed on this system since the last reboot/start-up.

The SBC allows the operator to access data from the current interval and from the interval statistics table related to each object being monitored. The current interval consists of a statistics table entry that is accumulating data for the next interval report. The interval statistics table is a series of statistics table entries containing data from the most recently completed n intervals (where n is the number of intervals in the retention policy configuration).

Note
Refer to Links to Statistics Pages to navigate to a particular EMA or CLI statistics page.

System

Command Syntax

Below is a high-level view of the command syntax for 'show status system' command.

> show status system
	activeFileConfig
    activeRevision
	admin
	announcements
    adSyncStatus
    baseMacAddress
    configMode
	coredumpList
	coredumpSummary
	cpuUtilCurrentStatistics
	cpuUtilIntervalStatistics
	databaseIntegrity
	daughterBoardStatus
	dodModeStatus
	dsbc
	dspRes
	dspStatus
	ethernetPort
	faultAvalancheControl
    fanStatus
	fileStatisticsStatus
	fipsFSMState
	haConfig
	hardDiskStatus
	hardDiskUsage
	highAvailabilityPort
	ipPolicing
    isOAM
	jsrcServer
	ledStatus
    licenseDomainBundleInfo
	licenseInfo
	licenseNodeLockedBundleInfo
	licenseStatus
	loadBalancingService
	logicalMgmtIpInterfaceStatus
	macAddressStatus
	mediaProfile
	memoryUtilCurrentStatistics
	memoryUtilIntervalStatistics
	metaVariable
	mgmtIpInterfaceGroup
	networkProcessorStatistics
    niceLicense
	ntp
	objectStoreParameters
    pdcsLicense
	policyServer
	powerSupplyStatus
	savedConfigList
    sbcliLicense
	sbcPersonalityStatus
	security
	serverAdmin
	serverSoftwareUpgradeStatus
	serverStatus
	softwareUpgradeDetailedStatus
	softwareUpgradeStatus
	standbySyncStatus
	syncStatus
	systemCongestionCurrentStatistics
	systemCongestionIntervalStatistics
	systemCongestionStatus
    

Command Parameters

Note
show table system
command:

clusterAdmin, congestion, daughterBoardAdmin, dspPad, fileStatisticsAdmin, fipsBypassMode, intervalStatistics, licenseRequired, logicalMgmtIpInterface, media, metaVariableDynamic, mgmtStaticRoute, pathCheckPath

 

Shared Common Parameters - 'show status system' and 'show table system'

Parameter

Description

activeConfigFileDisplays the file name of the last retrieved file from the external object store service.
activeRevisionNumeric identifier for the configuration revision that is currently active(SBC SWe Cloud deployments only) The revision number is incremented when executing the saveAndActivate action or restoring a cluster configuration. If replication of the configuration to the nodes within the cluster fails, the revision number appears as -1. Refer to Request System - CLI and Restoring a Cluster Configuration.

admin

Basic configuration (name, location, etc) for the system. See Admin Attributes table below for details.

announcements

Announcement file status and statistics. See Announcements Attributes table below for details.

baseMacAddress

Displays base MAC address of servers.

  • activeBaseAddress – The base MAC address assigned to the active server.
  • assignedBaseAddress – The base MAC address assigned to this server.
clusterAdmin

Displays cluster-specific configuration details.

  • mgmtInterfaceGroup – The Management Interface Group used for intra-cluster communication
  • mgmtIpAddress – The management IP address used for intra-cluster communication
  • type – The interface type used during intra-cluster communication
configMode

Indicates the configuration mode for the node.

  • oam - an OAM node in a cluster that uses the OAM configuration type.
  • managed-vm - a node, managed by an OAM node, in a cluster that uses the OAM configuration type.
  • direct-single - a node in a cluster that uses the Direct Single configuration type.
  • sbc - a non-clustered node such as a hardware-based SBC.

congestion

System congestion profile for the node.

  • adaptive – adaptive overload configuration.
  • levelMC1 – Configuration for congestion level MC1.
  • levelMC2 – Configuration for congestion level MC2.
  • levelMC3 – Configuration for congestion level MC3.
  • mode – Mode (static or adaptive) of the system overload control.
  • policer – System congestion Call Rate Policer configuration.

coredumpList

List of core dumps on the server(s). Fields include:

  • coredumpFileName
  • size
  • dateAndTime
  • newSinceLastStart (true/false)

coredumpSummary

Summary of core dump files on server(s).

  • <server name> – The name of the server.
  • coredumpAndTraceCount – Number of coredumps and trace files.
  • totalSize – Indicates the total size of the coredumps (KBytes).
cpuTranscodeStatus

(Available only on SWe except S-SBC SWe)

<system name> – The SBC system name.

  • amrNbTotal – Total AMR–NB resource capacity on this server.

  • amrNbUtilization – Percentage utilization of AMR–NB resources on this server.

  • amrWbTotal – Total AMR–WB resource capacity on this server.

  • amrWbUtilization – Percentage utilization of AMR–WB resources on this server.
  • compressionAllocFailures – Running count of resource allocation failures due to resource exhaustion.
  • compressionAvailable – Actual compression resources currently available in real time. This essentially equates to the total number of G.711 resources after loading.
  • compressionTotal  Maximum number of compression resources on the server (i.e. before loading, so this number is static). This essentially equates to the total number of G.711 resources before loading (i.e. lightest codec).
  • compressionUtilization – Percentage of compression resources in use (accounting for various codec weights). This can be calculated using the formula (compressionTotal – compressionAvailable) / compressionTotal.
    NOTE: Use this value when determining the extent of DSP module load (regardless of codec type).

  • ecmTotal – Total T.38 ECM resource capacity on this server.
  • ecmUtilization – Percentage utilization of T.38 ECM resources on this server.
  • ecmV34Total – Total T.38 ECM V.34 resource capacity on this server.
  • ecmV34Utilization – Percentage utilization of T.38 ECM V.34 resources on this server.
  • efrTotal – Total EFR resource capacity on this server.
  • efrUtilization – Percentage utilization of EFR resources on this server.
  • evrc0Total – Total EVRC0 resource capacity on this server.
  • evrc0Utilization – Percentage utilization of EVRC0 resources on this server.
  • evrcb0Total – Total EVRCB0 resource capacity on this server.
  • evrcb0Utilization – Percentage utilization of EVRCB0 resources on this server.
  • g711SsTotal – Total G711SS (silence suppression) resource capacity on this server.
  • g711SsUtilization – Percentage utilization of G711SS (silence suppression) resources on this server.

  • g711Total – Total G711 resource capacity on this server.
  • g711Utilization – Percentage utilization of G711 resources on this server.
    NOTE: The g711Utilization includes g711 channels in use plus channels that are reserved but not activated as part of the call set up process.  In this case, ensure to reserve enough resources to account for the worst case codec. For example, in release 4.2.x, a reserved channel is about 4.5 times as expensive as a G.711 channel. 

  • g711V8Total – Total G711 V8 resource capacity on this server.

  • g711V8Utilization – Percentage utilization of G711 V8 resources on this server.

  • g722Total – Total G.722 resource capacity on this server.
  • g722Utilization – Percentage utilization of G.722 resources on this server.
  • g722V8Total – Total G.722 V8 resource capacity on this server.

  • g722V8Utilization – Percentage utilization of G.722 V8 resources on this server.

  • g726Total – Total G726 resource capacity on this server.
  • g726Utilization –  Percentage utilization of G726 resources on this server.
  • g726V8Total – Total G726 V8 resource capacity on this server.

  • g726V8Utilization – Percentage utilization of G726 V8 resources on this server.

  • g729AbTotal – Total G729A+B resource capacity on this server.
  • g729AbUtilization – Percentage utilization of G729A+B resources on this server.
  • g729AbV8Total – Total G729A+B V8 resource capacity on this server.

  • g729AbV8Utilization – Percentage utilization of G729A+B V8 resources on this server.

  • g7221Total – Total G.722.1 resource capacity on this server.
  • g7221Utilization – Percentage utilization of G.722.1 resources on this server.
  • g7221V8Total – Total G.722.1 V8 resource capacity on this server.

  • g7221V8Utilization – Percentage utilization of G.722.1 V8 resources on this server.

  • g7231Total – Total G723.1 resource capacity on this server.
  • g7231Utilization – Percentage utilization of G7231 resources on this server.
  • g7231V8Total – Total G723.1 V8 resource capacity on this server.

  • g7231V8Utilization – Percentage utilization of G7231 V8 resources on this server.

  • ilbcTotal – Total iLBC resource capacity on this server.
  • ilbcUtilization – Percentage utilization of iLBC resources on this server.
  • ilbcV8Total – Total iLBC V8 resource capacity on this server.

  • ilbcV8Utilization – Percentage utilization of iLBC V8 resources on this server.

  • opusTotal – Total OPUS resource capacity on this server.

  • opusUtilization – Percentage utilization of OPUS resources on this server.

  • toneAllocFailures – Percentage of tone resource allocation failures on this server.
  • toneAvailable – Number of tone resources currently unused and available on this server.
  • toneTotal  Total tone resource capacity on this server.
  • toneUtilization – Percentage utilization of tone resources on this server.

cpuUtilCurrentStatistics

The CPU utilization of the server for the current period.

  • <server name> – The name of the server.
  • average – The average CPU % utilization for this interval.
  • high – The high CPU % utilization for this interval.
  • low – The low CPU % utilization for this interval.

cpuUtilIntervalStatistics

The CPU utilization for the 'n' number of intervals.

  • number – The interval sequence number. The number of intervals to store are configurable. (Refer to Interval Statistics - CLI for status/statistics details)
  • ceName – The SBC server name.
  • cpu – The CPU number.
  • intervalValid – A setting of 'true' indicates the interval contains valid data during the time interval. Each interval is for a configurable fixed time (default interval is 15 minutes) starting on the hour. For example, if the system starts at 12:05, the first interval at 12:15 will not be valid because it is less than the 15-minute interval. Subsequent intervals will be valid upon meeting the 15-minute time interval. System switch-overs also cause invalid intervals because data is lost during the interval.
  • time – The system up time when the interval statistics are collected.
  • average – The average CPU % utilization for this interval.
  • high – The high CPU % utilization for this interval.
  • low – The low CPU % utilization for this interval.
databaseIntegrity

Displays SBC database sync status from executing the request system admin <system name> verifyDatabaseIntegrity command. (Refer to Admin - CLI)

The following command options are available to match the results of the 'show' command with the associated 'request' command:

activeAndStandbyPolicy – Display results of the sync check against policy databases on the active and standby servers.
activeConfigAndActivePolicy – Displays the results of the sync check against the policy and configuration databases on the active server.

Displayed results include the following fields:

  • syncModuleName – The database sync module name: activeAndStandbyPolicy, activeConfigAndActivePolicy
  • syncStatus – Possible results: inProgress, inSync, outOfSync, unknown.
  • timeStamp – Times tamp of when the command was executed.

daughterBoardAdmin

SBC 5x10/7000 daughter board administrative status from server/CE level.

  • ceName – The SBC server name.
  • disableCleanupAction – Identifies the type of disable cleanup action (forced/graceful)
  • dryUpTime – The set time, in minutes, for a graceful shutdown to occur (range: 0-60 / default = 10).
  • slot – Slot number designation for DSP20 (slot 1) and DSP25 (slots 1-4) cards.
  • state – Administrative state of daughter board.

NOTE: Not applicable for 5x00 or SWe systems.

daughterBoardStatus

Server Daughter Board (DB) status details. See Daughter Board Status Attributes table below for details.

dodModeStatus

DoD mode status details, with following details:

  • index – Index number
  • status – Specifies if DoD mode is enabled/disabled, as well as if CLI, EMA Platform Mode and sFTP are enabled for access while SBC is in DoD mode.
dsbc

Distributed SBC (D-SBC) statistics details.

  • dsbcSigPortStatisticsD-SBC signaling port statistics when communicating with the other D-SBC nodes. Fields include:
    • <IP address> – The IP address of the remote node
    • BytesReceivedThe total number of signaling bytes received from this remote node
    • BytesSentThe total number of signaling bytes sent to this remote node
    • Interface – The interface used for this link
    • PdusReceivedThe total number of signaling PDUs received from the remote node
    • PdusSentThe total number of signaling PDUs sent to the remote node
    • StateThe current state of the signaling link of the remote node
  • dsbcSigPortStatus – D-SBC signaling port status details.
    • <index> – The D-SBC signaling port index.
    • stateThe administrative state of the D-SBC signaling port.

dspPad

DSP PAD configuration service (must be restarted for new configuration to take effect). See DSP PAD Attributes table for details (for 'show table system' command only).

dspRes

DSP historical interval statistics. See DSP Resources Attributes table below for parameter details.

  • dspCallCurrentStatistics – The System Call DSP Resource Current table.
  • dspCallIntervalStatistics – The System Call DSP Resource Interval table.
  • dspUsageCurrentStatistics – The DSP Resource Current table.
  • dspUsageIntervalStatistics – The DSP Resource Interval table.

dspStatus dspUsage

Status of DSP resources. See DSP Status Attributes table below for details.

ethernetPort

Configuration for management, packet, and field service Ethernet ports. See Ethernet Port Attributes table for details.

fanStatus

Fan status on the server(s).

  • <system name>
  • <fan nomenclature>
  • speed
fileStatisticsAdmin

Displays whether the following interval statistics are enabled/disabled to write data to the statistics file.

  • CallFailIntervalStats
  • CallIntervalStats
  • DiamNodeRfIntervalStatistics
  • DnsGroupDnsServerStats
  • DspResDspCallIntervalStats
  • DspResDspUsageIntervalStats
  • H323SigPortStatisticsStats
  • IpAclOverallStats
  • IpAclRuleStats
  • IpPolicingSystemIntStats
  • LinkDetectionGroupStats
  • LinkMonitorStats
  • MtrmConnPortPeerStats
  • NBS5200TrunkGroupStatusStats
    NOTE: This statistic applies to both SBC 5000 and 7000 series. The EMS uses "SBC7KTrunkGroupStatusStats" for SBC 7000 series statistics.

  • SipIntervalStats
  • sipOcsCallIntervalStatistics
  • SipRegCountStats
  • SipSigPortStatisticsStats
  • SipSubCountStats
  • SysCpuUtilIntStatsSts
  • SysMemoryUtilIntStatsSts
  • SystemCongestionIntervalStats
  • TrafficControlStats
  • ZoneIntervalStatisticsStats

fileStatisticsStatus

Displays the current ID of the last performance statistics data written to the database.
fipsFSMState

FIPS finite state machine state.

  • issuer – FIPS FSM Issuer.
  • message – FIPS FSM message.
  • state – FIPS FSM state.
  • timeStamp – FIPS FSM timestamp.
gpuStatus

SWE only. Returns server name and GPU number for each attached GPU. See GPU Status table for details.

gpuTranscodeStatus

Returns GPU codec channel capacities. Available only on SBC SWe except S-SBC SWe. See GPU Transcode Status for details. 

haConfig

This statistic displays GRHA status details.

  • serverName
  • leaderElection – The current GRHA mode setting for the leader election algorithm type.
  • bondMonitoring – The current GRHA mode setting for bond monitoring type.

hardDiskStatus

Hard disk status on the server(s).

  • capacity – Capacity of the disk.
  • diskLifeRemaining – A calculated percentage estimating the life remaining of the device or N/A if not supported by the device.
  • diskStatus – Hard disk status that indicates if the disk is online/failed.
  • healthTest – Pass or Fail indicating the overall health of the device.
  • present – Indicates if the hard disk exists (true/false).
  • productId – Product ID of the hard disk as assigned by vendor.
  • revision – Revision of the hard disk as assigned by vendor  .

hardDiskUsage

Hard disk usage on the server(s).

  • freeDiskSpace – Indicates free hard disk space (KBytes).
  • role – Role of the server for the indicated partition (see Note below).
  • syncCompletion – Indicates partition's sync completion percentage.
  • syncStatus – Partition's synchronization status with peer server.
  • totalDiskSpace – Capacity of the disk (KBytes).
  • usedDiskSpace – Indicates used hard disk (%) .

NOTE: The role of the standby server is reflected as Primary for the root partition because the other partition, /var/log/sonus/sbx/evlog is not mirrored/mounted in the standby CE until a switch-over occurs and the Standby assumes the role of active.

highAvailabilityPort

Configuration and status for the HA ethernet ports.

  • statistics – Lists status/statistics details such as port name, number of packets transmitted/received, bytes transmitted/received, and errors transmitted/received.
    • <host name> – SBC host name.
    • allocRxBufFailRx – The number of receive buffer allocation errors.
    • byteRx – The number of bytes received.
    • byteTx – The number of bytes transmitted.
    • crcErrRx – The number of receive CRC errors.
    • errTx – The number of transmit errors.
    • noBufCntRx – The number of receive no buffer errors.
    • overErrRx – The number of receive overrun errors.
    • packetRx – The number of packets received.
    • packetTx – The number of packets transmitted.
  • status – List details such as port name, MAC address, IP address, negotiated speed and OOS reason.
    • ipAddress – The IP address of this port.
    • macAddress – The MAC address of this port.
    • negotiatedSpeed – The negotiated speed of this port.
    • oosReason – The reason this port is out of service.

intervalStatistics

The system- wide settings for interval statistics.

  • maxFileRetentionPeriod – The maximum retention period for statistics files stored on disk. (range: 60-1440 / default = 60)
  • nodeId – The EMS configured nodeID for this system to be used as part of the filename when writing the statistics  to the file. (default = 0)
  • numOfPastIntervals – The maximum number of past intervals display in CLI. (range: 1-12 / default = 4)
  • timeInterval – The time interval for interval statistics data.

ipPolicing

The MIB Module for IP Monitoring statistics. These statistics are divided into three categories: Offenders Lists statistics, Micro Flow statistics and System statistics.

  • Role – Offenders list role
  • Index – Index  number of this statistic
  • Address Context – Address context associated with this statistic
  • Interface Group Name – IP interface group name
  • Interface Name – Interface name
  • Source IP Address – Source IP address
  • Destination IP Address – Destination IP address
  • Source IP Port – Source IP port
  • Destination IP Port – Destination IP port
  • IP Protocol – IP protocol
  • Ether Type – This field indicates the decimal value representing which protocol is encapsulated in the payload of the Ethernet Frame. For example, a value of 2048 equates to 0800 hexidecimal, which in turn represents IPv4.
  • Discard Count – The number of packets dropped
  • Ring Type
  • Source Unique

 

Offenders Lists statistics (See Offenders List Details section for additional details)

  • aclOffendersList – The table of statistics for the ACL policer offenders list
  • aggregateOffendersList – The table of statistics for the aggregate policer offenders list
  • arpOffendersList – The table of statistics for the ARP policer offenders list
  • badEtherIpHdrOffendersList – The table of statistics for the bad Ethernet/IP Header policer offenders list
  • discardRuleOffendersList – The table of statistics for the discard rule offenders list
  • ipSecDecryptOffendersList – The table of statistics for the IPsec Decrypt policer offenders list
  • mediaOffendersList – The table of statistics for the media policer offenders list
  • rogueMediaOffendersList – The table of statistics for the rogue media policer offenders list
  • uFlowOffendersList – The table of statistics for the micro flow policer offenders list

Micro Flow statistics:

NOTE: This command displays any microflow entry regardless of whether SIPFE or MRM (or any sub-system) created the microflow.

System statistics:

isOAM

Indicates whether the node is an OAM node.

  • false
  • true

jsrcServer

JSRC server configuration.

  • globalConfig – This defines global configuration applicable to all the JSRC servers.
  • remoteServer – JSRC server configuration.
  • serverStatus – JSRC server status.

ledStatus

Displays status of various LEDs of the server.

  • ledColor – Indicates the LED color.
  • ledState – Indicates the LED state.
licenseDomainBundleInfoLicense details for the domain licenses available on the SBC. See License Attributes table for details.

licenseInfo

The license status for registered license features. See License Attributes table for details.

licenseNodeLockedBundleInfo

License details for the node-locked licenses stored on the SBC. See License Attributes table for details.

licenseRequired

Displays the licenseRequired configuration: The configured maximum number of licenses for a particular feature for a specific node when network-wide domain licensing is in effect. See License Attributes table for details.

(Applies to 'show table' command only)

licenseStatus

The CE license status table describes the current CE license state, for example "dualCe". See License Attributes table for details.

loadBalancingService

The Load Balancing Service status/statistics details with the following fields. See one of the following tables, as applicable, for details:

logicalMgmtIpInterface

The logical management IP interface status/statistics details with following fields:

  • name – The name of the logical IP interface.
  • mgmtIpInterfaceGroupName
  • ipAddress
  • state

logicalMgmtIpInterfaceStatus 

The Logical Mgmt IP Interface status status/statistics details with following fields:

  • name – The name of the logical IP interface.
  • operStatus – Operational status.
macAddressStatus

Displays MAC addresses of the system server(s).

  • <server name> – SBC server name.
  • status – Status of the specified MAC address.

  • usedBy – Name of the server using this MAC address.

  • usedByPort – The port used by this MAC address.

media

System- wide media configurations, UDP port range and RTP/RTCP peer inactivity timeout.

  • mediaPeerInactivity – media peer inactivity configurables.
  • mediaPortRange – Allowed range of UDP port numbers for RTP/RTCP media.
  • mediaRtcpControl – RTCP session configurables.

mediaProfile

DSP Media Profile configuration. (The System Media Profile configuration applies to hardware platforms (5000 series, 5400, 7000) only.)

 

  • compression – Percentage (of DSP cores) for capability COMPRESSION.
  • tone – Percentage (of DSP cores) for capability TONE.

memoryUtilCurrentStatistics

The memory utilization for the current interval period. Fields include:

  • ceName – The SBC server name.
  • average – The average memory % utilization for this interval.
  • averageSwap – The average swap % memory utilization for this interval.
  • high – The high memory % utilization for this interval.
  • highSwap – The high swap % memory utilization for this interval.
  • low – The low memory % utilization for this interval.
  • lowSwap – The low swap memory % utilization for this interval.

memoryUtilIntervalStatistics

The memory utilization for the 'n' number of intervals.

  • number – The interval sequence number. The number of intervals to store are configurable. Refer to Interval Statistics - CLI for status/statistics details.
  • ceName – The SBC server name.
  • average – The average memory % utilization for this interval.
  • averageSwap – The average swap memory % utilization for this interval.
  • high – The high memory % utilization for this interval.
  • highSwap – The high swap memory % utilization for this interval.
  • intervalValid – A setting of 'true' indicates the interval contains valid data during the time interval. Each interval is for a configurable fixed time (default interval is 15 minutes) starting on the hour. For example, if the system starts at 12:05, the first interval at 12:15 will not be valid because it is less than the 15-minute interval. Subsequent intervals will be valid upon meeting the 15-minute time interval. System switch-overs also cause invalid intervals because data is lost during the interval.
  • low – The low memory % utilization for this interval.
  • lowSwap – The low swap memory % utilization for this interval.
  • time – The system up time when the interval statistic is collected.
metaVariable

Displays the system dynamic metavariable names and values.

  • ceNameDisplays the name of the instance along with its HA IP address.
  • nameDisplays the name of the interface definition parameters.
  • valueDisplays the value associated with the IDP.
metaVariableDynamic

Displays user-configured metavariables that add to the metadata available to an existing SBC SWe cloud deployment.

  • ceName – Displays the name of the instance along with its HA IP address.
  • name – Displays the name of an interface definition parameter.
  • value – Displays the value assigned to the specified parameter.

mgmtIpInterfaceGroup

A group of management IP interfaces for the default address context. See Mgmt IP Interface Group Parameters table below for details.

mgmtStaticRoute

Static IP routes for this address context.

  • <destination IP address>
  • preference – Route preference value.
networkProcessorStatistics

NOTE: For internal debug use only.

Network Processor statistics details.See Network Processor Attributes table below for details.

niceLicenseReports whether the SBC NICE recording feature is dependent on the setting for the feature within the SBC's license. For deployments that upgraded and were already using the legacy license model, this status is set to "true" automatically and access to the NICE recording feature is maintained without the need to install a new license. If the status is set to "false" your installed license must have NICE recording explicitly enabled to enable the feature.

ntp

NTP services management details. See NTP Attributes table below for details

objectStoreParametersParameters used to specify an object store service to upload or download a configuration file (SBC SWe Cloud only)
pathCheckPath

Path for ICMP ping mechanism

  • name – Path Check Path name
  • sourceIpAddress – Source IP address of the ping path
  • targetIpAddress – Target IP address of the ping path
  • reportSignalIpAddress – Reported Signaling IP address of the ping path
  • reportSignalIpPort – Reported Signaling Port of the ping path
  • pathCheckProfile – Path Check profile name used when pinging this peer
  • addressContext – Address Context where the corresponding Interface Group is present
  • zone – Zone name used when pinging this peer
  • ipInterfaceGroup – IP Interface Group where the corresponding IP Interface is present.
  • ipInterface – IP interface from which ping should be generated.
  • state – Administrative state of pathCheckPath (active pinging state).

NOTE: This field applies to the 'show table' command only.

pdcsLicenseReports whether the SBC feature which enables lawful call interception based on receipt of a SIP P-DCS-LAES header is dependent on the setting for the feature within the SBC's license. For deployments that upgraded and were already using the legacy license model, this status is set to "true" automatically and access to the P-DCS-LAES feature is maintained without the need to install a new license. If the status is set to "false" your installed license must have the P-DCS-LAES feature explicitly enabled to enable the feature.

policyServer

Softswitch servers and client services status/statistics details. See Policy Server Attributes table below for details.

powerSupplyStatus

Power consumption/state of the server.

  • <server name>
  • partNum – Identifies the part number of the module.
  • powerFault – Indicates if there is power fault.
  • present – Indicates if the module is present or not.
  • productName – Identifies the name (as given by manufacturer) of power supply module.
  • serialNum – Identifies the serial number of the power supply module.
  • voltageFault – Indicates if there is voltage fault.
rgStatus

Displays the Redundancy Group status of the instances created through N:1 redundancy group.

NOTE: This command applies to N:1 redundancy configurations only.

savedConfigList

List of configurations saved on the system.

  • <index of saved config. file>
  • fileName – The file name of the saved configuration.
  • size – Indicates size of the saved configuration file (KBytes).
  • version – The software version name of the saved configuration.
sbcliLicenseReports whether the SBC feature which enables lawful interception (LI) service using ERE is dependent on the setting for the feature within the SBC's license. For deployments that upgraded and were already using the legacy license model, this status is set to "true" automatically and access to the feature is maintained without the need to install a new license. If the status is set to "false" your installed license must have the LI feature explicitly enabled to enable the feature.
sbcPersonalityStatus

Displays the personality role of the SBC SWe/SBC SWe Cloud instance. Choices are isbc, msbc and ssbc.

security

Security management status/statistics details. See Security Attributes table for details.

serverAdmin

The serverAdmin table describes the configuration of each server module.

  • name – The node name.
  • actualCeName
    • Cloud platform: The ceName provided in the user data.
    • Non-Cloud platform: The SBC name entered during the SBC application installation.
  • coredumpProfile – The core dump settings for this server.
  • role – If set to ‘primary’, role designates a server for internal processing.
  • deviceSmartAttrib – The smart control attribute value that reports disk life remaining. A value of 0 means that no overriding attribute is available. The SBC could still be using an internal value based on pre-defined settings of known disk types. If the SBC is unable to retrieve a value (reports "n/a") for "Disk Life Remaining" when you run the hardDiskStatus command you may be able to specify the integer ID number of a smart control attribute that reports the percentage lifetime used for the disk. Contact Ribbon Technical Support for assistance in determining whether there is a valid smart control attribute available on your system.
  • modularType – If set to 'true', the SBC uses modular DSPs.
  • hwType The type of server module the indexed slot has been configured to accept.
  • pktPortSpeedPacket port speed setting (1Gps, 10Gps).
  • hwSubType – This field stores the SBC SWe subscription type.

    • virtual – SBC SWe configured for Virtual (non-Cloud) environment.
    • virtualCloud – SBC SWe configured for Cloud environment.

serverSoftwareUpgradeStatus

The system server software upgrade status table describes the status of the server software upgrade module.

  • <server name>
  • upgradeStatus – Indicates the current status of the server (none, pendingRevert, pendingUpgrade, reverted, reverting, revertingOnError, upgraded, upgrading)

serverStatus

The system server status table provides status of the server module.

  • name – The node name.
  • hwType – The type of server module the indexed slot has been configured to accept.
  • serialNum Serial number of the server module.
  • partNum – Identifies the part number of the module.
  • platformVersion – Platform version currently running on server.
  • applicationVersion – Indicates the application version currently running on server.
  • mgmtRedundancyRole – Redundancy role of the server (for management entities)
  • upTime – Server module uptime in days/hours/minutes/seconds
  • applicationUpTime – Indicates application uptime on the server in days/hours/minutes/sec.
  • lastRestartReason – Reason for last restart of server.
  • syncStatus – Inter-CE data synchronization state.
  • daughterBoardPresent – Daughter board presence indicator.
  • currentTime – Current system time.
  • pktPortSpeed – Packet port speed setting (1Gps, 10Gps).
  • actualCeName
    • Cloud platform: The ceName provided in the user data.
    • Non-Cloud platform: The SBC name entered during the SBC application installation.
  • hwSubType – This field stores the SBC SWe subscription type.

    • virtual – SBC SWe configured for Virtual (non-Cloud) environment.
    • virtualCloud – SBC SWe configured for Cloud environment.
  • fingerprint – The licensing fingerprint for the node.
softwareUpgradeDetailedStatus

<system name> detailedStatus – Prints the complete Live Software Upgrade (LSWU) upgrade details for the specified system to the screen. Details include the number of steps involved, the time taken to completed LSWU and upgrade process results.

softwareUpgradeStatus

LSWU status at any given time with the following details.

  • activeCeAtStart – Active CE name when the upgrade started.
  • cemodeAtStart – CE mode when upgrade started (single/dual).
  • modelChange – Indicates if process model changed as part of this upgrade.
  • newRelease – Software release to which the upgrade is performed.
  • oldRelease – Software release running before upgrade started.
  • package – Name of the new package.
  • previousState – This is the previous LSWU state.
  • primaryUpgradeStatus – Indicates the current status of the primary server.
  • reason – Exit reason for failure of last software upgrade.
  • revertScript – Revert script to run in case upgrade fails.
  • revertStartTime – Start time of revert activity.
  • rpmName – Name of the new rpm used for upgrade.
  • secondaryUpgradeStatus – Indicates the current status of the secondary server.
  • state – Current LSWU state.
  • upgradeScript – Script to run to perform upgrade.
  • upgradeStartTime – LSWU start time.
standbySyncStatus

Sync status details of the standby node for active nodes created through a N:1 redundancy group configuration.

  • Call/Registration Data – The sync state of Call/Registration data for active or standby node.
  • Metavar Data – The sync state of metavariable data for the active or standby node.

syncStatus

HA Redundancy:

Sync status of both the active and standby nodes for an SBC HA pair.

  • Call/Registration Data – Call/Registration data synchronization status with the SBC peer 
  • Configuration Data – Configuration data synchronization status with the SBC peer
  • Disk Mirroring – Disk Mirroring synchronization status with the SBC peer
  • Policy Data – Policy data synchronization status with the SBC peer

N:1 Redundancy:

Sync status of both the active and standby nodes created through a N:1 redundancy group.

  • Call/REgistration DataThe sync state of Call/Registration data for active or standby node.
  • Metavar DataThe sync state of metavariable data for the active or standby node.

systemCongestionCurrentStatistics

The System Congestion Current Statistics table details.

  • avgCallRate – The average call rate calculated using the formula: (# call attempts in an interval) / (# seconds elapsed in that interval).
  • avgRegRate – The average registration rate calculated using the formula: (# registration attempts in an interval) / (# seconds elapsed in that interval).
  • avgSubsRate – The average SIP SUBSCRIBE arrival rate calculated using the formula: (# SUBSCRIBE attempts in an interval) / (# seconds elapsed in that interval).
  • callArrivals – The number of call arrivals since the current interval started.
  • emergencyCallArrivals – The number of SIP emergency call arrivals since the current interval started.
  • emergencyCallRejects – The number of SIP emergency call rejects since the current interval started.
  • levelMC1Count – The number of transitions into MC1 since the current interval started.
  • levelMC1TotalTime – The total number of seconds spent in MC1 since the current interval started.
  • levelMC2Count – The number of transitions into MC2 since the current interval started.
  • levelMC2TotalTime – The total number of seconds spent in MC2 since the current interval started.
  • levelMC3Count – The number of transitions into MC3 since the current interval started.
  • levelMC3TotalTime – The total number of seconds spent in MC3 since the current interval started.
  • overloadRejects – The number of calls rejected due to system congestion since the current interval started.
  • peakCallRate – The system peak call arrival rate (in calls per second) since the current interval started.
  • peakRegRate – The peak SIP registration arrival rate (in registrations per second) since the current interval started.
  • peakSubsRate – The peak SIP SUBSCRIBE arrival rate (in subscriptions per second) since the current interval started.
  • sipRegArrivals – The number of SIP registrations arrivals since the current interval started.
  • sipRegRejects – The  number of SIP registrations rejected since the current interval started.
  • sipSubsArrivals – The number of SIP SUBSCRIBEs that arrived since the current interval started.
  • sipsSubsRejects – The number of SIP SUBSCRIBEs that are rejected due to system congestion since the current interval started.

systemCongestionIntervalStatistics 

The System Congestion Interval Statistics details.

  • <sequence number> – The interval sequence number. The number of intervals to store are configurable. Refer to Interval Statistics - CLI for configuration details.
  • avgCallRate – The system average call arrival rate over the reporting inteval (callArrivals / interval-time = avgCallRate).
  • avgRegRate – The average SIP registration arrival rate (in registrations per second) over the reporting interval.
  • avgSubsRate – The average SIP SUBSCRIBE arrival rate (in subscriptions per second) over the reporting interval.
  • callArrivals – The total count of call arrivals during the interval (callArrivals / interval-time = avgCallRate) .
  • emergencyCallArrivals – The total count of SIP emergency calls that arrived.
  • emergencyCallRejects – The total count of rejected SIP emergency calls.
  • intervalValid – A setting of 'true' indicates the interval contains valid data during the time interval. Each interval is for a configurable fixed time (default interval is 15 minutes) starting on the hour. For example, if the system starts at 12:05, the first interval at 12:15 will not be valid because it is less than the 15-minute interval. Subsequent intervals will be valid upon meeting the 15-minute time interval. System switch-overs also cause invalid intervals because data is lost during the interval.
  • levelMC1Count – The total count of transitions into MC1 during the interval.
  • levelMC1TotalTime – The total time spent (in seconds) in MC1 during the interval.
  • levelMC2Count – The total count of transitions into MC2 during the interval.
  • levelMC2TotalTime – The total time spent (in seconds) in MC2 during the interval.
  • levelMC3Count – The total count of transitions into MC3 during the interval.
  • levelMC3TotalTime – The total time spent (in seconds) in MC3 during the interval.
  • maxActiveCalls – The high water mark of the total number of active calls in both inbound and outbound directions on all trunk groups in the system for specified interval. This statistic applies to calls which are setting up, tearing down or stable.

    Switch-over scenario:

    When a switch-over occurs from SBC-A to SBC-B, the number of stable calls that were transferred from SBC-A to SBC-B equals the initial value of "maxActiveCalls" (immediately after the switch-over). Subsequent values are calculated and recorded accordingly.

  • overloadRejects – The total count of calls rejected during the collection interval.
  • peakCallRate – The system peak call arrival rate (in calls per second) measured during the collection interval.
  • peakRegRate – The peak SIP registration arrival rate (in registrations per second) measured during the collection interval.
  • peakSubsRate – The peak SIP SUBSCRIBE arrival rate (in subscriptions per second) measured during the collection interval.

  • sipRegArrivals – The total count of SIP registrations that arrived during the collection interval.
  • sipRegRejects – The total count of SIP registrations rejected during the collection interval.
  • sipSubsArrivals – The total count of SIP SUBSCRIBEs that arrived during the collection interval.

  • sipsSubsRejects – The number of SIP SUBSCRIBEs rejected during the collection interval.

  • time – The system up time when the interval statisitic is collected.

systemCongestionStatus

System Congestion status status/statistics details.

  • systemCongestionCPULevel – The current System Machine Congestion (MC) Level at the time this command is executed.
    • 0 – No Congestion

    • 1 – Level one congestion

    • 2 – Level two congestion

    • 3 – Level three congestion

  • systemCongestionCallAcceptCount – A snapshot of the number of calls being accepted by the system. A value of "65535" represents all calls. During MC2 congestion, SBC calculates the CallAcceptRate peridocially (each second), and uses the value to compute a new CallAcceptCount.
  • systemCongestionCallAcceptRate – Current rate (in calls per second) at which calls are being accepted by the system.
  • systemCongestionCallArrivalRate – A snapshot of the number of call arrivals in the last second.
  •  systemCongestionCallEqArrivalRate – Indicates the number of call/subscribes/registrations arrival per second. For registrations and subscriptions, the counter is incremented after every four new subscriptions/registrations. For calls, the counter is incremented after every new call.
  • systemCongestionCallRateLevel – Call rate congestion level.
  •  systemCongestionIRTTLevel – Internal RoundTrip Time (IRTT) congestion level.
  • systemCongestionMCDuration – Number of seconds the system has been at this congestion level.
  • systemCongestionMCLevel – System congestion level.
  • systemCongestionRegArrivalRate –  A snapshot of the number of SIP registration arrivals in the last second.
  • systemCongestionSubsArrivalRate – The number of SIP SUBSCRIBEs that arrived in the last second.
transcodeInfo

(Available only on SWe except S-SBC SWe)

  • cpu – Number of cores used by CPU-based transcoding. This is system level information and shows only one entry in case of HA system.
  • gpu – GPU information. This is system level information and shows only one entry in case of HA system.
    • gpuName Name of the GPU, this is used to differentiate between instances of same GPU type such as M60_0, M60_1.
    • cpuCoresUsed CPU cores used for GPU transcoding by this GPU.
    • gpuType   GPU type.
    • gpuAllocationRatio GPU allocation ratio. Reserved for future use.
transcodeType

(Available only on SWe except S-SBC SWe)

Shows type of transcode information used (CPU, GPU, CPU + GPU, HWDSP). This is system level information and shows only one entry in case of HA system.


Note

The SBC releases that are officially FIPS-compliant are releases 5.1, 6.2, and 7.2.

 

Admin

Command Syntax

> show status system admin <system name>

Command Parameters

Admin Attributes

Parameter

Description

<system name>

System name

actualSystemNameSystem name given by the user as user/metadata
clusterIdclusterID instance present in the userdata
savedConfigurationsA list of saved configurations, by revision number and the timestamp when the configuration was saved. Applicable for SBC SWe Cloud clusters that are configured to use OAM node configuration.
sftpUserPasswordPassword rules for SFTP user
adSyncStatusDisplays AD server sync status

Announcements

Announcement file status and statistics.

Command Syntax

> show status system announcements

 Command Parameters

Announcements Attributes

ParameterDescription
memoryUsage

Announcement segment NP memory usage.

  • cachedSegments – Number of announcement segments cached in NP memory.
  • totalCacheMemory – Total amount of segment cache memory available in NP.
  • totalPlayoutTime – Total playout time of all segments cached in NP memory.
  • totalSegments – Total number of announcement segments on disk.
  • usedCacheMemory – Amount of segment cache memory being used in NP.
  • utilizedCacheMemory – Percentage of segment cache memory being used in NP.

segmentStatus <segment ID>

Announcement segment file status.

  • audioFormat – Compression type of audio data.

  • audioLength — Length of audio data in segment file.

  • pathname – Pathname of segment file.

  • playoutDuration – Playout duration of segment file.

  • state – State of segment.

  • totalPlays – Total number of times this segment has been played.

  • useCount – Number of announcements currently using this segment.

  • version – Version number of segment file.

Daughter Board Status

Command Syntax

> show status system daughterBoardStatus

 Command Parameters

Daughter Board Status Attributes

 ParameterDescription 
daughterBoardStatus<server name> Server name
daughterBoardId

Daughter board identifier

SBC 5000 series:

  • SPS100 – SBC 5x00 SPS100 module
  • DB0 – SBC 5x00 SPS100DB 0 module
  • DB1 – SBC 5x00 SPS100DB 1 module
  • DSP20 – SBC 5x10 DSP20 module
  • DSP25 – SBC 5x10 DSP25 module

SBC 7000 series:

  • FRU_DSP1 – SBC 7000 DSP-LC slot 1
  • FRU_DSP2 – SBC 7000 DSP-LC slot 2

  • FRU_DSP3 – SBC 7000 DSP-LC slot 3

  • FRU_DSP4 – SBC 7000 DSP-LC slot 4

fpgaVersion

 A card’s programmed firmware version (using FPGA build date)

NOTE: This maintenance field does not apply to SPS100 cards.

imageLoadFailureCount

Number of module boot failures since the last successful module boot, for use during diagnostic testing of a potentially failed module.

NOTE: This maintenance field does not apply to SPS100 cards.

operationalStatus

Operational state of daughter board.

  • disabled – Card is disabled.
  • dryup – Card is enabled but in the process of drying up. Once completed, card will be set to ‘disabled’.
  • enabled – Card is enabled.
  • failed – If a DSP2x or DSP-LC module fails to boot over three consecutive tries (typically due to a hardware failure), it is taken out of service and marked as state “failed”. The rest of the system continues to boot normally, including any other DSP modules. The module failure is logged/alarmed with trap “sonusConnexIpSystemCESlotFailedNotification”. The slot remains in the failed state until the module is disabled and re-enabled once a replacement card is installed.
  • loading – Card is enabled but in the process of booting. Resources are not yet available. Once completed, card will be set to ‘enabled’.
  • locked – Slot capacity is locked out due to mismatch (with “preserveRedundancy” configured).

NOTE: For 5x00 systems, only the “enabled” state displays in the results.

partNumThe part number of the module (if present)
presentIndicates if the module is present or not.
productNameIdentifies manufacturer name of module (if present)

serialNum

Identifies the serial number of the module (if present)

DSP

DSP Resources

Command Syntax

> show status system dspRes
	dspCallCurrentStatistics
	dspCallIntervalStatistics
	dspUsageCurrentStatistics
	dspUsageIntervalStatistics

Command Parameters

 

DSP Resources Attributes

ParameterDescription

dspRes

<system name or sequence number>

  • The system name (for CurrentStatistics objects).
  • A sequence number which identifies the interval for which the set of statistics is required (for IntervalStatistics objects).
dspCallCurrentStatistics

The System Call DSP Resource Current table containing the following information:

The following statistics are collected in this table for each codec.

  • numCallSuccessNoDspAllocFailure – Number of successful calls without DSP resource allocation failure during the current time interval.
  • numCallSuccessWithDspAllocFailure – Number of successful calls with DSP resource allocation failure during the current time interval.
  • numCallFailNo<codec> – Number of calls failed due to lack of DSP resource for the specified codec since initialization/last reboot.
  • numCallFailOtherOn<codec> – Number of call fails due to reason other than lack DSP resources for the specified codec since initialization/last reboot.
  • numCallSuccessNo<codec> – Number of successful calls even though lack of DSP resourcesfor the specified codec since initialization/last reboot.
dspCallIntervalStatistics

The System Call DSP Resource Interval table containing the following statistics for the 'n' number of intervals:

  • number – The interval sequence number. The number of intervals to store are configurable. Refer to Interval Statistics - CLI for configuration details.
  • intervalValid– A setting of 'true' indicates the interval contains valid data during the time interval. Each interval is for a configurable fixed time (default interval is 15 minutes) starting on the hour. For example, if the system starts at 12:05, the first interval at 12:15 will not be valid because it is less than the 15-minute interval. Subsequent intervals will be valid upon meeting the 15-minute time interval. System switch-overs also cause invalid intervals because data is lost during the interval.
  • time – The system up time when the interval statisitics are collected.
  • numCallSuccessNoDspAllocFailure – Number of successful calls without DSP resource allocation failure for the defined time interval.
  • numCallSuccessWithDspAllocFailure – Number of successful calls with DSP resource allocation failure for the defined time interval.
  • numCallFailNo<codec> – Number of failed calls due to lack of DSP resource for the specified codec during the defined time interval.
  • numCallSuccessNo<codec> – Number of successful calls even though lack of AMRNB DSP resource for the specified time interval.
dspUsageCurrentStatistics

The DSP Resource statistics details.

The following statistics are collected in this table for each codec. Statistics are collected once per second.

  • <codec>AverageAvailCount – The running average number of free DSP resources for the specified codec since the SBC started up.
  • <codec>AverageUsedCount – The running average number of used DSP resources for the specified codec since the SBC started up.
  • <codec>PeakUsedCount – The peak number of resources used for the specified codec since the SBC started up.
dspUsageIntervalStatistics

The DSP Resource Interval table containing the following statistics over the 'n' number of intervals. Interval statistics are weighted per codec type.

  • number – The interval sequence number. The number of intervals to store are configurable. Refer to Interval Statistics - CLI for configuration details.
  • intervalValid – A setting of 'true' indicates the interval contains valid data during the time interval. Each interval is for a configurable fixed time (default interval is 15 minutes) starting on the hour. For example, if the system starts at 12:05, the first interval at 12:15 will not be valid because it is less than the 15-minute interval. Subsequent intervals will be valid upon meeting the 15-minute time interval. System switch-overs also cause invalid intervals because data is lost during the interval.
  • time – The system up time when the interval statisitics are collected.
  • <codec>AverageAvailCount – The running average number of free DSP resources for the specified codec over the defined interval.
  • <codec>AverageUsedCount – The running average number of used DSP resources for the specified codec over the defined interval.
  • <codec>PeakUsedCount – The peak number of resources used for the specified codec over the defined interval.

NOTE: The number of available transcoded calls depends on whether or not back-to-back transcoding is required. Also, DSP resources are commonly held during call setup (even when transcoding ultimately is not required on the call).  At a high call rate this can marginally cut into the number of DSP resources available on the system.

DSP Status

This statistic command provides the current number of transcoded sessions per DSP2x slot (SBC 5x10) or SPS100 module (SBC 5x00) depending upon the number of modules installed for the specified system. The SBC 5x10 can include up to four DSP modules. The SBC 5x00 can be configured for up to three SPS100 modules  

(Refer to DSP Channel Densities for SBC 5000 and 7000 Series for details).

Command Syntax

> show status system dspStatus dspUsage

 Command Parameters

DSP Status Attributes

ParameterDescription

dspStatus dspUsage

<system name> – The SBC system name.

The below fields display raw count of DSP resources (i.e. channels) in use on each slot to aid in understanding which slots are loaded and to what extent in case card removal/hot swap is necessary.

  • slot1ResourcesUtilized
  • slot2ResourcesUtilized

  • slot3ResourcesUtilized

  • slot4ResourcesUtilized

For each DSP codec, a <codec>Total and <codec>Utilization field displays. 

    1. The <codec>Total field indicates how many transcoding sessions the system can support for that codec to G.711.
    2. The <codec>Utilization field indicates what percent of those sessions are actually in use.

      NOTE: For compressed-to-compressed transcoding, two resources are required, one for each codec. 

Additional fields:

  • amrNbTotal – Total AMR–NB resource capacity on this server.

  • amrNbUtilization – Percentage utilization of AMR–NB resources on this server.

  • amrWbTotal – Total AMR–WB resource capacity on this server.

  • amrWbUtilization – Percentage utilization of AMR–WB resources on this server.
  • compressionAllocFailures – Running count of resource allocation failures due to resource exhaustion.
  • compressionAvailable – Actual compression resources currently available in real time. This essentially equates to the total number of G.711 resources after loading.
  • compressionTotal – Maximum number of compression resources on the server (i.e. before loading, so this number is static). This essentially equates to the total number of G.711 resources before loading (i.e. lightest codec).
  • compressionUtilization – Percentage of compression resources in use (accounting for various codec weights). This can be calculated using the formula (compressionTotal compressionAvailable) / compressionTotal.
    NOTE: Use this value when determining the extent of DSP module load (regardless of codec type).

  • ecmTotal – Total T.38 ECM resource capacity on this server.
  • ecmUtilization – Percentage utilization of T.38 ECM resources on this server.
  • ecmV34Total – Total T.38 ECM V.34 resource capacity on this server.
  • ecmV34Utilization – Percentage utilization of T.38 ECM V.34 resources on this server.
  • efrTotal – Total EFR resource capacity on this server.
  • efrUtilization – Percentage utilization of EFR resources on this server.
  • evrc0Total – Total EVRC0 resource capacity on this server.
  • evrc0Utilization – Percentage utilization of EVRC0 resources on this server.
  • evrcb0Total – Total EVRCB0 resource capacity on this server.
  • evrcb0Utilization – Percentage utilization of EVRCB0 resources on this server.
  • g711SsTotal – Total G711SS (silence suppression) resource capacity on this server.
  • g711SsUtilization – Percentage utilization of G711SS (silence suppression) resources on this server.

  • g711Total – Total G711 resource capacity on this server.
  • g711Utilization – Percentage utilization of G711 resources on this server.
    NOTE: The g711Utilization includes g711 channels in use plus channels that are reserved but not activated as part of the call set up process.  In this case, ensure to reserve enough resources to account for the worst case codec. For example, in release 4.2.x, a reserved channel is about 4.5 times as expensive as a G.711 channel. 

  • g711V8Total – Total G711 V8 resource capacity on this server.

  • g711V8Utilization – Percentage utilization of G711 V8 resources on this server.

  • g722Total – Total G.722 resource capacity on this server.
  • g722Utilization – Percentage utilization of G.722 resources on this server.
  • g722V8Total – Total G.722 V8 resource capacity on this server.

  • g722V8Utilization Percentage utilization of G.722 V8 resources on this server.

  • g726Total – Total G726 resource capacity on this server.
  • g726Utilization –  Percentage utilization of G726 resources on this server.
  • g726V8Total Total G726 V8 resource capacity on this server.

  • g726V8Utilization Percentage utilization of G726 V8 resources on this server.

  • g729AbTotal – Total G729A+B resource capacity on this server.
  • g729AbUtilization – Percentage utilization of G729A+B resources on this server.
  • g729AbV8Total Total G729A+B V8 resource capacity on this server.

  • g729AbV8Utilization Percentage utilization of G729A+B V8 resources on this server.

  • g7221Total – Total G.722.1 resource capacity on this server.
  • g7221Utilization – Percentage utilization of G.722.1 resources on this server.
  • g7221V8Total Total G.722.1 V8 resource capacity on this server.

  • g7221V8Utilization Percentage utilization of G.722.1 V8 resources on this server.

  • g7231Total – Total G723.1 resource capacity on this server.
  • g7231Utilization – Percentage utilization of G7231 resources on this server.
  • g7231V8Total Total G723.1 V8 resource capacity on this server.

  • g7231V8Utilization Percentage utilization of G7231 V8 resources on this server.

  • ilbcTotal – Total iLBC resource capacity on this server.
  • ilbcUtilization – Percentage utilization of iLBC resources on this server.
  • ilbcV8Total Total iLBC V8 resource capacity on this server.

  • ilbcV8Utilization Percentage utilization of iLBC V8 resources on this server.

  • opusTotal Total OPUS resource capacity on this server.

  • opusUtilization Percentage utilization of OPUS resources on this server.

  • silk16Total Total Silk16 resource capacity on this server.
  • silk16Utilization Percentage utilization of Silk8 resources on this server.
  • silk8Total Total Silk8 resource capacity on this server.
  • silk8Utilization Percentage utilization of Silk8 resources on this server.
  • toneAllocFailures – Percentage of tone resource allocation failures on this server.
  • toneAvailable – Number of tone resources currently unused and available on this server.
  • toneTotal Total tone resource capacity on this server.
  • toneUtilization – Percentage utilization of tone resources on this server.

Ethernet Port

The SBC 5400 firmware/software is enhanced in 8.0 to add support for one Gbps speeds to the management ports (in addition to the existing 100 Mbps support), including the support of half or full duplex with auto-negotiation on all four management ports. Each management port auto-negotiates the speed/mode independently from other management ports.

Additionally, the SBC Core is enhanced to display the negotiated management port speed and current bandwidth for all management ports from the CLI/EMA.

Since this enhancement allows one Gbps traffic bandwidth for all management ports, it increases the possibility of a traffic overload condition due to the increased bandwidth of the combined management, media and signaling traffic. To address this, the SBC sets the management traffic as the lowest priority. Thus, the system drops the management packets, as necessary, to avoid impacting media or signaling traffic.

Command Syntax

 

show status system ethernetPort mgmtPortStatus
mgmtPortStatus GARNET mgt0 {
    ifIndex           1;
    macAddress        0:10:6b:3:da:a5;
    negotiatedSpeed   speed1000Mbps;
    linkState         admnEnabledPortUp;
    duplexMode        full;
    rxActualBandwidth 0;
    txActualBandwidth 0;
    rxPackets         21316;
    txPackets         1794;
    rxErrors          0;
    txErrors          0;
    rxDropped         183;
    txDropped         0;
}
mgmtPortStatus GARNET mgt1 {
    ifIndex           2;
    macAddress        0:10:6b:3:da:a6;
    negotiatedSpeed   speed1000Mbps;
    linkState         admnEnabledPortUp;
    duplexMode        full;
    rxActualBandwidth 0;
    txActualBandwidth 0;
    rxPackets         571;
    txPackets         28240;
    rxErrors          0;
    txErrors          0;
    rxDropped         0;
    txDropped         0;
}
mgmtPortStatus GARNET mgt2 {
    ifIndex           3;
    macAddress        0:10:6b:3:db:3b;
    negotiatedSpeed   speed1000Mbps;
    linkState         admnEnabledPortUp;
    duplexMode        full;
    rxActualBandwidth 510;
    txActualBandwidth 0;
    rxPackets         456103;
    txPackets         2839;
    rxErrors          0;
    txErrors          0;
    rxDropped         201;
    txDropped         0;
}
mgmtPortStatus GARNET mgt3 {
    ifIndex           4;
    macAddress        0:10:6b:3:db:3c;
    negotiatedSpeed   speed1000Mbps;
    linkState         admnEnabledPortUp;
    duplexMode        full;
    rxActualBandwidth 558;
    txActualBandwidth 290;
    rxPackets         326895;
    txPackets         1263198;
    rxErrors          0;
    txErrors          0;
    rxDropped         0;
    txDropped         0;
}
[ok]

Command Syntax

> show status system ethernetPort
	mgmtAdmin 
	mgmtPortStatus
	mgmtStatistics
	packetAdmin 
	packetPortStatus
	packetStatistics
	portMonitorStatus
	portRedundancyGroupStatus 

 Command Parameters

Ethernet Port Attributes

ParameterDescription
mgmtAdminManagement ports.
mgmtPortStatus

Management port status details.

  • ifIndex – The unique ifIndex of this management NIF"
  • linkState – The state of the interface.
    • admnDisabled
    • admnEnabledPortDown
    • admnEnabledPortUp
    • nifCreated
    • nifCreating 
    • null
  • macAddress – The MAC address of the network interface.
  • rxDropped – The number of packets dropped due to no receive buffers.
  • rxErrors – The number of bad packets received
  • rxPackets – The number of received packets.
  • txDropped – The number of packets dropped due to no transmit buffers.
  • txErrors – The number of packet transmit failures.
  • txPackets – The number of transmitted packets.
mgmtStatistics

Management port transmit and receive statistics.

  • rxDropped – The number of packets dropped due to no receive buffers.
  • rxErrors – The number of bad packets received.
  • rxPackets – The number of received packets.
  • txDropped – The number of packets dropped due to no transmit buffers.
  • txErrors  – The number of packet transmit failures.
  • txPackets – The number of transmitted packets.
packetPortStatus

Packet port status details.

  • allocatedBandwidth – The bandwidth (bytes/second) allocated for a particular port for active media streams.
  • bandwidthDeviation – The percentage of deviation of actual bandwidth from allocated bandwidth.
  • bandwidthUsage – The percentage of load (allocatedBandwidth) for a particular port using the formula:
    allocatedBandwidth / maxBandwidth * 100
  • ifIndex – The unique ifIndex of this Packet NIF.
  • linkState – The state of the interface.
    • admnDisabled 
    • admnEnabledPortDown 
    • admnEnabledPortUp 
    • null
  • macAddress – The MAC address of the metwork interface.
  • maxBandwidth – The maximum bandwidth that the port is capable of supporting. For example,

    • For SBC 7000 series platform, 95% of 10 GB port is 1,187,500,000 bytes/second.
    • For SBC 5000 series platform, 95% of 1 GB port is 118,750,000 bytes/second.
  • negotiatedSpeed – The interface speed.
  • rxActualBandwidth – The actual Rx bandwidth, which is used for a particular port (bytes/second).
  • txActualBandwidth – The actual Tx bandwidth, which is used for a particular port (bytes/second).
packetStatistics

Packet port transmit and receive statistics.

  • rxDropped – The number of packets dropped due to no receive buffers.
  • rxErrors – The number of bad packets received.
  • rxPackets – The number of received packets.
  • txDropped – The number of packets dropped due to no transmit buffers.
  • txErrors – The number of packet transmit failures.
  • txPackets – The number of transmitted packets.
portMonitorStatus 

The port monitor status.

  • <ceName> – The SBC server name
  • failures – Current number failures of this port monitor
  • faultState – The fault state of the physical port
    • failed
    • restored
    • unknown
  • linkFailures – The current number of link failures of this port monitor
  • linkState The state of the link monitor configured on this port in the link detection group. The linkState is set to “unknown” if link monitors are not configured.
    • failed
    • restored
    • unknown
  • macAddress – The MAC address associated with the physical port
  • pmName – The name of this port monitor.
  • portName – The name of the physical port.
  • prg – The name of the port redundancy group.
  • role – The role of the physical port
    • active
    • no_role
    • standby
  • state – The state of the physical port
    • down
    • unknown
    • up

 

portRedundancyGroupStatus

Status of the port redundancy group.

  • <host name> – The server host name.
  • failureCount – Total number of port monitor failures within this port redundancy group.
  • failures – The current number of port monitors within this port redundancy group that have declared themselves failed.

  • ifIndex – The unique ifIndex of this Packet NIF.

  • ifNum The unique ifNum of this Packet NIF.

  • interfaceType Interface Type of this port redundancy group.

    • mgmt
    • pkt
  • portMonitorCount The number of port monitors configured in this port redundancy group.

  • portName The name of physical/logical port.

  • primaryMacAddress The Primary MAC address of the network interface.

  • secondaryMacAddress The Secondary MAC address of the network interface.

License

Command Syntax

> show status system
    licenseDomainBundleInfo	
	licenseInfo
	licenseNodeLockedBundleInfo 
	licenseStatus 

Command Parameters

Note

The following object only applies to the show table system command:

  • licenseRequired

License Attributes

ParameterDescription

licenseDomainBundleInfo

License details for the domain licenses available on the SBC.

  • activeLicenseMode – The licensing mode currently in use by the SBC
  • bundleName – License bundle name
  • expirationDate – License expiration date
  • featureName – license keys for each licensed feature
  • generationDate – The date the license was generated
  • installDate – The date the license was installed
  • licenseId – License ID
  • lineId – The line ID for the license feature entry
  • purchaseOrderId – The purchase order ID specified when the license was generated
  • usageLimit – Usage limit for the licensed feature

licenseInfo

The license status for all license features or for a specified <featureName> <licenseID> combination.

  • <featureName> – license keys for each licensed feature:
    • DSP-AMRNB

    • DSP-AMRWB

    • DSP-EVRC

    • DSP-EVS

    • DSP-G722

    • DSP-SILK

    • ENCRYPT

    • POL-BASE

    • SBC-1X10GMP

    • SBC-4X1GMP

    • SBC-CAPACITY

    • SBC-LI

    • SBC-MRF-RTU

    • SBC-NICEREC

    • SBC-P-DCS-LAES

    • SBC-POL-E911

    • SBC-POL-ENUM

    • SBC-POL-RTU

    • SBC-PSX-RTU

    • SBC-RTU

    • SBC-SIP-I

    • SBC-SIP323

    • SBC-SIPREC

    • SBC-VIDEO

    • SRTP

    • SWE-INSTANCE

    • VDSP-RTU

  • <license ID> License identifier
  • expirationDate – The expiration date for a licensed feature
  • inUse – The number of licenses used by the SBC for this feature
  • licenseId – License identifier
  • source – Source of the license (BuiltIn, domain, or nodeLocked)
  • usageLimit – The maximum count allowed for this feature
licenseNodeLockedBundleInfo

License details for the legacy licenses stored on the SBC.

  • bundleName – License bundle name
  • featureName – license keys for each licensed feature
  • licenseId – License ID
  • expirationDate – License expiration date
  • usageLimit – Usage limit for the license
  • activeLicenseMode – The licensing mode currently in use by the SBC (domain/nodeLocked)
licenseRequired

Displays the licenseRequired configuration: The configured maximum number of licenses for a particular feature for a node when network-wide domain licensing is in effect.

  • featureNamelicense key for a licensed feature
  • maxCount – The maximum number of licenses the SBC can request from the SLS.

(Applies to 'show table' command only)

NOTE: This attribute only applies if the current licenseMode is "domain."

licenseStatus

The CE license status table describes the current CE license state, for example "dualCe".

  •   cemode

Network Processor

Command Syntax

> show status system networkProcessorStatistics
	annStatistics
	defragStatistics
	digitStatistics
	rtcpGenStatistics

Command Parameters

MultiExcerpt named Network Processor was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro

NTP

NTP services management

Command Syntax

> show status system ntp
	peerStatus
	systemStatus

Command Parameters

Note

The following objects only apply to the show table system command:

  • keys
  • serverAdmin
  • timeZone

NTP Attributes

ParameterDescription
keys

Displays NTP server key details.

  • keyId
  • keyType
  • keyValue
peerStatus

Displays status information about each NTP peer.

  • ceName – The name of this SBC server.
  • ipAddress – IP address of the CE.
  • state – the state of the NTP peer (insynce, outofsync, reachable).
  • stratum – A number representing the distance from the reference clock, starting at "0". Stratum 16 represents that a device is out of sync.
  • refTime – The time this NTP peer was last updated.
serverAdmin

Displays information about each NTP Server configured to provide network time.

  • ipAddress – The IP address of this NTP server.
  • version – The NTP version of this NTP server.
  • minPoll – The minimum poll interval to this NTP server.
  • maxPoll – The maxiimum poll interval to this NTP server.
  • state – The configured state of the NTP server entry.
systemStatus

Displays system status information about NTP.

  • ceName – The name of this SBC server.
  • clock – The SBC regularly checks system time. This field represents the system time as of the last check by SBC, not the actual system time.
  • refTime – The time this system was last updated.

timeZone

This table contains Time Zone configuration. Fields include:

  • name – System name.
  • zone – The current time zone.

NOTE: In an HA configuration, the Active and Standby system times and refTimes will not match in the results of this command because SBC updates NTP data independently.

Policy Server

Command Syntax

> show status system policyServer
	policyServerStatus

Command Parameters

Note

The following objects only apply to the show table system command:

  • globalConfig
  • localServer
  • policyServerStatus
  • remoteServer

Policy Server Attributes

 AttributeDescription
globalConfig

Defines global configuration applicable to all policy servers.

  • congestionControl – The SBC throttles the sending or policy requests to either active or standby PSX when this field is enabled.
  • mgmtInterfaceGroup – The Management Interface Group to use for communicating with external PSX.
  • reconnectTimeout – The timer parameter for re-attempting connection to a Policy Server that is in the enabled state in seconds.
  • switchOverMode – (automatic or manual) This setting determines how the policy server is set to ACTIVE after a switchover.
  • type – Interface type supported by policyServer.
localServer

Local (embedded) policy server configuration.

  • action – The action for the operation mode for this trunk group
  • keepAliveTimer – The time in seconds between sending Keep Alive indications to the internal Policy Server.
  • mode – Assignment of the Policy Server to have the active, standby, out of service or alternate role.
  • retries – The maximum number of retransmission attempts for a transaction on this Policy Server.
  • retryTimer – The time in milliseconds that the SBC waits for a response from the local Policy Server.
  • state – Administrative state of the softswitch server.
  • transactionTimer – The time in milliseconds that the SBC waits for a response from the Policy Server after sending it a transaction request.
policyServerStatus

Policy Server status table. Fields include:

  • allowancePercent – The number of SBC policy requests allowed by PSX. For example, an allowance of 75%, means that the SBC is skipping one out of every four policy requests. This allowance is provisioned on the PSX and enforced on the SBC when PSX Congestion Control is enabled.
  • averageTransactionTime – Records the average time taken in milliseconds for a softswitch transaction.

  • congestionLevel – The PSX congestion level.

  • dataRequests – The cumulative number of data requests received from the softswitch.

  • index – Identifies the softswitch entry.

  • interfaceIpAddress – Identifies the IP address the SBC uses to communicate with the PSX for this Policy Server.
  • ipAddress – IP Address of the softswitch server.

  • negotiatedVersion – The lowest negotiated protocol version between the gateway and all the active and alternate softswitches.

  • operState – Operational state of the softswitch.

  • queriesSkippedAndRejected – The cumulative number of rejected Policy Requests while the active PSX is congested and a standby PSX is either congested or not available.

  • queriesSkippedAndServiced – The cumulative number of Policy Requests serviced by the standby PSX while the active PSX experienced congestion.

  • redirectRequests – The cumulative number of redirect requests received from the softswitch.

  • releaseRequests – The cumulative number of release-call requests received from the softswitch.

  • serverReconnects – The number of successful reconnections between the gateway and the softswitch.

  • transactionCompleted – The number of successful transactions between the gateway and the softswitch.

  • transactionFailedAttempts – The number of unsuccessful transactions between the gateway and the softswitch.

  • transactionRetryAttempts – The number of transaction retries between the gateway and the softswitch.

  • version – The negotiated protocol version between the gateway and the softswitch.

remoteServer

Table of softswitch remote server configurations. Fields include:

  • name – Remote server name.
  • ipAddress – IP adddress of the remote server.
  • portNumber – The IP port number of the softswitch server.
  • state – Administrative state of the softswitch server.
  • mode – Policy Server mode (active, standby, out of service or alternate role).
  • action – The method by which queued transactions are processed when oper-state goes to standby or out-of-service. Possibilities include:
  • dryup all queue entries are processed to completion unless retries expires.
  • force – all queue transactions are dropped immediately.
  • transactionTimer – The time in milliseconds that the SBC waits for a response from the Policy Server after sending it a transaction request.
  • keepAliveTimer – The time in seconds between sending Keep Alive indications to the Policy Server.
  • retryTimer – The time in milliseconds that the SBC waits for a response from the Policy Server after retransmitting the transaction request.
  • retries – The maximum number of retransmission attempts for a transaction on this Policy Server.
  • subPortNumber – The port number assigned for the IP address of the Policy Server for the specific purpose of communicating subscriber data.

Security

Security management status/statistics details.

Command Syntax

> show status system security
	ocspProfileUses
	ocspStatistics
	pki

 

Command Parameters

Note

The following objects only apply to the show table system command:

  • certExpiryCheck
  • ipsec

Security Attributes

ParameterDescription
certExpiryCheck

Checks for expired certificates, trust anchor validity, and if certificates have been revoked if OSCP is enabled. Fields include:

  • certReCheckRate – The rate, in hours, to recheck certificates for TLS sessions.
  • expirationPeriodicWarning – Interval of the periodic warnings in days generated after the certificate has reached the expiry threshold.
  • expiryWarningThreshold – The number of days before generating a warning for a certificate nearing expiry.
hashEventLogsShows the existence of an entry in the PrivateKeyName fields. If there is a PrivateKeyName entry displayed, this indicates that a private key is configured.
ipsec

IPsec configuration.

  • ikeDpdInterval – The Dead Peer Detection interval.
  • ikeRetransmitInterval – The IKE retransmit interval period in seconds.
  • ikeRetrasmitCount – The number of IKE retransmits.
ocspProfileUses

 This table contains OCSP profile usage status. Fields include:

  • ocspName
  • tlsName
  • ocspTlsRefNum
ocspStatistics 

This table contains OCSP Statistics. Fields include:

  • ocspInternalErrors – Number of internal error responses.
  • ocspMalformedRequests – Number of malformed request responses.
  • ocspRepondersUnreachable – Number of times OCSP responders are unreachable.
  • ocspRequestAttempts – Number of OCSP request attempts that have been made.
  • ocspResponseTimeouts – Number of times OCSP response timeouts are encountered.
  • ocspResponsesGood – Number of OCSP Responses received with 'Good' status.
  • ocspResponsesRevoked – Number of OCSP Responses received with 'Revoked' status.
  • ocspResponsesUnknown – Number of OCSP Responses received with 'Unknown' status.
  • ocspSigRequired – Number of 'sigRequired' responses.
  • ocspTryLaters – Number of 'tryLater' responses.
  • ocspUnauthorized – Number of unauthorized responses.
pki
  • certStatistics– Certificate statistics.
    • caCerts – Number of installed CA/remote certificates.
    • localCerts – Number of installed local certificates.
  • certificate – Collection of certificates configured on the SBC.
    • encoding – The encoding type of the certificate.

    • fileName – The certificate content file name

    • passPhrase – Pass-phrase to decrypt RSA private key in PKCS12 file.

    • state – The administration state of this certificate.

    • status – The status of the certificate.

    • type – The type of the certificate:

      • remote – certificate is imported from remote location.

      • local – certificate is used locally.

      • local-internal – local certificate with private key generated on the SBC.

Command Examples

To view announcements memory usage:

Click to expand

 

To view base MAC address:

Click to expand 

 

To view coredump list:

Click to expand

 

To view Daughterboard status (SBC 7000 example is below):

Click to expand

 

To view DSP usage:

Note

This example includes several results in the form of <codec>V8Total or <codec>V8Utilization. These entries apply if you allowed support for T.38 version 3 (also called V.34 fax transcoding). If you enabled T.38 version 3, you must enable a V.8 signaling detector for all voice codecs.

Click to expand 

 

To view Ethernet Port packet statistics:

Click to expand

 

To view hard disk usage:

Click to expand

 

To view systemCongestionIntervalStatistics:

Click to expand

 

To view system congestion status details.

Click to expand 

 

To view system congestion current  statistics.

Click to expand 

 

To view Micro Flow stats:

Click to expand 

 

To display the current HA configuration settings:

Click to expand

 

To display the D-SBC Sig Port statistics:

Click to expand

 

To display sync status of active and standby nodes created through a N:1 redundancy group:

Click to expand 

To view the status of the Load Balancing Service on S-SBC:

Click to expand 

To view the status of the Load Balancing Service on M-SBC:

Click to expand