@@ -16,13 +16,15 @@ Installs the Certification Authority Web Enrollment.
1616## SYNTAX
1717
1818```
19- Install-AdcsWebEnrollment [-CAConfig <String>] [-Force] [-Credential <PSCredential>] [-WhatIf] [-Confirm]
20- [<CommonParameters>]
19+ Install-AdcsWebEnrollment [-CAConfig <String>] [-Force]
20+ [-Credential <PSCredential>] [-WhatIf] [-Confirm] [ <CommonParameters>]
2121```
2222
2323## DESCRIPTION
24- The ** Install-AdcsWebEnrollment** cmdlet performs initial installation and configuration of the Certification Authority (CA) Web Enrollment role service.
25- To remove the Web Enrollment role service use the ** Uninstall-AdcsWebEnrollment** cmdlet.
24+
25+ The ` Install-AdcsWebEnrollment ` cmdlet performs initial installation and configuration of the
26+ Certification Authority (CA) Web Enrollment role service. To remove the Web Enrollment role service
27+ use the ` Uninstall-AdcsWebEnrollment ` cmdlet.
2628
2729You can import the cmdlet by running the following commands from Windows PowerShell:
2830
@@ -32,24 +34,30 @@ You can import the cmdlet by running the following commands from Windows PowerSh
3234## EXAMPLES
3335
3436### Example 1: Install the Web Enrollment role service to a CA with confirmation
35- ```
36- PS C:\> Install-AdcsWebEnrollment -CAConfig "<CAComputerName>\<CACommonName>"
37+
38+ ``` powershell
39+ Install-AdcsWebEnrollment -CAConfig "<CAComputerName>\<CACommonName>"
3740```
3841
39- This command installs the Web Enrollment role service to a CA specified by ` <CAComputerName>\<CACommonName> ` .
40- Replace the computer name of the CA for ` <CAComputerName> ` and replace the CA common name for ` <CACommonName> ` when running the command.
42+ This command installs the Web Enrollment role service to a CA specified by
43+ ` <CAComputerName>\<CACommonName> ` . Replace the computer name of the CA for ` <CAComputerName> ` and
44+ replace the CA common name for ` <CACommonName> ` when running the command.
4145
4246### Example 1: Install the Web Enrollment role service to a CA without confirmation
43- ```
44- PS C:\> Install-AdcsWebEnrollment -CAConfig "<CAComputerName>\<CACommonName>" -Force
47+
48+ ``` powershell
49+ Install-AdcsWebEnrollment -CAConfig "<CAComputerName>\<CACommonName>" -Force
4550```
4651
47- This command installs the Web Enrollment role service to a CA specified by ` <CAComputerName>\<CACommonName> ` without requiring user confirmation.
48- Replace the computer name of the CA for ` <CAComputerName> ` and replace the CA common name for ` <CACommonName> ` when running the command.
52+ This command installs the Web Enrollment role service to a CA specified by
53+ ` <CAComputerName>\<CACommonName> ` without requiring user confirmation. Replace the computer name of
54+ the CA for ` <CAComputerName> ` and replace the CA common name for ` <CACommonName> ` when running the
55+ command.
4956
5057## PARAMETERS
5158
5259### -CAConfig
60+
5361Specifies the CA config parameter string.
5462Do not specify this if there is a local CA installed.
5563
@@ -66,6 +74,7 @@ Accept wildcard characters: False
6674` ` `
6775
6876### -Confirm
77+
6978Prompts you for confirmation before running the cmdlet.
7079
7180` ` ` yaml
@@ -81,11 +90,12 @@ Accept wildcard characters: False
8190` ` `
8291
8392### -Credential
84- Specifies a **PSCredential** object for the CA Web Enrollment.
85- To obtain a credential object, use the **Get-Credential** cmdlet.
86- For more information, type ` Get-Help Get-Credential`.
87- If the Web Enrollment service is configured to use Standalone CA, then an account that is a member of the local Administrators on the CA is required.
88- If the Web Enrollment service is configured to use an Enterprise CA, then an account that is a member of Domain Admins is required.
93+
94+ Specifies a **PSCredential** object for the CA Web Enrollment. To obtain a credential object, use the
95+ ` Get-Credential` cmdlet. For more information, type `Get-Help Get-Credential`. If the Web Enrollment
96+ service is configured to use Standalone CA, then an account that is a member of the local
97+ Administrators on the CA is required. If the Web Enrollment service is configured to use an
98+ Enterprise CA, then an account that is a member of Domain Admins is required.
8999
90100` ` ` yaml
91101Type: PSCredential
@@ -100,6 +110,7 @@ Accept wildcard characters: False
100110` ` `
101111
102112# ## -Force
113+
103114Forces the command to run without asking for user confirmation.
104115
105116` ` ` yaml
@@ -115,6 +126,7 @@ Accept wildcard characters: False
115126` ` `
116127
117128# ## -WhatIf
129+
118130Shows what would happen if the cmdlet runs. The cmdlet is not run.
119131
120132` ` ` yaml
@@ -130,7 +142,11 @@ Accept wildcard characters: False
130142` ` `
131143
132144# ## CommonParameters
133- 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).
145+
146+ This cmdlet supports the common parameters : -Debug, -ErrorAction, -ErrorVariable,
147+ -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
148+ -WarningAction, and -WarningVariable. For more information, see
149+ [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
134150
135151# # INPUTS
136152
@@ -143,12 +159,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
143159# ## Microsoft.CertificateServices.Deployment.Common.WEP.WebEnrollmentResult
144160
145161# # NOTES
146- * Ensure you run Windows PowerShell as an administrator. You can use the *Force* parameter to bypass the prompt for confirmation.
147- To see parameters, run the following command : ` Install-AdcsWebEnrollment -?`
162+
163+ - Ensure you run Windows PowerShell as an administrator. You can use the **Force** parameter to
164+ bypass the prompt for confirmation. To see parameters, run the following command :
165+
166+ ` Install-AdcsWebEnrollment -?`
148167
149168# # RELATED LINKS
150169
151170[Uninstall-AdcsWebEnrollment](./Uninstall-AdcsWebEnrollment.md)
152171
153172[Get-Credential](https://go.microsoft.com/fwlink/?LinkID=293936)
154-
0 commit comments