The command syntax and parameters of the objects related to the show table oam
command is shown below.
Multiexcerpt |
---|
MultiExcerptName | OamSyntax |
---|
|
AccountingCommand Syntax Code Block |
---|
| > show table oam accounting
admin
earlyAttemptState
eventAcctMethods
eventAcctPsxInfoState
eventAcctState
generationMode
intermediateAcctInterval
intermediateAcctMode
intermediateAcctState
intermediateLongDurGenTime
intermediateLongDurThreshold
intermediateTrapState
maxRecordSequenceNum
populateIpTgFarEndSwitchType
populateNonPortedLnpNumbers
populateRemoteGsxInfoState
secondStageInheritFirstStage
sendEgressCdrInfoOnReceipt
startAcctState
cdrServer
admin
type
ipAddress
cdrPort
useSshKeyFile
username
password
path
filePrefix
filePostfix
connectionTimeout
transferTimeout
bufferSize
status <primary or secondary>
failedTransfers
pendingTransfers
progress
state
successfulTransfers
radius
accountingAdmin
failoverPolicy
maxErrorRate
maxNoResponseTime
maxPacketRetryCount
maxQueuedPacketsInMemory
nasIdentifier
nasIpAddress
radiusUserDetails
sendNasIdentifier
sendNasIpAddress
state
radiusServer
radiusServerStatus |
Command Parameters Caption |
---|
0 | Table |
---|
1 | Shared Accounting Parameters - 'show status oam' and 'show table oam' |
---|
|
Parameter | Description |
---|
admin | Call CDR configuration. earlyAttemptState – Identifies whether early ATTEMPT accounting is enabled or disabled.eventAcctMethods – Log event records for the methods specified in the configuration.
eventAcctPsxInfoState – EVENT records relating to PSX are generated if enabled.
eventAcctState – EVENT records are generated if enabled.
generationMode – Identifies the accounting generation mode for the node.intermediateAcctInterval – Identifies the Intermediate Accounting Interval in seconds NOTE: this object is only applicable when sonusAcctIntAcctMode is set to "interval(1)".intermediateAcctMode – Identifies the intermediate record generation mode for the node.intermediateAcctState – Identifies whether Intermediate Accounting is Enabled or Disabled for the NodeintermediateLongDurGenTime – Octet string that identifies the GMT time to generate Telcordia Long Duration accounting records.intermediateLongDurThreshold – Identifies the Accounting Intermediate Records Duration in hours.intermediateTrapState – Identifies whether a trap will be generated whenever an INTERMEDIATE record is generated.maxRecordSequenceNum – Specifies the maximum record sequence number for logging the CDR records.populateIpTgFarEndSwitchType – Specifies whether or not Ingress Far End Switch Type is used to passed down from the PSX the IP trunk group for SIP ingress calls.populateNonPortedLnpNumbers – Specifies whether or not to populate the Called Number Before Translation field in the accounting record under the following conditions: 1) for a number for which an LNP lookup was performed 2) the lookup indicated that the number has not been ported.populateRemoteGsxInfoState - Identifies whether a destination SBC propagates its billing data to originating GSX/SBC for GW-GW calls.secondStageInheritFirstStage - This indicates whether or not second stage accounting records for two-stage calls inherit fields from the first stage call.sendEgressCdrInfoOnReceipt - This indicates whether or not to send the egress CDR info immediately after receiving and processing it.startAcctState - Identifies whether Start Accounting is enabled or disabled for the node.
| cdrServer | Configuration for external CDR servers. admin (not available with 'show status' command)
type ipAddress cdrPort useSshKeyFile username password path filePrefix filePostfix connectionTimeout transferTimeout bufferSize status type state progress successfulTransfers failedTransfers pendingTransfers
| radius | Configuration for external Radius servers. accountingAdmin failoverPolicy maxErrorRate maxNoResponseTime maxPacketRetryCount maxQueuedPacketsInMemory nasIdentifier nasIpAddress sendNasIdentifier sendNasIpAddress state
radiusServer radiusServerStatus radiusUserDetails
|
|
AlarmsCommand Syntax Code Block |
---|
| > show table oam alarms
ethernetCrcErrAlarm
ethernetCrcErrAlarmStatus
ipPolicingAlarmAdmin
majorAlarmMode
majorAlarmProfileName
minorAlarmMode
minorAlarmProfileName
ipPolicingAlarmStatus
aclAlarmDuration
aclAlarmLevel
aclDiscardRate
aclPacketsAccepted
aclPacketsDiscarded
aggregateAlarmDuration
aggregateAlarmLevel
aggregateDiscardRate
aggregatePacketsAccepted
aggregatePacketsDiscarded
arpAlarmDuration
arpAlarmLevel
arpDiscardRate
arpPacketsAccepted
arpPacketsDiscarded
badEthernetIpHeaderAlarmDuration
badEthernetIpHeaderAlarmLevel
badEthernetIpHeaderDiscardRate
badEthernetIpHeaderPacketsDiscarded
discardRuleAlarmDuration
discardRuleAlarmLevel
discardRuleDiscardRate
discardRulePacketsDiscarded
ipSecDecryptAlarmDuration
ipSecDecryptAlarmLevel
ipSecDecryptDiscardRate
ipSecDecryptPacketsDiscarded
mediaAlarmDuration
mediaAlarmLevel
mediaDiscardRate
mediaPacketsDiscarded
rogueMediaAlarmDuration
rogueMediaAlarmLevel
rogueMediaDiscardRate
rogueMediaPacketsDiscarded
srtpDecryptAlarmDuration
srtpDecryptAlarmLevel
srtpDecryptDiscardRate
srtpDecryptPacketsDiscarded
uFlowAlarmDuration
uFlowAlarmLevel
uFlowDiscardRate
uFlowPacketsAccepted
uFlowPacketsDiscarded
mediaSrtpErrAlarm
mediaSrtpErrAlarmStatus |
Command Parameters Caption |
---|
0 | Table |
---|
1 | Shared Alarm Parameters - 'show status oam' and 'show table oam' |
---|
|
Parameter | Description |
---|
ethernetCrcErrAlarm | This table contains Ethernet CRC error alarm configuration. | ethernetCrcErrAlarmStatus | This table contains the Ethernet CRC error alarm status, with following fields: <interface name> currentErrRate maxErrRate totalCrcErrors numAlarmsRaised currentAlarmState
| ipPolicingAlarmAdmin | This table contains system policer alarm configuration. majorAlarmMode majorAlarmProfileName minorAlarmMode minorAlarmProfileName
| ipPolicingAlarmStatus | This table contains system policer alarm status. aclAlarmDuration aclAlarmLevel aclDiscardRate aclPacketsAccepted aclPacketsDiscarded aggregateAlarmDuration aggregateAlarmLevel aggregateDiscardRate aggregatePacketsAccepted aggregatePacketsDiscarded arpAlarmDuration arpAlarmLevel arpDiscardRate arpPacketsAccepted arpPacketsDiscarded badEthernetIpHeaderAlarmDuration badEthernetIpHeaderAlarmLevel badEthernetIpHeaderDiscardRate badEthernetIpHeaderPacketsDiscarded discardRuleAlarmDuration discardRuleAlarmLevel discardRuleDiscardRate discardRulePacketsDiscarded ipSecDecryptAlarmDuration ipSecDecryptAlarmLevel ipSecDecryptDiscardRate ipSecDecryptPacketsDiscarded mediaAlarmDuration mediaAlarmLevel mediaDiscardRate mediaPacketsDiscarded rogueMediaAlarmDuration rogueMediaAlarmLevel rogueMediaDiscardRate rogueMediaPacketsDiscarded - srtpDecryptAlarmDuration
- srtpDecryptAlarmLevel
- srtpDecryptDiscardRate
- srtpDecryptPacketsDiscarded
uFlowAlarmDuration uFlowAlarmLevel uFlowDiscardRate uFlowPacketsAccepted uFlowPacketsDiscarded
| mediaSrtpErrAlarm | This table contains Media SRTP Authorization error alarm configuration. | mediaSrtpErrAlarmStatus | This table contains the Media SRTP authorization error alarm status, with following fields: <system name> currentErrRate maxErrRate totalSrtpErrors numAlarmsRaised currentAlarmState
|
|
EMACommand Syntax Code Block |
---|
| > show table oam ema clientAuthMethod |
Command Parameter Caption |
---|
0 | Table |
---|
1 | EMA Parameter - 'show table oam' only |
---|
|
Parameter | Description |
---|
clientAuthMethod
| Show EMA current setting of client authorization method. |
|
Event LogCommand Syntax Code Block |
---|
| > show table oam eventLog
confdDebugLevel
dataAgentAdmin
dataAgentStatus
filterAdmin
filterStatus
memusage
platformAuditLogs
platformRsyslog
subsystemAdmin
typeAdmin
typeStatus |
Command Parameters Caption |
---|
0 | Table |
---|
1 | Shared Event Log Parameters - 'show status oam' and 'show table oam' |
---|
|
Parameter | Description |
---|
confdDebugLevel | Current debug level for ConfD components | . dataAgentAdmin
| Configuration for sending logs to a remote data warehouse. | dataAgentStatus | Status of the remote data warehouse. | filterAdmin | Event Log Class Filter configuration table per card, with following fields (not available for 'show status' command) :
ceName type – event typeeventClass level state
| filterStatus | Event Log Class Filter status table per card, with following fields: ceName type – event typeeventClass eventsFiltered – Number of events filtered for the associated event type and class.
| memusage
| Process memory usage logging controls. | platformAuditLogs | Platform audit logs configuration. state – Administrative state of platform audit logging.
Note: Not availiable for 'show status' command. | platformRsyslog | Syslog configuration for platform Linux logs, with the fields: syslogState servers (table) linuxLogs (table)
Note: Not available for 'show status' command. | subsystemAdmin | Subsystem Event Logging configuration table, with the fields (not available for 'show status' command): ceName systemId infoLogState minEventId maxEventId
| typeAdmin | Event Log configuration table for configuration items related to each Event Log type, with following fields (not available for 'show status' command): type state fileCount fileSize messageQueueSize saveTo filterLevel rolloverStartTime rolloverInterval rolloverType rolloverAction fileWriteMode syslogState renameOpenFiles - diskThrottleLimit
eventLogValidation - serverNo
- syslogRemoteHost
- syslogRemoteProtocol
- syslogRemotePort
| typeStatus | Event Log status table for status items related to each Event Log type, with following fields: type currentFile fileRecords fileBytes totalFiles totalFileBytes filesDropped nextRollover logDestination lastFileDrop infoLevelLoggingDisabled
|
|
LDAP AuthenticationThe OAM statistic, ldapAuthentication, provides LDAP server status details. Command Syntax Code Block |
---|
% show table oam ldapAuthentication ldapStatus |
Command ParametersParameter | Description |
---|
ldapStatus | LDAP server status details. The following fields are included. serverName – LDAP server namestatus – Either available or unavailableavailableAt – The time when the server is automatically put back into the "available" state.
|
Local AuthCommand Syntax Code Block |
---|
| > show table oam localAuth
user
userStatus |
Command Parameters Caption |
---|
0 | Table |
---|
1 | Shared Local Auth Parameters - 'show status oam' and 'show table oam' |
---|
|
Parameter | Description |
---|
user | AAA services management, with following fields: name – User name.
group – The group that the user is a member of.accountAgingState – The state of account expiry for the user.
interactiveAccess – Whether the user is allowed to access interactive interfaces like CLI/EMA.
m2mAccess – Whether the user is allowed to access machine to machine interfaces like REST.
passwordAgingState – The state of password expiry for the user.
passwordLoginSupport – Whether the user is allowed to login using password.
| userStatus | Current status of the specified user, with following fields: name – User name.currentStatus – Current status of the user account.userId – User ID number.
|
|
Radius AuthenticationCommand Syntax Code Block |
---|
| > show table oam radiusAuthentication
radiusServer
radiusStatus
retryCriteria |
Command Parameters Caption |
---|
0 | Table |
---|
1 | CLI Statistics Details for 'show status' |
---|
3 | CLI Statistics Details for 'show status' |
---|
|
Parameter | Details |
---|
radiusServer
| Displays RADIUS server name of each server. The following field is included. -
radiusServer – Name of radius server
| radiusStatus | RADIUS server status details. The following fields are included. status – Either available or unavailableavailableAt – The time when the server is automatically put back into 'available' state.
|
|
Caption |
---|
0 | Table |
---|
1 | CLI Statistics Details for 'show table' |
---|
3 | CLI Statistics Details for 'show table' |
---|
|
Parameter | Details |
---|
radiusServer
| RADIUS server configuration details of each server. The following field is included. serverName – RADIUS server namepriority – The order the SBC uses to attempt RADIUS authentication. The RADIUS server with the lowest priority is contacted first.state – Operational state of the RADIUS server.radiusServerIp – IPv4 address of the RADIUS server.radiusServerPort – The RADIUS server port to which the SBC sends the request.radiusNasIp – IPv4 address of the SBC to send in ACCESS_REQUESTradiusSharedSecret – The shared secret used to encrypt the data exchanged between SBC and RADIUS server.mgmtInterfaceGroup – Name of the Management Interface Group to connect to this RADIUS server.
| radiusStatus | RADIUS server status details. The following fields are included. serverNameId – RADIUS server namestatus – Either available or unavailableavailableAt – The time when the server is automatically put back into 'available' state.
| retryCriteria | RADIUS server Retry criteria settings. The following fields are included. retryTimer – Time in milliseconds before the SBC attempts another authentication request.retryCount – Number of retries the SBC uses to attempt authentication.oosDuration – Time in minutes the RADIUS server remains out of service after a timeout.
|
|
SNMPCommand Syntax Code Block |
---|
| > show table oam snmp
community engineId
trapTarget
fqdn
ipAddress
port
state
trapType
|
Command Parameters Caption |
---|
0 | Table |
---|
1 | Shared SNMP Parameter - 'show status oam' and 'show table oam' |
---|
|
Parameter | Description |
---|
community | This table contains SNMP community information. | communityString | This table contains SNMP community strings used in a SNMP request, with following fields: snmpCommunityIndex snmpCommunityName
| localEngineId
| SNMPv3 SNMP-USER-BASED-SM-MIB usmUserEngineID and SNMP-COMMUNITY-MIB snmpCommunityContextEngineID | securityLevel
| SNMPv3 SNMP-VIEW-BASED-ACM-MIB vacmAccessSecurityLevel for all users in model 0 and 3. | trapTarget
| Trap target configuration details, with following fields: name fqdn ipAddress port trapType targetUsername targetSecurityLevel state
| users | Auth key and Priv key details for each user, with following fields: username group authProtocol authKey privProtocol privKey
| version | SNMP version currently supported. |
|
TrapsCommand Syntax Code Block |
---|
| > show table oam traps
admin <traps>
dspAdmin
callFailureTrap lackdsp
interval
threshold
dspAvailabilityTrap
allThreshold
g711PacketThreshold
g726Threshold
g729Threshold |
Command Parameters Caption |
---|
0 | Table |
---|
1 | Traps Parameters - 'show table oam' only |
---|
|
Parameter | Description |
---|
admin | The sonusTrapTable identifies the SNMP notifications that this node supports. | dspAdmin | DSP resource usage trap configuration. callFailureTrap lackdsp – Trap configuration for Call Failure due to no DSP.dspAvailabilityTrap – DSP Availability trap threshold configuration.allThreshold – Indicates the percentage DSP Availability threshold for all types.
g711PacketThreshold – Indicates the percentage of G711 Packet type DSP Availability threshold.
g726Threshold – Indicates the percentage of G726 type DSP Availability threshold.
g729Threshold – Indicates the percentage of G729 type DSP Availability threshold.
|
|
|
Command Examples
To view Event Log filter status:
Code Block |
---|
|
admin@sbx1> show table oam eventLog filterStatus
EVENT EVENTS
CE NAME TYPE CLASS FILTERED
----------------------------------------
cesbx15 system sysmgmt 509
cesbx15 system callproc 0
cesbx15 system resmgmt 1
cesbx15 system directory 0
cesbx15 system netmgmt 0
cesbx15 system signaling 0
cesbx15 system routing 6
cesbx15 system trace 0
cesbx15 system security 0
cesbx15 system policy 0
cesbx15 system audit 0
cesbx15 debug sysmgmt 627259
cesbx15 debug callproc 0
cesbx15 debug resmgmt 84365
cesbx15 debug directory 1
cesbx15 debug netmgmt 0
cesbx15 debug signaling 14506502
cesbx15 debug routing 162
cesbx15 debug trace 0
cesbx15 debug security 0
cesbx15 debug policy 0
cesbx15 debug audit 0
cesbx15 trace sysmgmt 0
cesbx15 trace callproc 0
cesbx15 trace resmgmt 0
cesbx15 trace directory 0
cesbx15 trace netmgmt 0
cesbx15 trace signaling 0
cesbx15 trace routing 0
cesbx15 trace trace 0
cesbx15 trace security 0
cesbx15 trace policy 0
cesbx15 trace audit 0
cesbx15 security sysmgmt 0
cesbx15 security callproc 0
cesbx15 security resmgmt 0
cesbx15 security directory 0
cesbx15 security netmgmt 0
cesbx15 security signaling 0
cesbx15 security routing 0
cesbx15 security trace 0
cesbx15 security security 1
cesbx15 security policy 0
cesbx15 security audit 0
cesbx15 audit sysmgmt 0
cesbx15 audit callproc 0
cesbx15 audit resmgmt 0
cesbx15 audit directory 0
cesbx15 audit netmgmt 0
cesbx15 audit signaling 0
cesbx15 audit routing 0
cesbx15 audit trace 0
cesbx15 audit security 0
cesbx15 audit policy 0
cesbx15 audit audit 0 |
To view Event Log configuration of event log types:
Code Block |
---|
|
admin@SBXUK11-1> show table oam eventLog typeAdmin
MESSAGE ROLLOVER FILE RENAME DISK SYSLOG SYSLOG SYSLOG
FILE FILE QUEUE SAVE FILTER START ROLLOVER ROLLOVER WRITE SYSLOG OPEN THROTTLE EVENT LOG SERVER REMOTE REMOTE REMOTE
TYPE STATE COUNT SIZE SIZE TO LEVEL TIME INTERVAL ROLLOVER TYPE ACTION MODE STATE FILES LIMIT VALIDATION NO HOST PROTOCOL PORT
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
system enabled 32 2048 10 disk major - 0 nonrepetitive stop default disabled disabled 5000 disabled server1 0.0.0.0 tcp 514
debug enabled 32 2048 10 disk major - 0 nonrepetitive stop default disabled disabled - disabled server1 0.0.0.0 tcp 514
trace enabled 32 2048 10 disk info - 0 nonrepetitive stop default disabled disabled - disabled server1 0.0.0.0 tcp 514
acct enabled 32 2048 10 disk major - 0 nonrepetitive stop default disabled disabled - disabled server1 0.0.0.0 tcp 514
security enabled 32 2048 10 disk major - 0 nonrepetitive stop default disabled disabled - disabled server1 0.0.0.0 tcp 514
audit enabled 32 2048 10 disk info - 0 nonrepetitive stop default disabled disabled - disabled server1 0.0.0.0 tcp 514
packet enabled 32 2048 10 disk major - 0 nonrepetitive stop default disabled disabled - disabled server1 0.0.0.0 tcp 514
memusage enabled 32 2048 10 disk major - 0 nonrepetitive stop default disabled disabled - disabled server1 0.0.0.0 tcp 514
[ok][2018-08-13 16:46:32]
|
To view status items related to each Event Log:
Code Block |
---|
|
admin@sbx1> show table oam eventLog typeStatus
INFO
TOTAL LEVEL
CURRENT FILE FILE TOTAL FILE FILES NEXT LOG LOGGING
TYPE FILE RECORDS BYTES FILES BYTES DROPPED ROLLOVER DESTINATION LAST FILE DROP DISABLED
--------------------------------------------------------------------------------------------------------------------------
system 1000003.SYS 177 23512 3 58587 0 0 localDisk 0000-00-00T00:00:00+00:00 false
debug 1000003.DBG 338 36667 3 70576 0 0 localDisk 0000-00-00T00:00:00+00:00 false
trace 1000003.TRC 0 128 3 478 0 0 localDisk 0000-00-00T00:00:00+00:00 false
acct 1000003.ACT 1 206 3 634 0 0 localDisk 0000-00-00T00:00:00+00:00 false
security 1000003.SEC 2 323 3 1275 0 0 localDisk 0000-00-00T00:00:00+00:00 false
audit 1000003.AUD 36 6482 3 12294 0 0 localDisk 0000-00-00T00:00:00+00:00 false
packet 1000003.PKT 0 128 3 176 0 0 localDisk 0000-00-00T00:00:00+00:00 false |
To view local authorization configuration details:
Code Block |
---|
|
user admin {
group Administrator;
passwordAgingState enabled;
accountAgingState disabled;
passwordLoginSupport enabled;
interactiveAccess enabled;
m2mAccess disabled;
}
userStatus admin {
currentStatus Enabled;
userId 3000;
}
|
To view SNMP community string:
Code Block |
---|
|
admin@sbx1> show table oam snmp communityString
SNMP SNMP
COMMUNITY COMMUNITY
INDEX NAME
----------------------
admin admin
guest guest
operator operator |
To view the OAM statistic, LDAP server status details:
Code Block |
---|
show table oam ldapAuthentication ldapStatus
SERVER AVAILABLE
NAME STATUS AT
---------------------------------
ldapServer1 available n/a |
To view OAM users Auth and Priv key information:
Code Block |
---|
|
admin@sbx1> show table oam snmp users
AUTH PRIV
USERNAME GROUP PROTOCOL AUTH KEY PROTOCOL PRIV KEY
------------------------------------------------------------------------------------------
admin admin hmacsha 00:00:00:00:00:00:00:00 aes128 00:00:00:00:00:00:00:00
guest guest hmacsha 00:00:00:00:00:00:00:00 aes128 00:00:00:00:00:00:00:00
operator operator hmacsha 00:00:00:00:00:00:00:00 aes128 00:00:00:00:00:00:00:00 |
To view RADIUS authentication details:
Code Block |
---|
language | none |
---|
title | Statistics Examples |
---|
|
> show status oam radiusAuthentication radiusServer
radiusServer s1;
> show status oam radiusAuthentication radiusStatus
radiusStatus s1 {
status available;
availableAt n/a;
> show table oam radiusAuthentication radiusServer
RADIUS RADIUS RADIUS RADIUS MGMT
SERVER SERVER SERVER NAS IP SHARED INTERFACE
NAME PRIORITY STATE IP PORT SECRET GROUP
--------------------------------------------------------------------------------
s1 1 enabled 10.54.90.107 1812 0.0.0.0 - -
> show table oam radiusAuthentication radiusStatus
SERVER
NAME AVAILABLE
ID STATUS AT
----------------------------------------
s1 available n/a
> show table oam radiusAuthentication retryCriteria
retryTimer 2000;
retryCount 2;
oosDuration 120; |
To view CDR Server admin details:
Code Block |
---|
> show table oam accounting cdrServer admin
USE
SSH
IP CDR KEY FILE CONNECTION TRANSFER
TYPE ADDRESS PORT FILE USERNAME PASSWORD PATH PREFIX TIMEOUT TIMEOUT
---------------------------------------------------------------------------------------------------------
primary 10.10.10.10 22 enable admin $3$6ukQCu3ULEw= "testPath "cdr 15 15 |
To view Platform Audit Logs configuration details:
Code Block |
---|
admin@WFDSBC01b> show table oam eventLog platformAuditLogs
state enabled; |
To view platformRsyslogConfig details:
Code Block |
---|
admin@SBXUK11-1> show configuration details oam eventLog platformRsyslog
syslogState disabled;
linuxLogs {
platformAuditLog disabled;
consoleLog disabled;
sftpLog disabled;
kernLog disabled;
userLog disabled;
daemonLog disabled;
authLog disabled;
syslogLog disabled;
ntpLog disabled;
cronLog disabled;
fipsLog disabled;
}
servers server1 {
remoteHost 0.0.0.0;
protocolType tcp;
port 515;
}
[ok][2018-08-13 11:10:39] |
Error Messages
Include Page |
---|
| NP0_Error_Counter_Message |
---|
| NP0_Error_Counter_Message |
---|
|