Page History

Add_workflow_for_techpubsAUTH2AUTH1JIRAIDAUTHSBX-70104REV5REV6REV3REV1

Panel

In this section:

Table of Contents

maxLevel	2

The request system command applies to both system-level and configure modes except where noted.

Admin

Command Syntax

Code Block

language	none

% request system admin <SYSTEM NAME>
	license loadLicenseFile
		bundleName <license bundle name>
		fileName <license filename>
	loadConfig
		allowOldVersion <no | yes>
		filename 
	reenableOSaccount <username>
	reGenerateSshRsaKeys
	reKeyConfdEncryptionKeys
	removeSavedConfig fileName <filename>
	restart
	saveConfig fileNameSuffix <suffix>
	setHaConfig
		bondMonitoring <currentValue | direct-connect | network-connect> 
		leaderElection <currentValue | enhanced | standard>
	softReset
	switchover
	verifyDatabaseIntegrity <activeAndStandbyPolicy | activeConfigAndActivePolicy | all>
	zeroizePersistenKeys

Command Parameters

Include Page

	GRHA_not_in_SWe_Cloud
	GRHA_not_in_SWe_Cloud

Caption

0	Table
1	System Admin Parameters (request)

Parameter

Description

license loadLicenseFile

Load the specified license file stored in the

Spacevars

0	product

directory /opt/sonus/external.

bundleName <license bundle name> – The bundle name to use for the license installation.
fileName <license filename> – The name of the license file to install.

References:

loadConfig

Load saved configuration and restart the system without rebooting the servers.

allowOldVersion – This option is only intended for use to override checks for older releases which do not identify their version. In this case, the follow error results. Follow the instructions given:

"There is no version identifier on the saved file. Use the allowOldVersion parameter only if you are sure the version of the saved configuration file is compatible with the running software version."
- no
- yes
filename – Enter the configuration file to load.

NOTE: In a redundant system, using loadConfig restarts both CEs

NOTE: If "reason Configuration file version not compatible with current software version. matrixFileNotAvailable" error is returned, the lswuMatrixSBX5000.bin/lswuMatrixSBX5000.txt file is missing from the/opt/sonus directory. You must must restore these files from the release package of the currently running software with the name pattern of "sbc-V0X.YY.ZZRQQQ.x86_64.tar.gz". Unzip and untar the current release's tar.gz file in that directory, return to the CLI and perform the command again.

reenableOSaccount

Use this command to re-enable an OS account for a specific user.

userame - User name of account to re-enable.

reGenerateSshRsaKeys Use this control to regenerate all SSH keys.

reKeyConfdEncryptionKeys

Use this control to regenerate system configuration database encryption keys.

NOTE:

Spacevars

0	company

recommends backing up current encrypted parameters in plaintext, if possible.

Spacevars

0	company

further recommends performing a full configuration backup immediately after this activity has successfully completed.

removeSavedConfig

Remove the saved configuration from the system.

fileName – Specify filename of configuration to remove from the system.

restart

Restart system (all CEs).

saveConfig

Save the current configuration.

fileNameSuffix – Use this parameter to specify the filename suffix to use when saving the configuration.

setHaConfig

Use this action command to configure SBC for Geographical Redundancy High Availability (GRHA) mode when active and standby servers are located in two different data centers to protect SBCs against data center and network failures. To configure/change just one setting, use currentValue option for the other setting.

bondMonitoring – Select the bond monitoring type for GRHA mode.
- currentValue
- direct-connect
- network-connect
leaderElection – Select the leader election algorithm type to use for GRHA mode.
- currentValue
- enhanced
- standard

References:

Refer to SBC Core Redundancy for feature details.
Refer to Show Table System or Show Status System for statistics details
Refer to Enabling Geographical Redundancy HA Mode best practice for configuration details.

NOTE: Bond monitoring is not applicable to the

Spacevars

0	product2

.

softReset

Restart the applications on the system without rebooting the server(s).

switchover

Perform a switchover of the management applications and restart all applications on currently active server.

verifyDatabaseIntegrity

Use this command to verify that the

Spacevars

0	product

policy and configuration databases on the active server are in sync and that the policy databases on the active and standby servers are in sync. Because these commands take a few seconds to execute, it is not advisable to constantly run these commands on systems.

