cEdge CLI

The following steps are involved in the conversion and export of cEdge CLI configuration to a vManage or as a Sastre archive in the form of device and feature templates:

  1. Upload
  2. Convert
  3. Export

Upload

The user initially uploads a cEdge CLI configuration file that they want to convert and export to a vManage or as a Sastre archive in the form of device and feature templates. The configuration file is parsed and validated by the SD-WAN Conversion Tool to ensure it conforms with the structure and configuration blocks of a cEdge CLI configuration. In case of any errors, the line numbers of the errors and the string containing the error messages are returned to the UI for the user to identify and fix the specific issues in the uploaded config.

Activity Window

The activity window for the Upload step allows the following two options to the user for uploading a cEdge CLI configuration file:

  • Drag and drop
  • Manually browse for a file
_images/cedge002.png

Figure 1. Upload activity window

Upload Workflow

  1. The first step required by the user is to upload the cEdge CLI configuration file which is to be converted and exported as device and feature templates. The SD-WAN Conversion Tool supports two ways to upload the configuration file:

    • Drag and Drop: To upload a file, simply drag and drop it to the activity window. The name of the file will be displayed next to the cedge003 icon, as shown in the figure below.
    _images/cedge004.png

    Figure 2. Uploaded file in activity window

    • Manually Browse: To upload a file manually, click on the cedge003 icon and browse the file in your computer’s directory.

Note

Currently, SD-WAN Conversion Tool supports text files with plain text or a config file without any extension for upload in the cEdge CLI workflow.

  1. Click on Next to upload the file to the SD-WAN Conversion Tool. A loading screen will appear as shown in the figure below.
_images/cedge005.png

Figure 3. Loading screen in Upload step

  1. Upon successfully uploading the file to the SD-WAN Conversion Tool, a two-pane screen will be shown to the user as shown below.
_images/cedge006.png

Figure 4. Upload successful

The contents of the original file will be displayed in an on-screen editor on the left of the screen and the device variables extracted from the file (if any) will be displayed on the right. The user can update the configuration on the left and click on cedge007 to update the variables on the right.

Note

In case of an error in upload, refer to Upload Error: cEdge CLI Workflow section in Appendix A.

  1. Once the user has seeded in the values of the device variables by uploading a CSV file or manually filling in the values, click Next to proceed. A loading screen will appear on the application window that indicates the beginning of the validation process in which the configuration is validated with the seeded values of device variables if present.
_images/cedge008.png

Figure 5. Loading screen in Validating step

  1. After the configuration is successfully validated, the validated configuration content is displayed in an on-screen editor. If the uploaded cEdge CLI configuration has Add-On CLI configuration in it, two tabs are shown on the screen, one for displaying each of the XE-SDWAN and Add-On CLI configuration. The screenshots for both scenarios of a cEdge CLI with and without Add-On CLI configuration are shown below.
_images/cedge009.png

Figure 6. Validation successful

_images/cedge010.png

Figure 7. Validation successful with Add-On CLI

Note

In case of an error in validation, refer to Validation Error: cEdge CLI Workflow section in Appendix A.

  1. Click on Next to initiate the conversion process of the XE-SDWAN configuration.

Convert

The SD-WAN Conversion Tool converts the XE-SDWAN CLI configuration to XML format using Cisco NSO NEDs. The converted configuration is then consumed by the feature template generator tool in the subsequent step.

Activity Window

This section gives the details of the available functionalities for the Convert step in the activity window. An example activity window for this step is shown in the figure below.

_images/cedge011.png

Figure 8. Conversion step

  • SD-WAN File: This file contains SD-WAN specific details of the configuration with all the necessary information about the system and VPN0 block. The user can download this config file by clicking on download.
  • Converted File: This is the configuration file that is generated in the conversion process based upon the configuration in the cEdge CLI configuration file.The user can download this config file by clicking on download.
  • Non-editable Window: It displays the contents of the converted configuration file. No changes can be made to the configuration at this point.

Convert Workflow

Once the cEdge CLI config file has been validated successfully, the next step is to convert this configuration to XML format.

  1. After the config file has been successfully validated, click on Next to proceed. A loading screen will appear on the application window that indicates the beginning of the conversion process.
_images/cedge012.png

Figure 9. Conversion Loader

  1. Upon successfully converting the config file to XML format, the following screen will appear on the application window indicating a successful conversion process.
_images/cedge013.png

Figure 10. Conversion Successful

Note

In case of an error, refer to the Conversion Error: cEdge CLI Workflow section in Appendix A.

Export

The SD-WAN Conversion Tool generates feature templates using the converted SD-WAN configuration. In the case of vManage as a target, these templates are created in user-selected vManage and attached to a device template for consumption from the vManage UI. The credentials provided for vManage can be saved by the user for subsequent workflows in the future. In case of Sastre archive as a target, the tool creates a Sastre archive that contains these templates which can be downloaded from the tool’s UI.

Activity Window

This section gives the details of the available functionalities in the activity window for the Export step. An example activity window for this step is shown in the figure below.

_images/cedge014.png

Figure 11. Export Form

Field Name Description
Target Type Type of target (Live vManage or Sastre archive) for the conversion.
Target Device Type It lists the available SD-WAN device types. The selected device type will be used as the target device for the exported templates.
vManage IP/New IP This is the IP or domain name of the running vManage to which the device and feature templates will be exported. The user can either enter a new IP or select from the list of previously saved vManage IPs from the drop-down menu. This field is disabled when Sastre archive is selected as the target type.
vManage Port This is the port of the vManage to which the feature templates will be exported. This field is disabled when Sastre archive is selected as the target type.
Username This is the username of the server on which vManage is running. It is disabled when Sastre archive is selected as the target type.
Password This is the password of the server on which vManage is running. It is disabled when Sastre archive is selected as the target type.

Note

All cEdge devices present in vManage 20.6 are supported as target device types in the cEdge CLI workflow.

Export Workflow

Once the cEdge CLI config file has been converted successfully, the next step is to export this config file.

  1. After the config file has been successfully converted to XML format, click on Next to proceed. The following screen will appear.
_images/cedge014.png

Figure 12. Export Form

  1. Fill in the required fields by entering the relevant configuration details of the target to proceed with the export process. An example is shared in the figure below.
_images/cedge15.png

Figure 13. Filled Export Form

  1. Once the user has filled in the relevant fields, click on Next to proceed. A loading screen will appear on the application window that indicates the beginning of the export process in which the templates generated from the configuration are exported to vManage or as a Sastre archive.
_images/cedge16.png

Figure 14. Export Loader

  1. After the templates have been successfully exported to vManage or as a Sastre archive, a screen will appear on the application window indicating a successful export process. The successful export screen would vary based on the target environment chosen earlier by the user. In case of Sastre target type, the user will be additionally shown a Sastre archive available for download. The screenshots for both scenarios are shown below.
_images/cedge017.png

Figure 15. Config file successful export - Live vManage as target

_images/cedge018.png

Figure 16. Config file successful export - Sastre as target

Note

In case of an error, refer to the Export Error: cEdge CLI Workflow section in Appendix A.

On the export successful screen, the following two buttons are available to the user:

  • Convert: To perform another configuration conversion, click the Convert button. This will take the user back to the workflow selection screen.
  • History: To view the history of the configuration conversion workflows, click the History button. This will take the user to the History tab.