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

Hyper-V

Hyper-V Virtual Machine Management

Simplify, centralize and automate control over your Hyper-V virtual machines

Package Details

  • Vendor: Microsoft
  • Target Platform: Windows Universal
  • Package Type: Server and Workstation Management

Why use this

Control virtual assets from inside Hornbill

Take the strain and complexity out of managing Hyper-V virtual machines by automating VM admin with Hornbill. Access to virtual machines can be presented to developers as services in your service catalog—saving dev and ops teams time.

Example: If a developer needs a test environment with a specific configuration, they can request a new VM through a service catalog—triggering an automated workflow process that creates the new VM. They get immediate access to the compute power they need—accelerating innovation and reducing IT ops team workload.

Benefits

  • Automate provisioning/deprovisioning of virtual machines
  • Enable instant digital delivery of VMs to developers
  • Reduce IT ops workloads and service desk calls

These actions can be taken by Hornbill users, automated business process workflows, and IT operations runbooks, making compute resource provisioning and deprovisioning “hands free” for IT ops.

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)
  • Installation of Hyper-V PowerShell/Hyper-V Management Package on the machine that will execute scripts
  • 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:

  • 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.

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

Package Automations

OperationDescription
Add VHD To VM This operation will add a Virtual Hard Disk to a Hyper-V Virtual Machine. See
Checkpoint VM This operation will create a Checkpoint for a Hyper-V Virtual Machine.
Enable VM Resource Metering This operation will enable Resource Metering on a Hyper-V Virtual Machine.
Get VHD This operation will retrieve details about a Virtual Hard Disk, using either
Measure VM This operation will gather resource utilization data for a specific Hyper-V
Move VM This operation will move a Hyper-V Virtual Machine. See the Move-VM
New Network Adapter This operation will add a Network Adapter to a Hyper-V Virtual Machine. See the
New VHD This operation will create a new Virtual Hard Disk, then mount, initialize,
Remove VM Snapshot This operation will remove a snapshot from a Hyper-V Virtual Machine.
Restart VM This operation will resume a Hyper-V Virtual Machine.
Resume VM This operation will resume a Hyper-V Virtual Machine.
Save VM This operation will save a Hyper-V Virtual Machine.
Set Memory This operation will set the memory details for a specific Hyper-V Virtual
Set Processor This operation will set the processor details for a specific Hyper-V Virtual
Start VM This operation will start a Hyper-V Virtual Machine.
Stop VM This operation will stop a Hyper-V Virtual Machine.
Suspend VM This operation will suspend a Hyper-V Virtual Machine.

See also

In This Document