Kaspersky SD-WAN

Contents

Managing network services and virtualization of network functions

Network services

Network services relay traffic over the network and apply network functions to it, such as WAN optimization, shaping, and traffic protection. Each network service has a topology that you build using a graphical design tool. You can add components to the topology and connect them to each other.

You can build a topology in a network service template and then assign that network service template to a tenant. Components added to the template topology are automatically assigned to the tenant together with the network service template. A tenant can create and deploy network services, if necessary, using assigned network service templates, and edit network services that are already deployed.

You can use network services to deploy SD-WAN instances. The network service for deploying SD-WAN instances is called the SD-WAN network service (SD-WAN service).

An example of a network service topology is shown in the figure below.

Catalog_NS_example

Network service topology

Network function virtualization

Network function virtualization (NFV) lets you use virtualized storage, compute resources, and networks to provide network functions and combine these into network services.

You can deploy virtual network functions (VNF) and physical network functions (PNF) in network services. The difference between virtual and physical network functions is that the orchestrator does not manage the lifecycle of physical network functions. Third-party network functions are supported.

Kaspersky SD-WAN complies with the architecture specified in the ETSI NFV MANO specification (NFV Management and Network Orchestration), which defines the following main functional components:

  • .
  • .
  • .
  • The Zabbix monitoring system monitors the status of virtual and physical network functions and notifies the orchestrator when a network function needs to be restored or scaled.
  • The NFV infrastructure consists of physical resources such as hardware storage, servers, and network devices.
  • .

The figure below shows the relations between the solution components and the NFV infrastructure. Components of external solutions are marked in white, Kaspersky SD-WAN components are marked in green, and the red lines are connections between components.The diagram shows the connections between the monitoring system, orchestrator, controller, OpenStack controller, NFVI, and VNF.

NFV infrastructure

In this Help section

Managing network service templates

Managing network services

Scenario: Deploying a virtual network function

Scenario: Deploying a physical network function

Managing VNF and PNF packages

Specifying a brief description of a shared network service

Managing virtual network functions

Managing physical network functions

Configuring a P2P service

Configuring a P2M service

Configuring an M2M service

Configuring a shared network (OS 2 SHARED)

Configuring a virtual router (OS vRouter)

Configuring a VLAN

Configuring a VXLAN

Configuring a flat network

Configuring a UNI

Page top
[Topic 267245]

Managing network service templates

A list of network service templates is displayed on the administrator portal in the Infrastructure section, in the Catalog pane on the Templates tab.

In this section

Creating a network service template

Editing a network service template

Deleting a network service template

Page top
[Topic 266408]

Creating a network service template

To create a network service template:

  1. In the menu, go to the Catalog section.

    The network service management page is displayed.

  2. In the upper part of the page, click + Template.

    The graphical design tool for building the topology is displayed.

  3. Add network service components to the topology:
    1. Drag network server components from the Catalog pane into the graphical design tool. The pane displays the following network service components:
      • Network service templates — when you add a network service template to a topology, the topology is constructed in accordance with the network service template. You can add multiple network service templates to the topology.
      • Shared network services — you must add a shared network service to the topology of network services that you want to connect to the shared network service. You can specify a brief description of the shared network service.
      • Virtual and physical network functions. The actions that you can perform on virtual and physical network functions are described in the Managing virtual network functions and Managing physical network functions sections.
    2. Drag and drop links from the Links tab into the graphical design tool. The following links are displayed on this tab:

      The remaining links are relevant to network communication at the VIM level and are established between VNFs hosted by the OpenStack cloud platform:

    3. Select the UNI tab and drag CPE device UNIs to the graphical design tool. The tab displays two components, UNI and WAN. Both components designate abstract UNIs that the tenant must replace with real UNIs when creating or editing a network service. The WAN component refers to UNIs that connect to the WAN.

      You can configure a UNI in the topology.

    The components are added to the topology and displayed in the graphical design tool.

  4. Connect the network service components added to the topology to each other:
    1. Click the link to which you want to connect a network service component.
    2. Click Add leaf to connect a network service component with the leaf role to the link. If you clicked a P2M service, you can click Add root to connect a network service component with the root role to the link.
    3. Click the network service component that you want to connect to the link. If you clicked a network function or shared network service, select the port to connect the link to in the displayed window.

    The network service component is connected to the link, and a line is displayed between them in the topology. For example, the figure below shows the VLAN to which a virtual network function is connected.

    Catalog_OS_VLAN_add_leaf

  5. If you want to assign backup UNIs:

    A backup UNI can be assigned only for UNIs which are connected to at least one link.

    1. Click the UNI for which you want to assign a backup UNI.
    2. Click Reserve.
    3. Click the UNI that you want to use as the backup.

    The UNI is designated as the backup UNI, and a dotted line is displayed between the UNI, the backup UNI, and the link to which the UNI is connected. For example, in the figure below, the WAN is the backup interface for the UNI.

    Catalog_backup_interface

  6. If you want to remove a network service component from the topology, click the component, then click Delete.

    The network service component is removed from the topology and is no longer displayed in the graphical design tool.

  7. If you want to horizontally align the topology, click Arrange.
  8. If you do not want to hide the descriptions of the added network service components in the topology, clear the Description check box. This check box is selected by default.
  9. In the Name field, enter the name of the network service.
  10. In the upper part of the graphical design tool, click Save.

The network service template is created and displayed in the Catalog pane, on the Templates tab.

Page top
[Topic 244164]

Editing a network service template

When you edit a network service template, the changes are not applied to network services that have already been created and deployed using the network service template.

To edit a network service template:

  1. In the menu, go to the Catalog section.

    The network service management page is displayed.

  2. In the Catalog pane, select the Templates tab.

    A list of network service templates is displayed.

  3. Click the network service template that you want to edit.

    The graphical design tool for building the topology is displayed.

  4. Edit the settings of the network service template. For a description of the settings, see the instructions for creating a network service template.
  5. In the upper part of the graphical design tool, click Save.

The network service template is modified and updated in the Templates tab.

Page top
[Topic 266367]

Deleting a network service template

Deleted network service templates cannot be restored.

To delete a network service template:

  1. In the menu, go to the Catalog section.

    The network service management page is displayed.

  2. In the Catalog pane, select the Templates tab.

    A list of network service templates is displayed.

  3. Click the delete icon next to the network service template that you want to delete.
  4. In the confirmation window, click Delete.

The network service template is deleted and is no longer displayed in the Templates tab.

Page top
[Topic 256184]

Managing network services

The list of network services is displayed on the self-service portal in the Infrastructure section, on the Network services pane. Before managing network services, you must log in to the tenant's self-service portal.

In this section

Creating a network service

Editing a network service

Deploying a network service

Checking the consistency of a network service

Redeploying a network service

Disabling or enabling automatic network service recovery

Viewing the network service log

Deleting a network service

Page top
[Topic 266409]

Creating a network service

To create a network service:

  1. In the menu, go to the Catalog section.

    The network service management page is displayed.

  2. In the upper part of the Network services pane, click + Network service.

    The graphical design tool for building the topology is displayed.

  3. Add network service components to the topology:
    1. Drag network server components from the Catalog pane into the graphical design tool. The pane displays the following network service components:
      • Network service templates — when you add a network service template to a topology, the topology is constructed in accordance with the network service template. You can add multiple network service templates to the topology.
      • Shared network services — you must add a shared network service to the topology of network services that you want to connect to the shared network service. You can specify a brief description of the shared network service.
      • Virtual and physical network functions. The actions that you can perform on virtual and physical network functions are described in the Managing virtual network functions and Managing physical network functions sections.
    2. Drag and drop links from the Links tab into the graphical design tool. The following links are displayed on this tab:

      The remaining links are relevant to network communication at the VIM level and are established between VNFs hosted by the OpenStack cloud platform:

    3. Select the UNI tab and drag CPE device UNIs to the graphical design tool. If you are using a network service template, you must replace the abstract UNIs in the topology with real UNIs. Abstract UNIs can be designated by two components, UNI and WAN. The WAN component refers to UNIs that connect to the WAN.

      You can configure a UNI.

  4. Connect the network service components added to the topology to each other:
    1. Click the link to which you want to connect a network service component.
    2. Click Add leaf to connect a network service component with the leaf role to the link. If you clicked a P2M service, you can click Add root to connect a network service component with the root role to the link.
    3. Click the network service component that you want to connect to the link. If you clicked a network function or shared network service, select the port to connect the link to in the displayed window.

    The network service component is connected to the link, and a line is displayed between them in the topology. For example, the figure below shows the VLAN to which a virtual network function is connected.

    Catalog_OS_VLAN_add_leaf

  5. If you want to assign backup UNIs:

    A backup UNI can be assigned only for UNIs which are connected to at least one link.

    1. Click the UNI for which you want to assign a backup UNI.
    2. Click Reserve.
    3. Click the UNI that you want to use as the backup.

    The UNI is designated as the backup UNI, and a dotted line is displayed between the UNI, the backup UNI, and the link to which the UNI is connected. For example, in the figure below, the WAN is the backup interface for the UNI.

    Catalog_backup_interface

  6. If you want to remove a network service component from the topology, click the component, then click Delete.

    The network service component is removed from the topology and is no longer displayed in the graphical design tool.

  7. If you want to horizontally align the topology, click Arrange.
  8. If you do not want to hide the descriptions of the added network service components in the topology, clear the Description check box. This check box is selected by default.
  9. In the Name field, enter the name of the network service.
  10. Finish creating the network service in one of the following ways:
    • To save the network service, click Save.
    • To save and deploy the network service, click Deploy.

The network service is created and displayed in Network services pane. If you clicked Deploy, the deployment of the network service begins, which may take several minutes. You can interrupt the deployment by clicking Abort deploy.

See also

Scenario: Deploying an SD-WAN instance for a tenant

Page top
[Topic 255976]

Editing a network service

To edit a network service:

  1. In the menu, go to the Catalog section.

    The network service management page is displayed.

  2. In the Network services pane, select the network service that you want to edit.

    The graphical design tool for building the topology is displayed.

  3. In the upper part of the graphical design tool, click Edit.
  4. If necessary, edit the settings of the network service. For a description of the settings, see the instructions for creating a network service.
  5. Finish editing the network service in one of the following ways:
    • If you are editing a network service that is not deployed, do one of the following:
      • To save the network service, click Save.
      • To save and deploy the network service, click Deploy.
    • If you are editing a deployed network service, click Deploy changes to deploy the modified network service.

The network service is modified and updated in Network services pane. If you clicked Deploy or Deploy changes, deployment begins, which may take several minutes. You can interrupt the deployment by clicking Abort deploy.

Page top
[Topic 260680]

Deploying a network service

If a virtual network function deployed on a uCPE device is added to the network service topology and there is connectivity between the orchestrator and the uCPE device, this network service is deployed when connectivity is restored.

To deploy a network service:

  1. In the menu, go to the Catalog section.

    The network service management page is displayed.

  2. In the Network services pane, select the network service that you want to deploy.

    The graphical design tool for building the topology is displayed.

  3. In the upper part of the graphical design tool, click Edit.
  4. Click Deploy.

This starts the deployment of the network service, which may take several minutes. You can interrupt the deployment by clicking Abort deploy.

See also

Scenario: Deploying an SD-WAN instance for a tenant

Page top
[Topic 256183]

Checking the consistency of a network service

The consistency check allows verifying that the components are added to the network service topology actually exist.