activeAndStandbyPolicy – Check if policy databases on the active and standby servers are in sync.
activeConfigAndActivePolicy – Check if the policy and configuration databases on the active server are in sync.
all – Perform both of the above checks.

To view the results of the above checks, use the 'show table system databaseIntegrity' command. Refer to Show Table System for details.

zeroizePersistenKeys

Use this control to securely erase all persistent CSPs from the system. The

Spacevars

0	product

server reboots after confirmation.

Ethernet Port

Command Syntax

Multiexcerpt

MultiExcerptName	ethernetPort_syntax

Code Block

language	none

% request system ethernetPort packetAdmin <host name> <pkt0 | pkt1> switchover

Command Parameter

Multiexcerpt

MultiExcerptName	ethernetPort_parameter

Caption

0	Table
1	Ethernet Port 'request' Parameter

Parameter

Description

switchover

Use this parameter to initiate a port switchover within a redundancy pair.

Note: The switchover command only applies to pkt0 and pkt1 on the

Spacevars

0	series2

and

Spacevars

0	product3

active server.

IP Policing

Command Syntax

Code Block

language	none

> request system ipPolicing resetOffendersList <OffendersList name> 
  aclOffendersList 
  aggregateOffendersList 
  arpOffendersList 
  badEtherIpHdrOffendersList 
  discardRuleOffendersList 
  ipSecDecryptOffendersList 
  mediaOffendersList 
  rogueMediaOffendersList 
  uFlowOffendersList

Offenders List Details

Multiexcerpt include

MultiExcerptName	Offenders List
PageWithExcerpt	Show Table System

Logout

Info

title	Note

Operational mode only.

Command Syntax

Code Block

language	none

> request system logout user <user_Id>

Policy Server

Command Syntax

Code Block

language	none

> request system policyServer remoteServer <server_name>

Reset License Statistics

Command Syntax

Code Block
> request system resetLicenseStats resetLicenseFeatureStats resetLicenseServerStats

Command Parameters

Caption

0	Figure
1	Reset License Statistics Parameters

Parameter	Description
resetLicenseFeatureStats	Use this command to clear the current counts in the License Feature Status table.
resetLicenseServerStats	Use this command to clear the current counts in the License Server Status table.

Security

For additional security configuration details, see PKI Security - CLI.

Command Syntax

Multiexcerpt

MultiExcerptName	security_syntax

Code Block

language	none

% request system security 
	eventLogValidation 
        deleteUserPrivateKey
        generateDefaultKeys
        setUserPrivateKey <uniqueUserPrivateKeyName> <userPrivateKey>
        showPublicKey <default/user>
    generateSipHeaderEncryptionKeys
	pki 
		certificate <certificate name>
			generateCSR
				csrSub (max 255 chars)
				keySize (ketSize1K | keySize2K)
				subjectAlternativeDnsName (0-512 chars)
			importCert certContent (max 4096 chars)
			retrieveCertContent
		uploadCertificate

Command Parameters

Multiexcerpt

MultiExcerptName	security_parameters

Caption

0	Table
1	request system security Parameters

Parameter

Description

eventLogValidation

deleteUserPrivateKey – Delete an existing user-submitted private key. When the key is removed the SBC will revert back to using its default private key.

generateDefaultKeys – Requests the generation of a new default SBC-generated private key pair.

setUserPrivateKey <uniqueUserPrivateKeyName> <userPrivateKey> – Configures the user-submitted private key. The private key is encrypted in CDB using existing CDB encryption methods. The user-submitted private key is only available internally. The key is encrypted and hidden, thus not displayable, once configured in CDB.

showPublicKey <user/default> – Access the public key associated with the chosen private key.

generateSipHeaderEncryptionKeys

Use this command to generate header encryption keys. A "Success" or "Failure" indication is returned. The SBC then adds the key-Id to each encrypted header based on which key is selected as the correct key for decryption.

The SBC stores up to two sets of keys at any given time. There is no limit to the number of times this command may be executed. Additionally, there is no specific time delay required before reissuing the command.

NOTE: Generating new keys too frequently may lead to a situation where the SBC receives a request with an expired key-id (i.e. the current header encryption key is over-written due to the new key generation) causing unsuccessful decryption of headers. This may lead to call failures any calls caught in the transition to the new key-id.

