Dokumentation
Interne Befehlsreferenz
Die Funktionen in diesem Bereich sind für den internen Gebrauch vorgesehen, z.B. für die Konsole. Sie können sich jederzeit ohne Ankündigung ändern oder entfallen und sollten nicht in eigenen Skripten oder Modulen verwendet werden.
Hilfsfunktionen
Funktionen in dieser Gruppe stehen nur über die JSON-RPC Schnittstelle zur Verfügung.
| IPS_GetConfigurationsFromChildren | liefert die Konfiguration, welche die untergeordneten Instanzen für eine Instanz vorgeben |
| IPS_GetFunctions | liefert umfassende Informationen über mehrere Funktionen |
| IPS_GetIcons | liefert alle Icons inklusive der Icons der Skins |
| IPS_GetLibraries | liefert Informationen über mehrere Bibliotheken |
| IPS_GetModules | liefert Informationen über mehrere Module |
| IPS_GetScriptThreads | liefert Informationen über mehrere Threads der Skript-Engine |
| IPS_GetTimers | liefert Informationen über mehrere Timer |
| IPS_GetTraces | liefert alle Traces eines Objekts inklusive ihrer Ursachen |
Lizenz
Funktionen in dieser Gruppe liefern Informationen zur Lizenz von IP-Symcon.
| IPS_GetDemoExpiration | liefert den Ablaufzeitpunkt des Demo-Modus |
| IPS_GetLicensee | liefert den Lizenznehmer |
| IPS_GetLimitDemo | liefert, ob eine Demo-Lizenz verwendet wird |
| IPS_GetLimitFeatures | liefert die freigeschalteten Features der Lizenz |
| IPS_GetLimitServer | liefert die Server-Beschränkung der Lizenz |
| IPS_GetLimitVariables | liefert die maximale Anzahl an Variablen der Lizenz |
| IPS_GetLimitWebFront | liefert die maximale Anzahl an Visualisierungen der Lizenz |
| IPS_GetSubscriptionExpiration | liefert das Ende der Subskription |
Replikation
Funktionen dieser Gruppe liefern den Status der Replikation (Mirroring), steuern das Failover und rechnen die Objekt-IDs von Sync Remote um.
| IPS_DemoteToReplicationSlave | stuft einen zum Master beförderten Slave wieder zurück |
| IPS_FindObjectID | liefert die lokale ID zu einer ID des entfernten Systems |
| IPS_FindRemoteID | liefert die ID des entfernten Systems zu einer lokalen ID |
| IPS_FindServerID | liefert die Sync Remote Instanz eines gespiegelten Objekts |
| IPS_GetRemoteObject | liefert die ID eines gespiegelten Objekts auf dem entfernten System |
| IPS_GetReplicationFailoverTime | liefert den Zeitpunkt des letzten Failovers |
| IPS_GetReplicationMode | liefert den Modus der Replikation |
| IPS_GetReplicationSyncTime | liefert den Zeitpunkt des letzten erfolgreichen Abgleichs |
| IPS_IsReplicationActive | prüft, ob die Replikation aktiv ist |
| IPS_IsReplicationFailoverActive | prüft, ob der Slave die Aufgaben des Masters übernommen hat |
| IPS_PromoteToReplicationMaster | befördert den Slave zum Master |
Snapshots
Funktionen in dieser Gruppe liefern den vollständigen Zustand von IP-Symcon und dessen Änderungen für Clients.
| IPS_GetSnapshot | liefert den vollständigen Zustand von IP-Symcon |
| IPS_GetSnapshotChanges | liefert die Änderungen seit einer bestimmten Nachricht |
| IPS_GetSnapshotDiff | liefert die Unterschiede zu einem früheren Snapshot |
Spezialschalter
Funktionen in dieser Gruppe lesen und setzen die Spezialschalter (Optionen) von IP-Symcon.
| IPS_GetOption | liefert den Wert eines Spezialschalters |
| IPS_GetOptionEx | liefert aktuellen, gespeicherten und Standardwert eines Spezialschalters |
| IPS_GetOptionList | liefert die Namen aller Spezialschalter |
| IPS_SetOption | setzt den Wert eines Spezialschalters |
Statistiken
Funktionen in dieser Gruppe liefern Laufzeitstatistiken von IP-Symcon.
| IPS_GetActiveProxyConnections | liefert die Anzahl der aktiven Videostream-Proxy-Verbindungen |
| IPS_GetActiveWebRTCConnections | liefert die Anzahl der offenen WebRTC-Sitzungen |
| IPS_GetActiveWebServerConnections | liefert die Anzahl der offenen HTTP-Verbindungen des Webservers |
| IPS_GetActiveWebSocketConnections | liefert die Anzahl der offenen WebSocket-Verbindungen des Webservers |
| IPS_GetAllocatorStats | liefert die Statistik des Speicher-Allokators |
| IPS_GetConnectionList | liefert die Sendewarteschlangen der Verbindungen des Webservers |
| IPS_GetFileCacheStats | liefert die Größe des Dateicaches des WebServers |
| IPS_GetFlowScriptStatistic | liefert die Ausführungsstatistik eines Ablaufplans |
| IPS_GetInstanceDataFlowStatistics | liefert die Statistik des Datenflusses je Instanz |
| IPS_GetInstanceMessageQueueSize | liefert die Anzahl der ausstehenden Nachrichten an Instanzen |
| IPS_GetInstanceMessageStatistics | liefert die Statistik der Nachrichtenverarbeitung je Instanz |
| IPS_GetInstanceStats | liefert den Speicherbedarf der Instanzen |
| IPS_GetMediaStats | liefert den Speicherbedarf der Medienobjekte |
| IPS_GetSettingsStats | liefert die Größe der Einstellungen |
| IPS_GetSnapshotBufferStats | liefert die Größe des Snapshot-Puffers |
| IPS_GetSnapshotRingBufferStats | liefert die Größe des Nachrichten-Ringpuffers |
| IPS_GetStatsHistory | liefert den Verlauf der Speicherstatistiken |
| IPS_GetThreadStats | liefert den Speicherbedarf der Skript-Threads |
| IPS_GetTraceStats | liefert die Größe des Trace-Speichers |
| IPS_GetVariableStats | liefert den Speicherbedarf der Variablen |