To check the consistency of a network service:

  1. In the menu, go to the Catalog section.

    The network service management page is displayed.

  2. In the Network services pane, click the settings icon Check consistency next to the network service whose consistency you want to check.
  3. In the confirmation window, click Confirm.

This begins the consistency check of the network service.

Page top
[Topic 256194]

Redeploying a network service

Redeploying a network service may result in short-term interruptions or temporary inoperability. When planning redeployment activities, we recommend taking into account your organization's circumstances to minimize the disruptions.

To redeploy a network service:

  1. In the menu, go to the Catalog section.

    The network service management page is displayed.

  2. In the Network services pane, click the settings icon → Redeploy next to the network service that you want to redeploy.
  3. In the confirmation window, click Confirm.

This starts the redeployment of the network service, which may take several minutes. You can interrupt the deployment by clicking Abort deploy.

Page top
[Topic 256195]

Disabling or enabling auto-healing for a network service

The Zabbix server monitors network service components and sends a REST API request to the orchestrator whenever a problem is detected. If the auto-healing functionality is enabled for the network service, the orchestrator initiates auto-healing for components with problems. By default, this functionality is enabled.

To disable or enable auto-healing for a network service:

  1. In the menu, go to the Catalog section.

    The network service management page is displayed.

  2. In the Network services pane, click the settings icon → Disable Auto-Healing or Enable Auto-Healing next to the network service for which you want to disable or enable auto-healing.

Auto-healing is disabled or enabled for the network service.

You can perform auto-healing of virtual network functions or their VDUs even if auto-healing is disabled for the network service.

Page top
[Topic 256193]

Viewing the network service log

To view the log of a network service:

  1. In the menu, go to the Catalog section.

    The network service management page is displayed.

  2. In the Network services pane, click the settings icon Open log next to the network service whose log you want to view.

The page with the network service log is displayed.

Page top
[Topic 256190]

Deleting a network service

Deleted network services cannot be restored.

To delete a network service:

  1. In the menu, go to the Catalog section.

    The network service management page is displayed.

  2. In the Network services pane, click the settings icon Delete next to the network service that you want to delete.
  3. In the confirmation window, click Delete.

The network service is deleted and is no longer displayed in the Network services pane.

Page top
[Topic 256207]

Scenario: Deploying a virtual network function

You can deploy a virtual network function for a tenant in a network service. The lifecycle of virtual network functions is managed by an orchestrator. To deploy virtual network functions, you need the OpenStack cloud platform.

For example, you can deploy a virtual network function at the central office of your organization to protect user traffic that is transmitted between CPE devices.

Virtual network function deployment involves the following steps:

  1. Preparing a VNF package

    Prepare the VNF package that you want to deploy, and then upload the VNF package to the orchestrator web interface. If necessary, you can enable protection of VNF and PNF packages against substitution before uploading the VNF package to the orchestrator web interface.

  2. Ensuring network connectivity between the orchestrator and the OpenStack cloud platform

    Ensure network connectivity between the virtual machine or physical server where the orchestrator is deployed and the OpenStack cloud platform.

  3. Assigning the virtual network function to a tenant

    Use one of the following methods to assign the virtual network function to the tenant for which you want to deploy it:

  4. Logging in to the tenant self-service portal

    Log in to the tenant self-service portal

  5. Deploying the virtual network function

    Do the following:

    1. Add the virtual network function to the topology when creating or editing a network service in one of the following ways:
      • If you want to deploy a virtual network function using a network service template, add the network service template to the topology.
      • If you want to deploy a virtual network function without a network service template, add the virtual network function to the topology.
    2. If necessary, configure the topology of the network service and the virtual network function. For a description of what you can do with virtual network functions, see the Managing virtual network functions section.
    3. Deploy the virtual network function using one of the following methods:
      • If you added the virtual network function to the topology while creating the network service, deploy the network service.
      • If you added the virtual network function to the topology while editing a network service, deploy the modified network service.

The virtual network function is deployed.

Page top
[Topic 287247]

Scenario: Deploying a physical network function

You can deploy a physical network function for a tenant in a network service. As physical network functions, you can use dedicated hardware as well as virtual entities created using third-party virtualization environments. The orchestrator does not manage the lifecycle of physical network functions.

For example, you can deploy a physical network function at the central office of your organization to protect user traffic that is transmitted between CPE devices.

Physical network function deployment involves the following steps:

  1. Preparing the PNF package

    Prepare the PNF package that you want to deploy, and then upload the PNF package to the orchestrator web interface. If necessary, you can enable protection of VNF and PNF packages against substitution before uploading the PNF package to the orchestrator web interface.

  2. Ensuring network connectivity between the orchestrator and the physical network function

    Ensure network connectivity between the virtual machine or physical server on which the orchestrator is deployed and the dedicated hardware or virtual entity on which you want to deploy the physical network function.

  3. Assigning the physical network function to a tenant

    Use one of the following methods to assign the physical network function to the tenant for which you want to deploy it:

  4. Logging in to the tenant self-service portal

    Log in to the tenant self-service portal

  5. Deploying a physical network function

    Do the following:

    1. Add the physical network function to the topology when creating or editing a network service in one of the following ways:
      • If you want to deploy a physical network function using a network service template, add the network service template to the topology.
      • If you want to deploy a physical network function without a network service template, add the physical network function to the topology.
    2. If necessary, configure the topology of the network service and the physical network function. For a description of what you can do with physical network functions, see the Managing physical network functions section.
    3. Deploy the physical network function using one of the following methods:
      • If you added the physical network function to the topology while creating the network service, deploy the network service.
      • If you added the physical network function to the topology while editing a network service, deploy the modified network service.

The physical network function is deployed.

Page top
[Topic 287412]

Managing VNF and PNF packages

A VNF or PNF package is a ZIP archive in which you must place the following components to deploy a network function and manage its lifecycle:

  • The VNF/PNF descriptor, a file with parameters of the network function.
  • The /image directory, which contains virtual machine images in the QCOW format for deploying the virtual network function. This directory is not included in the PNF package.
  • The /scripts directory, which contains scripts for deploying and managing the network function.
  • logo.png, the icon of the network function. This component is optional.
  • description-file.pdf, technical documentation or specification of the network function. This component is optional.

You must upload the VNF or PNF package to the orchestrator web interface to add a virtual or physical network function to the topology when managing a network service template or network service.

In this section

Configuring the VNF descriptor

Configuring the PNF descriptor

Protection of VNF and PNF packages against spoofing and modification

Uploading a VNF or PNF package to the orchestrator web interface

Page top
[Topic 267236]

Configuring the VNF descriptor

Expand all | Collapse all

Specify the settings of the virtual network function in a VNF descriptor in YAML or XML format, then add the VNF descriptor to the root directory of the VNF package. A VNF descriptor has the following structure:

Section/setting

Description

name

Name of the virtual network function.

description

Brief description of the virtual network function.

description_file

Name of the PDF file with the technical documentation or specification of the virtual network function. This file must be placed in the root directory of the VNF package. Users can view and download the file in the orchestrator web interface.

Optional parameter.

provider

Provider of the virtual network function.

version

Version of the virtual network function.

external_connections

External connection points of the virtual network function. You can configure the specified external connection points of the virtual network function in the orchestrator web interface.

internal_connections

Internal connection points of VDUs that are part of the virtual network function.

This section is optional.

virtual_links

Virtual links for connecting internal connection points.

This section must be specified if you specified the internal_connections section.

images

VDU disk images. You can deploy multiple VDUs using the same VDU disk image.

configurations

Scripts for performing actions at various stages of the virtual network function lifecycle, for example, during deployment of the virtual network function.

flavours

Flavours of the virtual network function. You can select one of the specified flavours of the virtual network function in the orchestrator web interface.

scaling

Virtual network function scaling parameters.

This section is optional.

user_configurations

Orchestrator web interface inputs that are added to the settings area of the virtual network function.

This section is optional.

backups

Virtual network function backup tasks.

This section is optional.

VNF descriptor example

name: OpenWrt18

description: OpenWrt 18.06.1

description_file: openwrt-presentation.pdf

provider: Kaspersky

version: 1.0.1

external_connections:

- name: LAN

description: eth1

ip: AUTO

mask: AUTO

group: eth1-group

- name: WAN

description: eth2

ip: AUTO

mask: AUTO

group: eth2-group

images:

- name: openwrt

container_format: BARE

disk_format: QCOW2

type: OPENSTACK

filename: openwrt-18.06.1-x86-64.qcow2

configurations:

- name: config

filename: config.yml

stage: initialization

executor: ansible

authentication: password

- name: config2

filename: 3VDU.sh

stage: initialization

executor: /bin/sh

authentication: key

- name: config3

filename: 2VDU.sh

stage: initialization

executor: /bin/sh

authentication: key

flavours:

- name: 2VDU

description: 1 vCPU, 512MB memory

position: 1

affinity:

groups:

- name: aff

vdu_name:

- OpenWrt

- OpenWrt2

management:

vnc:

- vdu_name: OpenWrt

ssh:

- vdu_name: OpenWrt

def_user: root

authentication: key

web:

- vdu_name: OpenWrt

vdus:

- name: OpenWrt

password_rules:

length: 12

use_upper_case: true

use_lower_case: true

use_digits: true

specific_symbols: .?$#@![]-{}

specific_symbols_min_usage: 2

zabbix_template: Template OS Linux

monitoring_type: agent

ssh_port: 22

configurations:

- config

- config3

def_user: root

def_password: p@ssw0rd

password_authentication: yes

disks:

- name: default

order: 1

type: default

image: openwrt

storage_gb: 1

cpu:

smt: prefer

cpu_pinning: dedicated

num_vpu: 1

memory:

total_memory_mb: 512

network_interfaces:

- name: Management

type: management

description: eth0

- name: eth1

type: data

description: eth1

connection_point_ref: LAN

- name: eth2

type: data

description: eth2

connection_point_ref: WAN

auto_healing:

triggers_set: any

triggers:

- name: unreachable

action_set:

- type: reprovision

- name: OpenWrt2

password_rules:

length: 12

use_upper_case: true

use_lower_case: true

use_digits: true

specific_symbols: .?$#@![]-{}

specific_symbols_min_usage: 2

zabbix_template: Template OS Linux

monitoring_type: agent

ssh_port: 22

configurations:

- config

- config3

def_user: root

def_password: p@ssw0rd

password_authentication: yes

disks:

- name: default

order: 1

type: default

image: openwrt

storage_gb: 1

cpu:

smt: prefer

cpu_pinning: dedicated

num_vpu: 1

memory:

total_memory_mb: 512

network_interfaces:

- name: Management

type: management

description: eth0

- name: eth1

type: data

description: eth1

connection_point_ref: LAN

- name: eth2

type: data

description: eth2

connection_point_ref: WAN

auto_healing:

triggers_set: any

triggers:

- name: unreachable

action_set:

- type: reprovision

- name: VDU

description: 1 vCPU, 512MB memory

position: 2

affinity:

groups:

- name: aff

vdu_name:

- OpenWrt

- OpenWrt2

- OpenWrt3

management:

vnc:

- vdu_name: OpenWrt

ssh:

- vdu_name: OpenWrt

def_user: root

authentication: key

web:

- vdu_name: OpenWrt

vdus:

- name: OpenWrt

password_rules:

length: 12

use_upper_case: true

use_lower_case: true

use_digits: true

specific_symbols: .?$#@![]-{}

specific_symbols_min_usage: 2

check_connection_mode: none

zabbix_template: Template OS Linux

