DO NOT SHARE THESE DOCS WITH CUSTOMERS!

This is an LA release that will only be provided to a select number of PLM-sanctioned customers (PDFs only). Contact PLM for details.

In this section:

Related articles:

 

Use the request oam command to perform the following OAM actions.

  • Accounting – Force a server to be the current server, or reset CDR statistics
  • Alarms – Reset IP Policing Alarm stats
  • Event Log – Reset filter stats, roll over an event log or re-enable info level logging
  • Local Auth –  Enable or disable a user account; add, delete or view an RSA key.

Accounting

Command Syntax

> request oam accounting cdrServer admin <primary | secondary>
	forceCurrentServer  - Set this server to be the current
	generateSshPublicKeys - Generate SSH public key
	resetCdrServerStats - Reset the CDR server statistics 

Command Parameters

OAM Accounting Parameters

Parameter

Description

forceCurrentServer

Use this request parameter to forcibly set the specified server (primary or secondary) as the current server.

generateSshPublicKeys

Use this request to generate the SSH public key to authenticate remote CDR servers.

resetCdrServerStats

Use this request parameter to reset the CDR server statistics for the specified server (primary or secondary).

Alarms

Command Syntax

> request oam alarms resetIpPolicingAlarmStatus

Command Parameter

OAM Alarm Parameter

Parameter

Description

 resetIpPolicingAlarmStatus Resets the statistics in the IP policing alarm status.

Event Log

Command Syntax

> request oam eventLog
	filterStatus
	infoLevelLoggingEnable
	typeAdmin	

> request oam eventLog filterStatus <node name>
	<event_type: audit | debug | security | system | trace>
	<event_class: audit | callproc | directory | netmgmt | policy |  resmgmt | routing | security | signaling | sysmgmt | trace>
	resetStats

> request oam eventLog infoLevelLoggingEnable clearInfoLevelLoggingDisabled 

> request oam eventLog typeAdmin <event_type: acct | audit | debug | packet | security | system | trace> rolloverLogNow

Command Parameters

Filter Status

Filter Status Event Log Parameters

Parameter

Description

filterStatus

Event log class filter status table.

<system name>

SBC system name.

<event type>

The type of event log:

  • audit – System audit data. These files contain a record of all management interactions that modify the state of the system, and includes all the changes made via the CLI and the Netconf interface. These files use .AUD extensions.
  • debug – System debugging data. These files have .DBG extensions.
  • memusage – Process heap memory usage data. These files have .MEM extensions.
  • security – Security level events. These files have .SEC extensions.
  • system – System level events. These files have .SYS extensions.
  • trace – System trace data. These files have .TRC extensions.

<event class>

Event class for each event type:

  • audit – Audit subsystem.
  • callproc – Call Processing subsystem.
  • directory – Directory Services subsystem.
  • netmgmt – Network Management subsystem.
  • policy – Policy subsystem.
  • resmgmt – Resource Management subsystem.
  • routing – Network Routing subsystem.
  • security – Security subsystem.
  • signaling – Signaling subsystem.
  • sysmgmt – System Management subsystem.
  • trace – Call Trace subsystem.

resetStats

Use this control to reset the value of Events Filtered column of the filterStatus display.

Info Level Logging Enable

Info Level Logging Enable Event Log Parameter

Parameter

Description

clearInfoLevelLoggingDisabled

Use this command to re-enable info level logging after it becomes disabled due to system congestion. If this command is executed while the system is still congested, this may cause the system to become further congested.

Note: Only issue this command once system congestion dissipates. The system may become further congested if this command is executed while the system is still congested

Type Admin

Type Admin Event Log Parameters (request command)

Parameter

Description

typeAdmin

Event Log configuration table for configuration items related to each Event Log type.

<event_type>

