Versions Compared

Old Version 1

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-58959REV5REV6REV3REV1
Panel

In this section:

Table of Contents
maxLevel3


Overview

Sonus Ribbon seeds initial configuration in order to simplify SBC setup. After setup, the SBC provides schema-based configuration management through CLI, SNMP, NETCONF and REST API. When requested, this configuration management shows the seeded configuration plus subsequent configuration changes or additions made by the user (user configuration).

In addition, the export/import framework provides an automated way of exporting and importing configuration, but it expects a compressed tar ball as input with metadata to validate the incoming configuration. To simplify editing by users, the SBC provides a way to easily manage the configuration as plain XML files without any metadata.

 


Info
titleuser-config-info Notes
  • When you import the configuration from another installation (same or different version), the encrypted fields may not work. You must update the XML file with the plain text password to make it work.
  • When you import the configuration from a different SBC version, configurations must be manually updated to accommodate the schema changes between the versions.
  • These commands are only available to the Administrator group.
  • You must manually re-create TLS certificates after an export/import because they require PKI Certificates to be installed on the new server deployment.

user-config-show

Displays the user configuration. This can be fine-grained to a specified XPath.

Command Syntax

Code Block
languagenone
> user-config-show
   <optional argument XPath>

Command Parameters

Caption
0Table
1user-config-show


Parameter

Description

<optional argument XPath>Returns all user configuration under the specified XPath.


Command Example

Code Block
languagenone
admin@cg171> user-config-show
<config xmlns="http://tail -f.com/ns/config/1.0">
   <eventLog xmlns="http://whatevernet.org/ns/mibs/WHATEVER-GEN2-EVENT-LOG-MIB/1.0">
      <typeAdmin>
         <type>debug</type>
         <filterLevel>info</filterLevel>
      </typeAdmin>
   </eventLog>
   <aaa xmlns="http://tail -f.com/ns/aaa/1.1">
       <authentication>
          <users>
            <user>
               <name>admin</name>
               <password>xxxXXXXXxxxXXXXxxxxXXXXxxxXXXXxxxxXXXxxxXXXxxxXXXxx</password>
            </user>
          </users>
        </authentication>
    </aaa>
</config>
[ok][2020-02-01 05:24:36]

 


user-config-export

When there is no modified configuration, user-config-export will not create a configuration file.

Command Syntax

Code Block
languagenone
> user-config-export
   <filename>
   <xpath>

Command Parameters

Caption
0Table
1user-config-export


ParameterLength/RangeDefaultDescription
<filename>N/AN/A

The user modified configuration will be stored in a file with suffix .xml under the path /var/log/sonus/sbx/config/.

NOTE: The SBC will return an error if the file name provided (appended with the xml suffix) is already present in /var/log/sonus/sbx/config/.

<xpath>N/AN/ASpecifies the XPath to be saved.
 



Command Examples

Code Block
languagenone
admin@cg171> user-config-export sbc-config.xml
User configuration saved to sbc-config.xml
[ok][2020-02-01 06:24:36]

 


user-config-import

Command Syntax

Code Block
languagenone
> user-config-import
   <filename>


Command Parameters


Caption
0Table
1user-config-import


ParameterLength/RangeDefaultDescription
<filename>N/AN/A

The user modified configuration stored as a file with suffix .xml under a designated path.

 



 


Command Examples

 


Code Block
languagenone
admin@cg171> user-config-import sbc-config.xml
[ok][2020-02-01 07:24:36]
 

 Pagebreak