monitoring_type: agent

ssh_port: 22

configurations:

- config

- config2

def_user: root

def_password: p@ssword

password_authentication: yes

disks:

- name: default

order: 1

type: default

image: openwrt

storage_gb: 1

cpu:

smt: prefer

cpu_pinning: dedicated

num_vpu: 1

memory:

total_memory_mb: 512

network_interfaces:

- name: Management

type: management

description: eth0

- name: eth1

type: data

description: eth1

connection_point_ref: LAN

- name: eth2

type: data

description: eth2

connection_point_ref: WAN

auto_healing:

triggers_set: any

triggers:

- name: unreachable

action_set:

- type: reprovision

- name: OpenWrt2

password_rules:

length: 12

use_upper_case: true

use_lower_case: true

use_digits: true

specific_symbols: .?$#@![]-{}

specific_symbols_min_usage: 2

zabbix_template: Template OS Linux

monitoring_type: agent

ssh_port: 22

configurations:

- config

- config2

def_user: root

def_password: p@ssw0rd

password_authentication: yes

disks:

- name: default

order: 1

type: default

image: openwrt

storage_gb: 1

cpu:

smt: prefer

cpu_pinning: dedicated

num_vpu: 1

memory:

total_memory_mb: 512

network_interfaces:

- name: Management

type: management

description: eth0

- name: eth1

type: data

description: eth1

connection_point_ref: LAN

- name: eth2

type: data

description: eth2

connection_point_ref: WAN

auto_healing:

triggers_set: any

triggers:

- name: unreachable

action_set:

- type: reprovision

- name: OpenWrt3

password_rules:

length: 12

use_upper_case: true

use_lower_case: true

use_digits: true

specific_symbols: .?$#@![]-{}

specific_symbols_min_usage: 2

zabbix_template: Template OS Linux

monitoring_type: agent

ssh_port: 22

configurations:

- config

- config2

def_user: root

def_password: p@ssw0rd

password_authentication: yes

disks:

- name: default

order: 1

type: default

image: openwrt

storage_gb: 1

cpu:

smt: prefer

cpu_pinning: dedicated

num_vpu: 1

memory:

total_memory_mb: 512

network_interfaces:

- name: Management

type: management

description: eth0

- name: eth1

type: data

description: eth1

connection_point_ref: LAN

- name: eth2

type: data

description: eth2

connection_point_ref: WAN

auto_healing:

triggers_set: any

triggers:

- name: unreachable

action_set:

- type: reprovision

scaling:

scale_in_status: permit

scale_out_status: "permit"

user_configurations:

tab:

- name: GW

variables:

- name: "gw_ip"

description: IP

input_type: input

required: true

type: string

default_value: 192.168.0.1

example: 192.168.0.1

- name: direction

description: traffic direction

input_type: dropdown

required: true

type: string

values:

- value: in

is_default: true

- value: out

update_configuration_name:

- update_var

- change

backups:

- name: backup_config

description: backup/etc/config

backup:

path: /root/config.thz

interval: 600

store_configs: 10

backup_type: vnfm_scp

authentication: key

configuration_name_ref: backup

restore:

path: /tmp/config.tgz

backup_type: vnfm_scp

authentication: password

configuration_name_ref: restore

external_connections

The external_connections section has the following structure:

Section/setting

Description

- name

Name of the external connection point.

 

description

Brief description of the external connection point.

ip

IP address of the external connection point. Enter a value in the XXX.XXX.XXX.XXX format, for example:

192.168.110.126

mask

Subnet mask of the external connection point. Possible values:

  • Value in the XXX.XXX.XXX.XXX format, for example:

    255.255.255.0

    The subnet mask is assigned using DHCP via MAC-based reservation of an OpenStack port. In this case, the subnet mask cannot be changed.

  • AUTO — The subnet mask is assigned automatically using an external DHCP server or scripts. You can specify scripts in the configurations section.
  • MANUAL — the subnet mask must be specified manually in the orchestrator web interface when configuring external connection points of the virtual network function.

gw

IP address of the gateway of the external connection point. Possible values:

  • Value in the XXX.XXX.XXX.XXX format, for example:

    192.168.110.126

    The IP address is assigned using DHCP via MAC-based reservation of an OpenStack port. In this case, the IP address cannot be changed.

  • AUTO — The IP address is assigned automatically using an external DHCP server or scripts from the configurations section.
  • MANUAL — the IP address must be specified manually in the orchestrator web interface when configuring external connection points of the virtual network function.

Optional parameter.

dns

IP address of the DNS server of the external connection point. Possible values:

  • Value in the XXX.XXX.XXX.XXX format, for example:

    192.168.110.126

    The IP address is assigned using DHCP via MAC-based reservation of an OpenStack port. In this case, the IP address cannot be changed.

  • AUTO — The IP address is assigned automatically using an external DHCP server or scripts from the configurations section.
  • MANUAL — the IP address must be specified manually in the orchestrator web interface when configuring external connection points of the virtual network function.

Optional parameter.

group

The group to which the external connection point belongs.

This setting is required if multiple VDUs within the virtual network function use the same external connection point.

Example of this section

external_connections:

- name: LAN

description: eth1

ip: 192.168.2.0

mask: 255.255.255.0

gw: 192.168.0.1

dns: 192.168.0.10

group: lan-group

internal_connections

The internal_connections section has the following structure:

Section/setting

Description

- name

Name of the internal connection point.

 

description

Brief description of the internal connection point.

virtual_link_name

Name of the virtual link from the virtual_links section for the internal connection point.

ip

IP address of the internal connection point. Possible values:

  • Value in the XXX.XXX.XXX.XXX format, for example:

    192.168.110.126

    The IP address is assigned using DHCP via MAC-based reservation of an OpenStack port. In this case, the IP address cannot be changed.

  • AUTO — The IP address is assigned automatically using an external DHCP server or scripts. You can specify scripts in the configurations section.
  • MANUAL — the IP address must be specified manually in the orchestrator web interface when configuring external connection points of the virtual network function.

mask

Subnet mask of the internal connection point. Possible values:

  • Value in the XXX.XXX.XXX.XXX format, for example:

    255.255.255.0

    The subnet mask is assigned using DHCP via MAC-based reservation of an OpenStack port. In this case, the subnet mask cannot be changed.

  • AUTO — The subnet mask is assigned automatically using an external DHCP server or scripts. You can specify scripts in the configurations section.

gw

IP address of the gateway of the internal connection point. Possible values:

  • Value in the XXX.XXX.XXX.XXX format, for example:

    192.168.110.126

    The IP address is assigned using DHCP via MAC-based reservation of an OpenStack port. In this case, the IP address cannot be changed.

  • AUTO — The IP address is assigned automatically using an external DHCP server or scripts from the configurations section.

Optional parameter.

dns

IP address of the DNS server of the internal connection point. Possible values:

  • Value in the XXX.XXX.XXX.XXX format, for example:

    192.168.110.126

    The IP address is assigned using DHCP via MAC-based reservation of an OpenStack port. In this case, the IP address cannot be changed.

  • AUTO — The IP address is assigned automatically using an external DHCP server or scripts from the configurations section.

Optional parameter.

group

The group to which the internal connection point belongs.

This setting is required if multiple VDUs within the virtual network function use the same internal connection point.

Example of this section

internal_connections:

- name: LAN

description: eth3

ip: 192.168.2.0

mask: 255.255.255.0

gw: 192.168.0.1

dns: 192.168.0.10

group: lan-group

virtual_link_name: int-link

virtual_links

The virtual_links section has the following structure:

Section/setting

Description

- name

Name of the virtual link.

 

cidr

IPv4 prefix of the virtual link. Enter a value in the XXX.XXX.XXX.XXX/XX format, for example:

192.168.2.0/24

ip_version

Version of IP addresses in the subnet. Possible values:

  • v4
  • v6

Example of this section

virtual_links:

- name: int_link

cidr: 203.0.113.0/24

ip_version: v4

images

The images section has the following structure:

Section/setting

Description

- name

Name of the VDU disk image.

 

container_format

Container format of the VDU disk image.

disk_format

Format of the VDU disk image.

type

VIM type.

file_name

File name of the VDU disk image. You must place the VDU disk image in the /image directory of the VNF package.

Example of this section

images:

- name: VDU_img

container_format: BARE

disk_format: QCOW2

type: OPENSTACK

filename: VDU_img.qcow2

configurations

The configurations section has the following structure:

Section/setting

Description

- name

Name of the script.

 

filename

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

The stage of operation of the virtual network function at which the script runs. Possible values:

executor

Script interpreter. Possible values:

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

     

  • <path to the custom script interpreter>, for example /usr/bin/php.

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 virtual network 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 with a user name and password from the flavours → vdus section.

files_path

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

Optional parameter.

config_drive

Using config-drive. Possible values:

  • true
  • false

     

This parameter must be specified if as the executor, you specified cloud_init.

timeout

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

You can specify this parameter if you have specified a path to a custom script executor for the executor parameter.

Example of this section

configurations:

- name: config

filename: config.yml

stage: initialization

executor: ansible

authentication: password

files_path: SSH_scripts

config_drive: true

timeout: 15

flavours

The flavours section has the following structure:

Section/setting

Description

- name

Name of the deployment option.

 

description

Brief description of the flavour.

position

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

affinity

Groups of VDUs 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

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

management

Parameters of VDU administration consoles.

vdus

VDU settings.

The affinity and anti-affinity sections have the following structure:

Section/setting

Description

groups

VDU groups.

 

- name

Name of the VDU group.

 

vdu_name

Names of VDUs. Specify a list of values, for example:

vdu_name:

- VDU_1

- VDU_2

The management section has the following structure:

Section/setting

Description

vnc

Settings for managing VDUs using the VNC console.

 

- vdu_name

Name of the VDU.

ssh

Settings for managing VDUs using the SSH console.

 

- vdu_name

Name of the VDU.

 

def_user

User name for establishing the SSH session.

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 virtual network function is deployed. You need to get the key using a script from the configurations section.
  • password means the VNFM is authenticated in the virtual network function with a user name and password from the vdus section.

web

Settings for managing VDUs using the web console.

 

- vdu_name

Name of the VDU.

 

protocol

Protocol for connecting to the web console. Possible values:

  • http
  • https

port

Port for connecting to the web console. Enter a value in the range of 1 to 65,536. By default, port 80 is used.

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.

The vdus section has the following structure:

Section/setting

Description

- name

Name of the VDU.

 

password_rules

VDU password requirements. This section is optional.

 

length

Minimum length of the password.

use_upper_case

Users must use uppercase characters in the password. Possible values:

  • true
  • false

use_lower_case

Users must use lowercase characters in the password. Possible values:

  • true
  • false

use_digits

Users must use numerals in the password. Possible values:

  • true
  • false

specific_symbols

Whether users must use special characters in the password, such as:

@"!

specific_symbols_min_usage

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

check_connection_mode

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

  • ssh
  • none

Optional parameter.

zabbix_template

Name of the Zabbix template for the VDU.

monitoring_type

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

Port number for establishing an SSH session.

Optional parameter.

configurations

Names of scripts from the configurations section to be run on the VDU. Specify a list of values, for example:

vdu_name:

- config_1

- config_2

backups

Names of backup tasks from the backups to be used on the VDU. Specify a list of values, for example:

vdu_name:

- backup_1

- backup_2

This section is optional.

def_user

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

Optional parameter.

def_password

Password for authenticating the VNFM in the virtual network function.

Optional parameter.

password_authentication

