Variables & Values

Variables

To further extend the use of  Add-ins  we have the possibility to use variables. These can be used as read-only values within  Add-in  scripts.

A variable consists of

• name
• type
• value

You can create and edit Add-ins in the menu Add-ins → Variables.

Adding Variables:

A variable can be set the following places and follows a hierarchy where the last one overrides the previous ones.

• global
• network
• site
• device

Global:

If a value is assigned to a variable, the variable is valid globally. The variable can then be used in an Add-in.

Networks:

1) Go to the menu Networks, select a network and click on Variables → Add Variables.

2) Select the desired variable and assign it a value or select an action. Click Add afterwards.

Sites:

1) Go to the menu Sites, select a site and click on Variables → Add variables.

2) Select the desired variable and assign it a value or select an action. Click Add afterwards.

Devices:

1) Go to the menu Devices, select a device and click on Variables → Add variables.

2) Select the desired variable and assign it a value or select an action. Click Add afterwards.

Defining a Variable Type

1) Go to the meu Add-ins and click on Variables.

2) Click on Variable types.

3) Click Add new type afterwards.

4) There are two possible variable types (String selection and Regular expression).

String selection:

Modify the follwing parameters and click Save: 

• Variable type: Select the option String selection.
• Name: Enter a descriptive name for the variable (in this example Switch).
• Name / Value: Enter one or multiple names and associated value(s) (in this example enable → on and disabled → off).

Regular expression:

To limit the input for variables, also regular expressions are supported (Regex). 

The following options can be used for regular expressions:

Modify the follwing parameters and click Save: 

• Variable Type: Select the option Regular expression.
• Name: Enter a descriptive name for the variable (in this example IP).
• Display name: For better understanding a Display name is added in this example, as no blank space must be used in the Name. 
• Regular expression: In the dropdown menu select the desired option (in this example IPv4).

Create a new Variable

1) Go to the menu Add-ins → Variables and click on New variable.

2) Modify the following parameters and click Save:

• Name: Enter a descriptive name for the variable (in this example wlanstate).
• Variable type: In the dropdown menu select a Variable type (in this example the newly created type Switch defined in the section Defining a Variable type).
• Value: Enter a value for the variable or select an option in the dropdown menu.

Using variables

Variable values can be used using the object  context.vars:

      
        /**
 * @param {Config} config
          
 * @param {Context} context
          
 * Do not edit this comment or parameter types. Required for code suggestions
*/
exports.main = 
          function (config, context) {
    if (context.vars.deviceName) { // checks if the variable is set
        context.setScalarByOid("1.2.1" /* /Setup/Name */, config.vars.deviceName);
    }
};
    

System variables

System variables manage specific aspects of the smart configuration.

• All System variables (with the exception of the variable UF_DEFAULT_IF) can be modified in the Project specifications.
• System variables cannot be modified by Add-in scripts (Read-Only).
• System variables are only available for the Network and Device layers.
• System variables can only be used for status queries (the configuration is to be rolled out, if the System variable equals a certain value).

Example for a status query:

The following code snippet shows the general approach for a status query. Change the variables “Systemvariable” and “Value” according to your needs. Enter the actual Addin code under the commented line “Code will be executed, if variable is met.”.

      
        /**
 * @param {Config} config
          
 * @param {Context} context
          
 * Do not edit this comment or parameter types. Required for code suggestions
*/
 exports.main = 
          function (config, context) {

     if Systemvariable == ("Value"){

            //Code will be executed, if variable is met.

     };

};

    

Available System variables:

• INITIAL_TEST_MODE_ENABLED:

  • Enables a 300 second test mode for initial configuration rollout (enabled by default).
  • Can be modified with the setting Testmode after initial configuration rollout in the menu Project specifications → Device startup.

• PASSWORD:

  • Global Main device password.
  • Can be modified in the menu Project specifications → Basic.

• UF_CLEAR_DEFAULT_CFG:

  • Disables default interfaces of a Unified Firewall during configuration rollout (disabled by default).
  • Can be modified with the setting Disable default networks during configuration rollout to LANCOM R&S®Unified Firewalls in the menu Project specifications → Device startup.

• UF_DEFAULT_IF:

  • Default interface for network rollout via the LANCOM Management Cloud.
  • The default interface is eth1 and can only be changed via the API.

• LMC_DOMAIN:

  • URL setting for private LMC instances.

• UF_ETH0_NETWORKS ... UF_ETH10_NETWORKS:

  • Network assignment to ETH port of the Unified Firewalls.

• VPN_IDENTITY_SEPARATOR:

  • Symbol used for the automatic VPN creation: (e.g with the default "@": ALL@HQ__).

Values

Writing

To modify the configuration that is sent to a device you can use  config.setScalarByOid:

      
        /**
 * @param {Config} config
          
 * @param {Context} context
          
 * Do not edit this comment or parameter types. Required for code suggestions
*/
exports.main = 
          function (config, context) {
    config.setScalarByOid("1.2.9.11", "Comment 1");
    config.setScalarByOid("1.2.9.12", "Comment 2");
};

    

Changes made by  config.setScalarByOid  will be visible in the  config preview, as they are applied to the configuration before it is sent to the device.

The same can be achieved by using  config.addScriptLine:

      
        /**
 * @param {Config} config
          
 * @param {Context} context
          
 * Do not edit this comment or parameter types. Required for code suggestions
*/
exports.main = 
          function (config, context) {
    // LCOS only:
    config.addScriptLine('set /Setup/SNMP/Comment-1 "Hello"');
    config.addScriptLine('set /Setup/SNMP/Comment-2 "World"');
};

    

Changes made by  config.addScriptLine  are  NOT  visible in the  config preview, as they are only run on the device.  This method only works on  LCOS  based devices.

Reading

      
        /**
 * @param {Config} config
          
 * @param {Context} context
          
 * Do not edit this comment or parameter types. Required for code suggestions
*/
exports.main = 
          function (config, context) {
    var comment1 = config.getScalarByOid("1.2.9.11");
    var comment2 = config.getScalarByOid("1.2.9.12");
};

    

There is no equivalent  config.addScriptLine  to read data from the device.