Documentation

{{docApp.title}}

{{docApp.description}}

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?


What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

Nagios XI

Nagios XI Management

Connect Nagios XI monitoring for clear visibility of service and device status in Hornbill—to prevent avoidable downtime

Package Details

  • Vendor: Nagios
  • Target Platform: Windows Universal
  • Package Type: Application Management

Why use this

Real-time visibility of what’s going on in your infrastructure and what needs attention

Reduce stress and get in front of problems with better visibility of service/device status. Blind spots in your infrastructure represent risks. Integration between Hornbill and Nagios XI gives you real-time visibility of service/device status inside Hornbill—so you can spot and resolve issues before they impact your employees/customers.

Example: See and respond more quickly to issues to reduce service downtime. Create detect-and-correct automations that respond in real time to issues as they happen. For example, if a server hard drive breaches a 90% capacity threshold, it’s time to clear some space or deploy more capacity.

Benefits

  • Spot and solve problems before they impact services
  • Improve service quality and customer satisfaction
  • Reduce business risks
  • Reduce service desk calls
  • Cut IT ops workloads

How to get it

  • You can try out ITOM for free (not for production use, limited runs) by installing the ITOM application from the Hornbill App Store.
  • If you would like to explore ITOM and consider subscribing, please contact your account manager here.

Requirements

  • Install the Hornbill Site Integration Server inside your firewall (if you don’t already have it).
  • PowerShell v5.x
  • If the script execution policy on the machine executing these operations is set to Restricted, then this will need to be updated to RemoteSigned. See the Microsoft website for more information.

Authentication

When creating jobs for operations contained within this package, they need to be run on the target machine as a user who has the correct privileges within your environment. To create and securely store keys to run the operations:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button, then select Username + Password;
  • Give the KeySafe Key a Title (this is the name/identifier for the Active Directory account as you will see it when creating an IT Automation Job, or adding an IT Automation node to a Workflow);
  • Optionally add a Description;
  • Populate the Username field with the domain username for the account being used, for example: DOMAINNAME\yourusername;
  • Populate the Password field with the password for the above account;
  • Select Create Key to save.

Extra Credentials

Operations in this package require extra credentials to be sent, as well as the credentials for the user running the operation (as above). To create and securely store keys to run the operations:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button, then select API Key;
  • Give the KeySafe Key a Title (this is the name/identifier for the Nagios XI account as you will see it when creating an IT Automation Job, or adding an IT Automation node to a Workflow);
  • Optionally add a Description;
  • Populate the API Key field with an API Key that has the rights to perform the operations contained within this package;
  • Populate the API Endpoint field with the API Endpoint for your Nagios XI instance. For example: https://yournagiosxiserver/nagiosxi/api/v1;
  • Select Create Key to save.

Once you have created your KeySafe Keys, you can then use them to populate the Credentials > Admin or Run As and Extra Credentials inputs when creating IT Automation Jobs from this package.

Package Automations

OperationDescription
Acknowledgements - Acknowledge Host Problem Acknowledges a Host Problem.
Acknowledgements - Acknowledge Service Problem Acknowledges a Service Problem.
Acknowledgements - Remove Host Acknowledgement Removed an Acknowledgement from a Host.
Acknowledgements - Remove Service Acknowledgement Removed a Service Acknowledgement from a Host.
Checks - Disable Host Checks Disables checking on a Host.
Checks - Disable Host Service Checks Disables checking of all Services on a Host.
Checks - Disable Service Checks Disables checking of a specific Service on a Host.
Checks - Enable Host Chesks Enabled checking on a Host.
Checks - Enable Host Service Checks Enables checking of all Services on a Host.
Checks - Enable Service Checks Enables checking of a specific Service on a Host.
Checks - Process Service Check Results This is used to submit a passive check result for a particular service.
Comments - Add Host Comment Add a Comment to a particular Host.
Comments - Add Service Comment Add a Comment to a Service on a particular Host.
Notifications - Disable Host Notifications Disables notifications for a particular host.
Notifications - Disable Host Service Notifications Disables notifications for all services on the specified host.
Notifications - Disable Notifications Disables host and service notifications on a program-wide basis.
Notifications - Disable Service Notifications Disables notifications for a particular Service on a Host.
Notifications - Enable Host Notifications Enables notifications for a particular host.
Notifications - Enable Host Service Notifications Disables notifications for all services on the specified host.
Notifications - Enable Notifications Enables host and service notifications on a program-wide basis.
Notifications - Enable Service Notifications Enables notifications for a particular Service on a Host.
Schedules - Schedule Forced Host Check Schedules a forced active check of a particular host at "check_time".
Schedules - Schedule Forced Host Service Checks Schedules a forced active check of all services associated with a particular host at "check_time".
Schedules - Schedule Forced Service Check Schedules a forced active check of a particular service associated with a particular host at "check_time".
Schedules - Schedule Host Check Schedules the next active check of a particular host at "check_time".
Schedules - Schedule Host Downtime Schedules downtime for a specified host.
Schedules - Schedule Host Services Checks Schedules the next active check of all services on a particular host at "check_time".
Schedules - Schedule Host Services Downtime Schedules downtime for all services associated with a particular host.
Schedules - Schedule HostGroup Hosts Downtime Schedules downtime for all hosts in a specified hostgroup.
Schedules - Schedule HostGroup Services Downtime Schedules downtime for all services associated with hosts in a specified hostgroup.
Schedules - Schedule Service Check Schedules the next active check of a specified service at "check_time".
Schedules - Schedule Service Downtime Schedules downtime for a specified service.
Schedules - Schedule ServiceGroup Hosts Downtime Schedules downtime for all hosts that have services in a specified servicegroup.
Schedules - Schedule ServiceGroup Services Downtime Schedules downtime for all services in a specified servicegroup.
Schedules - Schedule and Propagate Host Downtime Schedules downtime for a specified host and all of its children (hosts).
Schedules - Schedule and Propagate Triggered Host Downtime Schedules downtime for a specified host and all of its children (hosts).
Status - Get Host Status Retrieves the status of a specified host.
Status - Get Service Status Retrieves the status of a specified service.

See also

In This Document