Password authentication of the VNFM in the virtual network function. Possible values:

  • yes
  • no

Optional parameter.

disks

Parameters of VDU virtual disks.

 

- name

Name of the VDU virtual disk.

 

order

Mounting order of the VDU virtual disk.

type

Type of the ephemeral OpenStack disk.

image

Name of the VDU virtual disk image from the images section.

Optional parameter if you are creating a blank VDU disk.

storage_db

Size of the VDU virtual disk in gigabytes.

cpu

VDU CPU 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

Use of 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.

memory

VDU RAM settings.

 

total_memory_mb

Amount of VDU RAM in megabytes.

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

network_interfaces

Network interface settings

 

- name

Name of the network interface.

 

type

Type of the network interface. 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.

connection_point_ref

Name of the external connection point from the external_connections section for the management network interface.

port_security

Whether

is used. Possible values:

  • disabled
  • enabled

Optional parameter.

properties

Advanced settings of the network interface.

 

vnic_type

vNIC type of the network interface. Possible values:

  • virtio
  • direct
  • macvtap
  • vhost

auto_healing

VDU auto-healing parameters.

 

triggers_set

External triggers that initiate VDU auto-healing. 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.

triggers

External triggers.

 

- name

Name of the external trigger. Possible values:

  • unreachable
  • scale_up
  • scale_down

action_set

Action to perform when an external trigger is triggered.

 

- type

Type of action. Possible values:

  • reprovision to reprovision the VDU.
  • reboot to restart the VDU.
  • script to run the specified script.

configuration_name_ref

Name of the script from the configuration section that is run when an external trigger is triggered.

This parameter must be specified if as the - type, you selected script.

bootstrap_timeout

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.

Optional parameter.

Example of this section

vdus:

- name: vgw

password_rules:

length: 12

use_upper_case: true

use_lower_case: true

use_digits: true

specific_symbols: .?$#@![]-{}

specific_symbols_min_usage: 2

check_connection_mode: none

zabbix_template: Template OS Linux

monitoring_type: agent

ssh_port: 22

configurations:

- config_1

- config_2

backups:

- backup_config

def_user: root

def_password: p@ssw0rd

password_authentication: yes

disks:

- name: "default"

order: 1

type: default

image: openwrt

storage_gb: 1

cpu:

smt: prefer

cpu_pinning: dedicated

num_vpu: 1

memory:

total_memory_mb: 512

page_size: small

network_interfaces:

- name: eth

type: data

description: eth0

connection_point_ref: WAN

auto_healing:

triggers_set: any

triggers:

- name: unreachable

action_set:

- type: reprovision

scaling

The scaling section has the following structure:

Parameter

Description

scale_in_status

Horizontal scaling to a scaling option with a lower sequential number. Possible values:

  • permit
  • deny

scale_out_status

Horizontal scaling to a scaling option with a higher sequential number. Possible values:

  • permit
  • deny

scale_up_status

Vertical scaling to a scaling option with a lower sequential number. Possible values:

  • permit
  • deny

scale_down_status

Vertical scaling to a scaling option with a higher sequential number. Possible values:

  • permit
  • deny

Example of this section

scaling:

scale_in_status: permit

scale_out_status: permit

scale_up_status: permit

scale_down_status: permit

user_configurations

The user_configurations section has the following structure:

Section/setting

Description

tab

Tabs that are added to the settings area of the virtual network function.

- name

Name of the tab.

 

variables

Orchestrator web interface inputs that are displayed on the tab.

- name

Name of the orchestrator web interface input.

 

description

Brief description of the orchestrator web interface input.

input_type

Type of the orchestrator web interface input. Possible values:

  • input to add a field.
  • dropdown to add a drop-down list.

default_value

Default value of the field.

You can specify this parameter if as the input_type, you specified input.

values

The options that are displayed in the drop-down list.

This setting can be specified if as the input_type, you specified dropdown.

- value

The name of the value.

 

is_default

Default value. Possible values:

  • true
  • false

Optional parameter.

required

Required orchestrator web interface input. Possible values:

  • true
  • false

Optional parameter.

type

The type of value that can be specified in the orchestrator web interface input.

Optional parameter.

example

A tooltip that is displayed when the value of the orchestrator web interface input changes.

Optional parameter.

update_configuration_name

Names of scripts from the configurations section that are run when the value of the orchestrator web interface input changes. Specify a list of values, for example:

update_configuration_name:

- config_1

- config_2

Example of this section

user_configurations:

tab:

- name: GW

variables:

- name: "gw_ip"

description: IP

input_type: input

required: true

type: string

default_value: 192.168.0.1

example: 192.168.0.1

- name: direction

description: traffic direction

input_type: dropdown

required: true

type: string

values:

- value: in

is_default: true

- value: out

update_configuration_name:

- update_var

- change

backups

The backups section has the following structure:

Section/setting

Description

- name

Name of the backup task.

 

description

Brief description of the backup task.

backup

Backup parameters.

 

path

Path to the virtual network function directory where the files that you want to backup are located.

interval

Time interval in seconds for backup.

store_config

Number of backup copies to keep.

backup_type

Type of backup.

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 virtual network function is deployed. You need to get the key using a script from the configurations section.
  • password means the VNFM is authenticated in the virtual network function with a user name and password from the flavours → vdus section.

configuration_name_ref

Name of the script from the configurations section to run before the backup.

restore

Backup restoration parameters.

 

path

Path to the virtual network function directory where the restored files are placed.

backup_type

Type of backup.

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 virtual network function is deployed. You need to get the key using a script from the configurations section.
  • password means the VNFM is authenticated in the virtual network function with a user name and password from the flavours → vdus section.

configuration_name_ref

Name of the script from the configurations section to run after the restoration from backup begins.

Example of this section

backups:

- name: backup_config

description: backup/etc/config

backup:

path: /root/config.thz

interval: 600

store_configs: 10

backup_type: vnfm_scp

authentication: key

configuration_name_ref: backup

restore:

path: /tmp/config.tgz

backup_type: vnfm_scp

authentication: password

configuration_name_ref: restore

Page top
[Topic 266608]

Configuring the PNF descriptor

Expand all | Collapse all

Specify the settings of the physical network function in a PNF descriptor in YAML or XML format, then add the PNF descriptor to the root directory of the PNF package. A PNF descriptor has the following structure:

Section/setting

Description

name

Name of the physical network function.

description

Brief description of the physical network function.

description_file

Name of the PDF file with the technical documentation or specification of the physical network function. This file must be placed in the root directory of the PNF package. Users can view and download the file in the orchestrator web interface.

Optional parameter.

provider

Provider of the physical network function.

version

Version of the physical network function.

external_connections

External connection points of the physical network function.

internal_connections

Internal connection points of VDUs that are part of the physical network function.

This section is optional.

configurations

Scripts for performing actions at various stages of the physical network function lifecycle, for example, during deployment of the physical network function.

flavours

Flavours of the physical network function. You can select one of the specified flavours of the physical network function in the orchestrator web interface.

scaling

Physical network function scaling parameters.

This section is optional.

user_configurations

Orchestrator web interface inputs that are added to the settings area of the physical network function.

This section is optional.

backups

Physical network function backup tasks.

This section is optional.

PNF descriptor example

name: OpenWrt18

description: OpenWrt 18.06.1

description_file: openwrt-presentation.pdf

provider: Kaspersky

version: 1.0.1

external_connections:

- name: LAN

description: eth1

ip: AUTO

mask: AUTO

group: eth1-group

- name: WAN

description: eth2

ip: AUTO

mask: AUTO

group: eth2-group

configurations:

- name: config

filename: config.yml

stage: initialization

executor: ansible

authentication: password

- name: config2

filename: 3VDU.sh

stage: initialization

executor: /bin/sh

authentication: key

- name: config3

filename: 2VDU.sh

stage: initialization

executor: /bin/sh

authentication: key

flavours:

- name: 2VDU

description: 1 vCPU, 512MB memory

position: 1

management:

ssh:

- vdu_name: OpenWrt

def_user: root

authentication: key

web:

- vdu_name: OpenWrt

vdus:

- name: OpenWrt

password_rules:

length: 12

use_upper_case: true

use_lower_case: true

use_digits: true

specific_symbols: .?$#@![]-{}

specific_symbols_min_usage: 2

zabbix_template: Template OS Linux

monitoring_type: agent

ssh_port: 22

configurations:

- config

- config3

def_user: root

def_password: p@ssw0rd

password_authentication: yes

network_interfaces:

- name: Management

type: management

description: eth0

- name: eth1

type: data

description: eth1

connection_point_ref: LAN

- name: eth2

type: data

description: eth2

connection_point_ref: WAN

auto_healing:

triggers_set: any

triggers:

- name: unreachable

action_set:

- type: reboot

- name: OpenWrt2

password_rules:

length: 12

use_upper_case: true

use_lower_case: true

use_digits: true

specific_symbols: .?$#@![]-{}

specific_symbols_min_usage: 2

zabbix_template: Template OS Linux

monitoring_type: agent

ssh_port: 22

configurations:

- config

- config3

def_user: root

def_password: p@ssw0rd

password_authentication: yes

network_interfaces:

- name: Management

type: management

description: eth0

- name: eth1

type: data

description: eth1

connection_point_ref: LAN

- name: eth2

type: data

description: eth2

connection_point_ref: WAN

auto_healing:

triggers_set: any

triggers:

- name: unreachable

action_set:

- type: reboot

- name: VDU

description: 1 vCPU, 512MB memory

position: 2

management:

ssh:

- vdu_name: OpenWrt

def_user: root

authentication: key

web:

- vdu_name: OpenWrt

vdus:

- name: OpenWrt

password_rules:

length: 12

use_upper_case: true

use_lower_case: true

use_digits: true

specific_symbols: .?$#@![]-{}

specific_symbols_min_usage: 2

check_connection_mode: none

zabbix_template: Template OS Linux

monitoring_type: agent

ssh_port: 22

configurations:

- config

- config2

def_user: root

def_password: p@ssword

password_authentication: yes

network_interfaces:

- name: Management

type: management

description: eth0

- name: eth1

type: data

description: eth1

connection_point_ref: LAN

- name: eth2

type: data

description: eth2

connection_point_ref: WAN

auto_healing:

triggers_set: any

triggers:

- name: unreachable

action_set:

- type: reboot

- name: OpenWrt2

password_rules:

length: 12

use_upper_case: true

use_lower_case: true

use_digits: true

specific_symbols: .?$#@![]-{}

specific_symbols_min_usage: 2

zabbix_template: Template OS Linux

monitoring_type: agent

ssh_port: 22

configurations:

- config

- config2

def_user: root

def_password: p@ssw0rd

password_authentication: yes

network_interfaces:

- name: Management

type: management

description: eth0

- name: eth1

type: data

description: eth1

connection_point_ref: LAN

- name: eth2

type: data

description: eth2

connection_point_ref: WAN

auto_healing:

triggers_set: any

triggers:

- name: unreachable

action_set:

- type: reboot

- name: OpenWrt3

password_rules:

length: 12

use_upper_case: true

use_lower_case: true

use_digits: true

specific_symbols: .?$#@![]-{}

specific_symbols_min_usage: 2

zabbix_template: Template OS Linux

monitoring_type: agent

ssh_port: 22

configurations:

- config

- config2

def_user: root

def_password: p@ssw0rd

password_authentication: yes

network_interfaces:

- name: Management

type: management

description: eth0

- name: eth1

type: data

description: eth1

