How to remove residual code from a config file

[Anonymous]

Introduction

Purpose & Scope

When building a custom default configuration file, steps should be taken to ensure the file contains only relevant configuration parameters and that all other information is cleansed from the file, thus reducing the file size to a minimum.  This article provides instructions for the removal of residual code left over when performing a backup of the running configuration on a SmartRG gateway where the backup running configuration will be used to build a custom default configuration file.  The article covers the most common types of residual code but does not cover every configuration scenario.  Instructions for building a custom default configuration file are beyond the scope of this document.

Preparation:

1. Build the custom default configuration using the SmartRG gateway user interface.
2. Backup the configuration of your gateway to your PC. This shall serve as the baseline custom default configuration file.
3. Open the configuration file for editing using Wordpad or other simple text editor app.

Parameters to modify:

The parameters listed below should be changed to reflect values unique to an organization.

Parameter	Action
<X_CLEARACCESS_COM_Origin>ClearAccess</X_CLEARACCESS_COM_Origin>	Search the file for the opening tag as appears in this example.  Replace the value ClearAccess with the name of the customers company or organization.  The value may not contain spaces.
<URL>https://cpe.acme.net/v1/</URL>	Search for <ManagementServer> within that section of the file, locate the parameter listed on the left.  If necessary, modify the URL to reflect the correct address.  Delete the trailing v1/.
<PeriodicInformInterval>82800</PeriodicInformInterval>	Search the file for the opening tag.  Modify the value 82800 to reflect how often the gateway will check into the ACS.  Too short of an interval will add network overhead and too long of an interval will result in stale ACS information.  Factory default is 3600 seconds.
<SSID>SmartRGccfa</SSID>	Search the file for the opening tag as appears in this example.  If using WiFi and require that the SSID is dynamically changed to SmartRG + the last 4-digits of the MAC address, strip off the residual 4-digits from this parameter value in the custom default configuration file.
<PreSharedKey>OneCpeToRuleThemAll</PreSharedKey>	These must reflect OneCpeToRuleThemAll even when using base MAC as passphrase.
<KeyPassphrase>OneCpeToRuleThemAll</KeyPassphrase>	These must reflect OneCpeToRuleThemAll even when using base MAC as passphrase.

Parameters to delete:

The parameters listed below are residual code left over from backing up the configuration file and should be deleted from a custom default configuration file.

Parameter	Action
<FirstUseDate>0001-01-01T00:00:00Z</FirstUseDate>	Search the file for the opening tag. Delete the entire entry (including the tags). Values you find between the tags will vary from the example shown to the left.
<PeriodicInformTime>1970-01-01T00:01:47+00:00</PeriodicInformTime>	Search the file for the opening tag. Delete the entire entry (including the tags). Values you find between the tags will vary from the example shown to the left.
<ConnectionRequestURL notification="2">(null)</ConnectionRequestURL>	Search the file for the opening tag. Delete the entire entry (including the tags).
<ConnectionRequestUsername>admin</ConnectionRequestUsername>	Search the file for the opening tag. Delete the entire entry (including the tags). Values you find between the tags will vary from the example shown to the left.
<ConnectionRequestPassword>OneAcsToRuleThemAll </ConnectionRequestPassword>	Search the file for the opening tag. Delete the entire entry (including the tags). Values you find between the tags will vary from the example shown to the left.
<STUNServerAddress>acme.clearaccess.com</STUNServerAddress>	Search the file for the opening tag.  Delete the entire entry (including the tags).
STUNUsername>00236a:00236a52ccfa@acme</STUNUsername>	Search the file for the opening tag.  Delete the entire entry (including the tags).
<STUNMaximumKeepAlivePeriod>300</STUNMaximumKeepAlivePeriod>	Search the file for the opening tag.  Delete the entire entry (including the tags).
<STUNMinimumKeepAlivePeriod>60</STUNMinimumKeepAlivePeriod>	Search the file for the opening tag.  Delete the entire entry (including the tags).
<X_CLEARACCESS_COM_AcsControlPanelUrl>https://acs.acme.net/acs-portal/control-panel/login?device=00236A:00236A52CCFA</X_CLEARACCESS_COM_Ac...>	Search the file for the opening tag.  Delete the entire entry (including the tags). Values you find between the tags will vary from the example shown to the left.
<X_CLEARACCESS_COM_Setting>4DE46CB92B5CFF99223C5E8DD0FF5A </X_CLEARACCESS_COM_Setting>	Search the file for the opening tag.  Delete the entire entry (including the tags). Values you find between the tags will vary from the example shown to the left.
<X_CLEARACCESS_COM_Setting>51E768882F6BECA1193B5784E1E44C9E0D230A </X_CLEARACCESS_COM_Setting>	Search the file for the opening tag.  Delete the entire entry (including the tags). Values you find between the tags will vary from the example shown to the left.
<WlSsid>SmartRGccfa</WlSsid>	Search the file for the opening tag.  Delete the entire entry (including the tags). Values you find between the tags will vary from the example shown to the left.
<WlBssMacAddr>00:23:6A:52:CC:FC</WlBssMacAddr>	Search the file for the opening tag.  Delete only the value between the opening tag and the closing tag. There may be multiple instances of this parameter and it may be necessary to search the file multiple times until all instances of the MAC address are removed from this parameter.
<ExternalIPAddress notification="2">0.0.0.0</ExternalIPAddress>	Search the file for the opening tag.  Delete the entire entry (including the tags). There may be multiple instances of this parameter and it may be necessary to search the file multiple times until all instances are deleted.

Once the fields referenced above have been modified or removed, save the configuration file and ensure that the file loads to a SmartRG gateway without error.