Kaspersky SD-WAN

flavours block

April 17, 2024

ID 267319

In the flavours block, you can specify the names of flavours by using the following parameter:

- name

For each flavour, you can specify the following parameters and blocks.

Value

Type

Description

description

Parameter

Brief description of the flavour.

position

Parameter

Sequential number of the flavour. The flavour with the lowest position has the lowest performance.

affinity

Block

Groups of VDUs that you want to be hosted on the same OpenStack host. We recommend hosting VDUs that require minimizing communication delays which each other on the same OpenStack host.

anti_affinity

Block

Groups of VDUs that you want to be hosted on distinct OpenStack hosts. We recommend deploying VDUs that may require vertical scaling or high availability on distinct OpenStack hosts.

management

Block

Parameters of VDU administration consoles.

vdus

Block

VDU settings.

All parameters and blocks are mandatory.

affinity and anti_affinity blocks

You can specify VDU groups using the following block:

groups

In this block, you can specify the names of VDU groups using the following parameter:

- name

For each VDU group, you can specify the VDU names using the following block:

vdu_name

Example of 'affinity' and 'anti_affinity' blocks

management block

In the management block, you can specify the following blocks:

  • vnc

    Parameters relevant to managing VDUs through the VNC console. You can specify VDU names using the following parameter:

    - vdu_name

  • ssh

    Parameters relevant to managing VDUs through the SSH console. You can specify VDU names using the following parameter:

    - vdu_name

    For each VDU, you can specify the following parameters:

    • def_user

      Name of the user on whose behalf the SSH session is to be established.

    • authentication

      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 get the key using a script. Scripts can be specified in the configurations block.
      • 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 vdus block.

    All parameters are mandatory.

  • web

    Parameters relevant to managing VDUs through the web console. You can specify VDU names using the following parameter:

    - vdu_name

    For each VDU, you can specify the following parameters:

    • protocol

      Protocol for connecting to the web console. Possible values: http and https.

    • port

      Port for connecting to the web console. By default, port 80 is used. Range of values: 1 to 65,536.

    • path

      Path to the web console.

    • def_user

      User name for authenticating in the web console.

    • def_password

      Password for authenticating in the web console.

    All parameters are optional.

Example of a 'management' block

vdus block

In the vdus block, you can specify the names of VDUs using the following parameter:

- name

For each VDU, you can specify the following parameters and blocks:

Value

Type

Mandatory

Description

password_rules

Block

No_icon

VDU password requirements. You can specify the following parameters:

  • length

    Minimum length of the password.

  • use_upper_case

    Whether users must use uppercase characters in their passwords. Possible values: true and false.

  • use_lower_case

    Whether users must use lowercase characters in the password. Possible values: true and false.

  • use_digits

    Whether users must use numeric characters in their passwords. Possible values: true and false.

  • specific_symbols

    Whether users must use special characters such as $ or @ in the password.

  • specific_symbols_min_usage

    Minimum number of special characters that must be present in the password.

All parameters are optional.

check_connection_mode

Parameter

No_icon

Type of VDU availability test performed during deployment. Possible values: ssh and none. By default, an SSH test is performed.

zabbix_template

Parameter

Yes_icon

Template for creating a host on Zabbix server corresponding to the virtual network function.

monitoring_type

Parameter

Yes_icon

Monitoring type of the virtual network function. Possible values:

  • agent means monitoring using a Zabbix agent.
  • snmp means monitoring using the SNMP protocol.

ssh_port

Parameter

No_icon

Port number for establishing an SSH session.

configurations

Block

Yes_icon

Names of scripts to be run on the VDU. Scripts can be specified in the configurations block.

backups

Block

No_icon

Names of backup tasks to be used on the VDU. Backup tasks can be specified under backups.

def_user

Parameter

No_icon

User name for authenticating the VNFM in the virtual network function.

def_password

Parameter

No_icon

Password for authenticating the VNFM in the virtual network function.

password_authentication

Parameter

No_icon

Whether password authentication of the VNFM in the virtual network function is allowed. Possible values: yes and no.

disks

Block

Yes_icon

Names of the VDU virtual disks. You can specify the names using the following parameter:

- name

For each VDU disk, you can specify the following parameters:

  • order

    Mounting order of the VDU virtual disk. Mandatory parameter.

  • type

    Type of the ephemeral OpenStack disk. Mandatory parameter.

  • image

    Name of the VDU virtual disk image. VDU virtual disk images can be specified in the images block. Optional parameter if you are creating a blank VDU disk.

  • storage_db

    Size of the VDU virtual disk in GB. Mandatory parameter.

cpu

Block

Yes_icon

VDU CPU parameters. You can specify the following parameters:

  • smt

    Simultaneous multithreading requirements for VDU deployment. Possible values:

    • prefer to use simultaneous multithreading if it is enabled on the VDU host.
    • isolate to not use simultaneous multithreading.
    • require to use simultaneous multithreading.
  • cpu_pinning

    Whether you want to use CPU pinning. Possible values:

    • shared if you do not want to pin CPU cores to the VDU.
    • dedicated if you want to pin CPU cores to the VDU.
  • num_vpu

    Number of CPU cores pinned to the VDU.

All parameters are mandatory.

memory

Block

Yes_icon

VDU RAM settings. You can specify the following parameters:

  • total_memory_mb

    Amount of VDU RAM in MB.

  • page_size

    Size of memory pages when deploying the VDU. Possible values:

    • small for 4KB.
    • large for 2 MB or 1 GB.
    • any for any size.
    • 4KB
    • 2MB
    • 2048
    • 1GB

All parameters are mandatory.

network_interfaces

Block

Yes_icon

Network interface settings You can specify the names of network interface using the following parameter:

- name

For each network interface, you can specify the following parameters:

  • type

    Type of the network interface. Mandatory parameter. Possible values:

    • data is a network interface for data transfer.
    • management is a management network interface that is mapped to a network port.
  • description

    Brief description of the network interface. Mandatory parameter.

  • connection_point_ref

    Names of external connection points of the management network interface. Mandatory parameter. You can specify external connection points in the exernal_connections block.

  • port_security 

    Whether you want to enable the Port security function. Optional parameter. Possible values: disabled and enabled.

If you need to specify the vNIC type of the network interface, you need to add the following block:

properties

In this block, you can specify the vNIC type using the following parameter:

vnic_type

Possible values:

  • virtio
  • direct
  • macvtap
  • vhost

auto_healing

Block

Yes_icon

VDU auto-healing parameters. You can specify which external triggers must initiate VDU auto-healing using the following parameter:

triggers_set

Possible values:

  • any to have any external trigger initiate VDU auto-healing.
  • all to initiate VDU auto-healing if all specified external triggers are triggered.
  • <trigger name> to initiate VDU auto-healing when the specified external trigger is triggered.

You can specify which external triggers must trigger to initiate VDU auto-healing using the following block:

triggers

In this block, you can specify the names of external triggers using the following parameter:

- name

Possible values:

  • unreachable
  • scale_up
  • scale_down

You can specify the action that you want performed when an external trigger is triggered using the following block:

action_set

In this block, you can specify the action using the following parameter:

- type

Possible values:

  • reprovision to reprovision the VDU.
  • reboot to restart the VDU.
  • script to run the specified script. When specifying this value, you must specify the name of the script using the following parameter:

    configuration_name_ref

    Scripts can be specified in the configurations block.

bootstrap_timeout

Parameter

No_icon

SSH availability timeout during VDU deployment, in seconds. If the VDU is not available over SSH after the specified timeout expires, the deployment is rolled back.

Example of a 'vdus' 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.