Konfigurations-VariablenAllgemein| Typ | Methode | Beschreibung | | void | config.resetConfigToDefault() | Rücksetzen aller Änderungen auf die Standard-Konfiguration. | | void | config.addScriptLine(line: string) | Fügt eine Zeile zum Skript hinzu, das auf dem Gerät ausgeführt wird.
| | void | config.infoLog(msg: string) | Gibt die Meldung im Geräte-Log der LMC mit dem Level info aus. | | void | config.infoLog(key: string, msg: string) | Gibt die Meldung im Geräte-Log der LMC mit dem Protokoll-Schlüsse mit dem Level info aus.
| | void | config.warnLog(msg: string) | Gibt die Meldung im Geräte-Log der LMC mit dem Level warn aus. | | void | config.abort(msg: string) | Bricht das Erstellen der Konfiguration ab und protokolliert die Meldung im Geräte-Log der LMC mit dem Level error. | | OutputStream | config.createOutputStream() | Erstellt eine neue Standard-Ausgabe für Strings (nur von One-Time Skript unterstützt). | | OutputStream | config.createOutputStream(key: string) | Erstellt eine neue Ausgabe für Strings (nur von One-Time Skript unterstützt). | | void | OutputStream.addLine(key: string) | Fügt einen String zu einer Ausgabe hinzu. |
Skalar | Typ | Methode | Beschreibung |
|---|
| string | config.getScalarByOid(oid) | Liest den Wert eines Skalars per oid aus. | | string | config.getScalarByAlias(alias) | Liest den Wert eines Skalars per Alias aus. | | string | config.setScalarByOid(oid, value) | Setzt den Wert eines Skalars per oid (liest den alten Wert aus). | | string | config.setScalarByAlias(alias, value) | Setzt den Wert eines Skalars per Alias (liest den alten Wert aus). | | string | config.resetScalarToDefaultByOid(oid); | Setzt ein Skalar per oid auf den Standard-Wert zurück. | | string | config.resetScalarToDefaultByAlias(alias); | Setzt ein Skalar per Alias auf den Standard-Wert zurück. |
Tabelle | Typ | Method | Beschreibung |
|---|
| Table | config.getTableByOid(oid: string); | Liest eine Tabelle per oid aus. | | Table | config.getTableByAlias(alias: string); | Liest eine Tabelle per Alias aus. | | List<Row> | table.getRows(); | Liest alle Zeilen einer Tabelle aus. | | Row | table.getRowBySingleIndex(indexValue: string); | Liest den Zeilen-Index aus, sofern nur ein Index vorhanden ist | | List<Row> | table.getRowsByOid(oid: string, value: string); | Liest alle Zeilen aus, die dem Wert entsprechen (per oid). | | List<Row> | table.getRowsByAlias(alias:string, value:string); | Liest alle Zeilen aus, die dem Wert entsprechen (per Alias). | | List<Row> | table.getRowsByOids(Map<oid, value>); | Liest alle Zeilen aus, die den Such-Kriterien entsprechen (per oid). | | List<Row> | table.getRowsByAliases(Map<alias, value>); | Liest alle Zeilen aus, die den Such-Kriterien entsprechen (per Alias). | | Row | table.getFirstRowByOid(oid, value); | Gibt die erste passende Zeile aus, die dem Wert entspricht (per oid). | | Row | table.getFirstRowByAlias(alias, value); | Gibt die erste passende Zeile aus, die dem Wert entspricht (per Alias). | | Row | table.getFirstRowByOids(Map<oid, value>); | Gibt die erste passende Zeile aus, die den Werten entsprechen (per oid). | | Row | table.getFirstRowByAliases(Map<alias, value>); | Gibt die erste passende Zeile aus, die den Werten entsprechen (per Alias). | | Row | table.createNewRow(); | Erstellt eine neue leere Zeile. | | Row | table.addOrMerge(row) | Aktualisiert die Zeile, wenn die Zeile dem Index entspricht. Ansonsten wir die Zeile hinzugefügt. | | boolean | table.resetToDefault(); | Setzt die Tabelle auf die Standard-Konfiguration zurück. |
Zeile| Typ | Methode | Beschreibung |
|---|
| string | row.getByOid(oid); | Get value via oidLiest einen Wert per oid aus. | | string | row.getByAlias(alias); | Get value via aliasLiest einen Wert per Alias aus. | | string | row.setByOid(oid, value); | Set value via oidSetzt einen Wert per oid. | | string | row.setByAlias(oid, value); | Set value via aliasSetzt einen Wert per Alias. | | void | row.setByOids(Map<oid, value>); | Set multiple values via oidSetzt mehrere Werte per oid. | | void | row.setByAliases(Map<alias, value>); | Set multiple values via aliasesSetzt mehrere Werte per Alias. | | Row | row.addByOid(oid, value);Like setByOid but returns the row for fluent API usage | Wie setByOid, gibt aber zusätzlich die Zeile für die Verwendung in der API an. | | Row | row.addByAlias(alias, value);Like setByAlias but returns the row for fluent API usage | Wie setByAlias, gibt aber zusätzlich die Zeile für die Verwendung in der API an. | | boolean | row.delete();Delete the row from the table | Löscht die Zeile aus der Tabelle. |
Ausschließen/IncludeEinbeziehen| Typ | Methode | Beschreibung |
|---|
| void | config.excludeByOid(oid: string) | Do not write element(s) that match oid filter to the device, e.g. configSchreibt keine Elemente in das Gerät, welche dem Filter entsprechen (per oid), z.B. config.excludeByOid("1.2.9.13"); | | void | config.excludeByOids(oids: List<string>) | Do not write element(s) that match oid filter to the device, e.g. configSchreibt keine Elemente in das Gerät, welche dem Filter entsprechen (per oid), z.B. config.excludeByOids(["1.2.9.17", "1.2.9.18", "1.2.11.*"]); | | void | config.includeByOid(oid: string)Only write the element(s) matching the oid filter to the device | Schreibt nur die Elemente in das Gerät, welche dem Filter entsprechen (per oid). | | void | config.includeByOids(oids: List<string>)Only write the element | (s) matching the oid filter to the device (Note: the include calls do not stackSchreibt nur die Elemente in das Gerät, welche dem Filter entsprechen (per oid). -- (Hinweis: Die Aufrufe zum Einbeziehen werden nicht gestapelt!) |
Kontext-VariablenKontext-Variablen sind schreibgeschützt. DSC| Typ | Methode | Beschreibung |
|---|
| boolean | context.dsc.existsScalarByOid(oid)Checks | whether the given scalar exists by oidPrüft per oid, ob das Skalar existiert. | | boolean | context.dsc.existsScalarByAlias(alias)Checks | whether the given scalar exists by aliasPrüft per Alias, ob das Skalar existiert. | | boolean | context.dsc.existsTableByOid(oid)Checks | whether the given Table exists via oidPrüft per oid, ob eine Tabelle existiert. | | boolean | context.dsc.existsTableByAlias(alias)Checks | whether the given Table exists via aliasPrüft per Alias, ob eine Tabelle existiert. |
Netzwerk| Typ | Methode | Beschreibung |
|---|
| <SsidObj>[] | context.network.ssids | Map of SSID objects indexed by its name (usage see next lines). | | string[] | context.network.ssids[<SSID>].ifcNumber | List with interface numbers for Liste von Schnittstellen-Nummern einer SSID. | | string[] | context.network.ssids[<SSID>].ifcName | List with interface names for Liste von Schnittstellen-Namen einer SSID. | | string | context.network.ssids[<SSID>].radiusName | Radius name for Name des RADIUS-Server in einer SSID. | | string | context.network.ssids[<SSID>].name | The SSID (always same as ) | | string | context.network.nameNetwork name | Netzwerk-Name | | string | context.network.configName | Network configuration nameNetzwerk-Konfigurations-Name | | string | context.network.configNameLongLong network configuration name | Langer Netzwerk-Konfigurations-Name | | string | context.network.ifcNumber | Network interface numberSchnittstellen-Nummer des Netzwerks | | string | context.network.tag | Network Vlan IdVLAN-ID des Netzwerks | | string | context.network.vpnGateway | Central Site Gateway address-Adresse | | string[] | context.network.vpnConnections | List of peer ident names for vpn connetions | | <Variables> | context.network.vpnSiteVars[<SubnetGroupConfigName> or <PeerIdent>] | Benutzer-Variablen für den VPN-StandortUser variablen for vpn location | | string | context.network.vpnCredentials[<SubnetGroupConfigName> or <PeerIdent>].remote.identity | VPN remote identity for site- entfernte Identität für einen Standort | | string | context.network.vpnCredentials[<SubnetGroupConfigName> or <PeerIdent>].remote.psk | VPN remote psk for site- entfernter PSK für einen Standort | | string | context.network.vpnCredentials[<SubnetGroupConfigName> or <PeerIdent>].local.identity | VPN local identity for site- lokale Identität für einen Standort | | string | context.network.vpnCredentials[<SubnetGroupConfigName> or <PeerIdent>].local.psk | VPN local psk for site- lokaler PSK für einen Standort | | string | context.network.vpnRemoteData[peerName].subnetMask |
| | string | context.network.vpnRemoteData[peerName].subnetId |
| | boolean | context.network.isCentralGateway | true if vpn & gateway & central-site | | boolean | context.network.isBranchGateway | true if vpn & gateway & not central-site | | number | context.network.gatewayNumber | gateway numberNummer des Gateways | | <DevRolObj> | context.network.deviceRoles | return device roles object (usage see next 2 linesGibt die Geräte-Rollen aus (Verwendung siehe die nächsten beiden Zeilen) | | boolean | context.network.deviceRoles.contains(role string) | Check if device has role gateway with GWPrüft, ob das Gerät die Rolle GW (Gateway) hat, access point with AP or switch with SWwith AP or switch with SW | | string[] | context.network.deviceRoles.list() | Get list of device roles, e.g. {"GW", "AP", "SW"} |
Gerät| Typ | Methode | Beschreibung |
|---|
| boolean | context.device.isGateway | true if device is gateway | | boolean | context.device.isAccesspoint | true if device is accesspoint | | boolean | context.device.isSwitch | true if device is switch | | number | context.device.firmwareVersion | Firmware version without build number as double value | | number | context.device.firmwareVersionWithBuild | Firmware version with build number as double value | | string | context.device.firmwareVersionString | Firmware version as stringGibt die Firmware-Version als String aus. | | Object | context.device.firmwareVersionObject | Firmware version as object: { major: number, minor: number, patch: number } | | string | context.device.typeDevice type string.device.type | Gibt den Geräte-Typ als String aus. | | <Features> | context.device.features | Feature object (usage see next line) | | boolean | context.device.features.supports(int) | Checks whether a feature with given ID is supported, e.g. 43 for feature LAN bridge | | string | context.device.macAddress | MAC Address for LAN interface. (Added April 2022. Requires device reboot before use.) | | string | context.device.serialNumber | Serial number of the device (Added April 2022. Requires device reboot before use.) |
Standort| Typ | Methode | Beschreibung |
|---|
| string | context.location.configName | Name des Standorts | | string | context.location.subnetId | Network ID at location, for example 192Netz-Adresse am Standort, z.B. 192.168.1.0 | | string | context.location.subnetMask | Subnetz-Maske | | string | context.location.gatewayIp | Routing IP address to -Adresse zum Central Site, if device Role is Gateway, else nullsofern die Geräte-Rolle "Gateway" ist. Ansonsten "null". | | string[] | context.location.gatewayIpsReturns IP addresses of all location gateways | Gibt die IP-Adressen aller Gateways des Standorts aus. |
|
