Versions Compared

Old Version 6

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Add_workflow_for_techpubsAUTH1JIRAIDAUTHSBX-51758REV5REV6JIRAIDAPPR2SBX-51760REV3JIRAIDAPPRSBX-51759REV1

 

Panel

In this section:

Table of Contents
maxLevel3

Info
iconfalse

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.
  • Local Auth - show RSA key –  View the configured RSA keys.
  • Local Auth - set RSA key –  Add an RSA key.
  • Local Auth - delete RSA key –  Delete ; add, delete or view an RSA key.

Anchor
accounting
accounting
Accounting

Command Syntax

Code Block
languagenone
> 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

Caption
0Table
1OAM 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).

Anchor
alarms
alarms
Alarms

Command Syntax

Code Block
languagenone
> request oam alarms resetIpPolicingAlarmStatus

Command Parameter

Caption
0Table
1OAM Alarm Parameter

ParameterLength/Range

Description

 resetIpPolicingAlarmStatus N/A Resets the statistics in the IP policing alarm status.

Anchor
eventLog
eventLog
Event Log

Command Syntax

Code Block
languagenone
> 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

Multiexcerpt include
MultiExcerptNamefilterStatus
nopaneltrue
PageWithExcerptEvent Log - CLI

Info Level Logging Enable

Multiexcerpt include
MultiExcerptNameinfoLevelLoggingEnable
nopaneltrue
PageWithExcerptEvent Log - CLI

Type Admin

Multiexcerpt include
MultiExcerptNametypeAdmin2
nopaneltrue
PageWithExcerptEvent Log - CLI

Anchor
localAuth
localAuth
Local Auth

Command Syntax

Code Block
languagenone
> request oam localAuth userStatus <account name> <disable | enable>

Command Parameter

Caption
0Table
1OAM Local Auth Parameter
3OAM Local Auth Parameter

Parameter

Description

userStatus <account name>

 Use this command to enable or disable a user account.

  • disable
  • enable

 

AnchorlocalAuth show RSA keylocalAuth show RSA keyLocal Auth - showRsaKey

Command Syntax

Code Block
languagenone
> request oam localAuth userStatus <userName> 
	deleteRsaKey keyName <key name>
	disable
	enable
	setRsaKey 
		keyName <key name>
		rsaKey <key>
	showRsaKey

Command Parameters

Caption
0Table
1OAM Local Auth Parameter - showRsaKey
3OAM Local Auth Parameter - showRsaKey
Length/Range

Parameter

Description

userStatus
type-tailf:string

 CLI user name (existing field)

 

Command Example

Code Block
titleExample
> 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

 

AnchorlocalAuth set RSA keylocalAuth set RSA keyLocal Auth - setRsaKey
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:

Code Block

Command Syntax

Code Block
languagenone
> request oam localAuth userStatus <userName> setRsaKey keyName <keyName> rsaKey <RSAkey>

Command Parameters

Caption
0Table
1OAM Local Auth Parameter - setRsaKey
3OAM Local Auth Parameter

Parameter

Length/Range

Description

userStatus type-tailf:stringCLI user name (existing field)
keyName
type-tailf:stringUnique name/number for future reference to the key
rsaKey

type-tailf:string

tailf:suppress-echo true

RSA public key with at least 2048 bit strength

 

Command Example

Code Block
titleExample
> 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

 

AnchorlocalAuth

To delete

RSA keylocalAuth delete RSA keyLocal Auth - deleteRsaKey

an RSA key:

Command Syntax

Code Block
languagenone
> request oam localAuth userStatus <userName> deleteRsaKey <keyName>

Command Parameters

Caption
0Table
1OAM Local Auth Parameter - deleteRsaKey
3OAM Local Auth Parameter

Parameter

Length/Range

Description

userStatus
type-tailf:string

 CLI user name (existing field)

keyName
type-tailf:string

Unique name/number for the key

 

Command Example

Code Block
titleExample
> 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:

Code Block
titleExample
> 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

 

Pagebreak