Documentation Library

Search for information on Hornbill Documentation.


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

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 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 over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{docApp.libraryHomeViewProduct.title ||}}


  1. {{book.title}}

{{group.title ||}}


  1. {{book.title}}


Complex Types - sisDiscoveryJobOptionsType


The options required by the discovery process to run


Name Type Occurrence Description
container xs:string Optional The container we are discovering from. Only valid when mode = ‘adsi’
domain xs:string Optional The domain we are discovering. Only valid when mode = ‘win’ or ‘enum’
includeOnly xs:string Optional
Array (0/∞)
If specified, then only computers/defices defined are included in the discovery process
ldapCredentials xs:unsignedInt Optional The keysafe credentials optionally used for LDAP when using the LDAP discovery mode.
ldapDC xs:string Optional Specify the LDAP server to use. Only valid whem mode=‘ldap’
ldapFilter xs:string Optional Specify the LDAP filter to apply to search results. Only valid whem mode=‘ldap’
ldapRoot xs:string Optional Specify the LDAP directory root to search. Only valid whem mode=‘ldap’
list xs:string Optional The list of names, individual IP addresses, IP address ranges and CIDR specifications that are used as the baisis for discovery. Only valid when mode = ‘list’
mode sisDiscoveryJobModeType Required Which network/computer discovery scheme to use.
noPingRequired xs:boolean Optional
do not ping discovered computers
organisationalUnit xs:string Optional The organizational unit we are discovering from. Only valid when mode = ‘adsi’
pingHopCount xs:unsignedInt Optional
The maximum number of hops (TTL) between subnets before the ping fails.
pingTimeout xs:unsignedInt Optional
How long (in seconds) to wait for a ping response.
protocol sisDiscoveryJobProtocolType Optional
package operation
threads xs:unsignedInt Optional
The number of threads used during discovery.
useDynamicThreading xs:boolean Optional
enable the thread count to vary based on the workload
In This Document