Kaspersky SD-WAN

configurations block

17 April 2024

ID 267097

In the configurations block, you can specify the names of scripts using the following parameter:

- name

For each script, you can specify the following parameters:

Value

Mandatory

Description

filename

Yes_icon

The file name of the script file, Ansible playbook, or user-data attribute for Cloud-init. You must place the script in the /scripts directory of the VNF package.

stage

Yes_icon

The stage of operation of the virtual network function at which the script must be run. Possible values:

  • initialization to run the script on deployment of the virtual network function.
  • termination to run the script on deletion of the virtual network function.
  • none to run the script when the value in the field or drop-down list in the virtual network function settings area changes. You can specify the fields and drop-down lists in the user_configurations block.

executor

Yes_icon

Interpreter. Possible values:

  • ansible
  • expect
  • /bin/sh
  • bin/bash
  • cloud-init

You can enter the path to a custom script executor, for example:

/user/bin/php

authentication

Yes_icon

Method for authenticating the VNFM in the virtual network function for running scripts. Possible values:

  • key means the VNFM is authenticated in the virtual network function using a key that is generated when the function is deployed. You need to use a script to get the key, so we recommend not to specify this value for the first script.
  • password means the VNFM is authenticated in the virtual network function using a user name and password. The user name and password can be specified in the flavours block inside the vdus block.

files_path

No_icon

Path to files for running scripts using SSH. You need to create a directory inside the /scripts directory of the VNF package and place the files in that directory. The files are copied to the VDU.

config_drive

No_icon

Whether or not you want to use config-drive. You can specify this parameter if you have specified cloud_init for the executor parameter. Possible values: true and false.

timeout

No_icon

The time to wait for the script to finish, in seconds. If the script does not finish within the specified time, execution is terminated.

You can specify this parameter if you have specified a path to a custom script executor for the executor parameter. The timeout starts at the moment the script is run.

Example of a 'configurations' block

Did you find this article helpful?
What can we do better?
Thank you for your feedback! You're helping us improve.
Thank you for your feedback! You're helping us improve.