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

Set Processor

Operation Information

This operation will set the processor details for a specific Hyper-V Virtual Machine. The target VM must be in a shutdown state, as per the Set-VMProcessor documentation: https://docs.microsoft.com/en-us/powershell/module/hyper-v/set-vmprocessor?view=win10-ps

Input Parameters

Name	Type	Description	Required	Sensitive
`VMName`	`string`	The name of the Virtual Machine to perform the action against	Yes	No
`HostName`	`string`	Optionally provide the Hyper-V host to perform the action on. NetBIOS names, IP addresses, and fully qualified domain names are allowable	No	No
`Count`	`decimal`	Specifies the number of virtual processors for the virtual machine	No	No
`CompatibilityForMigrationEnabled`	`boolean`	Specifies whether the virtual processor's features are to be limited for compatibility when migrating the virtual machine to another host	Yes	No
`CompatibilityForOlderOperatingSystemsEnabled`	`boolean`	Specifies whether the virtual processor's features are to be limited for compatibility with older operating systems	Yes	No
`HwThreadCountPerCore`	`decimal`	Specifies the number of virtual SMT threads exposed to the virtual machine	No	No
`Maximum`	`decimal`	Specifies the maximum percentage of resources available to the virtual machine processor to be configured. Allowed values range from 0 to 100	No	No
`Reserve`	`decimal`	Specifies the percentage of processor resources to be reserved for this virtual machine. Allowed values range from 0 to 100	No	No
`RelativeWeight`	`decimal`	Specifies the priority for allocating the physical computer's processing power to this virtual machine relative to others. Allowed values range from 1 to 10000	No	No
`MaximumCountPerNumaNode`	`decimal`	Specifies the maximum number of processors per NUMA node to be configured for the virtual machine	No	No
`MaximumCountPerNumaSocket`	`decimal`	Specifies the maximum number of sockets per NUMA node to be configured for the virtual machine	No	No
`ResourcePoolName`	`string`	Specifies the name of the processor resource pool to be used	No	No
`EnableHostResourceProtection`	`boolean`	Specifies whether to enable host resource protection on the virtual machine	Yes	No
`ExposeVirtualizationExtensions`	`boolean`	Specifies whether the hypervisor should expose the presence of virtualization extensions to the virtual machine, which enables support for nested virtualization	Yes	No

Output Parameters

Name	Type	Description	Required	Sensitive
`outcome`	`string`	Outcome of the operation. Can be OK, WARN or FAIL	Yes	No
`errors`	`string`	Any errors returned by the operation	No	No
`warnings`	`string`	Any warnings returned by the operation	No	No

In This Document

{{docApp.title}}

{{docApp.description}}