connection_point_ref: LAN

- name: eth2

type: data

description: eth2

connection_point_ref: WAN

auto_healing:

triggers_set: any

triggers:

- name: unreachable

action_set:

- type: reboot

scaling:

scale_in_status: permit

scale_out_status: "permit"

user_configurations:

tab:

- name: GW

variables:

- name: "gw_ip"

description: IP

input_type: input

required: true

type: string

default_value: 192.168.0.1

example: 192.168.0.1

- name: direction

description: traffic direction

input_type: dropdown

required: true

type: string

values:

- value: in

is_default: true

- value: out

update_configuration_name:

- update_var

- change

backups:

- name: backup_config

description: backup/etc/config

backup:

path: /root/config.thz

interval: 600

store_configs: 10

backup_type: vnfm_scp

authentication: key

configuration_name_ref: backup

restore:

path: /tmp/config.tgz

backup_type: vnfm_scp

authentication: password

configuration_name_ref: restore

external_connections

The external_connections section has the following structure:

Section/setting

Description

- name

Name of the external connection point.

 

description

Brief description of the external connection point.

ip

IP address of the external connection point. Enter a value in the XXX.XXX.XXX.XXX format, for example:

192.168.110.126

mask

Subnet mask of the external connection point. Possible values:

  • Value in the XXX.XXX.XXX.XXX format, for example:

    255.255.255.0

    The subnet mask is assigned using DHCP via MAC-based reservation of an OpenStack port. In this case, the subnet mask cannot be changed.

  • AUTO — The subnet mask is assigned automatically using an external DHCP server or scripts. You can specify scripts in the configurations section.

gw

IP address of the gateway of the external connection point. Possible values:

  • Value in the XXX.XXX.XXX.XXX format, for example:

    192.168.110.126

    The IP address is assigned using DHCP via MAC-based reservation of an OpenStack port. In this case, the IP address cannot be changed.

  • AUTO — The IP address is assigned automatically using an external DHCP server or scripts from the configurations section.

Optional parameter.

dns

IP address of the DNS server of the external connection point. Possible values:

  • Value in the XXX.XXX.XXX.XXX format, for example:

    192.168.110.126

    The IP address is assigned using DHCP via MAC-based reservation of an OpenStack port. In this case, the IP address cannot be changed.

  • AUTO — The IP address is assigned automatically using an external DHCP server or scripts from the configurations section.

Optional parameter.

group

The group to which the external connection point belongs.

This setting is required if multiple VDUs within the physical network function use the same external connection point.

Example of this section

external_connections:

- name: LAN

description: eth1

ip: 192.168.2.0

mask: 255.255.255.0

gw: 192.168.0.1

dns: 192.168.0.10

group: lan-group

internal_connections

The internal_connections section has the following structure:

Section/setting

Description

- name

Name of the internal connection point.

 

description

Brief description of the internal connection point.

ip

IP address of the internal connection point. Possible values:

  • Value in the XXX.XXX.XXX.XXX format, for example:

    192.168.110.126

    The IP address is assigned using DHCP via MAC-based reservation of an OpenStack port. In this case, the IP address cannot be changed.

  • AUTO — The IP address is assigned automatically using an external DHCP server or scripts. You can specify scripts in the configurations section.

mask

Subnet mask of the internal connection point. Possible values:

  • Value in the XXX.XXX.XXX.XXX format, for example:

    255.255.255.0

    The subnet mask is assigned using DHCP via MAC-based reservation of an OpenStack port. In this case, the subnet mask cannot be changed.

  • AUTO — The subnet mask is assigned automatically using an external DHCP server or scripts. You can specify scripts in the configurations section.

gw

IP address of the gateway of the internal connection point. Possible values:

  • Value in the XXX.XXX.XXX.XXX format, for example:

    192.168.110.126

    The IP address is assigned using DHCP via MAC-based reservation of an OpenStack port. In this case, the IP address cannot be changed.

  • AUTO — The IP address is assigned automatically using an external DHCP server or scripts from the configurations section.

Optional parameter.

dns

IP address of the DNS server of the internal connection point. Possible values:

  • Value in the XXX.XXX.XXX.XXX format, for example:

    192.168.110.126

    The IP address is assigned using DHCP via MAC-based reservation of an OpenStack port. In this case, the IP address cannot be changed.

  • AUTO — The IP address is assigned automatically using an external DHCP server or scripts from the configurations section.

Optional parameter.

group

The group to which the internal connection point belongs.

This setting is required if multiple VDUs within the physical network function use the same internal connection point.

Example of this section

internal_connections:

- name: LAN

description: eth3

ip: 192.168.2.0

mask: 255.255.255.0

gw: 192.168.0.1

dns: 192.168.0.10

group: lan-group

configurations

The configurations section has the following structure:

Section/setting

Description

- name

Name of the script.

 

filename

File name of the script or Ansible playbook. You must place the script in the /scripts directory of the PNF package.

stage

The stage of operation of the physical network function at which the script runs. Possible values:

executor

Script interpreter. Possible values:

  • ansible
  • expect
  • /bin/sh
  • bin/bash
  • <path to the custom script interpreter>, for example /usr/bin/php.

authentication

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

  • key means the VNFM is authenticated in the physical network function using a key that is generated when that physical network 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 physical network function with a user name and password from the flavours → vdus section.

files_path

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

Optional parameter.

timeout

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

You can specify this parameter if you have specified a path to a custom script executor for the executor parameter.

Example of this section

configurations:

- name: config

filename: config.yml

stage: initialization

executor: ansible

authentication: password

files_path: SSH_scripts

config_drive: true

timeout: 15

flavours

The flavours section has the following structure:

Section/setting

Description

- name

Name of the deployment option.

 

description

Brief description of the flavour.

position

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

management

Parameters of VDU administration consoles.

vdus

VDU settings.

The management section has the following structure:

Section/setting

Description

ssh

Settings for managing VDUs using the SSH console.

 

- vdu_name

Name of the VDU.

 

def_user

User name for establishing the SSH session.

authentication

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

  • key means the VNFM is authenticated in the physical network function using a key that is generated when that physical network function is deployed. You need to get the key using a script from the configurations section.
  • password means the VNFM is authenticated in the physical network function with a user name and password from the vdus section.

web

Settings for managing VDUs using the web console.

 

- vdu_name

Name of the VDU.

 

protocol

Protocol for connecting to the web console. Possible values:

  • http
  • https

port

Port for connecting to the web console. Enter a value in the range of 1 to 65,536. By default, port 80 is used.

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.

The vdus section has the following structure:

Section/setting

Description

- name

Name of the VDU.

 

password_rules

VDU password requirements. This section is optional.

 

length

Minimum length of the password.

use_upper_case

Users must use uppercase characters in the password. Possible values:

  • true
  • false

use_lower_case

Users must use lowercase characters in the password. Possible values:

  • true
  • false

use_digits

Users must use numerals in the password. Possible values:

  • true
  • false

specific_symbols

Whether users must use special characters in the password, such as:

@"!

specific_symbols_min_usage

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

check_connection_mode

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

  • ssh
  • none

Optional parameter.

zabbix_template

Name of the Zabbix template for the VDU.

monitoring_type

Monitoring type of the physical network function. Possible values:

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

ssh_port

Port number for establishing an SSH session.

Optional parameter.

configurations

Names of scripts from the configurations section to be run on the VDU. Specify a list of values, for example:

vdu_name:

- config_1

- config_2

backups

Names of backup tasks from the backups to be used on the VDU. Specify a list of values, for example:

vdu_name:

- backup_1

- backup_2

This section is optional.

def_user

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

Optional parameter.

def_password

Password for authenticating the VNFM in the physical network function.

Optional parameter.

password_authentication

Password authentication of the VNFM in the physical network function. Possible values:

  • yes
  • no

Optional parameter.

network_interfaces

Network interface settings

 

- name

Name of the network interface.

 

type

Type of the network interface. 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.

connection_point_ref

Name of the external connection point from the external_configurations section for the management network interface.

auto_healing

VDU auto-healing parameters.

 

triggers_set

External triggers that initiate VDU auto-healing. 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.

triggers

External triggers.

 

- name

Name of the external trigger. Possible values:

  • unreachable
  • scale_up
  • scale_down

action_set

Action to perform when an external trigger is triggered.

 

- type

Type of action. Possible values:

  • reboot to restart the VDU.
  • script to run the specified script.

configuration_name_ref

Name of the script from the configuration section that is run when an external trigger is triggered.

This parameter must be specified if as the - type, you selected script.

Example of this section

vdus:

- name: vgw

password_rules:

length: 12

use_upper_case: true

use_lower_case: true

use_digits: true

specific_symbols: .?$#@![]-{}

specific_symbols_min_usage: 2

check_connection_mode: none

zabbix_template: Template OS Linux

monitoring_type: agent

ssh_port: 22

configurations:

- config_1

- config_2

backups:

- backup_config

def_user: root

def_password: p@ssw0rd

password_authentication: yes

network_interfaces:

- name: eth

type: data

description: eth0

connection_point_ref: WAN

auto_healing:

triggers_set: any

triggers:

- name: unreachable

action_set:

- type: reprovision

scaling

The scaling section has the following structure:

Parameter

Description

scale_up_status

Vertical scaling to a scaling option with a lower sequential number. Possible values:

  • permit
  • deny

scale_down_status

Vertical scaling to a scaling option with a higher sequential number. Possible values:

  • permit
  • deny

Example of this section

scaling:

scale_in_status: permit

scale_out_status: permit

user_configurations

The user_configurations section has the following structure:

Section/setting

Description

tab

Tabs that are added to the settings area of the physical network function.

- name

Name of the tab.

 

variables

Orchestrator web interface inputs that are displayed on the tab.

- name

Name of the orchestrator web interface input.

 

description

Brief description of the orchestrator web interface input.

input_type

Type of the orchestrator web interface input. Possible values:

  • input to add a field.
  • dropdown to add a drop-down list.

default_value

Default value of the field.

You can specify this parameter if as the input_type, you specified input.

values

The options that are displayed in the drop-down list.

This setting can be specified if as the input_type, you specified dropdown.

- value

The name of the value.

 

is_default

Default value. Possible values:

  • true
  • false

Optional parameter.

required

Required orchestrator web interface input. Possible values:

  • true
  • false

Optional parameter.

type

The type of value that can be specified in the orchestrator web interface input.

Optional parameter.

example

A tooltip that is displayed when the value of the orchestrator web interface input changes.

Optional parameter.

update_configuration_name

Names of scripts from the configurations section that are run when the value of the orchestrator web interface input changes. Specify a list of values, for example:

update_configuration_name:

- config_1

- config_2

Example of this section

user_configurations:

tab:

- name: GW

variables:

- name: "gw_ip"

description: IP

input_type: input

required: true

type: string

default_value: 192.168.0.1

example: 192.168.0.1

- name: direction

description: traffic direction

input_type: dropdown

required: true

type: string

values:

- value: in

is_default: true

- value: out

update_configuration_name:

- update_var

- change

backups

The backups section has the following structure:

Section/setting

Description

- name

Name of the backup task.

 

description

Brief description of the backup task.

backup

Backup parameters.

 

path

Path to the physical network function directory where the files that you want to backup are located.

interval

Time interval in seconds for backup.

store_config

Number of backup copies to keep.

backup_type

Type of backup.

authentication

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

  • key means the VNFM is authenticated in the physical network function using a key that is generated when that physical network function is deployed. You need to get the key using a script from the configurations section.
  • password means the VNFM is authenticated in the physical network function with a user name and password from the flavours → vdus section.

