Seitenhistorie

Seiteneigenschaften

...

Variablen

Um die Nutzung der Add-ins weiter auszubauen, besteht die Möglichkeit Variablen zu verwenden. Diese können als schreibgeschützte Werte in Add-ins verwendet werden.

Eine Variable besteht aus den folgenden Parametern:

Name
Typ
Wert

Variables können in dem Menü Add-ins → Variablen erstellt und bearbeitet werden.

Image Removed

Variablen hinzufügen:

Eine Variable kann an verschiedenen Stellen verwendet werden. Bei Verwendung der gleichen Variable an mehreren Stellen überschreibt die letzte Variable die vorherigen Einträge.

Global
Netze
Standort
Gerät

Global:

Wird einer Variable ein Wert zugewiesen, gilt diese global. Diese kann dann in einem Add-in verwendet werden.

Netze:

1. Wechseln Sie in das Menü Netze, wählen ein Netzwerk aus und klicken auf Variablen → Variablen hinzufügen.

Image Removed

2. Wählen Sie die gewünschte Variable aus und weisen dieser gegebenenfalls einen Wert zu bzw. wählen die Aktion aus. Klicken Sie anschließend auf Hinzufügen.

Image Removed

Standorte:

1. Wechseln Sie in das Menü Standorte, wählen einen Standort aus und klicken auf Variablen → Variablen hinzufügen.

Image Removed

2. Wählen Sie die gewünschte Variable aus und weisen dieser gegebenenfalls einen Wert zu bzw. wählen die Aktion aus. Klicken Sie anschließend auf Hinzufügen.

Image Removed

Geräte:

1. Wechseln Sie in das Menü Geräte, wählen ein Gerät aus und klicken auf Variablen → Variablen hinzufügen.

Image Removed

2. Wählen Sie die gewünschte Variable aus und weisen dieser gegebenenfalls einen Wert zu bzw. wählen die Aktion aus. Klicken Sie anschließend auf Hinzufügen.

Image Removed

Neuen Variablen-Typ definieren:

1. Wechseln Sie in das Menü Add-ins und klicken auf Variablen.

Image Removed

2. Klicken Sie auf Variablen-Typen.

Image Removed

3. Klicken Sie anschließend auf Neuen Typ hinzufügen.

Image Removed

4. Es gibt zwei mögliche Variablen-Typen (String selection und Regulärer Ausdruck).

String selection:

Passen Sie die folgenden Parameter an und klicken auf Speichern:

Variablen Typ: Wählen Sie die Option String selection aus.
Name: Vergeben Sie einen aussagekräftigen Namen für die Variable (in diesem Beispiel Switch).
Name / Wert: Vergeben Sie einen oder mehrere Namen und zugehörige Wert(e) (in diesem Beispiel enable → on und disabled → off).

Image Removed

Regulärer Ausdruck:

Um die Eingabe-Möglichkeiten für Variablen zu limitieren, wird auch die Möglichkeit zur Verwendung regulärer Ausdrücke (regular expressions - Regex) unterstützt.

Für die regulären Ausdrücke stehen die folgenden Optionen zur Verfügung:

...

Passen Sie die folgenden Parameter an und klicken auf Speichern:

Variablen Typ: Wählen Sie die Option Regulärer Ausdruck aus.
Name: Vergeben Sie einen aussagekräftigen Namen für die Variable (in diesem Beispiel IP).
Anzeigename: In diesem Beispiel wird zum besseren Verständnis zusätzlich ein Anzeigename hinterlegt, da im Namen kein Bindestrich verwendet werden darf.
Regulärer Ausdruck: Wählen Sie im Dropdown-Menü die gewünschte Option aus (in diesem Beispiel IPv4).

Image Removed

Neue Variable anlegen:

1. Wechseln Sie in das Menü Add-ins → Variablen und klicken auf Neue Variable.

Image Removed

2. Passen Sie die folgenden Parameter an und klicken auf Speichern:

Name: Vergeben Sie einen aussagekräftigen Namen für die Variable (in diesem Beispiel wlanstate).
Variablen Typ: Wählen Sie im Dropdown-Menü einen Variablen Typ aus (in diesem Beispiel den im Abschnitt Neuen Variablen-Typ definieren erstellten Typ Switch).
Wert: Vergeben Sie einen Wert für die Variable oder wählen im Dropdown-Menü eine Option aus.

Image Removed

Verwenden von Variablen:

