Seitenhistorie

...

Deutsch

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, welche welches dem Filter entsprechen entspricht (per oid), z.B. config.excludeByOid("1.2.9.13");
void	config.excludeByOids(oids: List<string>)	Schreibt keine Elemente in das Gerät, welche welches dem Filter entsprechen 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, welche welches dem Filter entsprechen entspricht (per oid).
void	config.includeByOids(oids: List<string>)	Schreibt nur die Elemente in das Gerät, welche welches dem Filter entsprechen 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	Map of SSID objects indexed by its name (usage see next linesListe 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-Server Servers in einer SSID.
string	context.network.ssids[<SSID>].name	The SSID (always same as )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	List of peer ident names for vpn connetionsListe 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	true if vpn & gateway & central-siteWenn das Gerät VPN & Gateway & Central-Site → True
boolean	context.network.isBranchGateway	true if vpn & gateway & not central-siteWenn 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()	Get list of device roles, e.g. Liest die Liste der Geräte-Rollen aus, z.B. {"GW", "AP", "SW"}.

Gerät

Typ	Methode	Beschreibung
boolean	context.device.isGatewaytrue if device is gateway	Wenn das Gerät Gateway ist → True
boolean	context.device.isAccesspointtrue if device is accesspoint	Wenn das Gerät Accesspoint ist → True
boolean	context.device.isSwitchtrue if device is switch	Wenn das Gerät Switch ist → True
number	context.device.firmwareVersion	Firmware version without build number as double value-Version ohne Build-Nummer mit doppelter Genauigkeit.
number	context.device.firmwareVersionWithBuild	Firmware version with build number as double value-Version mit Build-Nummer mit doppelter Genauigkeit.
string	context.device.firmwareVersionString	Gibt die Firmware-Version als String aus.
Object	context.device.firmwareVersionObject	Firmware version as object: -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 object (usage see next line-Objekt (zur Verwendung siehe nächste Zeile)
boolean	context.device.features.supports(int)	Checks whether a feature with given ID is supported, e.g. 43 for feature LAN bridgePrü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 Address for LAN interface. (Added April 2022. Requires device reboot before use.)-Addresse der LAN-Schnittstelle (im April 2022 hinzugefügt; benötigt einen Geräte-Neustart bevor die Funktion verwendet werden kann).
string	context.device.serialNumberSerial number of the device (Added April 2022. Requires device reboot before use.)	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.

...

Englisch

Config Variables

General

Type	Method	Description
void	config.resetConfigToDefault()	Revert all changes to the default configuration.
void	config.addScriptLine(line: string)	Adds the line to the script that is executed on the device.
void	config.infoLog(msg: string)	Prints the message into the device log within the LMC with log level `info`.
void	config.infoLog(key: string, msg: string)	Prints the message into the devicelog with the log key within the LMC with log level `info`.
void	config.warnLog(msg: string)	Prints the message into the device log within the LMC with log level `warn`.
void	config.abort(msg: string)	Aborts config building, and log the message into the device log within the LMC with log level `error`.
OutputStream	config.createOutputStream()	Creates a new standard output stream for strings. (Only supported for OneTimeScripts)
OutputStream	config.createOutputStream(key: string)	Creates a new output stream for strings. (Only supported for OneTimeScripts)
void	OutputStream.addLine(key: string)	Adds a string to the output stream.

Scalar

Type	Method	Description
string	config.getScalarByOid(oid)	Returns the value of the given scalar via oid.
string	config.getScalarByAlias(alias)	Returns the value of the given scalar via alias.
string	config.setScalarByOid(oid, value)	Sets scalar value (returns old value)
string	config.setScalarByAlias(alias, value)	Sets scalar value (returns old value)
string	config.resetScalarToDefaultByOid(oid);	Reset the given scalar via oid to the default configuration value.
string	config.resetScalarToDefaultByAlias(alias);	Reset the given scalar via alias to the default configuration value.

Table

Type	Method	Description
Table	config.getTableByOid(oid: string);	Get the Table object via oid.
Table	config.getTableByAlias(alias: string);	Get the Table object via alias.
List<Row>	table.getRows();	Get all rows of the Table object.
Row	table.getRowBySingleIndex(indexValue: string);	Get a row index, if it has only one index.
List<Row>	table.getRowsByOid(oid: string, value: string);	Get rows matching the value value in the column oid.
List<Row>	table.getRowsByAlias(alias:string, value:string);	Get rows matching the value valuein the column alias.
List<Row>	table.getRowsByOids(Map<oid, value>);	Get all rows matching all search criteria.
List<Row>	table.getRowsByAliases(Map<alias, value>);	Get all rows matching all search criteria, using aliases.
Row	table.getFirstRowByOid(oid, value);	Return first matching row via oid.
Row	table.getFirstRowByAlias(alias, value);	Return first matching row via alias
Row	table.getFirstRowByOids(Map<oid, value>);	Get first matching row matching via oid.
Row	table.getFirstRowByAliases(Map<alias, value>);	Get first matching row matchign via aliases
Row	table.createNewRow();	Create a new empty row.
Row	table.addOrMerge(row)	If the index matches a row the row is updated, otherwise the row is added.
boolean	table.resetToDefault();	Reset the table to the default configuration.

Row

Type	Method	Description
string	row.getByOid(oid);	Get value via oid.
string	row.getByAlias(alias);	Get value via alias.
string	row.setByOid(oid, value);	Set value via oid.
string	row.setByAlias(oid, value);	Set value via alias.
void	row.setByOids(Map<oid, value>);	Set multiple values via oid.
void	row.setByAliases(Map<alias, value>);	Set multiple values via aliases.
Row	row.addByOid(oid, value);	Like setByOid but returns the row for fluent API usage.
Row	row.addByAlias(alias, value);	Like setByAlias but returns the row for fluent API usage.
boolean	row.delete();	Delete the row from the table.

Exclude/Include

Type	Method	Description
void	config.excludeByOid(oid: string)	Do not write element(s) that match oid filter to the device, e.g. 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. 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
void	config.includeByOids(oids: List<string>)	Only write the element(s) matching the oid filter to the device (Note: the include calls do not stack!)

Context Variables

Context variables are read only.

DSC

Type	Method	Description
boolean	context.dsc.existsScalarByOid(oid)	Checks whether the given scalar exists by oid.
boolean	context.dsc.existsScalarByAlias(alias)	Checks whether the given scalar exists by alias.
boolean	context.dsc.existsTableByOid(oid)	Checks whether the given Table exists via oid.
boolean	context.dsc.existsTableByAlias(alias)	Checks whether the given Table exists via alias.

Network

variablen

Type	Method	Description
<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 SSID.
string[]	context.network.ssids[<SSID>].ifcName	List with interface names for SSID.
string	context.network.ssids[<SSID>].radiusName	Radius name for SSID.
string	context.network.ssids[<SSID>].name	The SSID (always same as )
string	context.network.name	Network name
string	context.network.configName	Network configuration name
string	context.network.configNameLong	Long network configuration name
string	context.network.ifcNumber	Network interface number
string	context.network.tag	Network Vlan Id
string	context.network.vpnGateway	Central Site Gateway address
string[]	context.network.vpnConnections	List of peer ident names for vpn connetions
<Variables>	context.network.vpnSiteVars[<SubnetGroupConfigName> or <PeerIdent>]	User	variables for vpn location
string	context.network.vpnCredentials[<SubnetGroupConfigName> or <PeerIdent>].remote.identity	VPN remote identity for site
string	context.network.vpnCredentials[<SubnetGroupConfigName> or <PeerIdent>].remote.psk	VPN remote psk for site
string	context.network.vpnCredentials[<SubnetGroupConfigName> or <PeerIdent>].local.identity	VPN local identity for site
string	context.network.vpnCredentials[<SubnetGroupConfigName> or <PeerIdent>].local.psk	VPN local psk for site
string	context.network.vpnRemoteData[peerName].subnetMask	VPN remote subnetmask for site
string	context.network.vpnRemoteData[peerName].subnetId	VPN remote subnet ID for site
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 number
<DevRolObj>	context.network.deviceRoles	return device roles object (usage see next 2 lines)
boolean	context.network.deviceRoles.contains(role string)	Check if device has role gateway with GW, access point with AP or switch with SW
string[]	context.network.deviceRoles.list()	Get list of device roles, e.g. {"GW", "AP", "SW"}

Device

Type	Method	Description
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 string
Object	context.device.firmwareVersionObject	Firmware version as object:	{major: number, minor: number, patch: number}
string	context.device.type	Device type string
<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.)

Location

Type	Method	Description
string	context.location.configName	Location configuration name
string	context.location.subnetId	Network ID at location, for example 192.168.1.0
string	context.location.subnetMask	Subnet mask
string	context.location.gatewayIp	Routing IP address to Central Site, if device Role is Gateway, else null
string[]	context.location.gatewayIps	Returns IP addresses of all location gateways.

Seiteneigenschaften

Seitenhierarchie

Versionen im Vergleich

Alte Version 8

Neue Version 9

Schlüssel

Konfigurations-Variablen

Allgemein

Skalar

Tabelle

Zeile

Ausschließen/Einbeziehen

Kontext-Variablen

DSC

Netzwerk

Gerät

Standort

Config Variables

General

Scalar

Table

Row

Exclude/Include

Context Variables

DSC

Network

Device

Location

Service & Support

Links