Specifies the type of event log to roll over:

  • acct – System account data. These files have .ACT extensions.
  • audit – System audit data. These files contain a record of all management interactions that modify the state of the system. These files have .AUD extensions. It  includes   all the changes made via the CLI and the Netconf interface. (This attribute is only available to an Administrator)
  • debug – System debugging data. These files have .DBG extensions.
  • memusage – Process heap memory usage data. These files have .MEM extensions.
  • packet – Packet information details. These files have .PKT extensions. If enabled, stores the packet details to .PKT files.
  • security – Security level events. These files have .SEC extensions. (This attribute is only available to an Administrator)
  • system – System   level events. These files have .SYS extensions.
  • trace – System trace data. These files have .TRC extensions.

rolloverLogNow

This control is used with request command to perform a roll-over of the specified log immediately.

Local Auth

Command Syntax

> request oam localAuth userStatus <account name> 
	deleteRsaKey keyName <key name>
	disable
	enable
	setRsaKey 
		keyName <key name>
		rsaKey <key>
	showRsaKey

Command Parameters

OAM Local Auth Parameter

Parameter

Description

userStatus 

<account name> – The user account name to execute this command against.

deleteRsaKey

Use this parameter to delete the specified RSA key.

  • keyName –
disableDisable the specified user account.
enableEnabled the specified user account.
setRsaKey

Use this parameter to add an RSA public key. The SBC supports up to five RSA keys.

  • keyName – Unique name/number as a future reference to the rsaKey
  • rsaKey – RSA public key

NOTE: The RSA public key must use at least 2048-bit strength and be in one of the following formats:

  • PEM
  • PKCS8
  • RFC4716
  • OpenSSH

 

showRsaKeyUse this command to display the configured RSA public key(s).

 

Command Examples

To set an RSA key:

> request oam localAuth userStatus admin setRsaKey keyName Orkney rsaKey "ssh-rsa
AAAAB3NzaC1yc2EAAAADAQABAAABAQDEQFsIKJx8YqUsrenlSdeBDaaC7okxXKsEjiPQR8V8UnpTMMYqnkyd7ZMvvYgJkEbjxVbunv0S3y+6GN0FVndbV9y9KFNeeTOyTCrokhE4Z2YKmIrGHHqZJ8Gk9/CNS39HLC43I3tn4EPlyQLLZ9S7EVpk7/opzk7z2GkmdG+eYqLWwrK8CFS+oXyWGpXr7KSU22/N8uVa6qLhVMxGzvFf4RKJd6HJuktOihjFsm5aN2LQbjbkVJoPEPjd6dlXKf9/MHc8stHXekdJtxY0kLjJ9GI5zYhJjm5XdU0i31AYE/7j/DM6UgpUSDB1SuEbzapDQmEaEI4+Nj9/hMVK1WIT"
result success 
reason Request to add RSA Key for the user admin is successful

 

To delete an RSA key:

Example
> request oam localAuth userStatus admin deleteRsaKey keyName Orkney
result success
reason
Request to delete SSH key for user admin is successful.

 

To view an RSA key:

Example
> request oam localAuth userStatus admin showRsaKey
result success
reason success
rsaKey1 SBX ssh-rsa
AAAAB3NzaC1yc2EAAAADAQABAAABAQDEQFsIKJx8YqUsrenlSdeBDaaC7okxXKsEjiPQR8V8UnpTMMYqnkyd7ZMvvYgJkEbjxVbunv0S3y+6GN0FVndbV9y9KFNeeTOyTCrokhE4Z2YKmIrGHHqZJ8Gk9/CNS39HLC43I3tn4EPlyQLLZ9S7EVpk7/opzk7z2GkmdG+eYqLWwrK8CFS+oXyWGpXr7KSU22/N8uVa6qLhVMxGzvFf4RKJd6HJuktOihjFsm5aN2LQbjbkVJoPEPjd6dlXKf9/MHc8stHXekdJtxY0kLjJ9GI5zYhJjm5XdU0i31AYE/7j/DM6UgpUSDB1SuEbzapDQmEaEI4+Nj9/hMVK1WIT
rsaKey2
rsaKey3
rsaKey4
rsaKey5

 

  • No labels