SAYMON SAYMON Wiki
Download

SAYMON Wiki

    • Getting started
    • Server installation
      • Install SAYMON Server on Oracle VM VirtualBox
    • Server configuration
      • System architecture
      • Network access
      • Configuration files
        • Server configuration
        • Web application configuration
        • Server logs configuration
      • Guides
        • SMS-notifications and Voice call enabling
        • Add custom probes
        • Hide unused probes
        • Scripts execution with object creation and deletion
        • Analytics module
        • Configuring Elasticsearch
        • Forward incidents to 3rd-party systems
        • Server self-monitoring
        • Start server via PM2
        • Users registration
        • Backup and restore data
        • Keycloak
        • LDAP
    • Connect to server
      • Connect to server with Web-interface
      • Connect to server via REST API
      • Connect to server with SSH
  • Monitoring
    • Monitoring architecture in SAYMON
    • Setting Up Basic Monitoring Scenarios
    • Agent selection
    • Built-in probes
      • Binary protocol
      • Configuration file / directory
      • Database query
      • FTP probe
      • HTTP request
      • JMX probe
      • Local port
      • MQTT probe
      • Ping probe
      • Process by name
      • Program / script execution
      • Remote port
      • SNMP Get
      • SNMP Trap
      • WMI probe
      • Agent Watchdog
    • SAYMON Agent
      • Install agent
        • Windows
        • Linux
        • macOS
        • Wiren Board
        • Autoinstallation
        • Extra agents installation
      • Configuration
        • Agent configuration file
        • Agent log files configuration
      • Autodiscovery
      • Update agents
      • Agent metadata
      • Agent update notes
    • Web-interface
      • General interface description
        • Main screen
        • Navigation panel
        • Main toolbar
        • Views panel
        • Breadcrumbs
          • Widgets time range
        • Context menu
          • Object context menu
          • Link context menu
          • Alarm context menu
      • Main screen views
        • Standard view
        • Geo view
        • Table view
        • End view
        • Grid view
        • Info modal
        • Simplified display modes (Single node)
      • Objects and links settings
        • Data
        • Parameters
          • Object parameters
          • Link parameters
        • Actions on state changes
          • Custom programs or scripts
          • Email notifications
          • Popup messages in browser
          • SMS notifications
          • Telegram messenger notifications
          • Voice calls
        • Data forming rules
          • Conditions entry example
          • DROP examples
          • EXTEND examples
          • Rules structure
          • SET examples
        • Graphs
          • Main controls
          • Page with graphs
        • State change conditions
        • Monitoring
        • Alarm generation conditions
        • Properties
        • Documents
        • Operations
        • Operations history
        • State history
        • Change log
        • Configuration files and directories modifications
        • Widgets
      • System configuration window
        • Users
          • General
          • Interface
          • Password change
          • Permissions
          • Object access
          • Event log
          • Remove user
          • Change password log
          • Activity log
        • Session log
        • Agents
        • Event log
        • Notification templates
        • States
        • Incidents
        • Object classes
          • General
          • Properties
          • Operations
          • Table
          • Triggers
        • Scripts
        • Configuration options
        • Password policies
        • Dictionaries
        • Dictionaries for monitoring
        • Property classes
      • Event Log
      • Alarms list
      • Security log interface
      • Search and bulk operations
      • Elements deletion
      • User registration window
    • Security notes
      • Using SSL Certificates
        • Registration of a domain name for the web server of the SAYMON server
        • Obtaining a free SSL certificate from Let’s Encrypt
        • Installation of Self-Signed SSL Certificate
        • Obtaining a commercial SSL certificate
      • Security log
        • Enable security log
        • Security log events
        • CEF format support
      • Password Encryption
      • Setting Up the Comet and Rest Server to Use an SSL Security Certificate
      • Configuring Kafka to Use an SSL Security Certificate
      • Setting up a secure connection via the MQTT protocol
      • CSRF/XSRF attacks protection
    • Guides
      • Agent
        • Setup TLS for PostgreSQL in the "Database query" probe
        • Change agent registration parameters
      • Alarms
        • Acknowledge an alarm
        • Configure alarm display
        • Get a list of active alarms
        • Undo clear alarm
        • Clear alarm automatically
        • Manually clear an alarm
        • Create alarm
        • Create and edit presets
        • Create synthetic alarm
        • Export active alarms to Excel file
        • Check the list of historic alarms
        • Remove historic alarm
        • Show object properties in the alarm table
        • Remove the "Acknowledged" mark from an active alarm
      • Alarm filter
        • Temporarily block alarms with filters
        • Reset filter
        • Save filter
        • Set filter with given criteria
      • Alarm levels
        • Create new alarm level
        • Edit/delete alarm levels
        • Create a backing
      • Dictionaries
        • Create dictionary
        • Export dictionary
        • Import dictionary
      • Graphs
        • Adding graphs and multigraphs
        • Comments
        • Maths on graphs
      • Language
        • Configure available interface languages
      • Links
        • Configure link
      • Monitoring
        • Stop data collection
        • Poll on demand
        • Test monitoring probe
      • Objects
        • Clone object
        • Create object
        • Reassign object parents
        • Mute alarms for an object
      • Probes
        • Get file ID in custom probe
      • Properties
        • Use property values as variables
      • States
        • Manual state transition
      • State Change Conditions
        • Splash analytics and prediction
      • Users and groups
        • Registration
        • Delete your account
        • Delete user accounts
        • Delete user groups
        • View user activity log
        • Change user’s password
        • Configure user permissions
      • Widgets
        • Create a widget
        • Delete widget
        • Embed widget on an external web site
        • Create an IFrame widget
        • Create a Ring widget and set time period
        • Temporarily change the widgets' time period
      • Connect to host via SSH or Telnet
      • Get system version
    • Integrations
      • Zabbix integration
      • Grafana integration
      • Keycloak integration
      • Integration with VictoriaMetrics
      • Integration with InfluxDB
    • Glossary
    • System elements
      • Agent
      • Alarms
      • Audit Log
      • Backings
      • Object classes
      • Dictionary
      • Dictionary group
      • Dictionary for monitoring
      • Dictionary group for monitoring
      • Flow
      • Link
      • Multiparent
      • Notification Template
      • Object
      • Object permissions
      • Operation
      • Password policies
      • Permissions
      • Property
      • Property class
      • Reference
      • State
      • State change conditions
      • States priority and propagation
      • Widgets
        • Button
        • Chart
        • Circle
        • Counter
        • IFrame
        • Level
        • Radial
        • Ring
        • Section
        • Structure
    • Extensions
      • Alarms Plus
        • Install and update extension
        • Configuration file
        • Interface
          • Side menu
          • Alarms
          • History
          • Events
          • Object
          • Login screen
          • Event menu
          • User menu
          • Additional windows
        • Profiles
        • Release notes
    • Regular Expressions
    • REST API
      • Postman Collection
      • General
        • Permissions
        • Response errors
      • Methods
        • Agents
          • Update Agent
          • Update All Agents
        • Authentication
          • Authentication
          • Authentication Token
            • Create Authentication Token
            • Delete Authentication Token
          • Session ID
            • Create Session ID
            • Delete Session ID
            • Verify Session ID
        • Bulks
          • Get Bulk Operation Status
          • Run Bulk Operation for Objects
        • Classes
          • State Conditions
            • Get Class’s State Conditions
            • Set Class’s State Conditions
            • Check If Class’s State Conditions Exist
          • Incident Conditions
            • Get Class’s Incident Conditions
            • Set Class’s Incident Conditions
          • Create Class
          • Get Class by ID
          • Get All Classes
          • Update Class
          • Delete Class by ID
          • Count Class’s Objects
        • Security
          • Get Security Log
        • Server Configuration
          • Password Policy
            • Create Password Policy
            • Get All Password Policies
            • Update Password Policy
            • Delete Password Policy
          • Password Log
            • Get Password Log
            • Get Password Expiration Time
          • Get All Custom Triggers
          • Get Server Configuration
          • Get All Custom Tasks
          • Update Server Configuration
        • Client Configuration
          • Get Client Configuration
          • Update Client Configuration
          • Reset Client Configuration
        • Dictionaries
          • Create Dictionary
          • Get Dictionary
          • Get All Dictionaries
          • Update Dictionary
          • Delete Dictionary by ID
        • Dictionary groups
          • Create dictionary group
          • Get dictionary group
          • Get all dictionary groups
          • Update dictionary group
          • Delete dictionary group
        • Dictionaries for monitoring
          • Create dictionary for monitoring
          • Get dictionary for monitoring
          • Get all dictionaries
          • Update dictionary
          • Delete dictionary for monitoring
        • Dictionary groups for monitoring
          • Create dictionary group for monitoring
          • Get dictionary group
          • Get all dictionary groups for monitoring
          • Update dictionary group for monitoring
          • Delete dictionary group for monitoring
        • Entities
          • Stat
            • Get Entity Stat
            • Set Entity Stat
          • State
            • Set Entity State
            • Set Entity’s Manual State
          • Get Entity by ID
          • Get Entity Children
          • Get All Root Entities
        • Event Log
          • Storage
            • Update Storage Limits For Event Log
            • Get Event Log Storage Info
          • Assign Event Log Record to User
          • Get Event Log
          • Get Event Log Modifications
          • Update Event Log Record Payload
          • Delete Event Log Record
        • Extensions
          • Get All Backend Extensions
        • Files
          • Download saved file
        • Flows
          • Documents
            • Get Flow’s Document
            • Add Document to Flow
            • Delete Flow’s Document
          • Create Flow
          • Get All Flows
          • Update Flow
          • Delete Flow
        • History Annotations
          • Create History Annotation
          • Get History Annotations
          • Update History Annotation
          • Delete History Annotation
        • Incident Levels
          • Create Incident Level
          • Get All Incident Levels
          • Update Incident Level
          • Delete Incident Level
        • Incidents
          • Get Incident by ID
          • Get All Incidents
          • Clear Incident
          • Clear and Remove Incident
          • Remove Incident from the History
          • Undo Clear Incident
          • Undo Remove Incident
          • Acknowledge Incident
          • Undo Incident Acknowledgement
          • Get Number Of Active Incidents
          • Add Incident Comment
          • Get Incident Comment History
          • Get Incidents History
          • Get Comments List for Historic Incident
        • Jobs
          • Get Link’s Job History
          • Get Object’s Job History
          • Get Job by Object/Link IDs
          • Get Job by ID
          • Add Custom Job Result
        • Limits
          • Get list of blocked requests
        • Links
          • State Conditions
            • Get Link’s State Conditions
            • Set Link’s State Conditions
            • Delete Link’s State Conditions
            • Check If Link’s State Conditions Exist
          • Config Log
            • Get Link’s Config Log
            • Get Link’s Config Log Item
          • State
            • Get Link’s State Triggers
            • Set Link’s State Triggers
            • Set Link’s Manual State
            • Get Link’s State History
            • Set Link’s State
          • Stat
            • Get Link’s Stat
            • Set Link’s Stat
            • Get Link’s Stat Metadata
            • Set Link’s Stat Metadata
            • Get Link’s Stat Metrics
            • Get Link’s Metrics History
            • Get Link’s N Last Metrics
          • Incident Conditions
            • Set Link’s Incident Conditions
            • Get Link’s Incident Conditions
            • Delete Link’s Incident Conditions
          • Documents
            • Add Document to Link
            • Get Link’s Document
            • Delete Link’s Document
          • Create Link
          • Get Link by ID
          • Get All Links
          • Get Link’s Parent Paths
          • Get Link’s Audit Log
          • Update Link
          • Delete Link by ID
        • Metric Tokens
          • Create Metric Token
          • Get Entity Stat with Metric Token
          • Get Entity History Data
        • MQTT
          • Get All MQTT Subscriptions
        • Notification Templates
          • Get All Notification Templates
          • Get Notification Template Preview
          • Update Notification Template
          • Restore Default Notification Template
        • Objects
          • State Conditions
            • Set Object’s State Conditions
            • Get Object’s State Conditions
            • Delete Object’s State Conditions
            • Check If Object’s State Conditions Exist
          • Config Log
            • Get Object’s Config Log
            • Get Object’s Config Log Item
          • State
            • Set Object’s State
            • Set Object’s Manual State
            • Get Object’s State History
            • Get Object’s State Triggers
            • Set Object’s State Triggers
          • Stat
            • Get Object’s Stat
            • Set Object’s Stat
            • Get Object’s Stat Metrics
            • Get Object’s Metrics History
            • Get Object’s N Last Metrics
            • Get Object’s Stat Metadata
            • Set Object’s Stat Metadata
            • Get Object Child Metrics
          • Incident Conditions
            • Get Object’s Incident Conditions
            • Set Object’s Incident Conditions
            • Delete Object’s Incident Conditions
          • Documents
            • Add Document to Object
            • Get Object’s Document
            • Delete Object’s Document
          • Create Object
          • Get Object by ID
          • Get All Objects
          • Update Object
          • Delete Object by ID
          • Get Object’s Parent Paths
          • Get Object’s Audit Log
          • Get Object’s Children
          • Get Object’s Children Links
          • Clone Object
          • Clone Object in Background
          • Get Objects' Properties Names
          • Search Objects
        • Operations
          • Entity Operations
            • Execute Entity Operation
          • Link Operations
            • Create Link Operation
            • Update Link Operation
            • Delete Link Operation
            • Execute Link Operation
          • Class Operations
            • Create Class Operation
            • Update Class Operation
            • Delete Class Operation
          • Object Operations
            • Create Object Operation
            • Update Object Operation
            • Execute Object Operation
            • Delete Object Operation
          • Get Operation ID
        • Presets
          • Create Preset
          • Get All Presets
          • Update Preset
        • Properties
          • Entity Properties
            • Get Entity Properties
          • Object Properties
            • Create Object Property
            • Get Object Properties
            • Update Object Property
            • Delete Object Property
            • Get Object Children Properties
            • Set Object’s Monitoring Properties
            • Test Monitoring Properties
            • Perform Object’s Monitoring Check
          • Class Properties
            • Create Class Property
            • Get Class Properties
            • Update Class Property
            • Delete Class Property
          • Flow Properties
            • Create Flow Property
            • Get Flow Properties
            • Update Flow Property
            • Delete Flow Property
          • Link Properties
            • Create Link Property
            • Get Link Properties
            • Update Link Property
            • Delete Link Property
            • Set Link’s Monitoring Properties
            • Test Monitoring Properties
            • Perform Link’s Monitoring Check
          • Incident Properties
            • Set Incident Properties
            • Delete Incident Properties
        • Property Classes
          • Create Property Class
          • Get Property Class
          • Get All Property Classes.
          • Modify Property Class
          • Delete Property Class
          • Get All Property Value Types.
        • References
          • Create Reference
          • Get All References
          • Get Reference by ID
          • Update Reference
          • Delete Reference by ID
        • Reports
          • Generate Excel Chart Report
          • Generate Excel Report of Incident History
          • Generate CSV Report of Incidents History
          • Generate Excel Report of Active Incidents
          • Generate Property Inventory Report
        • Scripts
          • Create Script
          • Get All Scripts
          • Update Script
          • Delete Script by ID
          • Get Script’s Usage Count
        • Service
          • Ping Server
          • Get SAYMON Version
          • Get SAYMON Version Hash
          • Get Server Time
          • Run Consistency Check
        • Stat
          • Get Stat History
          • Get Stat for Several Entities
        • Stat Rules
          • Objects
            • Get Object Stat Rules
            • Set Object Stat Rules
          • Links
            • Get Link Stat Rules
            • Set Link Stat Rules
        • State History
          • Get State History Log
          • Get All State History
          • Update State Comment
        • States
          • Create State
          • Get All States
          • Delete State
        • Tags
          • Create Tag
          • Get All Tags
        • User Groups
          • Create User Group
          • Get All User Groups
          • Update User Group
          • Delete User Group
        • Users
          • Favorites
            • Get Favorites
            • Set Favorites
          • Register User
            • Confirm Registration
            • Register User
            • Generate CAPTCHA
          • Passwords
            • Change User’s Password
            • Restore User’s Password
            • Send Restore Password Email
          • Log
            • Get Users' Sessions Log
            • Get User’s Audit Log
          • Create User
          • Get Current User
          • Get User by ID
          • Get All Users
          • Update User
          • Delete User
          • Search Users
      • Methods (API v2)
        • Get links (API v2)
        • Get objects (API v2)
        • Get references (API v2)
        • Misc
          • Search (API v2)
      • Misc
        • Sections' names
        • Conditions
        • EntityTypes
        • Incident Filters
        • State Change Reason
        • Security Event Classes
      • Models
        • Backend Extensions
        • Server Configuration
        • Client Configuration
        • Dictionary
        • Event Filter
        • Event Log
        • Flow
        • Favorites
        • History Annotation
        • Incident Condition
        • Incident Level
        • Incident
        • Incident Comment
        • Job
        • Link
        • Manual State
        • Notification template
        • Object
        • Operation
        • Password Policy
        • Password Log
        • Preset
        • Property
        • Property class
        • Reference
        • Script
        • Security Log
        • Stat
        • Stat Metadata
        • Stat Rule
        • State
        • State Change Condition
        • State Trigger
        • State History
        • Tag
        • User
        • User Group
        • Widget
      • Cookbook
        • Metrics
          • How to get minimum, maximum, and average values of metrics
        • Download Document
        • Upload background image to an object
    • Socket.IO
      • Entity State
        • State Change Event
      • Client Event
        • Client Notification Event
      • Entity Stat
        • Stat Event
      • Server Events
        • Bulk Operation Finished Event
        • Custom Server Event
        • Job Added Event
        • Job Result Received Event
        • MQTT Event
        • SNMP Trap Event
      • Model Events
        • Model Changed Event
      • Incidents
        • Incidents Event
        • Incident Count Event
      • Error Event
      • Custom Style Change Event
    • Release notes
  • SAYMON Wiki
  • Guides

Guides

This section contains guides on basic actions a user can perform with the system. These guides contain instructions for both built-in SAYMON web interface and the REST API.

CSRF/XSRF attacks protection Setup TLS for PostgreSQL in the "Database query" probe