Managing controllers

To display the table of controllers, go to the Infrastructure menu section, click the created data center, and select the Network resources tab. Information about controllers is displayed in the following columns of the table:

• Name is the name of the controller.
• Transport/service strategy is the
  transport strategy

  A transport service encapsulation mechanism that includes the algorithm for adding a stack of traffic packet header tags and the type of these tags. Kaspersky SD-WAN temporarily supports one transport strategy, Generic VNI Swapping Transport.

  being used.
• Controller nodes are IP addresses of controller nodes.
• Connection type is the type of connection of CPE devices to the controller:
  • Unicast
  • Multicast
• Cluster status is the status of the cluster of controller nodes:
  • Up means the cluster is operating normally.
  • DEGRADED means an error occurred during the operation of the cluster.
  • Down means the cluster is not operational.
• Node statuses is the status of controller nodes:
  • Connected (primary) means the node is connected to the controller and is the primary node in the cluster.
  • Connected (single) means the node is connected to the controller and is the only node in the cluster.
  • Connected (secondary) means the node is connected to the controller and is a secondary node in the cluster.
  • Disconnected means the node is not connected to the controller.
  • Not in cluster means the node is not added to a cluster.
  • Unavailable means the node is not available.
  • Unknown means the status of the node is unknown.

The actions you can perform with the table are described in the Managing solution component tables instructions.

Editing a controller

To edit a controller:

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

   This opens the resource management page. By default, the Network resources tab is selected, which displays the table of controllers.

2. Click Management → Edit next to the controller that you want to edit.
3. This opens a window; in that window, in the Name field, enter the name of the controller. Range of values: 1 to 128 characters.
4. If necessary, in the Description field, enter a brief description of the controller.
5. In the Controller installation on <1>/<3>/<5> servers field, select the number of controller nodes.
6. In the Connection type drop-down list, select the type of connection of CPE devices to the controller:
   • Unicast
   • Multicast
7. Configure the controller node:
   1. In the Address (IP or hostname) field, enter the IP address or hostname of the controller node.
   2. In the gRPC port field, enter the gRPC port number of the controller node.
   3. In the JGroups port field, enter the jGroups port number of the controller node.
   4. If you want to make the controller node the primary node, select the Primary option.

   You can configure multiple controller nodes.

8. Click Save.

The controller is modified and updated in the table.

Reprovisioning a controller

During reprovisioning, controller properties are reset to their default values. This may help resolve errors.

To reprovision the controller:

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

   This opens the resource management page. By default, the Network resources tab is selected, which displays the table of controllers.

2. Click Management → Reprovision next to the controller that you want to reprovision.
3. In the confirmation window, click Reprovision.

The controller is reprovisioned.

Restoring a controller

You can download a file with controller settings and later use the file to restore the controller if necessary.

To restore a controller:

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

   This opens the resource management page. By default, the Network resources tab is selected, which displays the table of controllers.

2. Click Management → Download backup file next to the controller whose settings file you want to download.

   A file with controller settings in YAML format is saved to your local device.

3. Click Management → Restore next to the controller that you want to restore.
4. This opens a window; in that window, specify the path to the downloaded file with controller settings.
5. Click Restore.

The controller is restored with settings from the controller settings file.

Enabling or disabling the maintenance mode on a controller

You can enable maintenance mode on the controller when performing maintenance work related to the SD-WAN network to minimize the impact of the controller on parts of the SD-WAN network that are not affected by the maintenance work. In maintenance mode, the controller monitors the status of the SD-WAN network, but does not take any action when the parameters of the SD-WAN network change. For example, in maintenance mode the controller does not rebuild links and paths, does not rewrite MAC addresses of service interfaces, or change transport services.

When you disable maintenance mode, the controller performs actions corresponding to the changes you made to the parameters of the SD-WAN network.

To enable or disable maintenance mode on the controller:

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

   This opens the resource management page. By default, the Network resources tab is selected, which displays the table of controllers.

2. Do one of the following:
   • If you want to enable maintenance mode on the controller, click Management → Enable maintenance next to it.
   • If you want to disable maintenance mode on the controller, click Management → Disable maintenance next to it.

Maintenance mode is enabled or disabled on the controller.

Deleting a controller

Deleted controllers cannot be restored.

To delete a controller:

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

   This opens the resource management page. By default, the Network resources tab is selected, which displays the table of controllers.

2. Click Management → Delete next to the controller that you want to delete.
3. In the confirmation window, click Delete.

The controller is deleted and is no longer displayed in the table.

Managing controller properties

Properties regulate the operation of the controller. Each property has a change method that determines whether the property value can be changed and when the change takes effect. The following change methods are available:

• Read-only means the property cannot be changed.
• Reload means that when a property is changed, the orchestrator commits the new value to the database of the controller. The new value takes effect after the controller is restarted.

  A property value that is in the database, but has not yet taken effect is called a planning value. You can delete a planning value before restarting the controller to keep the current value.

