INDEX

Documentation Library

Search for information on Hornbill Documentation.

Filter

Books

All
{{book.title}}
{{book.foundCount}}

Products

{{product.name}} {{docApp.searchFilteredProducts[product.id].returnedCount}}

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

{{resultItem.title}}

{{resultItem.url}}

{{resultItem.content}}

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

{{book.title}}

{{book.title}}

More...

VMware vSphere

VMware vSphere Virtual Machine Management

Manage your VMware vSphere from inside Hornbill

Package Details

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

Why use this

Comprehensive control over virtual machines in your vSphere environment

Integration between Hornbill and vSphere enables simple control of VM administration—either by IT ops people or automated business processes/runbooks.

Example: Hornbill can automatically increase the number of virtual CPUs powering a virtual machine. If VM system monitoring shows that processor capacity is about to breach on a virtual machine, Hornbill can automatically increase capacity to ensure continuity of service during busy periods. No downtime. No incidents. Smooth experience for customers.

Benefits

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

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).
The VMware.PowerCLI PowerShell module needs to exist on the machine that will be executing the scripts;
Target machine for script execution should be running PowerShell 5.1
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.

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 VMware vSphere 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 a VMware vSphere account that has the correct privileges to run the operations;
Populate the Password field with the password for the abover account;
Populate the API Endpoint field with the hostname of your VMware host that you wish to target, for example: your.vmware.host.com;
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

Operation	Description
Add HDD	This operation will add a virtual hard disk to a VMware vSphere Virtual Machine.
Add Network Adapter	This operation will add a virtual network adapter to a VMware vSphere Virtual Machine.
Amend RAM Total	This operation will amend the amount of RAM for a VMware vSphere Virtual Machine.
Amend vCPU Count	This operation will amend the number of vCPUs for a VMware vSphere Virtual Machine.
Move VM	This operation will VMware vSphere Virtual Machine to another folder, host, cluster or resource pool.
New Snapshot	This operation will take a snapshot of a VMware vSphere Virtual Machine.
Remove Snapshot	This operation will remove a snapshot from a VMware vSphere Virtual Machine.
Restart VM	This operation will restart a VMware vSphere Virtual Machine.
Restart VM Guest	This operation will restart the guest OS on a VMware vSphere Virtual Machine.
Start VM	This operation will start a VMware vSphere Virtual Machine.
Stop VM	This operation will power off a VMware vSphere Virtual Machine.
Suspend VM	This operation will suspend a VMware vSphere Virtual Machine.

{{docApp.title}}

{{docApp.description}}