Documentation Library

Search for information on Hornbill Documentation.


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

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 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 over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{docApp.libraryHomeViewProduct.title ||}}


  1. {{book.title}}

{{group.title ||}}


  1. {{book.title}}


Firewall - Rule New

Operation Information

Creates a new Windows Firewall Rule. See the New-NetFirewallRule cmdlet documentation for more information:

Input Parameters

Name Type Description Required Sensitive
Name string Name of the Firewall Rule No No
DisplayName string Display Name of the Firewall Rule Yes No
Direction string Inbound / Outbound No No
PolicyStore string Policy Store No No
Description string Description No No
Group string Group No No
Enabled boolean Enabled No No
Profile string Any / Domain / Private / Public / NotApplicable No No
Platform string Platform No No
Action string NotConfigured / Allow / Block No No
EdgeTraversalPolicy string Allow / Block / DeferToUser / DeferToApp No No
LooseSourceMapping boolean Loose Source Mapping No No
LocalOnlyMapping boolean Local Only Mapping No No
Owner string Owner No No
LocalAddress string Local Address No No
RemoteAddress string Remote Address No No
Protocol string Protocol No No
LocalPort string Local Port No No
RemotePort string Remote Port No No
IcmpType string Icmp Type No No
DynamicTarget string Any / ProximityApps / ProximitySharing / WifiDirectPrinting / WifiDirectDisplay / WifiDirectDevices No No
Program string Program No No
Package string Package No No
Service string Service No No
InterfaceAlias string Interface Alias No No
InterfaceType string Any / Wired / Wireless / RemoteAccess No No
Encryption string NotRequired / Required / Dynamic No No
OverrideBlockRules boolean Override Block Rules No No

Output Parameters

Name Type Description Required Sensitive
outcome string Outcome of the operation. Can be OK, WARN or FAIL Yes No
error string Any errors returned by the operation No No
warning string Any warnings returned by the operation No No
name string Name No No
displayName string Display Name No No
In This Document