Konfigurations-Variablen
Allgemein
| 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); | Liest einen Wert per oid aus. |
| string | row.getByAlias(alias); | Liest einen Wert per Alias aus. |
| string | row.setByOid(oid, value); | Setzt einen Wert per oid. |
| string | row.setByAlias(oid, value); | Setzt einen Wert per Alias. |
| void | row.setByOids(Map<oid, value>); | Setzt mehrere Werte per oid. |
| void | row.setByAliases(Map<alias, value>); | Setzt mehrere Werte per Alias. |
| Row | row.addByOid(oid, value); | Wie setByOid, gibt aber zusätzlich die Zeile für die Verwendung in der API an. |
| Row | row.addByAlias(alias, value); | Wie setByAlias, gibt aber zusätzlich die Zeile für die Verwendung in der API an. |
| boolean | row.delete(); | Löscht die Zeile aus der Tabelle. |
Ausschließen/Einbeziehen
| Typ | Methode | Beschreibung |
|---|
| void | config.excludeByOid(oid: string) | Schreibt keine Elemente in das Gerät, welches dem Filter entspricht (per oid), z.B. config.excludeByOid("1.2.9.13"); |
| void | config.excludeByOids(oids: List<string>) | Schreibt keine Elemente in das Gerät, welches dem Filter entspricht (per oid), z.B. config.excludeByOids(["1.2.9.17", "1.2.9.18", "1.2.11.*"]); |
| void | config.includeByOid(oid: string) | Schreibt nur die Elemente in das Gerät, welches dem Filter entspricht (per oid). |
| void | config.includeByOids(oids: List<string>) | Schreibt nur die Elemente in das Gerät, welches dem Filter entspricht (per oid). → Hinweis: Die Aufrufe zum Einbeziehen werden nicht gestapelt! |
Kontext-Variablen
Kontext-Variablen sind schreibgeschützt.
DSC
| Typ | Methode | Beschreibung |
|---|
| boolean | context.dsc.existsScalarByOid(oid) | Prüft per oid, ob das Skalar existiert. |
| boolean | context.dsc.existsScalarByAlias(alias) | Prüft per Alias, ob das Skalar existiert. |
| boolean | context.dsc.existsTableByOid(oid) | Prüft per oid, ob eine Tabelle existiert. |
| boolean | context.dsc.existsTableByAlias(alias) | Prüft per Alias, ob eine Tabelle existiert. |
Netzwerk
| Typ | Methode | Beschreibung |
|---|
| <SsidObj>[] | context.network.ssids | Liste von SSIDs indexiert anhand des Namens (zur Verwendungsee siehe die nächsten Zeilen). |
| string[] | context.network.ssids[<SSID>].ifcNumber | Liste von Schnittstellen-Nummern einer SSID. |
| string[] | context.network.ssids[<SSID>].ifcName | Liste von Schnittstellen-Namen einer SSID. |
| string | context.network.ssids[<SSID>].radiusName | Name des RADIUS-Servers in einer SSID. |
| string | context.network.ssids[<SSID>].name | Name der SSID |
| string | context.network.name | Netzwerk-Name |
| string | context.network.configName | Netzwerk-Konfigurations-Name |
| string | context.network.configNameLong | Langer Netzwerk-Konfigurations-Name |
| string | context.network.ifcNumber | Schnittstellen-Nummer des Netzwerks |
| string | context.network.tag | VLAN-ID des Netzwerks |
| string | context.network.vpnGateway | Central Site Gateway-Adresse |
| string[] | context.network.vpnConnections | Liste von VPN-Gegenstellen |
| <Variables> | context.network.vpnSiteVars[<SubnetGroupConfigName> or <PeerIdent>] | Benutzer-Variablen für den VPN-Standort |
| string | context.network.vpnCredentials[<SubnetGroupConfigName> or <PeerIdent>].remote.identity | VPN - entfernte Identität für einen Standort |
| string | context.network.vpnCredentials[<SubnetGroupConfigName> or <PeerIdent>].remote.psk | VPN - entfernter PSK für einen Standort |
| string | context.network.vpnCredentials[<SubnetGroupConfigName> or <PeerIdent>].local.identity | VPN - lokale Identität für einen Standort |
| string | context.network.vpnCredentials[<SubnetGroupConfigName> or <PeerIdent>].local.psk | VPN - lokaler PSK für einen Standort |
| string | context.network.vpnRemoteData[peerName].subnetMask | VPN - Subnetzmaske des entfernten Standortes |
| string | context.network.vpnRemoteData[peerName].subnetId | VPN - Netz-Adresse des entfernten Standortes |
| boolean | context.network.isCentralGateway | Wenn das Gerät VPN & Gateway & Central-Site → True |
| boolean | context.network.isBranchGateway | Wenn das Gerät VPN & Gateway & nicht Central-Site → True |
| number | context.network.gatewayNumber | Nummer des Gateways |
| <DevRolObj> | context.network.deviceRoles | Gibt die Geräte-Rollen aus (Verwendung siehe die nächsten beiden Zeilen) |
| boolean | context.network.deviceRoles.contains(role string) | Prüft, ob das Gerät die Rolle GW (Gateway) hat, access point with AP or switch with SW |
| string[] | context.network.deviceRoles.list() | Liest die Liste der Geräte-Rollen aus, z.B. {"GW", "AP", "SW"}. |
Gerät
| Typ | Methode | Beschreibung |
|---|
| boolean | context.device.isGateway | Wenn das Gerät Gateway ist → True |
| boolean | context.device.isAccesspoint | Wenn das Gerät Accesspoint ist → True |
| boolean | context.device.isSwitch | Wenn das Gerät Switch ist → True |
| number | context.device.firmwareVersion | Firmware-Version ohne Build-Nummer mit doppelter Genauigkeit. |
| number | context.device.firmwareVersionWithBuild | Firmware-Version mit Build-Nummer mit doppelter Genauigkeit. |
| string | context.device.firmwareVersionString | Gibt die Firmware-Version als String aus. |
| Object | context.device.firmwareVersionObject | Firmware-Version als Objekt: {major: number, minor: number, patch: number} |
| string | context.device.type | Gibt den Geräte-Typ als String aus. |
| <Features> | context.device.features | Feature-Objekt (zur Verwendung siehe nächste Zeile) |
| boolean | context.device.features.supports(int) | Prüft durch Eingabe einer Feature-ID, ob das Feature unterstützt wird (z.B. 43 für das Feature LAN-Bridge). |
| string | context.device.macAddress | MAC-Addresse der LAN-Schnittstelle (im April 2022 hinzugefügt; benötigt einen Geräte-Neustart bevor die Funktion verwendet werden kann). |
| string | context.device.serialNumber | Serien-Nummer des Gerätes (im April 2022 hinzugefügt; benötigt einen Geräte-Neustart bevor die Funktion verwendet werden kann). |
Standort
| Typ | Methode | Beschreibung |
|---|
| string | context.location.configName | Name des Standorts |
| string | context.location.subnetId | Netz-Adresse am Standort, z.B. 192.168.1.0 |
| string | context.location.subnetMask | Subnetz-Maske |
| string | context.location.gatewayIp | Routing IP-Adresse zum Central Site, sofern die Geräte-Rolle "Gateway" ist. Ansonsten "null". |
| string[] | context.location.gatewayIps | Gibt die IP-Adressen aller Gateways des Standorts aus. |
