Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{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}}

{{book.title}}
More...

Rundeck

  • Article
  • 3 minutes to read

Rundeck DevOps Job Execution and Retrieval

Trigger Rundeck runbooks from inside Hornbill to resolve incidents faster and shrink the IT ops workload.

Package Details

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

Why use this

Control external runbooks from Hornbill to shorten incident timescales

If you already have Runbook Automations (RBA) that you use in Rundeck, this integration lets you trigger them directly from Hornbill—without jumping from Hornbill to Rundeck. After running, it pulls the execution details back into Hornbill for full visibility of what happened.

Example: If a customer calls the service desk with an issue that can be resolved by an existing Rundeck automation, the service desk agent can trigger the automation from inside Hornbill with just a few clicks. Call times are reduced and customer satisfaction is improved.

Alternatively (where appropriate) the customer can simply go to the service catalog and trigger the runbook automation themselves—bypassing the need to call the service desk.

Benefits

  • Empower service desk agents to take complex actions quickly to resolve incidents
  • Eliminate call volume spikes from wide-impacting issues
  • Empower employees and customers with runbook-driven services
  • Reduce routine call volumes

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 Rundeck 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 Rundeck instance. For example: https://yourrundeckserver:4440/api/32 where 4440 is the default port for Rundeck API calls, and 32 is the API version number;
  • 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
Get Execution Details Retrieves information regarding a job execution.
Get Execution Output Retrieves the output of a specified job execution.
Run Job Executes a job with a specified ID.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document