Adding a script to CPE devices

You can add a script to a CPE template. Scripts added to the CPE template are automatically added to all CPE devices that use this CPE template.

To add a script to CPE devices:

  1. In the menu, go to the SD-WAN → CPE templates section.

    A table of CPE templates is displayed.

  2. Click the CPE template to which you want to add a script.

    The settings area is displayed in the lower part of the page. You can expand the settings area to fill the entire page by clicking the expand icon . By default, the Information tab is selected, which displays general information about the CPE template.

  3. Select the Scripts tab.

    This displays the port number that VNFM uses to connect to the CPE device, the user name for running scripts, and the table of script if at least one script has been added.

  4. Click + Script.
  5. This opens a window; in that window, in the Name field, enter the name of the script. The maximum length of the name is 255 characters.
  6. In the Timeout (sec.) field, enter the time in seconds after which the VNFM stops attempting to run a script that could not run the first time. Default value: 360.
  7. In the Executor drop-down list, select one of the following values:
    • Ansible. Default value.
    • Shell
    • Expect
    • Custom to use an interpreter on the CPE device. If you s! this value is selected, enter the path to the custom interpreter in the Custom executor field.
  8. In the Stage drop-down list, select the stage of CPE device operation at which VNFM runs the script:
    • Registration. Default value.
    • Deletion
    • Manually to run the script only manually.
  9. If you need to run the script again, select the Repeat execution check box. This check box is cleared by default. Consider the following special considerations for re-running a script:
    • If in the Stage drop-down list, you selected Registration, the script is re-run in cases of registration, powering on, and restart of the CPE device.
    • If in the Stage drop-down list, you selected Deletion, the script does not run again.
    • If in the Stage drop-down list, you selected Manually, the script is re-run in cases of powering on and restart of the CPE device.
  10. In the Script field, enter the path to the script file or to the Ansible playbook script file.
  11. If necessary, in the File field, specify the path to the archive with additional files required to run the script. Supported formats of archives with files: TAR.GZ and ZIP.
  12. Click Save.

    The script is created and displayed in the table.

  13. In the upper part of the settings area, click Save to save CPE template settings.
Page top