Seitenhistorie

Variables

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

A variable consists of

• name
• type
• value

Variables can be created in the Add-in menu by selecting the variables button.

Image Added

A variable can be set /overwritten on the following levels, with ascending order:the following places and follows a hierarchy where the last one overrides the previous ones.

• global
• network
• location
• device
• Location
• Network
• Device

For this, open the respective Variables view, and add the defined variables.

As an example, here you can find the Variables menu on a device.

Image Added

Defining a Variable Type

A variable is either of type string or can have a custom type.

To define a new type click on the Variable Types button. 

Image RemovedImage Added

Next, click on Add new type.

Image RemovedImage Added

Give the type a name (e.g. Switch), and add a number of selectable variable values, for example: 

• enabled -> →  on
• disabled -> →  off

Click on Save to save your variable type.

Image Removed

Review your types, then close the dialog to return to the variables page.

Image Added

We also support regular expression for variable types to limit the input for variables.
Instead of String selection select Regular expression and use one of the four options offered:

Image AddedImage Removed

Defining a Variable

To define a new variable click on the Variable definition button. Provide a variable name and select the variable type from the drop down list.

Select the default value of the variable from the previously defined selections of the variable type. Select the checkbox Use as password if you want to hide the contents within the UI with asterisks (***).

Click on the checkbox to save your variable definition.

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.

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.