DSCResources/DSC_WSManListener/en-US/about_WSManListener.help.txt

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
.NAME
    WSManListener
 
.DESCRIPTION
    This resource is used to create, edit or remove WS-Management HTTP/HTTPS listeners.
 
    ## SubjectFormat Parameter Notes
 
    The subject format is used to determine how the certificate for the listener
    will be identified. It must be one of the following:
 
    - **Both**: Look for a certificate with a subject matching the computer FQDN.
      If one can't be found the flat computer name will be used. If neither
      can be found then the listener will not be created.
    - **FQDN**: Look for a certificate with a subject matching the computer FQDN
      only. If one can't be found then the listener will not be created.
    - **ComputerName**: Look for a certificate with a subject matching the computer
      FQDN only. If one can't be found then the listener will not be created.
 
.PARAMETER Transport
    Key - String
    Allowed values: HTTP, HTTPS
    The transport type of WS-Man Listener.
 
.PARAMETER Ensure
    Required - String
    Allowed values: Present, Absent
    Specifies whether the WS-Man Listener should exist.
 
.PARAMETER Port
    Write - UInt16
    The port the WS-Man Listener should use. Defaults to 5985 for HTTP and 5986 for HTTPS listeners.
 
.PARAMETER Address
    Write - String
    The Address that the WS-Man Listener will be bound to. The default is * (any address).
 
.PARAMETER Issuer
    Write - String
    The Issuer of the certificate to use for the HTTPS WS-Man Listener if a thumbprint is not specified.
 
.PARAMETER SubjectFormat
    Write - String
    Allowed values: Both, FQDNOnly, NameOnly
    The format used to match the certificate subject to use for an HTTPS WS-Man Listener if a thumbprint is not specified.
 
.PARAMETER MatchAlternate
    Write - Boolean
    Should the FQDN/Name be used to also match the certificate alternate subject for an HTTPS WS-Man Listener if a thumbprint is not specified.
 
.PARAMETER DN
    Write - String
    This is a Distinguished Name component that will be used to identify the certificate to use for the HTTPS WS-Man Listener if a thumbprint is not specified.
 
.PARAMETER Hostname
    Write - String
    The host name that a HTTPS WS-Man Listener will be bound to. If not specified it will default to the computer name of the node.
 
.PARAMETER Enabled
    Read - Boolean
    Returns true if the existing WS-Man Listener is enabled.
 
.PARAMETER URLPrefix
    Read - String
    The URL Prefix of the existing WS-Man Listener.
 
.PARAMETER CertificateThumbprint
    Write - String
    The Thumbprint of the certificate to use for the HTTPS WS-Man Listener.
 
.EXAMPLE 1
 
This will create or enable an HTTP WS-Man Listener on port 5985.
configuration Sample_WSManListener_HTTP
 
Configuration WSManListener_HTTP_Config
{
    Import-DscResource -Module WSManDsc
 
    Node localhost
    {
        WSManListener HTTP
        {
            Transport = 'HTTP'
            Ensure = 'Present'
        } # End of WSManListener Resource
    } # End of Node
} # End of Configuration
 
.EXAMPLE 2
 
Create an HTTPS Listener using a LocalMachine certificate that
is installed and issued by 'CN=CONTOSO.COM Issuing CA, DC=CONTOSO, DC=COM'
on port 5986.
 
Configuration WSManListener_HTTPS_Config
{
    Import-DscResource -Module WSManDsc
 
    Node localhost
    {
        WSManListener HTTPS
        {
            Transport = 'HTTPS'
            Ensure = 'Present'
            Issuer = 'CN=CONTOSO.COM Issuing CA, DC=CONTOSO, DC=COM'
        } # End of WSManListener Resource
    } # End of Node
} # End of Configuration
 
.EXAMPLE 3
 
Create an HTTPS Listener using a LocalMachine certificate containing a DN matching
'O=Contoso Inc, S=Pennsylvania, C=US' that is installed and issued by
'CN=CONTOSO.COM Issuing CA, DC=CONTOSO, DC=COM' on port 5986.
 
Configuration WSManListener_HTTPS_WithDN_Config
{
    Import-DscResource -Module WSManDsc
 
    Node localhost
    {
        WSManListener HTTPS
        {
            Transport = 'HTTPS'
            Ensure = 'Present'
            Issuer = 'CN=CONTOSO.COM Issuing CA, DC=CONTOSO, DC=COM'
            DN = 'O=Contoso Inc, S=Pennsylvania, C=US'
        } # End of WSManListener Resource
    } # End of Node
} # End of Configuration
 
.EXAMPLE 4
 
Create an HTTPS Listener using a LocalMachine certificate with a thumbprint
matching 'F2BE91E92AF040EF116E1CDC91D75C22F47D7BD6'. The host name in the
certificate must match the name of the host machine.
 
Configuration WSManListener_HTTPS_WithThumbprint_Config
{
    Import-DscResource -Module WSManDsc
 
    Node localhost
    {
        WSManListener HTTPS
        {
            Transport = 'HTTPS'
            Ensure = 'Present'
            CertificateThumbprint = 'F2BE91E92AF040EF116E1CDC91D75C22F47D7BD6'
        } # End of WSManListener Resource
    } # End of Node
} # End of Configuration
 
.EXAMPLE 5
 
Create an HTTPS Listener using a LocalMachine certificate with a thumbprint
matching 'F2BE91E92AF040EF116E1CDC91D75C22F47D7BD6'. If the subject in the
certificate does not match the name of the host then the Hostname parameter
must be specified. In this example the subject in the certificate is
'WsManListenerCert'.
 
Configuration WSManListener_HTTPS_WithThumbprintAndHostname_Config
{
    Import-DscResource -Module WSManDsc
 
    Node localhost
    {
        WSManListener HTTPS
        {
            Transport = 'HTTPS'
            Ensure = 'Present'
            CertificateThumbprint = 'F2BE91E92AF040EF116E1CDC91D75C22F47D7BD6'
            Hostname = 'WsManListenerCert'
        } # End of WSManListener Resource
    } # End of Node
} # End of Configuration