Skip to content

Commit 36384bb

Browse files
docs(bindings): add non-HTTP protocol format specification
- Document hostname-only format for net.pipe, net.msmq, msmq.formatname - Document port:hostname format for net.tcp - Add comprehensive multi-protocol example - Clarify SSL parameter restrictions for HTTPS only
1 parent 90fcf4e commit 36384bb

File tree

1 file changed

+50
-1
lines changed

1 file changed

+50
-1
lines changed

REFERENCE.md

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -673,6 +673,56 @@ The sslflags parameter accepts integer values from 0 to 3 inclusive.
673673
the centralized SSL certificate store while requiring Server Name
674674
Indicator
675675

676+
For non-web protocols, the bindinginformation format varies by protocol:
677+
678+
**net.pipe protocol:**
679+
- Format: `hostname` (hostname only, no port or colons)
680+
- Example: `'bindinginformation' => 'hostname'`
681+
682+
**net.tcp protocol:**
683+
- Format: `port:hostname` (port number required, followed by colon and hostname)
684+
- Example: `'bindinginformation' => '808:hostname'`
685+
686+
**net.msmq protocol:**
687+
- Format: `hostname` (hostname only, no port or colons)
688+
- Example: `'bindinginformation' => 'hostname'`
689+
690+
**msmq.formatname protocol:**
691+
- Format: `hostname` (hostname only, no port or colons)
692+
- Example: `'bindinginformation' => 'hostname'`
693+
694+
**Note:** SSL-related parameters (sslflags, certificatehash, certificatestorename)
695+
are only valid for HTTPS protocol bindings and will cause validation errors
696+
if used with other protocols.
697+
Example with multiple protocols:
698+
```puppet
699+
bindings => [
700+
{
701+
'bindinginformation' => '*:80:',
702+
'protocol' => 'http',
703+
},
704+
{
705+
'bindinginformation' => '*:443:hostname',
706+
'certificatehash' => 'ABCDEF1234567890ABCDEF1234567890ABCDEF12',
707+
'certificatestorename' => 'MY',
708+
'protocol' => 'https',
709+
'sslflags' => 1,
710+
},
711+
{
712+
'bindinginformation' => 'hostname',
713+
'protocol' => 'net.pipe',
714+
},
715+
{
716+
'bindinginformation' => '808:hostname',
717+
'protocol' => 'net.tcp',
718+
},
719+
{
720+
'bindinginformation' => 'hostname',
721+
'protocol' => 'net.msmq',
722+
},
723+
]
724+
```
725+
676726
##### `defaultpage`
677727

678728
Specifies the default page of the site.
@@ -846,4 +896,3 @@ The name of the virtual directory to manage
846896

847897
The specific backend to use for this `iis_virtual_directory` resource. You will seldom need to specify this --- Puppet
848898
will usually discover the appropriate provider for your platform.
849-

0 commit comments

Comments
 (0)