configuration_name_ref

Name of the script from the configurations section to run before the backup.

restore

Backup restoration parameters.

 

path

Path to the physical network function directory where the restored files are placed.

backup_type

Type of backup.

authentication

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

  • key means the VNFM is authenticated in the physical network function using a key that is generated when that physical network function is deployed. You need to get the key using a script from the configurations section.
  • password means the VNFM is authenticated in the physical network function with a user name and password from the flavours → vdus section.

configuration_name_ref

Name of the script from the configurations section to run after the restoration from backup begins.

Example of this section

backups:

- name: backup_config

description: backup/etc/config

backup:

path: /root/config.thz

interval: 600

store_configs: 10

backup_type: vnfm_scp

authentication: key

configuration_name_ref: backup

restore:

path: /tmp/config.tgz

backup_type: vnfm_scp

authentication: password

configuration_name_ref: restore

Page top
[Topic 287355]

Protection of VNF and PNF packages against substitution and modification

Some VNF and PNF package files are placed in the local directory of the Docker container of the orchestrator, and you can protect them against substitution and modification. When VNF and PNF packages are protected, the orchestrator automatically computes their SHA256 hash when they are uploaded to the orchestrator web interface. When accessing files in the local directory of the Docker container, the orchestrator compares their current SHA256 hash with the previously saved hash. If the SHA256 hashes do not match, the orchestrator prevents users from performing actions with the network function, such as adding it to the topology of a network service.

To protect of VNF and PNF packages against substitution and modification:

  1. In the lower part of the menu, click the settings icon → Storage security.
  2. This opens a window, in that window, select the Calculate hash sum SHA256 for VNF/PNF files on storage check box. This check box is cleared by default.

VNF and PNF packages are protected against substitution and modification.

Page top
[Topic 275010]

Uploading a VNF or PNF package to the orchestrator web interface

To upload a VNF or PNF package to the orchestrator web interface:

  1. In the menu, go to the Catalog section.

    The network service management page is displayed.

  2. In the upper part of the page, click + VNF or + PNF.
  3. This opens a window; in that window, select the VNF or PNF package.
  4. If you want to check the integrity of the VNF or PNF package, enter its SHA256 hash in the Hash sum SHA256 field. Maximum length: 64 characters.
  5. Click Save.

The VNF or PNF package is uploaded to the orchestrator web interface. The VNF or PNF is displayed in the Catalog pane. If you entered a SHA256 hash of a VNF or PNF package, the orchestrator compares the hash you entered with the actual SHA256 hash. If the SHA256 hashes do not match, the VNF or PNF package is not uploaded.

See also

Scenario: Deploying an SD-WAN instance for a tenant

Page top
[Topic 265540]

Specifying a brief description of a shared network service

You can specify a brief description of the shared network service.

  1. Navigate to the topology in one of the following ways:
  2. In the graphical design tool, click the shared network service for which you want to specify a brief description.

    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 Settings tab is selected, which displays a brief description of the shared network service.

  3. In the Description field, enter a brief description of the shared network service.
  4. In the upper part of the settings area, click Save to save shared network service settings.
Page top
[Topic 271373]

Managing virtual network functions

To manage a virtual network function, do one of the following:

Virtual network function settings are displayed on the following tabs:

  • Flavours contains flavours of the virtual network function.
  • Connection points contains external connection points of the virtual network function.
  • VNF settings contains basic settings of the virtual network function.
  • Placement contains placement settings of the virtual network function. You can place a virtual network function in a data center or on a uCPE device. This tab is displayed if you clicked the virtual network function when creating or editing a network service.

The following tabs are displayed if you clicked the virtual network function in the topology of a deployed network service:

Additionally, the tabs that you specified in the user_configurations section of the VNF descriptor may be displayed.

In this section

Selecting the flavour of a virtual network function

Configuring external connection points of a virtual network function

Basic settings of a virtual network function

Hosting the virtual network function in a data center and on a uCPE device

Stopping or starting a virtual network function or a VDU that is part of it

Pausing or unpausing a virtual network function or a VDU that is part of it

Suspending or unsuspending a virtual network function or a VDU that is part of it

Soft rebooting a virtual network function or a VDU that is part of it

Hard rebooting of a virtual network function or a VDU that is part of it

Redeploying a virtual network function or a VDU that is part of it

Automatically restoring a virtual network function or a VDU that is part of it

Managing VDU snapshots

Page top
[Topic 271370]

Selecting the flavour of a virtual network function

You can specify flavours in the flavours section of the VNF descriptor.

To select a virtual network function flavour:

  1. Navigate to the topology in one of the following ways:
  2. Click the virtual network function for which you want to select a deployment option.

    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 Flavours tab is selected, which displays flavours.

  3. Select a flavour for the virtual network function.
  4. In the upper part of the settings area, click Save to save virtual network function settings.
Page top
[Topic 260679]

Configuring external connection points of a virtual network function

You can specify external connection points of a virtual network function in the external_connections section of the VNF descriptor.

To configure external connection points of the virtual network function:

  1. Navigate to the topology in one of the following ways:
  2. Click the virtual network function for which you want to configure external connection points.

    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 Flavours tab is selected, which displays flavours.

  3. Select the Connection points tab.

    This displays the external connection points of the virtual network function.

  4. In the Type drop-down list, select how you want to assign an IPv4 prefix to the external connection point:
    • DHCP reservation to use DHCP to assign an IPv4 prefix to the external mount point. If you select this option, do the following:
      1. In the IP field, enter the IPv4 address that DHCP assigns to the external connection point.
      2. In the Mask field, enter the subnet mask that DHCP assigns to the external connection point.
    • AUTO to automatically assign an IPv4 prefix to the external connection point. Default value.
  5. In the Description field, enter a brief description of the external connection point.
  6. If you want to designate the connection point as the trunk port, select the Trunk check box. This check box is cleared by default.
  7. In the upper part of the settings area, click Save to save virtual network function settings.
Page top
[Topic 271391]

Basic settings of a virtual network function

To edit basic settings of the virtual network function:

  1. Navigate to the topology in one of the following ways:
  2. Click the virtual network function for which you want to configure basic settings.

    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 Flavours tab is selected, which displays flavours.

  3. Select the VNF settings tab.

    Basic settings of the virtual network function are displayed.

  4. In the Name field, enter the name of the virtual network function.
  5. In the Description field, enter a brief description of the virtual network function.
  6. In the Order field, enter the sequence number for deploying the virtual network function on the OpenStack cloud platform. When you deploy a network service, the virtual network function with the lowest number is the first to be deployed. If none of the virtual network functions added to the network service topology have a sequence number specified, all virtual network functions are deployed simultaneously.
  7. In the upper part of the settings area, click Save to save virtual network function settings.
Page top
[Topic 255085]

Hosting the virtual network function in a data center and on a uCPE device

To place a virtual network function in a data center or on a uCPE device.

  1. Navigate to the topology by starting to create or edit a network service.
  2. Click the virtual network function that you want to place in a data center or on a uCPE device.

    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 Flavours tab is selected, which displays flavours.

  3. Select the Placement tab.

    Placement settings of the virtual network function are displayed.

  4. In the Select placement type list, select one of the following values:
    • Data center to place the virtual network function in the specified data center. If you select this option, do the following:
      1. In the Data center field, enter the name of the created data center. As you type the name, you are prompted to select a data center from a drop-down list.
      2. In the VIM field, enter the name of the deployed VIM for the VNF. As you type the name, you are prompted to select a VIM from a drop-down list.
    • uCPE to place the VNF on the specified uCPE device. If you select this option, in the uCPE field, enter the name of the uCPE device. As you type the name, you are prompted to select an uCPE from a drop-down list.
  5. In the upper part of the settings area, click Save to save virtual network function settings.
Page top
[Topic 271393]

Stopping or starting a virtual network function or a VDU that is part of it

You can stop a virtual network function or a VDU that is part of it to free up the computational resources of the OpenStack cloud platform.

When you start a virtual network function or VDU, it begins consuming computational resources again. This restarts the processes running on the virtual network function or VDU.

To stop or start a virtual network function or a VDU that is part of it:

  1. On the self-service portal, go to the Catalog menu section.

    The network service management page is displayed.

  2. In the Network services pane, click the deployed network service to whose topology the virtual network function has been added.

    The topology is displayed.

  3. Click the virtual network function.

    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 Flavours tab is selected, which displays flavours.

  4. If you want to stop or start the virtual network function, in the upper part of the settings area, click the Management → Power → Stop VNF or Start VNF.
  5. If you want to stop or start a VDU that is part of the virtual network function:
    1. Select the VDU management tab.

      A table of VDUs is displayed.

    2. Click Management → Power → Stop VDU or Start VDU next to the VDU that you want to stop or start.
  6. In the confirmation window, click Apply.

The virtual network function or its VDU is stopped or started.

Page top
[Topic 260624]

Pausing or unpausing a virtual network function or a VDU that is part of it

You can pause a virtual network function or a VDU that is part of it to pause processes running on it. However, the virtual network function or VDU continues to consume the computational resources of the OpenStack cloud platform. When you unpause a virtual network function or VDU, processes running on it are resumed.

To pause or unpause a virtual network function or a VDU that is part of it:

  1. On the self-service portal, go to the Catalog menu section.

    The network service management page is displayed.

  2. In the Network services pane, click the deployed network service to whose topology the virtual network function has been added.

    The topology is displayed.

  3. Click the virtual network function.

    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 Flavours tab is selected, which displays flavours.

  4. Pause or unpause the virtual network function or a VDU that is part of it:
    • If you want to pause or unpause a virtual network function, in the upper part of the settings area, click Management → Pause VNF → Power or Unpause VNF.
    • If you want to pause or unpause a VDU that is part of the virtual network function:
      1. Select the VDU management tab.

        A table of VDUs is displayed.

      2. Click Management → Power → Pause VDU or Unpause VDU.
  5. In the confirmation window, click Apply.

The virtual network function or its VDU is paused or unpaused.

Page top
[Topic 260647]

Suspending or unsuspending a virtual network function or a VDU that is part of it

You can suspend a virtual network function or a VDU that is part of it to free up the computational resources of the OpenStack cloud platform. This saves the state of the virtual network function or VDU to the disk of the OpenStack virtual platform. When you unsuspend the virtual network function or VDU, it begins consuming computational resources again. Processes running on a virtual network function or VDU are resumed from the point at which its state was saved.

To suspend or unsuspend a virtual network function or its VDU:

  1. On the self-service portal, go to the Catalog menu section.

    The network service management page is displayed.

  2. In the Network services pane, click the deployed network service to whose topology the virtual network function has been added.

    The topology is displayed.

  3. Click the virtual network function.

    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 Flavours tab is selected, which displays flavours.

  4. Suspend or unsuspend a virtual network function or its VDU:
    • If you want to suspend or unsuspend a virtual network function, in the upper part of the settings area, click Management → Suspend VNF → Power or Resume suspended VNF.
    • If you want to suspend or unsuspend a VDU that is part of the virtual network function:
      1. Select the VDU management tab.

        A table of VDUs is displayed.

      2. Click Management → Power → Suspend VDU or Resume suspended VDU next to the VDU that you want to suspend or unsuspend.
  5. In the confirmation window, click Apply.

The virtual network function or its VDU is suspended or unsuspended.

Page top
[Topic 267158]

Soft rebooting a virtual network function or a VDU that is part of it

