Deutsch | |
---|---|
VariablenUm die Nutzung der VariablesTo 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
Variables can be created in the Add-in menu by selecting the variables button. A variable can be set the following places and follows a hierarchy where the last one overrides the previous ones.
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. Defining a Variable TypeA variable is either of type To define a new type click on the Variable Types button. Next, click on Add new type. Give the type a name (e.g. Switch), and add a number of selectable variable values, for example:
Click on Save to save your variable type. We also support regular expression for variable types to limit the input for variables. | |
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. |
Regulärer Ausdruck | Beschreibung |
---|---|
IPv4 | Dieser Variablen-Typ unterstützt nur valide IPv4-Adressen. |
Subnet mask | Dieser Variablen-Typ unterstützt nur valide Subnetzmasken. |
[A-Z a-z]* | Dieser Variablen-Typ unterstützt nur ASCII-Zeichen von A-Z und a-z. |
User defined | Mit dieser Option können Sie einen eigenen regulären Ausdruck erstellen, um die Eingabe zu limitieren. |
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).
Neue Variable anlegen:
1. Wechseln Sie in das Menü Add-ins → Variablen und klicken auf Neue Variable.
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.
Verwenden von Variablen:
Werte von Variablen können in dem Objekt context.vars
verwendet werde:
/**
* @param
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-Variablen:
System-Variablen verwalten spezifische Aspekte der Smart-Konfiguration.
- Alle System-Variablen (außer der Variable
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 specificationskönnen in den Projektvorgaben angepasst werden.
- System variables cannot be modified by -Variablen können nicht durch Add-in scripts Skripte modifiziert werden (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).
- -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 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.” 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.
};
};
Available Verfügbare System variables-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
- 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:
- 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
- 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 startupdeaktivieren in dem Menü Projektvorgaben → Inbetriebnahme von Geräten angepasst werden.
UF_DEFAULT_IF:
- Default interface for network rollout via the Standard-Schnittstelle für den Netzwerk-Rollout per LANCOM Management Cloud.The default interface is eth1 and can only be changed via the
- APIDie Standard-Schnittstelle ist eth1 und kann ausschließlich per API geändert werden.
LMC_DOMAIN:
- URL setting for für private LMC instances-Instanzen.
UF_ETH0_NETWORKS ... UF_ETH10_NETWORKS:
- Network assignment to ETH port of the Unified FirewallsZuweisung der ETH-Ports von Unified Firewalls zu den Netzwerken.
VPN_IDENTITY_SEPARATOR:
- Symbol used for the automatic VPN creation: (e.g with the default Zeichen, welches für die automatische Erstelleung von VPN-Verbindungen verwendet wird (z.B. mit dem Standard-Zeichen "@": ALL@HQ__).
Werte
Writing
Schreiben
Sie können die Konfiguration, welche an ein Gerät gesendet werden soll, per To modify the configuration that is sent to a device you can use 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");
};
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.
Konfigurations-Änderungen, welche per config.setScalarByOid
vorgenommen wurden, sind in der Konfigurations-Vorschau sichtbar, da diese in der Konfiguration hinzugefüht werden, bevor diese an das Gerät gesendet wird.
Dies kann auch per config.addScriptLine
erreicht werdenThe 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 Konfigurations-Änderungen, die per 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.
vorgenommen wurden, sind nicht in der Konfigurations-Vorschau sichtbar, da diese nur auf dem Gerät ausgeführt werden.Diese Mehode funktioniert ausschließlich auf LCOS-basierten Geräten.
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");
};
There is no equivalent config.addScriptLine
to read data from the device.
comment2 = config.getScalarByOid("1.2.9.12");
};
Es gibt kein Äquivalent für config.addScriptLine
, um Daten vom Gerät zu lesen.
Englisch | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
VariablesTo 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
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: 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 Type1) 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:
Regular expression: To limit the input for variables, also regular expressions are supported (Regex). The following options can be used for regular expressions:
| |||||||||||||
Englisch | |||||||||||||
VariablesTo 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
Variables can be created in the Add-in menu by selecting the variables button. A variable can be set the following places and follows a hierarchy where the last one overrides the previous ones.
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. Defining a Variable TypeA variable is either of type To define a new type click on the Variable Types button. Next, click on Add new type. Give the type a name (e.g. Switch), and add a number of selectable variable values, for example:
Click on Save to save your variable type. We also support regular expression for variable types to limit the input for variables.
Defining a VariableTo 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.
Modify the follwing parameters and click Save:
Create a new Variable1) Go to the menu Add-ins → Variables and click on New variable. 2) Modify the following parameters and click Save:
Using variablesVariable values can be used using the object
System variablesSystem variables manage specific aspects of the smart configuration.
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.”.
Available System variables:
ValuesWritingTo modify the configuration that is sent to a device you can use
Changes made by The same can be achieved by using
Changes made by Reading
There is no equivalent |
...