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

Add HDD

Operation Information

This operation will add a virtual hard disk to a VMware vSphere Virtual Machine.

See https://code.vmware.com/docs/10197/cmdlet-reference/doc/New-HardDisk.html for detailed information regarding the operation-specific parameters.

Extra Credentials

This operation requires an extra credential to be provided, stored in KeySafe, to the following specification:

  • Credential Reference: credential1
  • Credential Keysafe Key Type: Username + Password

Input Parameters

Name Type Description Required Sensitive
VMName string The name of the Virtual Machine to perform the action against Yes No
Port string Specifies the port on the server you want to use for the connection No No
Protocol string Specifies the internet protocol you want to use for the connection. It can be either http or https No No
NoTrustedCert boolean Specifies if the Connect-VIServer cmdlet will establish the connection without taking into account that the certificate is invalid Yes No
CapacityGB decimal Specifies the size (GB) of the new HDD No No
Persistence string Specifies the disk persistence mode. The valid values are Persistent, IndependentPersistent, and IndependentNonPersistent. This parameter is supported only when the DiskType is set to rawVirtual or flat No No
DiskType string Specifies the type of file backing that you want to use. The valid values are rawVirtual, rawPhysical, flat, and unknown No No
DeviceName string Specifies the host-specific device the Logical Unit Number (LUN) is being accessed through No No
DiskPath string Specifies the path to the disk No No
StorageFormat string Specifies the storage format of the new disk. This parameter accepts Thin, Thick, and EagerZeroedThick values No No
StoragePolicy string Specifies the storage policy that you want to attach to the new disk. If the storage policy is an encryption policy, the new disk will be encrypted. If the storage policy is a non-encryption policy, the policy will be attached to the new disk 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
storageFormat string Storage Format No No
persistence string Persistence No No
diskType string Disk Type No No
filename string Filename No No
capacityGB string The capacity of the new disk No No
parentId string Parent ID No No
uid string Unique ID No No
id string Disk ID No No
name string Disk Name No No
In This Document