When a virtual network function is soft rebooted, all active VDUs in it are restarted. To soft reboot a virtual network function, at least one VDU in it must not be suspended.

To perform a soft reboot of a virtual network function or a VDU that is part of it:

  1. On the self-service portal, go to the Catalog menu section.

    The network service management page is displayed.

  2. In the Network services pane, click the deployed network service to whose topology the virtual network function has been added.

    The topology is displayed.

  3. Click the virtual network function.

    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 Flavours tab is selected, which displays flavours.

  4. Perform a soft reboot of a virtual network function or its VDU:
    • If you want to perform a soft reboot of the virtual network function, in the upper part of the settings area, click Management → Power → Soft reboot VNF.
    • If you want to soft reboot a VDU that is part of the virtual network function:
      1. Select the VDU management tab.

        A table of VDUs is displayed.

      2. Click Management → Power → Soft reboot VDU next to the VDU that you want to soft reboot.
  5. In the confirmation window, click Apply.

The virtual network function or its VDU is soft rebooted.

Page top
[Topic 260631]

Hard rebooting of a virtual network function or a VDU that is part of it

A hard reboot imitates turning power on and off again. We recommend that performing a hard reboot only if soft reboot is not successful.

To perform a hard reboot of a virtual network function or a VDU that is part of it:

  1. On the self-service portal, go to the Catalog menu section.

    The network service management page is displayed.

  2. In the Network services pane, click the deployed network service to whose topology the virtual network function has been added.

    The topology is displayed.

  3. Click the virtual network function.

    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 Flavours tab is selected, which displays flavours.

  4. To perform a hard reboot of a virtual network function or its VDU:
    • If you want to perform a hard reboot of the virtual network function, in the upper part of the settings area, click Management → Power → Hard reboot VNF.
    • If you want to hard reboot a VDU that is part of the virtual network function:
      1. Select the VDU management tab.

        A table of VDUs is displayed.

      2. Click Management → Power → Hard reboot VDU next to the VDU that you want to hard reboot.
  5. In the confirmation window, click Apply.

A hard reboot of the VNF or its VDU is performed.

Page top
[Topic 260636]

Redeploying a virtual network function or a VDU that is part of it

Redeployment of a virtual network function or a VDU that is part of it may result in short-term interruptions or temporary loss of function. When planning and coordinating redeployment activities, we recommend taking into account your organization's circumstances to minimize the disruptions.

To redeploy a virtual network function or a VDU that is part of it:

  1. On the self-service portal, go to the Catalog menu section.

    The network service management page is displayed.

  2. In the Network services pane, click the deployed network service to whose topology the virtual network function has been added.

    The topology is displayed.

  3. Click the virtual network function.

    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 Flavours tab is selected, which displays flavours.

  4. To redeploy a virtual network function or its VDU:
    • If you want to redeploy the virtual network function, in the upper part of the configuration area, click Management → Redeploy VNF.
    • If you want to redeploy a VDU that is part of the virtual network function:
      1. Select the VDU management tab.

        A table of VDUs is displayed.

      2. Click Management → Healing VDU next to the VDU that you want to redeploy.
  5. In the confirmation window, click Confirm.

Redeployment of the virtual network function or its VDU begins, which may take several minutes. You can interrupt the deployment by clicking Abort deploy.

Page top
[Topic 260612]

Auto-healing a virtual network function or a VDU that is part of it

You can auto-heal a virtual network function or a VDU that is part of it, even if you have disabled auto-healing of the network service to whose topology this virtual network function has been added.

To auto-heal a virtual network function or a VDU that is part of it:

  1. On the self-service portal, go to the Catalog menu section.

    The network service management page is displayed.

  2. In the Network services pane, click the deployed network service to whose topology the virtual network function has been added.

    The topology is displayed.

  3. Click the virtual network function.

    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 Flavours tab is selected, which displays flavours.

  4. Perform auto-healing of the virtual network function or its VDU.
    • If you want to auto-heal the virtual network function, in the upper part of the settings area, click Management → Healing VNF.
    • If you want to auto-heal a VDU that is part of the virtual network function:
      1. Select the VDU management tab.

        A table of VDUs is displayed.

      2. Click Management → Healing VNF next to the VDU that you want to auto-heal.
  5. In the confirmation window, click Apply.

Auto-healing of the virtual network function or a VDU that is part of it begins.

Page top
[Topic 260618]

Managing VDU snapshots

To display the table of VDU snapshots, click the virtual network function in the topology of the deployed network service, select the VDU management tab, and click Management → Snapshot next to the VDU.

Information about VDU snapshots is displayed in the following columns of the table:

  • Name is the name of the VDU snapshot.
  • Created at is the date and time when the VDU snapshot was created.
  • Size is the size of the VDU snapshot.
  • Description is a brief description of the VDU snapshot.
  • Management contains actions that can be performed on the VDU snapshot.

In this section

Creating a VDU snapshot

Restoring VDU settings using a snapshot

Editing a VDU snapshot

Deleting a VDU snapshot

Page top
[Topic 271410]

Creating a VDU snapshot

We do not recommend storing snapshots for a long time because their existence reduces the performance of the VDU.

To take a VDU snapshot:

  1. On the self-service portal, go to the Catalog menu section.

    The network service management page is displayed.

  2. In the Network services pane, click the deployed network service to whose topology the virtual network function has been added.

    The topology is displayed.

  3. Click the virtual network function that includes the VDU.

    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 Flavours tab is selected, which displays flavours.

  4. Select the VDU management tab.

    A table of VDUs is displayed.

  5. Click Power → Snapshot next to the VDU for which you want to create a snapshot.

    This opens a window with the table of VDU snapshots.

  6. In the Name field, enter a name for the VDU snapshot.
  7. In the Description field, enter a brief description of the VDU snapshot.
  8. Click Create.

A snapshot of the VDU is created and displayed in the table.

Page top
[Topic 260603]

Restoring VDU settings using a snapshot

To restoring VDU settings using a snapshot:

  1. On the self-service portal, go to the Catalog menu section.

    The network service management page is displayed.

  2. In the Network services pane, click the deployed network service to whose topology the virtual network function has been added.

    The topology is displayed.

  3. Click the virtual network function that includes the VDU.

    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 Flavours tab is selected, which displays flavours.

  4. Select the VDU management tab.

    A table of VDUs is displayed.

  5. Click Power → Snapshot next to the VDU whose settings you want to restore using the snapshot.

    This opens a window with the table of VDU snapshots.

  6. Click Management → Revert next to the snapshot which you want to use to restore the VDU settings.
  7. In the confirmation window, click Revert.

The VDU settings are restored in accordance with the snapshot.

Page top
[Topic 267229]

Editing a VDU snapshot

To edit a VDU snapshot:

  1. On the self-service portal, go to the Catalog menu section.

    The network service management page is displayed.

  2. In the Network services pane, click the deployed network service to whose topology the virtual network function has been added.

    The topology is displayed.

  3. Click the virtual network function that includes the VDU.

    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 Flavours tab is selected, which displays flavours.

  4. Select the VDU management tab.

    A table of VDUs is displayed.

  5. Click Power → Snapshot next to the VDU whose snapshot you want to edit.

    This opens a window with the table of VDU snapshots.

  6. Click Management → Edit next to the VDU snapshot that you want to edit.
  7. This opens a window; in that window, if necessary, edit the name and/or description of the VDU snapshot.
  8. Click Save.

The VDU snapshot is modified and updated in the table.

Page top
[Topic 267226]

Deleting a VDU snapshot

Deleted VDU snapshots cannot be restored.

To delete a VDU snapshot:

  1. On the self-service portal, go to the Catalog menu section.

    The network service management page is displayed.

  2. In the Network services pane, click the deployed network service to whose topology the virtual network function has been added.

    The topology is displayed.

  3. Click the virtual network function that includes the VDU.

    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 Flavours tab is selected, which displays flavours.

  4. Select the VDU management tab.

    A table of VDUs is displayed.

  5. Click Power → Snapshot next to the VDU whose snapshot you want to delete.

    This opens a window with the table of VDU snapshots.

  6. Click Management → Delete next to the VDU snapshot that you want to delete.
  7. In the confirmation window, click Delete.

The VDU snapshot is deleted and is no longer displayed in the table.

Page top
[Topic 267232]

Managing physical network functions

To manage a physical network function, do one of the following:

Physical network function settings are displayed on the following tabs:

  • Flavours contains flavours of the physical network function.
  • VNF settings contains basic settings of the physical network function.

The following tabs are displayed if you clicked the physical network function in the topology of a deployed network service:

Additionally, the tabs that you specified in the user_configurations section of the PNF descriptor may be displayed.

In this section

Selecting the flavour of a physical network function

Basic settings of a physical network function

Page top
[Topic 271379]

Selecting the flavour of a physical network function

You can specify flavours in the flavours section of the PNF descriptor.

To select a physical network function flavour:

  1. Navigate to the topology in one of the following ways:
  2. Click the physical network function for which you want to select a deployment option.

    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 Flavours tab is selected, which displays flavours.

  3. Select a flavour for the physical network function.
  4. In the upper part of the settings area, click Save to save physical network function settings.
Page top
[Topic 271505]

Basic settings of a physical network function

To edit basic settings of the physical network function:

  1. Navigate to the topology in one of the following ways:
  2. Click the physical network function for which you want to configure basic settings.

    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 Flavours tab is selected, which displays flavours.

  3. Select the PNF settings tab.

    Basic settings of the physical network function are displayed.

  4. In the Name field, enter the name of the physical network function.
  5. In the Description field, enter a brief description of the physical network function.
  6. In the Order field, enter the sequence number for deploying the physical network function on the OpenStack cloud platform. When you deploy a network service, the physical network function with the lowest number is the first to be deployed. If none of the physical network functions added to the topology have a sequence number specified, all physical network functions are deployed simultaneously.
  7. In the upper part of the settings area, click Save to save physical network function settings.
Page top
[Topic 271506]

Configuring a P2P service

To configure a P2P service:

  1. Navigate to the topology in one of the following ways:
  2. Click the P2P service that you want to configure.

    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 .

  3. In the Name field, enter the name of the P2P service.
  4. If necessary, in the Description field, enter a brief description of the P2P service.
  5. In the upper part of the settings area, click Save to save P2P service settings.
Page top
[Topic 254792]

Configuring a P2M service

