SysOrb Network Monitoring System Administrator's Guide

For version 4.6.0

All trademarks used in this document are the properties of their respective owners

Table of Contents

Abstract

1. System Overview

1.1. SysOrb Components
1.2. How It Works

2. System Requirements

2.1. Agent Requirements
2.2. Server Requirements

3. Installing SysOrb

3.1. Installing the SysOrb Server

3.1.1. Microsoft Windows 7 / Server 2012
3.1.2. Red Hat Enterprise Linux 6 or CentOS6
3.1.3. Debian Linux 7.0 and other Debian based systems
3.1.4. Solaris 11

3.2. Installing a license file

3.3. Upgrading the SysOrb Server

3.3.1. Importing the default NodeClasses

3.4. Installing the SysOrb Agent

3.4.1. Microsoft Windows 7 / Server 2012
3.4.2. Red Hat Enterprise Linux 6 or CentOS6
3.4.3. Debian GNU/Linux 7.0 and other Debian based systems
3.4.4. Solaris 11

3.5. Unattended installation on Windows

4. Auto-upgrading the SysOrb Agent

4.1. Auto-upgrade with SysOrb Satellites

5. SysOrb Server Configuration

5.1. Microsoft Windows

5.2. Unix-like systems (FreeBSD, Linux and Solaris)

5.3. Configuration Options Reference

5.3.1. Logging Options
5.3.2. Database Options
5.3.3. Network Connection Manager Options
5.3.4. NetCheck Manager Options
5.3.5. General SysOrb Server Options
5.3.6. Alert Dispatcher Options
5.3.7. SNMP Options
5.3.8. Grid Options
5.3.9. WebAPI Options

5.4. Troubleshooting HTTPS/IMAPS/POP3S problems

5.5. On the fly debug logging

6. SysOrb Web Interface Configuration

6.1. General Web Interface Options

7. SysOrb Web Server Configuration

7.1. Web Server Configuration Reference

7.1.1. File Options
7.1.2. Logging
7.1.3. Server/network options

8. SysOrb Agent Configuration

8.1. Agent Configuration Reference

8.2. Releasing keys to force registering at SysOrb server

8.2.1. Releasing on agent
8.2.2. Releasing on server

8.3. Configuration of custom checks

8.4. Configuration of AgentActions

8.5. Configuration of Automated Actions - Remedy

8.6. Configuration of LogChecks

8.7. Enabling IPMI hardware monitoring

9. Grid configuration

9.1. Grid overview

9.1.1. Grid IDs - the GID
9.1.2. Links
9.1.3. Endpoint security

9.2. Configuring the Master

9.2.1. Installation and licensing
9.2.2. Configuring the master station
9.2.3. Adding a satellite to the master's configuration
9.2.4. Configuring the link between the master and the satellite
9.2.5. Exporting domains to the satellite

9.3. Configuring the Satellite

9.3.1. Installation and licensing
9.3.2. Configuring the satellite station
9.3.3. Adding the master to the satellite's configuration
9.3.4. Configuring the link between the satellite and the master
9.3.5. Mounting domains from the master

9.4. Getting started with remote monitoring

10. SysOrb Server maintenance

10.1. Adding MIB files

10.2. Custom NetChecks

10.2.1. Configuring Custom NetChecks

10.3. Custom AlertPaths

10.3.1. Script environment

10.4. Creating a new database

11. SysOrb Import and Export tools

11.1. sysorb-exporter
11.2. sysorb-importer
11.3. Examples of how to use

12. SysOrb Tool

12.1. The select command

12.1.1. How to specify the timeformat

12.2. The insert command

12.3. The listdomains command

12.4. The listnodes command

12.5. The listchecks command

12.6. The listactions command

12.7. The listproperties command

12.8. The update command

12.9. The resetscores command

12.10. The setdowntime command

12.11. Understanding the CSV file-format

12.11.1. Continuous checks
12.11.2. State checks
12.11.3. String checks