pki

PKI certification configuration details.

certificate <certificateName> –The name for a collection of certificates configured on SBC.
- generateCSR – Use this parameter to generate CSR (Certificate Signing Request).
  - csrSub – CSR subject name (max 255 chars). Place the parameter value within quotation marks if a string contains a space.
  - keySize – Size of the key to generate private key via openssl command.
    - keySize1K
    - keySize2K
  - subjectAlternativeDnsName – Alternative DNS subject name(s). Multiple alternative names can be specified using "," (comma) separator. (0-512 chars). Example: "nj.sonusnet.com, in.sonusnet.com, uk.sonusnet.com, ca.sonusnet.com, tx.sonusnet.com"
- importCert certContent – Import PEM format certificate (max 4096 characters).
  Note: When issuing this command, the SBC enables multi-line mode automatically. To exit multi-line mode you must press Ctrl+D manually.
- retrieveCertContent – Retrieve content of an existing PKI certificate (local, local-internal and remote).
uploadCertificate – Upload a pk12 certificate.

Command Example

Multiexcerpt

To retrieve certificate content of an existing PKI certificate:

Code Block

language	none

% request system security pki certificate server retrieveCertContent
result Certificate:
    Data:
        Version: 1 (0x0)
        Serial Number: 13211600523504912060 (0xb75908ad95e006bc)
    Signature Algorithm: sha1WithRSAEncryption
        Issuer: C=US, ST=MA, L=Westford, O=VeriSign
        Validity
            Not Before: Apr 28 09:56:54 2015 GMT
            Not After : Jul 12 09:56:54 2033 GMT
        Subject: C=IN, ST=TN, L=Chennai
        Subject Public Key Info:
            Public Key Algorithm: rsaEncryption
                Public-Key: (2048 bit)
                Modulus:
                    00:c5:80:dc:59:0a:8d:98:19:0b:bd:be:fd:ab:6c:
                    f7:e9:b6:28:d9:e8:fe:a5:84:fb:45:d9:16:97:f5:
                    fc:9f:df:7b:5b:03:6e:34:38:3f:10:2b:d0:d8:d6:
                    4a:03:5f:2a:78:85:4c:65:d4:0d:a6:e2:d3:be:1a:
                    fc:8b:96:a1:db:15:16:74:3e:9f:2a:34:95:88:6a:
                    49:3b:1e:78:15:bf:5c:e8:ec:a3:0d:8b:d4:2a:39:
                    d6:17:c1:a8:88:94:36:23:23:d5:3b:2c:49:fb:15:
                    d3:e6:7f:72:b0:e4:3d:e6:3a:44:f3:ac:a2:d3:2a:
                    62:f7:2f:d1:d4:a1:82:fe:03:57:49:1d:6b:12:14:
                    2c:28:f8:ef:6c:e0:c2:36:8c:7f:77:2a:32:d9:ce:
                    c7:9e:fc:4f:20:aa:43:db:b1:77:16:e9:d5:b5:44:
                    ff:06:8a:85:d4:74:63:af:3c:5e:f3:a3:e0:83:5a:
                    40:d1:5d:fc:84:36:34:b4:8b:ac:f1:5b:2c:b6:0e:
                    97:bc:1b:cd:a4:f8:17:b3:81:42:41:db:09:bb:79:
                    42:1f:92:dc:43:52:ca:78:e3:db:3d:db:e9:f6:39:
                    15:eb:3a:09:e5:ab:eb:18:5f:7e:14:ec:f9:b6:04:
                    9e:f5:6d:73:f4:ea:85:c4:4a:1f:5a:01:8f:2e:94:
                    b6:0d
                Exponent: 65537 (0x10001)
    Signature Algorithm: sha1WithRSAEncryption
         1a:91:c0:8a:b8:66:4b:a2:67:bc:99:4f:b4:0b:f8:bc:67:0e:
         de:23:37:42:bc:dd:96:64:7c:ef:e1:05:c7:eb:92:06:fa:ef:
         7b:72:ee:7f:26:b5:1c:39:b5:f2:b2:04:6e:2e:0c:1d:7e:1f:
         7a:87:b8:8b:9c:25:e2:8f:77:6f:ac:bb:a0:63:28:51:4f:7c:
         35:30:ad:31:24:85:f3:99:6d:c2:f8:33:eb:49:45:ed:ab:26:
         97:f4:04:a7:0a:06:dd:40:c3:f6:1a:0e:ec:72:0f:40:65:ab:
         34:4a:dc:51:2b:f3:61:b6:3a:1c:26:09:a1:af:37:dc:bf:a5:
         ba:dd