Werte von Variablen können in dem Objekt context.vars verwendet werde:

...

System-Variablen:

System-Variablen verwalten spezifische Aspekte der Smart-Konfiguration.

Alle System-Variablen (außer der Variable UF_DEFAULT_IF) können in den Projektvorgaben angepasst werden.
System-Variablen können nicht durch Add-in Skripte modifiziert werden (Read-Only).
System-Variablen können nur in den Menüs Netze und Geräte verwendet werden.
System-Variablen können nur für Status-Anfragen verwendet werden (die Konfiguration wird ausgerollt, wenn eine System-Variable einen bestimmten Wert hat).

Beispiel für eine Status-Anfrage:

Der folgende Code-Auszug zeigt die generelle Herangehensweise für eine Status-Anfrage. Tauschen Sie die Variablen “Systemvariable” und “Value” je nach Bedarf aus. Der Add-in Code muss unter der auskommentierten Zeile “Code will be executed, if variable is met.” eingefügt werden.

/**
 * @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.

     };

};

Verfügbare System-Variablen:

INITIAL_TEST_MODE_ENABLED:
- Aktiviert einen Test-Modus von 300 Sekunden für den initialen Konfigurations-Rollout (im Standard aktiv).
- Kann nach dem initialen Konfigurations-Rollout mit der Einstellung Testmodus nach initialem Konfigurations-Rollout in dem Menü Projektvorgaben → Inbetriebnahme von Geräten angepasst werden.
PASSWORD:
- Globales Haupt-Geräte-Passwort.
- Kann unter Projektvorgaben → Basis angepasst werden.
UF_CLEAR_DEFAULT_CFG:
- Deaktiviert die Standard-Schnittstellen einer Unified Firewall während des Konfigurations-Rollouts (im Standard deaktiviert).
- Kann mit der Einstellung Default-Netze beim Konfigurations-Rollout auf LANCOM R&S®Unified Firewalls deaktivieren in dem Menü Projektvorgaben → Inbetriebnahme von Geräten angepasst werden.
UF_DEFAULT_IF:
- Standard-Schnittstelle für den Netzwerk-Rollout per LANCOM Management Cloud.
- Die Standard-Schnittstelle ist eth1 und kann ausschließlich per API geändert werden.
LMC_DOMAIN:
- URL für private LMC-Instanzen.
UF_ETH0_NETWORKS ... UF_ETH10_NETWORKS:
- Zuweisung der ETH-Ports von Unified Firewalls zu den Netzwerken.
VPN_IDENTITY_SEPARATOR:
- Zeichen, welches für die automatische Erstelleung von VPN-Verbindungen verwendet wird (z.B. mit dem Standard-Zeichen "@": ALL@HQ__).

Werte

Schreiben

Sie können die Konfiguration, welche an ein Gerät gesendet werden soll, per config.setScalarByOid modifizieren:

/**
 * @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");
};

...

Dies kann auch per config.addScriptLine erreicht werden:

/**
 * @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"');
};

...

Lesen

Informationen können von einem Gerät über die Funktion config.getScalarByOid ausgelesen werden:

/**
 * @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");
};

...

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.

...

Image Added

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.

...

Image Added

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

...

Image Added

Sites:

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

...

Image Added

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

...

Image Added

Devices:

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

...

Image Added

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

...

Image Added

Defining a Variable Type

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

...

Image Added

2) Click on Variable types.

...

Image Added

3) Click Add new type afterwards.

...

Image Added

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).

...

Image Added

Regular expression:

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

The following options can be used for regular expressions:

Regular expression	Description
IPv4	Only a valid IP address is allowed for variables with that variable-type.
Subnet mask	Only a valid subnet mask is allowed for variables with that variable-type.
[A-Z a-z]*	Only ASCII characters in the range from A-Z and a-z are allowed for variables with that variable-type.
User defined	You are able to create your own regular expression to limit the input.

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).

...

Image Added

Create a new Variable

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

...

Image Added

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.

...

Image Added

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.

...

Seitenhierarchie

Versionen im Vergleich

Alte Version 1

Neue Version Aktuell

Schlüssel

Variablen

Variablen hinzufügen:

Neuen Variablen-Typ definieren:

Verwenden von Variablen:

System-Variablen:

Werte

Schreiben

Lesen

Variables

Adding Variables:

Defining a Variable Type

Create a new Variable

Using variables

System variables

Values

Writing

Reading

Service & Support

Links