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

Package - Start Deployment

  • Article
  • 2 minutes to read

Operation Information

Creates a package deployment to a Configuration Manager collection.

See the Start-CMDeployment cmdlet documentation for more information: https://docs.microsoft.com/en-us/powershell/module/configurationmanager/start-cmpackagedeployment?view=sccm-ps

Input Parameters

Name Type Description Required Sensitive
SiteID string The ID of the target Site Yes No
PackageName string The name of the Package No No
ProgramName string The name of the Program within the Package No No
CollectionName string The name of the Collection to deploy the Package to No No
ScheduleEvent string One of: AsSoonAsPossible / LogOff / LogOn / SendWakeUpPacket No No
DeployPurpose string One of: Available / Required No No
StandardProgram boolean Indicates that the program type in the deployment package is standard program No No
SendWakeupPacket boolean Indicates whether to send a wake up packet to computers before the deployment begins No No
Rerun boolean Indicates whether the deployment reruns. If this value is True, the deployment runs again for clients as specified in the RerunBehavior parameter. If this value is False, the deployment does not run again No No
RerunBehavior string One of: AlwaysRerunProgram / NeverRerunDeployedProgram / RerunIfFailedPreviousAttempt / RerunIfSucceededOnpreviousAttempt No No
SoftwareInstallation boolean Indicates whether to install the deployed software outside of maintenance windows No No
SystemRestart boolean Indicates whether a system restarts outside a maintenance window No No
PersistOnWriteFilterDevice boolean Indicates whether to enable write filters for embedded devices No No
FastNetworkOption string One of: RunProgramFromDistributionPoint / DownloadContentFromDistributionPointAndRunLocally No No
SlowNetworkOption string One of: DoNotRunProgram / DownloadContentFromDistributionPointAndLocally / RunProgramFromDistributionPoint No No
AllowSharedContent boolean Indicates whether clients use shared content No No
Comment string Specify a Comment for the Deployment No No
UseMeteredNetwork boolean Indicates whether to allow clients to download content over a metered Internet connection after the deadline, which may incur additional expense No No
Server string The FQDN of the ECM Server 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
advertisementId string The Advertisement ID No No
advertisementName string The Advertisement Name No No
packageId string The Package ID No No
collectionId string The Collection ID No No
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document