Add_workflow_for_techpubs | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Panel | ||||
---|---|---|---|---|
In this section:
|
The request system
command applies to both system-level and configure modes except where noted.
Code Block | ||
---|---|---|
| ||
% request system admin <SYSTEM NAME> adManualSync discardCandidateConfiguration license loadLicenseFile bundleName <license bundle name> fileName <license filename> loadConfig allowOldVersion <no | yes> filename reenableOSaccount userName <username> reGenerateSshRsaKeys reKeyConfdEncryptionKeys removeSavedConfig fileName <filename> restart restoreRevision revision <revision number> saveAndActivate saveConfig fileNameSuffix <suffix> saveLIGenericKey hexEncryptionKey <hex key> searchAdData adAttributeIdentifier <AD Attribute> searchString <search data> setHaConfig bondMonitoring <currentValue | direct-connect | network-connect> leaderElection <currentValue | enhanced | standard> softReset switchover verifyDatabaseIntegrity <activeAndStandbyPolicy | activeConfigAndActivePolicy | all> viewConfigurationChanges revision <revision number> zeroizePersistenKeys |
Include Page | ||||
---|---|---|---|---|
|
Parameter | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
| This is a request to sync with AD Server to fetch subscriber data. This is an optional parameter. | ||||||||
| Use to discard candidate configuration changes that have been committed on the OAM node, but not yet activated on the managed SBC nodes with the | ||||||||
hexEncryptionKey | The generic key for encrypting the LI Master Key. | ||||||||
license loadLicenseFile | Load the specified node-locked license file stored in the
/opt/sonus/external .
References: | ||||||||
| Load saved configuration and restart the system without rebooting the servers.
NOTE: In a redundant system, using NOTE: If " | ||||||||
reenableOSaccount | Use this command to re-enable an OS account for a specific user.
| ||||||||
reGenerateSshRsaKeys | Use this control to regenerate all SSH keys. | ||||||||
reKeyConfdEncryptionKeys | Use this control to regenerate system configuration database encryption keys. NOTE:
| ||||||||
| Remove the saved configuration from the system.
| ||||||||
| Restart system (all CEs). | ||||||||
| Use this command along with a specific, prior configuration revision number to revert to that configuration. The OAM nodes and the SBC nodes automatically restart when you restore a prior configuration.
| ||||||||
saveAndActivate | Use this command saves the configuration to
| ||||||||
| Save the current 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
References:
NOTE: Bond monitoring is not applicable to the
| ||||||||
| Restart the applications on the system without rebooting the server(s). | ||||||||
| Perform a switchover of the management applications and restart all applications on currently active server. | ||||||||
verifyDatabaseIntegrity | Use this command to verify that the
To view the results of the above checks, use the ' | ||||||||
| The behavior of this Issue this Specify a revision number to list the configuration changes associated with the specified revision.
If the revision number refers to a configuration that was part of restore operation, no changes are shown. Note that viewing of configuration related to lawful intercept (LI) is restricted to authorized users and therefore output is filtered accordingly. LI-related changes are not present in the output shown to users that lack LI privileges. Similarly, users with only LI privileges can see only LI-related configuration changes. |
zeroi
zePersistenKeys
zeroizePersistenKeys | Use this control to securely erase all persistent CSPs from the system. The
| ||||
searchAdData | Searches the local AD database | ||||
adAttributeIdentifier | AD Attribute Identifier | ||||
searchString | A request to Search String |
The following is an example of how to request manual sync:
Code Block |
---|
request system admin TICKS adManualSync |
The following is an example of how to search AD Data:
Code Block |
---|
request system admin TITAS searchAdData adAttributeIdentifier adAttribute2 searchString 8067100197 |
The following command is an example of encrypting the LI Master Key:
Code Block |
---|
request system admin PLUM saveLIGenericKey hexEncryptionKey A1234567890123$% |
Info | ||
---|---|---|
| ||
On cloud and SWe N:1 on upgrade, this key is not retained in the file. In all other scenarios (hardware/SWe 1:1), it is retained during the upgrade. |
Multiexcerpt | |||||
---|---|---|---|---|---|
| |||||
|
Multiexcerpt | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||
|
Code Block | ||
---|---|---|
| ||
> request system ipPolicing resetOffendersList <OffendersList name> aclOffendersList aggregateOffendersList arpOffendersList badEtherIpHdrOffendersList discardRuleOffendersList ipSecDecryptOffendersList mediaOffendersList rogueMediaOffendersList uFlowOffendersList |
Multiexcerpt include | ||||
---|---|---|---|---|
|
Use this command to test the License Manager settings, or to trigger a new License Manager registration after a previous registration request fails.
Code Block |
---|
> request system licenseManager register |
Info | ||
---|---|---|
| ||
Operational mode only. |
Code Block | ||
---|---|---|
| ||
> request system logout user <user_Id> |
Code Block | ||
---|---|---|
| ||
> request system policyServer remoteServer <server_name> |
For additional security configuration details, see PKI Security - CLI.
Multiexcerpt | |||||
---|---|---|---|---|---|
| |||||
|
Multiexcerpt | |||||
---|---|---|---|---|---|
| |||||
Caption | |||||
Table | |||||
1 | request system security Parameters |
Parameter | Description |
---|---|
eventLogValidation |
|
| 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.
|
|
|
uploadCertificate
– Upload a pk12 certificate.Multiexcerpt | |||||
---|---|---|---|---|---|
To retrieve certificate content of an existing PKI certificate:
|
Code Block | ||
---|---|---|
| ||
> 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> |
0 | Table |
---|---|
1 | 'request system serverAdmin' Command Parameters |
Parameter | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
| The unique name of the server. | ||||||||
apparmor | Use this command to evoke the App Armor Linux kernel security module. Select one of the following options in the pop-up window:
| ||||||||
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.
| ||||||||
removeCoredump | Use this object to remove the specified coredump from the chosen server.
| ||||||||
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.
|
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 |
Partial Application Process List
Process | PrsProcess | RtmProcess |
SamProcess | ScmProcess_0 | ScmProcess_1 |
ScmProcess_2 | ScmProcess_3 | SmProcess |
To set bond monitoring type to 'network-connect' and leader election algorithm type to 'enhanced':
Code Block | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
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 |