No Trusted Uses.
No Rejected Uses.
Alias: Server Cert
Key Id: 79:70:FC:99:1A:2B:15:A7:A1:33:21:F7:8A:57:0C:A7:07:7B:96:35
 
status 0

Server Admin

Command Syntax

Code Block

language	none

> request system serverAdmin <server_name>  
	forceCoreDump coreDumpType <full | partial>
	removeCoredump coredumpFileName <filename> 
	restart  
	softReset  
	startSoftwareUpgrade  
		integrityCheck <perform | skip>
		package <pkg_name> 
		rpmName <name> 
		versionCheck <perform | skip>

Command Parameters

Caption

0	Table
1	'request system serverAdmin' Command Parameters

Parameter Description

<serverName>

The unique name of the server.

forceCoreDump

Use this command to force the termination of a fixed set of application processes with accompanying core dumps for troubleshooting purposes. By default, a full dump is performed if no option is specified.

Before the command executes, the user is prompted to confirm or cancel the operation. If canceled, no further action is taken, and application operation is not affected.

coreDumpType– Choose an option below:
- full (default) – Full set of processes to dump (see Table 2 below).
- partial – Partial set of processes to dump (see Table 3 below).

removeCoredump

Use this object to remove the specified coredump from the chosen server.

coredumpFileName <filename> – The name of the coredump file.

restart Restart the specified server.

softReset Restart the application on the server without rebooting the server.

startSoftwareUpgrade

Use this control to start a software upgrade on the specified server.

integrityCheck – Use this flag to specify whether or not to perform an integrity check (signature validation) against
Spacevars
0 product
software updates and patches as they are uploaded to the
Spacevars
0 product
system.
- perform (default)
- skip
package – Name of the new package.
rpmName – Name of the rpm/package, if different from the file name of the .tar.gz.
versionCheck– Use this flag to perform/skip version checking during software upgrades.
- perform (default)
- skip

Caption

0	Table
1	Full Application Process List

CamProcess	ChmProcess	CpxAppProc	DiamProcess
DnsProcess	DsProcess	EmaProcess	EnmProcessMain
FmMasterProcess	IkeProcess	ImProcess	IpmProcess
PathchkProcess	PesProcess	PipeProcess	PrsProcess
RtmProcess	SamProcess	ScmProcess_0	ScmProcess_1
ScmProcess_2	ScmProcess_3	ScpaProcess	SmProcess
SsaProcess	SsreqProcess

Caption

0	Table
1	Partial Application Process List

Process	PrsProcess	RtmProcess
SamProcess	ScmProcess_0	ScmProcess_1
ScmProcess_2	ScmProcess_3	SmProcess

Command Examples

To set bond monitoring type to 'network-connect' and leader election algorithm type to 'enhanced':

Code Block

language	none

request system admin sbx1 setHaConfig bondMonitoring network-connect leaderElection enhanced

To set bond monitoring type to 'direct-connect' and retain current setting of leader election algorithm:

Code Block

language	none

request system admin sbx1 setHaConfig bondMonitoring direct-connect leaderElection currentValue

To load a license file:

Code Block
request system admin WFDSBC01 license loadLicenseFile bundleName BUND fileName FN This command will load the license file kept in /opt/sonus/external path. Do you want to continue? [yes,no] yes

Pagebreak

Space shortcuts

Page tree

Versions Compared

Old Version 20

New Version Current

Key

Admin

Command Syntax

Command Parameters

Ethernet Port

Command Syntax

Command Parameter

IP Policing

Command Syntax

Offenders List Details

Logout

Command Syntax

Policy Server

Command Syntax

Reset License Statistics

Command Syntax

Command Parameters

Security

Command Syntax

Command Parameters

Command Example

Server Admin

Command Syntax

Command Parameters

Command Examples