@@ -16,27 +16,36 @@ Installs the NDES role service.
1616## SYNTAX
1717
1818### DefaultParameterSet (Default)
19+
1920```
20- Install-AdcsNetworkDeviceEnrollmentService [-ApplicationPoolIdentity] [-RAName <String>] [-RAEmail <String>]
21- [-RACompany <String>] [-RADepartment <String>] [-RACity <String>] [-RAState <String>] [-RACountry <String>]
22- [-SigningProviderName <String>] [-SigningKeyLength <Int32>] [-EncryptionProviderName <String>]
23- [-EncryptionKeyLength <Int32>] [-CAConfig <String>] [-Force] [-Credential <PSCredential>] [-WhatIf] [-Confirm]
24- [<CommonParameters>]
21+ Install-AdcsNetworkDeviceEnrollmentService [-ApplicationPoolIdentity]
22+ [-RAName <String>] [-RAEmail <String>] [-RACompany <String>]
23+ [-RADepartment <String>] [-RACity <String>] [-RAState <String>]
24+ [-RACountry <String>] [-SigningProviderName <String>]
25+ [-SigningKeyLength <Int32>] [-EncryptionProviderName <String>]
26+ [-EncryptionKeyLength <Int32>] [-CAConfig <String>] [-Force]
27+ [-Credential <PSCredential>] [-WhatIf] [-Confirm] [<CommonParameters>]
2528```
2629
2730### ServiceAccountParameterSet
31+
2832```
29- Install-AdcsNetworkDeviceEnrollmentService -ServiceAccountName <String> -ServiceAccountPassword <SecureString>
30- [-RAName <String>] [-RAEmail <String>] [-RACompany <String>] [-RADepartment <String>] [-RACity <String>]
31- [-RAState <String>] [-RACountry <String>] [-SigningProviderName <String>] [-SigningKeyLength <Int32>]
32- [-EncryptionProviderName <String>] [-EncryptionKeyLength <Int32>] [-CAConfig <String>] [-Force]
33- [-Credential <PSCredential>] [-WhatIf] [-Confirm] [<CommonParameters>]
33+ Install-AdcsNetworkDeviceEnrollmentService -ServiceAccountName <String>
34+ -ServiceAccountPassword <SecureString> [-RAName <String>]
35+ [-RAEmail <String>] [-RACompany <String>] [-RADepartment <String>]
36+ [-RACity <String>] [-RAState <String>] [-RACountry <String>]
37+ [-SigningProviderName <String>] [-SigningKeyLength <Int32>]
38+ [-EncryptionProviderName <String>] [-EncryptionKeyLength <Int32>]
39+ [-CAConfig <String>] [-Force] [-Credential <PSCredential>] [-WhatIf]
40+ [-Confirm] [<CommonParameters>]
3441```
3542
3643## DESCRIPTION
37- The ** Install-AdcsNetworkDeviceEnrollmentService** cmdlet performs the configuration of the Network Device Enrollment Service (NDES) role service.
3844
39- To remove the NDES role service, use the ** Uninstall-AdcsNetworkDeviceEnrollmentService** cmdlet.
45+ The ` Install-AdcsNetworkDeviceEnrollmentService ` cmdlet performs the configuration of the Network
46+ Device Enrollment Service (NDES) role service.
47+
48+ To remove the NDES role service, use the ` Uninstall-AdcsNetworkDeviceEnrollmentService ` cmdlet.
4049
4150You can import the cmdlet by running the following commands from Windows PowerShell:
4251
@@ -48,42 +57,70 @@ Int is equivalent to Int32 in the [.NET Framework](https://msdn.microsoft.com/en
4857## EXAMPLES
4958
5059### Example 1: Display the default NDES settings
51- ```
52- PS C:\> Install-AdcsNetworkDeviceEnrollmentService -ApplicationPoolIdentity -WhatIf
60+
61+ ``` powershell
62+ Install-AdcsNetworkDeviceEnrollmentService -ApplicationPoolIdentity -WhatIf
5363```
5464
5565This command displays the default NDES settings that will be configured if it is installed.
5666
5767### Example 2: Display the default NDES settings using a service account name and password
58- ```
59- PS C:\> Install-AdcsNetworkDeviceEnrollmentService -ServiceAccountName "CONTOSO\svcNDES" -ServiceAccountPassword (read-host "Set user password" -assecurestring) -WhatIf
68+
69+ ``` powershell
70+ $params = @{
71+ ServiceAccountName = "CONTOSO\svcNDES"
72+ ServiceAccountPassword = (Read-Host "Set user password" -AsSecureString)
73+ WhatIf = $true
74+ }
75+ Install-AdcsNetworkDeviceEnrollmentService @params
6076```
6177
62- This command displays the default settings when NDES is using a service account without making any changes to the configuration.
63- This command uses the service account named "CONTOSO\svcNDES" that is a member of the local computer's IIS_USRS group.
78+ This command displays the default settings when NDES is using a service account without making any
79+ changes to the configuration. This command uses the service account named ` CONTOSO\svcNDES ` that
80+ is a member of the local computer's ` IIS_USRS ` group.
6481
6582### Example 3: Install NDES using the application pool identity
66- ```
67- PS C:\> Install-AdcsNetworkDeviceEnrollmentService -ApplicationPoolIdentity -CAConfig "<CAComputerName>\<CACommonName>"
83+
84+ ``` powershell
85+ $params = @{
86+ ApplicationPoolIdentity = $true
87+ CAConfig = "<CAComputerName>\<CACommonName>"
88+ }
89+ Install-AdcsNetworkDeviceEnrollmentService @params
6890```
6991
70- This command installs NDES using the application pool identity to use a remote CA as specified by the CA computer ` <CAComputerName>\<CACommonName> ` .
71- Substitute the appropriate CA computer name and common name for ` <CAComputerName> ` and ` <CACommonName> ` .
92+ This command installs NDES using the application pool identity to use a remote CA as specified by
93+ the CA computer ` <CAComputerName>\<CACommonName> ` . Substitute the appropriate CA computer name and
94+ common name for ` <CAComputerName> ` and ` <CACommonName> ` .
7295
7396### Example 4: Install NDES using a specific service account
74- ```
75- PS C:\> Install-AdcsNetworkDeviceEnrollmentService -ServiceAccountName "CONTOSO\svcNDES" -ServiceAccountPassword (read-host "Set user password" -assecurestring) -CAConfig "CAComputerName\CAName" -RAName "Contoso-NDES-RA" -RACountry "US" -RACompany "Contoso" -SigningProviderName "Microsoft Strong Cryptographic Provider" -SigningKeyLength 4096 -EncryptionProviderName "Microsoft Strong Cryptographic Provider" -EncryptionKeyLength 4096
97+
98+ ``` powershell
99+ $params = @{
100+ ServiceAccountName = "CONTOSO\svcNDES"
101+ ServiceAccountPassword = (Read-Host "Set user password" -AsSecureString)
102+ CAConfig = "CAComputerName\CAName"
103+ RAName = "Contoso-NDES-RA"
104+ RACountry = "US"
105+ RACompany = "Contoso"
106+ SigningProviderName = "Microsoft Strong Cryptographic Provider"
107+ SigningKeyLength = 4096
108+ EncryptionProviderName = "Microsoft Strong Cryptographic Provider"
109+ EncryptionKeyLength = 4096
110+ }
111+ Install-AdcsNetworkDeviceEnrollmentService @params
76112```
77113
78- This command installs the NDES using a service account named " CONTOSO\svcNDES" that is a member of the local computer's IIS_USRS group.
79- The command also specifies several non-default parameters.
114+ This command installs the NDES using a service account named ` CONTOSO\svcNDES ` that is a member of
115+ the local computer's ` IIS_USRS ` group. The command also specifies several non-default parameters.
80116
81117## PARAMETERS
82118
83119### -ApplicationPoolIdentity
84- Indicates that the cmdlet the identity that the Network Device Enrollment Service (NDES) uses when communicating with the certification authority (CA).
85- This parameter is only valid when NDES is using a remote CA.
86- If the CA is local, the application pool identity account cannot be used.
120+
121+ Indicates the identity that the Network Device Enrollment Service (NDES) uses when communicating
122+ with the certification authority (CA). This parameter is only valid when NDES is using
123+ a remote CA. If the CA is local, the application pool identity account cannot be used.
87124
88125``` yaml
89126Type : SwitchParameter
@@ -98,9 +135,10 @@ Accept wildcard characters: False
98135` ` `
99136
100137### -CAConfig
101- Specifies remote certification authority (CA) that the Network Device Enrollment Service uses.
102- This parameter is mandatory when used within the *ApplicationPoolIdentity* parameter.
103- Do not use this parameter when a local CA is installed.
138+
139+ Specifies the remote certification authority (CA) that the Network Device Enrollment Service uses. This
140+ parameter is mandatory when used within the **ApplicationPoolIdentity** parameter. Do not use this
141+ parameter when a local CA is installed.
104142
105143` ` ` yaml
106144Type : String
@@ -115,6 +153,7 @@ Accept wildcard characters: False
115153` ` `
116154
117155### -Confirm
156+
118157Prompts you for confirmation before running the cmdlet.
119158
120159` ` ` yaml
@@ -130,12 +169,13 @@ Accept wildcard characters: False
130169` ` `
131170
132171### -Credential
133- Specifies a **PSCredential** object that this cmdlet use to connect to the NDES role service.
134- To obtain a credential object, use the **Get-Credential** cmdlet.
135- For more information, type ` Get-Help Get-Credential`.
136- The NDES must be installed on a server that is a member of an Active Directory Domain Services (AD DS) domain.
137- If NDES is configured to use a Standalone CA, then an account that is a member of the local Administrators on the CA is required.
138- If NDES is installed to use an Enterprise CA, then using an account that is a member of Domain Admins group is required.
172+
173+ Specifies a **PSCredential** object that this cmdlet uses to connect to the NDES role service. To
174+ obtain a credential object, use the ` Get-Credential` cmdlet. For more information, type
175+ ` Get-Help Get-Credential` . The NDES must be installed on a server that is a member of an Active
176+ Directory Domain Services (AD DS) domain. If NDES is configured to use a Standalone CA, then an
177+ account that is a member of the local Administrators on the CA is required. If NDES is installed to
178+ use an Enterprise CA, then using an account that is a member of Domain Admins group is required.
139179
140180` ` ` yaml
141181Type: PSCredential
@@ -150,6 +190,7 @@ Accept wildcard characters: False
150190` ` `
151191
152192# ## -EncryptionKeyLength
193+
153194Specifies the encryption key length.
154195This option is not valid if you use existing keys during installation.
155196
@@ -166,7 +207,9 @@ Accept wildcard characters: False
166207` ` `
167208
168209# ## -EncryptionProviderName
169- Specifies the name of the encryption provider, such as the name of cryptographic service provider (CSP).
210+
211+ Specifies the name of the encryption provider, such as the name of cryptographic service provider
212+ (CSP).
170213
171214` ` ` yaml
172215Type: String
@@ -181,6 +224,7 @@ Accept wildcard characters: False
181224` ` `
182225
183226# ## -Force
227+
184228Forces the command to run without asking for user confirmation.
185229
186230` ` ` yaml
@@ -196,6 +240,7 @@ Accept wildcard characters: False
196240` ` `
197241
198242# ## -RACity
243+
199244Specifies the city of the registration authority.
200245
201246` ` ` yaml
@@ -211,6 +256,7 @@ Accept wildcard characters: False
211256` ` `
212257
213258# ## -RACompany
259+
214260Specifies the organization or company that the registration authority represents.
215261
216262` ` ` yaml
@@ -226,6 +272,7 @@ Accept wildcard characters: False
226272` ` `
227273
228274# ## -RACountry
275+
229276Specifies the country of the registration authority.
230277
231278` ` ` yaml
@@ -241,6 +288,7 @@ Accept wildcard characters: False
241288` ` `
242289
243290# ## -RADepartment
291+
244292Specifies the department of the registration authority.
245293
246294` ` ` yaml
@@ -256,6 +304,7 @@ Accept wildcard characters: False
256304` ` `
257305
258306# ## -RAEmail
307+
259308Specifies the email address of the registration authority.
260309
261310` ` ` yaml
@@ -271,6 +320,7 @@ Accept wildcard characters: False
271320` ` `
272321
273322# ## -RAName
323+
274324Specifies the name of the NDES registration authority.
275325
276326` ` ` yaml
@@ -286,7 +336,9 @@ Accept wildcard characters: False
286336` ` `
287337
288338# ## -RAState
289- Specifies the state or province (geographical political boundary), if applicable, of the registration authority.
339+
340+ Specifies the state or province (geographical political boundary), if applicable, of the
341+ registration authority.
290342
291343` ` ` yaml
292344Type: String
@@ -301,6 +353,7 @@ Accept wildcard characters: False
301353` ` `
302354
303355# ## -ServiceAccountName
356+
304357Specifies the name of the account that is used by the Network Device Enrollment Service.
305358
306359` ` ` yaml
@@ -316,6 +369,7 @@ Accept wildcard characters: False
316369` ` `
317370
318371# ## -ServiceAccountPassword
372+
319373Specifies the password of the service account that is used by the Network Device Enrollment Service.
320374
321375` ` ` yaml
@@ -331,6 +385,7 @@ Accept wildcard characters: False
331385` ` `
332386
333387# ## -SigningKeyLength
388+
334389Specifies the signing key length.
335390
336391` ` ` yaml
@@ -346,6 +401,7 @@ Accept wildcard characters: False
346401` ` `
347402
348403# ## -SigningProviderName
404+
349405Specifies the name of the signing device.
350406
351407` ` ` yaml
@@ -361,6 +417,7 @@ Accept wildcard characters: False
361417` ` `
362418
363419# ## -WhatIf
420+
364421Shows what would happen if the cmdlet runs. The cmdlet is not run.
365422
366423` ` ` yaml
@@ -376,7 +433,11 @@ Accept wildcard characters: False
376433` ` `
377434
378435# ## CommonParameters
379- This cmdlet supports the common parameters : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
436+
437+ This cmdlet supports the common parameters : -Debug, -ErrorAction, -ErrorVariable,
438+ -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
439+ -WarningAction, and -WarningVariable. For more information, see
440+ [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
380441
381442# # INPUTS
382443
@@ -395,14 +456,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
395456# ## Microsoft.CertificateServices.Deployment.Common.NDES.NetworkDeviceEnrollmentServiceResult
396457
397458# # NOTES
398- * Ensure you run Windows PowerShell as an administrator. You can use the *Force* parameter to bypass the prompt for confirmation.
399- To see parameters, run the following command : ` Install-AdcsNetworkDeviceEnrollmentService -?`
400459
401-
460+ - Ensure you run Windows PowerShell as an administrator. You can use the **Force** parameter to bypass
461+ the prompt for confirmation. To see parameters, run the following command :
462+
463+ ` Install-AdcsNetworkDeviceEnrollmentService -?`
402464
403465# # RELATED LINKS
404466
405467[Uninstall-AdcsNetworkDeviceEnrollmentService](./Uninstall-AdcsNetworkDeviceEnrollmentService.md)
406468
407469[Get-Credential](https://go.microsoft.com/fwlink/?LinkID=293936)
408-
0 commit comments