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

New VHD

  • Article
  • 2 minutes to read

Operation Information

This operation will create a new Virtual Hard Disk, then mount, initialize, partition and format it so the drive is ready to use, before adding it to the target VM. See the New-VHD documentation for more information: https://docs.microsoft.com/en-us/powershell/module/hyper-v/new-vhd?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
Path string The path and filename of the new VHD file Yes No
ParentPath string Specifies the path to the parent of the differencing disk to be created (this parameter may be specified only for the creation of a differencing disk) No No
SourceDisk decimal Specifies the physical disk to be used as the source for the virtual hard disk to be created No No
Fixed boolean Specifies that a fixed virtual hard disk is to be created Yes No
SizeBytes string The maximum size of the VHD to be created. Examples: 1.5GB, 10GB, 1TB No No
Differencing boolean Specifies that a differencing virtual hard disk is to be created Yes No
Dynamic boolean Specifies that a dynamic virtual hard disk is to be created Yes No
BlockSizeBytes string Specifies the block size of the virtual hard disk to be created. Examples: 128MB, 64MB No No
LogicalSectorSizeBytes decimal Specifies the logical sector size, in bytes, of the virtual hard disk to be created. Valid values are 512 and 4096 No No
PhysicalSectorSizeBytes decimal Specifies the physical sector size, in bytes, of the virtual hard disk to be created. Valid values are 512 and 4096 No No
FileSystem string Specifies the file system with which to format the volume. One of: NTFS/ReFS/exFAT/FAT32/FAT Yes No
NewFileSystemLabel string Specifies the label to use for the volume No 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
Path string Path No No
ObjectId string Object ID No No
UniqueId string Unique ID No No
DriveLetter string Drive Letter No No
FileSystem string File System No No
Size string Size No No
SizeRemaining string Size Remaining No No
OperationalStatus string Operational Status No No
ControllerLocation string Controller Location No No
ControllerNumber string Controller Number No No
ControllerType string Controller Type No No
Name string Name No No
ID string ID No No
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document