@@ -16,13 +16,15 @@ Installs the Certification Authority Web Enrollment.
16
16
## SYNTAX
17
17
18
18
```
19
- Install-AdcsWebEnrollment [-CAConfig <String>] [-Force] [-Credential <PSCredential>] [-WhatIf] [-Confirm]
20
- [<CommonParameters>]
19
+ Install-AdcsWebEnrollment [-CAConfig <String>] [-Force]
20
+ [-Credential <PSCredential>] [-WhatIf] [-Confirm] [ <CommonParameters>]
21
21
```
22
22
23
23
## 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.
26
28
27
29
You can import the cmdlet by running the following commands from Windows PowerShell:
28
30
@@ -32,24 +34,30 @@ You can import the cmdlet by running the following commands from Windows PowerSh
32
34
## EXAMPLES
33
35
34
36
### 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>"
37
40
```
38
41
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.
41
45
42
46
### 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
45
50
```
46
51
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.
49
56
50
57
## PARAMETERS
51
58
52
59
### -CAConfig
60
+
53
61
Specifies the CA config parameter string.
54
62
Do not specify this if there is a local CA installed.
55
63
@@ -66,6 +74,7 @@ Accept wildcard characters: False
66
74
` ` `
67
75
68
76
### -Confirm
77
+
69
78
Prompts you for confirmation before running the cmdlet.
70
79
71
80
` ` ` yaml
@@ -81,11 +90,12 @@ Accept wildcard characters: False
81
90
` ` `
82
91
83
92
### -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.
89
99
90
100
` ` ` yaml
91
101
Type: PSCredential
@@ -100,6 +110,7 @@ Accept wildcard characters: False
100
110
` ` `
101
111
102
112
# ## -Force
113
+
103
114
Forces the command to run without asking for user confirmation.
104
115
105
116
` ` ` yaml
@@ -115,6 +126,7 @@ Accept wildcard characters: False
115
126
` ` `
116
127
117
128
# ## -WhatIf
129
+
118
130
Shows what would happen if the cmdlet runs. The cmdlet is not run.
119
131
120
132
` ` ` yaml
@@ -130,7 +142,11 @@ Accept wildcard characters: False
130
142
` ` `
131
143
132
144
# ## 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).
134
150
135
151
# # INPUTS
136
152
@@ -143,12 +159,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
143
159
# ## Microsoft.CertificateServices.Deployment.Common.WEP.WebEnrollmentResult
144
160
145
161
# # 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 -?`
148
167
149
168
# # RELATED LINKS
150
169
151
170
[Uninstall-AdcsWebEnrollment](./Uninstall-AdcsWebEnrollment.md)
152
171
153
172
[Get-Credential](https://go.microsoft.com/fwlink/?LinkID=293936)
154
-
0 commit comments