Documentation
Internal Command Reference
The functions in this section are intended for internal use, e.g. for the console. They may change or be removed at any time without notice and should not be used in your own scripts or modules.
Helpers
Functions in this group are only available via the JSON-RPC interface.
| IPS_GetConfigurationsFromChildren | returns the configuration which the child instances specify for an instance |
| IPS_GetFunctions | returns comprehensive information about several functions |
| IPS_GetIcons | returns all icons including the icons of the skins |
| IPS_GetLibraries | returns information about several libraries |
| IPS_GetModules | returns information about several modules |
| IPS_GetScriptThreads | returns information about several threads of the script engine |
| IPS_GetTimers | returns information about several timers |
| IPS_GetTraces | returns all traces of an object including their causes |
License
Functions in this group return information about the license of IP-Symcon.
| IPS_GetDemoExpiration | returns the expiration time of the demo mode |
| IPS_GetLicensee | returns the licensee |
| IPS_GetLimitDemo | returns whether a demo license is used |
| IPS_GetLimitFeatures | returns the enabled features of the license |
| IPS_GetLimitServer | returns the server limitation of the license |
| IPS_GetLimitVariables | returns the maximum number of variables of the license |
| IPS_GetLimitWebFront | returns the maximum number of visualizations of the license |
| IPS_GetSubscriptionExpiration | returns the end of the subscription |
Replication
Functions in this group return the status of the replication (mirroring), control the failover and map the object IDs of Sync Remote.
| IPS_DemoteToReplicationSlave | demotes a slave promoted to master again |
| IPS_FindObjectID | returns the local ID for an ID of the remote system |
| IPS_FindRemoteID | returns the ID of the remote system for a local ID |
| IPS_FindServerID | returns the Sync Remote instance of a mirrored object |
| IPS_GetRemoteObject | returns the ID of a mirrored object on the remote system |
| IPS_GetReplicationFailoverTime | returns the point in time of the last failover |
| IPS_GetReplicationMode | returns the mode of the replication |
| IPS_GetReplicationSyncTime | returns the point in time of the last successful synchronization |
| IPS_IsReplicationActive | checks whether the replication is active |
| IPS_IsReplicationFailoverActive | checks whether the slave has taken over the tasks of the master |
| IPS_PromoteToReplicationMaster | promotes the slave to master |
Snapshots
Functions in this group return the complete state of IP-Symcon and its changes for clients.
| IPS_GetSnapshot | returns the complete state of IP-Symcon |
| IPS_GetSnapshotChanges | returns the changes since a specific message |
| IPS_GetSnapshotDiff | returns the differences to an earlier snapshot |
Special Switches
Functions in this group read and set the special switches (options) of IP-Symcon.
| IPS_GetOption | returns the value of a special switch |
| IPS_GetOptionEx | returns the current, stored and default value of a special switch |
| IPS_GetOptionList | returns the names of all special switches |
| IPS_SetOption | sets the value of a special switch |
Statistics
Functions in this group return runtime statistics of IP-Symcon.
| IPS_GetActiveProxyConnections | returns the number of active video stream proxy connections |
| IPS_GetActiveWebRTCConnections | returns the number of open WebRTC sessions |
| IPS_GetActiveWebServerConnections | returns the number of open HTTP connections of the web server |
| IPS_GetActiveWebSocketConnections | returns the number of open WebSocket connections of the web server |
| IPS_GetAllocatorStats | returns the statistics of the memory allocator |
| IPS_GetConnectionList | returns the send queues of the connections of the web server |
| IPS_GetFileCacheStats | returns the size of the file cache of the WebServer |
| IPS_GetFlowScriptStatistic | returns the execution statistics of a flow plan |
| IPS_GetInstanceDataFlowStatistics | returns the statistics of the data flow per instance |
| IPS_GetInstanceMessageQueueSize | returns the number of pending messages to instances |
| IPS_GetInstanceMessageStatistics | returns the statistics of the message processing per instance |
| IPS_GetInstanceStats | returns the memory usage of the instances |
| IPS_GetMediaStats | returns the memory usage of the media objects |
| IPS_GetSettingsStats | returns the size of the settings |
| IPS_GetSnapshotBufferStats | returns the size of the snapshot buffer |
| IPS_GetSnapshotRingBufferStats | returns the size of the message ring buffer |
| IPS_GetStatsHistory | returns the history of the memory statistics |
| IPS_GetThreadStats | returns the memory usage of the script threads |
| IPS_GetTraceStats | returns the size of the trace memory |
| IPS_GetVariableStats | returns the memory usage of the variables |