12.12. Example scripts

13. Acknowledgments

13.1. GD Graphics Library

13.2. OpenSSL Library

13.2.1. OpenSSL License
13.2.2. Original SSLeay license

14. WebAPI

14.1. Overview

14.1.1. Definitions
14.1.2. Overall description
14.1.3. External interfaces
14.1.4. Internal (system) interfaces
14.1.5. Protocols

14.2. Getting Started

14.2.1. Understanding objects hierarchy in SysOrb
14.2.2. Configuring SysOrb Web Service
14.2.3. Retrieving access token
14.2.4. Working with Domains
14.2.5. Working with Nodes
14.2.6. Working with CheckGroups and Checks
14.2.7. Managing Users in SysOrb
14.2.8. Enumerations in SysOrb
14.2.9. Common functions applied to most objects in SysOrb

14.3. Reference

14.3.1. Authentication
14.3.2. Database

List of Tables
14-1.
14-2.
14-3.
14-4.
14-5.
14-6.
14-7.
14-8.
14-9.
14-10.
14-11.
14-12.
14-13.
14-14.
14-15.
14-16.
14-17.
14-18.
14-19.
14-20.
14-21.
14-22.
14-23.
14-24.
14-25.
14-26.

List of Figures
14-1.

List of Examples
8-1. Good/bad check
8-2. Numeric integer check
8-3. Numeric real check
8-4. Differential numeric integer check
8-5. Differential numeric real check
8-6. Script outputting Response time: 1234 ms
8-7. Count the number of files in /tmp
8-8. IIS restart AgentAction
8-9. LogCheck declaration file
10-1. Custom NetCheck
11-1. Exporting contents of the Test domain
11-2. Contents of the exported file
11-3. Modified XML file, ready for import
11-4. Creating a node using sysorb-importer
12-1. Example extracting all data using bash
12-2. Example extracting all data on Windows
14-1. Request access token
14-2. Sign off
14-3. Get a list of subdomains
14-4. Get Domain StatusInfo
14-5. Get Domain template
14-6. Create a new Domain
14-7. Edit domain properties
14-8. Delete a Domain
14-9. Get a list of Nodes
14-10. Get Node template
14-11. Create a new Node
14-12. Update Node properties
14-13. Delete a Node
14-14. Read the check groups
14-15. Get all active checks
14-16. Get active ESXi checks in WARNING state
14-17. Request a check template for Network Check
14-18. Create a check
14-19. Get a lis of editable properties of the given check
14-20. Update a check
14-21. Delete a Check
14-22. Get a list of Users
14-23. Get User template
14-24. Create a new User
14-25. Update a User
14-26. Delete a User
14-27. Get object properties
14-28. Authorization header
14-29. Reply body schema
14-30. Reply body schema
14-31. Reply body schema
14-32. Reply body schema
14-33. Reply body schema
14-34. Request body schema
14-35. Request body schema
14-36. Reply body schema
14-37. Reply body schema
14-38. Reply body schema
14-39. Request body schema
14-40. Request body schema
14-41. Reply body schema
14-42. Reply body schema
14-43. Reply body schema
14-44. Reply body schema
14-45. Reply body schema
14-46. Reply body schema
14-47. Reply body schema
14-48. Request body schema
14-49. Reply body schema for Uptime, Accumulation, Continuous
14-50. Reply body schema for Enum
14-51. Reply body schema for Incident
14-52. Reply body schema
14-53. Reply body schema
14-54. Reply body schema
14-55. Reply body schema
14-56. Request body schema
14-57. Request body schema
14-58. Reply body schema
14-59. Reply body schema
14-60. Request body schema
14-61. Request body schema
14-62. Reply body schema
14-63. Reply body schema
14-64. Reply body schema
14-65. Request body schema
14-66. Request body schema
14-67. Reply body schema
14-68. Reply body schema
14-69. Request body schema
14-70. Request body schema

		Next
		Abstract