• Runtime means the new value takes effect immediately when the property is modified.

Modifying properties may lead to unstable operation of the controller, so we recommend contacting Kaspersky Technical Support before managing properties.

You can view the table of all controller properties or only changeable controller properties:

• To display the table of all controller properties, navigate to the Infrastructure section, click the added data center, select the Network resources tab, and click Management → Properties next to the controller.
• To display the table of changeable properties of the controller, navigate to the Infrastructure section, click the added data center, select the Network resources tab, click Management → Properties next to the controller and select the Changeable properties tab.

Information about controller properties is displayed in the following columns of the table:

• Change method is the change method of the property.
• Property is the name of the property.
• Current value is the current value of the property.
• Planned value is the planning value of the property. This column is displayed only on the Changeable properties tab.

The actions you can perform with the table are described in the Managing solution component tables instructions.

Description of editable controller properties

Modifying properties may lead to unstable operation of the controller, so we recommend contacting Kaspersky Technical Support before managing properties.

Page top

Editing a controller property

Changes you make to the controller properties with the Runtime change method take effect immediately. Changes you make to controller properties with the Reload change method take effect after the controller is restarted.

To change a controller property:

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

   This opens the resource management page. By default, the Network resources tab is selected, which displays the table of controllers.

2. Click Management → Properties next to the controller for which you want to change a property.

   The controller properties page is displayed. By default, the All properties tab is selected, which displays a table of all controller properties.

3. Select the Changeable properties tab.

   A table of editable properties of the controller is displayed.

4. Click Management → Edit next to the controller property that you want to edit.
5. This opens a window; in that window, in the Planned value field, enter the new value of the controller property.
6. Click Save.

The new value of a property with the Runtime method is displayed in the Current value column. The new value of a property with the Reload method is displayed in the Planned value column.

Deleting planning values of controller properties

You can delete a planning value to undo a controller property change. This action is applicable only to properties that have the Reload method.

Deleted planning values of controller properties cannot be restored.

To delete planning values of controller properties:

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

   This opens the resource management page. By default, the Network resources tab is selected, which displays the table of controllers.

2. Click Management → Properties next to the controller for which you want to delete planning values of properties.

   The controller properties page is displayed. By default, the All properties tab is selected, which displays a table of all controller properties.

3. Select the Changeable properties tab.

   A table of editable properties of the controller is displayed.

4. Delete the planning values of controller properties in one of the following ways:
   • If you want to delete the planning value of an individual property of the controller, click Management → Delete planned value next to that property.
   • If you want to delete planning values of all controller properties, in the upper part of the table, click the settings icon → Delete all planned values.
5. In the confirmation window, click Delete.

The planning values of controller properties are deleted.

Resetting controller properties to default values

To reset controller properties to default values:

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

   This opens the resource management page. By default, the Network resources tab is selected, which displays the table of controllers.

2. Click Management → Properties next to the controller whose properties you want to reset to default values.

   The controller properties page is displayed. By default, the All properties tab is selected, which displays a table of all controller properties.

3. Select the Changeable properties tab.

   A table of editable properties of the controller is displayed.

4. Reset the controller properties in one of the following ways:
   • If you want to reset an individual property of the controller to its default value, click Management → Reset property next to that property.
   • If you want to reset all controller properties to their default values, click the settings icon in the upper part of the table → Reset all properties.
5. In the confirmation window, click Reset.

The controller properties are reset to their default values.

Viewing information about controller nodes

To view information about controller nodes:

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

   This opens the resource management page. By default, the Network resources tab is selected, which displays the table of controllers.

2. Click Management → Configuration menu next to the controller for which you want to view information about nodes.

   This opens the controller configuration menu. By default, you are taken to the Controller nodes section, which displays a table of controller nodes. Information about controller nodes is displayed in the following columns of the table:

   • Address is the IP address of the controller node.
   • Status is the status of the controller node:
     • Connected (primary) means the node is connected to the controller and is the primary node in the cluster.
     • Connected (single) means the node is connected to the controller and is the only node in the cluster.
     • Connected (secondary) means the node is connected to the controller and is a secondary node in the cluster.
     • Disconnected means the node is not connected to the controller.
     • Not in cluster means the node is not added to a cluster.
     • Unavailable means the node is not available.
     • Unknown means the status of the node is unknown.
   • gRPC port is the number of the gRPC port of the controller node.
   • JGroups port is the JGroups port number of the controller node.
   • Version is the version of the controller node software.

   The actions that you can perform with the table are described in the Managing solution component tables instructions.

3. If you want to view statistics for a controller node, click Management →Statistics next to the node.
4. If you want to view the properties of a controller node, click Management → Node properties next to the node.