To configure a P2M service:

  1. Navigate to the topology in one of the following ways:
  2. Click the P2M service that you want to configure.

    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 .

  3. In the Name field, enter the name of the P2M service.
  4. If necessary, in the Description field, enter a brief description of the P2M service.
  5. In the Connection points field, enter the maximum number of P2M service connection points. Range of values: 2 to 9999. If you do not specify a value for this setting, the number of connection points is unlimited.
  6. In the Mode drop-down list, select whether the P2M service uses a DFI (Default Forwarding Interface), to which unknown unicast traffic is sent:
    • Classic if you do not want to use DFI. Default value.
    • DFI with FIB on root and leafs if you want to use DFI on the service interface with the root role.
    • DFI with FIB on leaf if you want to use DFI on the service interface with the root role. Service interfaces with the leaf role must be created on the same CPE device. Backup service interfaces with the leaf role must be created on the same CPE device, which must be different from the CPE device on which the primary service interfaces are created.
  7. In the MAC age (sec.) field, enter the time period in seconds during which entries are kept in the MAC table of the controller. Range of values: 10 to 65,535. Default value: 300.
  8. In the MAC learn mode drop-down list, select the action that you want to apply to a series of frames when the first frame is sent to the controller to learn the source MAC address:
    • Learn and flood means the controller remembers the MAC address of the source and checks for the presence of the destination MAC address in the MAC table. If the destination MAC address is not in the MAC table, the series of frames is sent to all service interfaces added to the P2M service, except for the service interface on which the series of frames originally arrived. Default value.
    • Learn and drop means the controller remembers the MAC address of the source and checks for the presence of the destination MAC address in the MAC table. If the destination MAC address is not in the MAC table, the series of frames is dropped.

    If the destination MAC address is present in the MAC table, the series of frames is sent to the destination service interface.

  9. In the MAC table size field, enter the maximum number of entries in the MAC table on the controller. Range of values: 0 to 65,535. 0 means the number of entries is not limited. Default value: 100.
  10. In the MAC table overload drop-down list, select the policy for processing new MAC addresses when the MAC table of the controller is full:
    • Flood means traffic with destination MAC addresses that have not been learned is transmitted as BUM traffic (Broadcast, unknown-unicast, and multicast). Default value.
    • Drop means that traffic with destination MAC addresses that have not been learned is dropped.
  11. If you want to configure the assignment of IP address to virtual network functions using DHCP:
    1. In the OpenStack DHCP drop-down list, select Enabled. The default value is Disable.
    2. In the CIDR field, enter the IPv4 prefix of the OpenStack subnet that assigns IP addresses to virtual network functions.
    3. If you want the OpenStack subnet to assign a particular gateway to virtual network functions, enter the IPv4 address of the gateway in the Gateway field.
    4. Specify the range of IP addresses from which the OpenStack subnet assigns IP addresses to virtual network functions: To do so, under Pools, click + Pooland enter the starting and ending values of the IP address range.

      The range of IP addresses is specified and displayed in the Pools section. You can specify multiple IP address ranges or delete an IP address range. To delete an IP address range, click Delete next to it.

    5. Specify the DNS server that the OpenStack subnet assigns to virtual network functions. To do so, under DNS, click + DNS and enter the IPv4 address of the DNS server.

      The DNS server is specified and displayed in the DNS section. You can specify multiple DNS servers or delete a DNS server. To delete a DNS server, click Delete next to it.

  12. In the upper part of the settings area, click Save to save P2M service settings.
Page top
[Topic 254794]

Configuring an M2M service

To configure an M2M service:

  1. Navigate to the topology in one of the following ways:
  2. Click the M2M service that you want to configure.

    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 .

  3. In the Name field, enter the name of the M2M service.
  4. If necessary, in the Description field, enter a brief description of the M2M service.
  5. In the Connection points field, enter the maximum number of M2M service connection points. Range of values: 2 to 9999. If you do not specify a value for this setting, the number of connection points is unlimited.
  6. In the MAC age (sec.) field, enter the time period in seconds during which entries are kept in the MAC table of the controller. Range of values: 10 to 65,535. Default value: 300.
  7. In the MAC learn mode drop-down list, select the action that you want to apply to a series of frames when the first frame is sent to the controller to learn the source MAC address:
    • Learn and flood means the controller remembers the MAC address of the source and checks for the presence of the destination MAC address in the MAC table. If the destination MAC address is not in the MAC table, the series of frames is sent to all service interfaces added to the P2M service, except for the service interface on which the series of frames originally arrived. Default value.
    • Learn and drop means the controller remembers the MAC address of the source and checks for the presence of the destination MAC address in the MAC table. If the destination MAC address is not in the MAC table, the series of frames is dropped.

    If the destination MAC address is present in the MAC table, the series of frames is sent to the destination service interface.

  8. In the MAC table size field, enter the maximum number of entries in the MAC table on the controller. Range of values: 0 to 65,535. 0 means the number of entries is not limited. Default value: 100.
  9. In the MAC table overload drop-down list, select the policy for processing new MAC addresses when the MAC table of the controller is full:
    • Flood means traffic with destination MAC addresses that have not been learned is transmitted as BUM traffic (Broadcast, unknown-unicast, and multicast). Default value.
    • Drop means that traffic with destination MAC addresses that have not been learned is dropped.
  10. If you want to configure the assignment of IP address to virtual network functions using DHCP:
    1. In the OpenStack DHCP drop-down list, select Enabled. The default value is Disable.
    2. In the CIDR field, enter the IPv4 prefix of the OpenStack subnet that assigns IP addresses to virtual network functions.
    3. If you want the OpenStack subnet to assign a particular gateway to virtual network functions, enter the IPv4 address of the gateway in the Gateway field.
    4. Specify the range of IP addresses from which the OpenStack subnet assigns IP addresses to virtual network functions: To do so, under Pools, click + Pooland enter the starting and ending values of the IP address range.

      The range of IP addresses is specified and displayed in the Pools section. You can specify multiple IP address ranges or delete an IP address range. To delete an IP address range, click Delete next to it.

    5. Specify the DNS server that the OpenStack subnet assigns to virtual network functions. To do so, under DNS, click + DNS and enter the IPv4 address of the DNS server.

      The DNS server is specified and displayed in the DNS section. You can specify multiple DNS servers or delete a DNS server. To delete a DNS server, click Delete next to it.

  11. If you want to use an M2M service to create a shared network service, select the Share network service check box. This check box is cleared by default.
  12. In the upper part of the settings area, click Save to save M2M service settings.
Page top
[Topic 254826]

Configuring a shared network (OS 2 SHARED)

To configure a shared network in the topology:

  1. Navigate to the topology in one of the following ways:
  2. Click the shared network that you want to configure.

    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 .

  3. In the Name field, enter the name of the shared network.
  4. If necessary, in the Description field, enter a brief description of the shared network.
  5. In the upper part of the settings area, click Save to save shared network settings.
Page top
[Topic 254897]

Configuring a virtual router (OS vRouter)

To configure a virtual router:

  1. Navigate to the topology in one of the following ways:
  2. Click the virtual router that you want to configure.

    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 .

  3. In the Name field, enter the name of the virtual router.
  4. If necessary, in the Description field, enter a brief description of the virtual router.
  5. If you want to set the 'up' value for the operating state of the virtual router, select the Administrative state check box. This check box is cleared by default.
  6. In the upper part of the settings area, click Save to save virtual router settings.
Page top
[Topic 254899]

Configuring a VLAN

To configure a VLAN:

  1. Navigate to the topology in one of the following ways:
  2. Click the VLAN that you want to configure.

    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 .

  3. In the Name field, enter the name of the VLAN.
  4. If necessary, in the Description field, enter a brief description of the VLAN.
  5. If you want to configure the assignment of IP address to virtual network functions using DHCP:
    1. In the OpenStack DHCP drop-down list, select Enabled. The default value is Disable.
    2. In the CIDR field, enter the IPv4 prefix of the OpenStack subnet that assigns IP addresses to virtual network functions.
    3. If you want the OpenStack subnet to assign a particular gateway to virtual network functions, enter the IPv4 address of the gateway in the Gateway field.
    4. Specify the range of IP addresses from which the OpenStack subnet assigns IP addresses to virtual network functions: To do so, under Pools, click + Pooland enter the starting and ending values of the IP address range.

      The range of IP addresses is specified and displayed in the Pools section. You can specify multiple IP address ranges or delete an IP address range. To delete an IP address range, click Delete next to it.

    5. Specify the DNS server that the OpenStack subnet assigns to virtual network functions. To do so, under DNS, click + DNS and enter the IPv4 address of the DNS server.

      The DNS server is specified and displayed in the DNS section. You can specify multiple DNS servers or delete a DNS server. To delete a DNS server, click Delete next to it.

  6. If you want to use the VLAN to create a shared network service, select the Share network check box. This check box is cleared by default.
  7. If you want to assign a VLAN tag to virtual network functions, in the Segmentation ID field, enter the VLAN tag.
  8. In the upper part of the settings area, click Save to save VLAN settings.
Page top
[Topic 254901]

Configuring a VXLAN

To configure a VXLAN:

  1. Navigate to the topology in one of the following ways:
  2. Click the VXLAN that you want to configure.

    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 .

  3. In the Name field, enter the name of the VXLAN.
  4. If necessary, in the Description field, enter a brief description of the VXLAN.
  5. If you want to configure the assignment of IP address to virtual network functions using DHCP:
    1. In the OpenStack DHCP drop-down list, select Enabled. The default value is Disable.
    2. In the CIDR field, enter the IPv4 prefix of the OpenStack subnet that assigns IP addresses to virtual network functions.
    3. If you want the OpenStack subnet to assign a particular gateway to virtual network functions, enter the IPv4 address of the gateway in the Gateway field.
    4. Specify the range of IP addresses from which the OpenStack subnet assigns IP addresses to virtual network functions: To do so, under Pools, click + Pooland enter the starting and ending values of the IP address range.

      The range of IP addresses is specified and displayed in the Pools section. You can specify multiple IP address ranges or delete an IP address range. To delete an IP address range, click Delete next to it.

    5. Specify the DNS server that the OpenStack subnet assigns to virtual network functions. To do so, under DNS, click + DNS and enter the IPv4 address of the DNS server.

      The DNS server is specified and displayed in the DNS section. You can specify multiple DNS servers or delete a DNS server. To delete a DNS server, click Delete next to it.

  6. If you want to use the VXLAN to create a shared network service, select the Share network check box. This check box is cleared by default.
  7. If you want to assign a VXLAN tag to virtual network functions, in the Segmentation ID field, enter the VXLAN tag.
  8. In the upper part of the settings area, click Save to save VXLAN settings.
Page top
[Topic 254904]

Configuring a flat network

To configure a flat network:

  1. Navigate to the topology in one of the following ways:
  2. Click the flat network that you want to configure.

    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 .

  3. In the Name field, enter the name of the flat network.
  4. If necessary, in the Description field, enter a brief description of the flat network.
  5. If you want to configure the assignment of IP address to virtual network functions using DHCP:
    1. In the OpenStack DHCP drop-down list, select Enabled. The default value is Disable.
    2. In the CIDR field, enter the IPv4 prefix of the OpenStack subnet that assigns IP addresses to virtual network functions.
    3. If you want the OpenStack subnet to assign a particular gateway to virtual network functions, enter the IPv4 address of the gateway in the Gateway field.
    4. Specify the range of IP addresses from which the OpenStack subnet assigns IP addresses to virtual network functions: To do so, under Pools, click + Pooland enter the starting and ending values of the IP address range.

      The range of IP addresses is specified and displayed in the Pools section. You can specify multiple IP address ranges or delete an IP address range. To delete an IP address range, click Delete next to it.

    5. Specify the DNS server that the OpenStack subnet assigns to virtual network functions. To do so, under DNS, click + DNS and enter the IPv4 address of the DNS server.

      The DNS server is specified and displayed in the DNS section. You can specify multiple DNS servers or delete a DNS server. To delete a DNS server, click Delete next to it.

  6. If you want to use the flat network to create a shared network service, select the Share network check box. This check box is cleared by default.
  7. In the upper part of the settings area, click Save to save flat network settings.
Page top
[Topic 254908]

Configuring a UNI

To configure a UNI:

  1. Navigate to the topology in one of the following ways:
  2. Click the UNI that you want to configure.

    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 .

  3. In the Name field, enter the name of the UNI.
  4. If necessary, in the Description field, enter a brief description of the UNI.
  5. In the upper part of the settings area, click Save to save UNI settings.
Page top
[Topic 266376]