Configurations

Link copied to clipboard

This tab allows you to manage the configurations used in your PortaSwitch system (each row represents a configuration tree).

The existing configurations are marked as follows:

  • active” (i.e. current) is bold black.
  • “backup” (i.e. previous) is black.
  • inactive” (i.e. old/new) is grey. Servers state

Field

Description

The  icon

The configuration information. Click the icon to open the configuration information page.

Servers

Contains clickable indicators that show the state of applying the configuration:

  • green (i.e., succeeded) indicates that a new configuration was applied successfully,

  • grey (i.e., failed) indicates the absence of errors,

  • red (i.e., failed) indicates that errors are detected,

  • a running man (i.e., running) indicates that the configuration is now being applied,

  • a number (e.g., 13) to the right of the indicator shows the number of involved servers.

When you click the succeeded or failed indicator those tasks are automatically displayed in the Task monitor window.

Configuration

The name of the configuration.

Description

A short description of the configuration. This field is not mandatory.

User

The user who performed the configuration.

Last Updated

The time when the configuration was last edited.

You can create a new configuration by clicking the Create button, typing in its name and description, and choosing which software version it applies to.

Create a new configuration

If the configuration already exists, you can edit its description by double-clicking on it.

You can clone the configuration by clicking the Clone button (to clone a configuration means to copy it), or delete it using the Delete button.

You cannot change or delete the active (currently applied) or the backup (previously used) configurations. This is to ensure that there is always a “stable” configuration you can use for rollback. You can open such a configuration for review using the arrow  Configuration Details button, or you can create a new configuration as its exact copy (and then edit this new configuration) by using the Clone button.

You can easily compare two configurations and see the differences between them. Choose two configurations by holding down the Ctrl button on your keyboard, and then click the Compare button which will become highlighted above.

Compare configurationsSee the differences

Click the arrow  Configuration Details button for the required option of the corresponding configuration to open it in the configuration editing mode. Bear in mind that you cannot change or delete the options of an active or backup configuration.

Configuration information

Link copied to clipboard

On this page, you can see the Configuration Tree, Environments, Groups panels, and the panel where all the configuration options for a given service are shown.

Configuration outline

Some options can be specified at the level of the particular instance and at the level of the configuration tree node that holds this instance.

For example, in the Configuration Tree panel, you can choose PortaSwitch > BillingEngine > porta-billing-radius-1@akbilling and set the Disconnector_Enabled option for this instance. (You can find this option in the ServiceTypes group.)

Per instance configuration

But you can also specify the same option at the level of the configuration tree node (PortaSwitch > BillingEngine > …).

Per node configuration

If you specify the option value at the level of the configuration tree node, it becomes a default value for all the instances under this configuration tree node. The Configuration server will choose which value to use according to the following rule:

  • If you specify the option value at the level of a particular instance, the Configuration server will use this value and ignore the data specified at the level of the configuration tree node;
  • If you leave the option value at the level of a particular instance blank, the Configuration server will use the default value – that is, specified at the level of the configuration tree node.

The same rule applies when you specify options for environments.

You can set up configuration options for each billing environment separately or you can do this globally for all billing environments by specifying a default value.

Note that it is not always correct to specify default (global) values for the options since such settings are applied to all instances, some of which may be located on different physical servers. For example, if you set private LADDR (Layered-Architecture Device Driver) for PortaSIP on the global level, the configuration will be correct as long as all virtual PortaSIP instances are located on the same physical server. However, if PortaSIP cluster is deployed within PortaSwitch installation, there are two or more PortaSIP servers. In such cases, setting a default value for the private IP address (LADDR) may not be correct since some PortaSIP instances that are located on other physical servers, may adopt the specified IP address (that doesn’t belong to their server).

Instances

Link copied to clipboard

A service that runs on your server (e.g., “web interface” or “SIP server”) is called an instance. Each service requires its own IP address so that it can be accessed by your customers. To add a new instance, press the instance_create  Instance create button. In the pop-up window, choose the server which this instance will run on, its service IP, and a billing environment where this instance will run, and then press Save.

To change these settings later on select the instance from the configuration tree and double-click on it.

Instance create

In the configuration options window, you can see instance options with either default values (shown in grey) or explicitly defined values (shown in black). To edit a specific option, double-click on it. You can also add one more value by using the add_button  Add Value button.

To find additional information about the required option, click the plus sign on the left. Once you open the required option, you will see its description and an alert about possible action in case you change the option value:

Info about affected servicesIf you see attention  red or warning  yellow triangles – the option value change requires a service restart or reload (there might be a period of service downtime when you apply this configuration).

If you want to create one more instance with the same options as in the existing one, use the  Instance clone button.

After all the values have been set, click the   Verify button to see the differences between the current configuration and the intended one. Then, click   Check/Apply button to verify if the configuration is valid (e.g.,  all the required options have values assigned to them); then on the pop-up window with the status information you can choose whether to perform a complete check or apply the configuration right away.

If you want to check whether any services will be restarted when a new configuration is applied (e.g., for more suitable scheduling) press the Complete Check button. The system will simulate the whole procedure and provide a detailed log of actions that will be executed when the configuration is applied.

When you apply a backup PortaSwitch configuration, the backup network configuration is simultaneously being applied.

If you are satisfied with the results of the preliminary check, press the Apply button. As soon as the configuration has been applied, you will see this action displayed on the Task page.

The Check/Apply button saves the configuration before checking it.