Skip to content

Commit 0eb523a

Browse files
committed
Sync
1 parent 610c2d1 commit 0eb523a

24 files changed

+514
-349
lines changed

docset/winserver2022-ps/grouppolicy/Get-GPInheritance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ by using the **Set-GPInheritance** cmdlet.
250250

251251
## NOTES
252252

253-
* You can use the *Domain* parameter to explicitly specify the domain for this cmdlet.
253+
* You can use the **Domain** parameter to explicitly specify the domain for this cmdlet.
254254

255255
If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain
256256
is the domain that is used to access network resources by the security context under which the

docset/winserver2022-ps/grouppolicy/Get-GPO.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ This cmdlet returns an object that represents the requested GPO.
235235
236236
## NOTES
237237
238-
* You can use the *Domain* parameter to explicitly specify the domain for this cmdlet.
238+
* You can use the **Domain** parameter to explicitly specify the domain for this cmdlet.
239239
240240
If you do not explicitly specify the domain, the cmdlet uses a default domain.
241241
The default domain is the domain that is used to access network resources by the security context under which the current session is running.
@@ -247,7 +247,7 @@ Therefore, when this cmdlet is run from a startup or shutdown script, the defaul
247247
248248
Only one domain can be used by an instance of this cmdlet.
249249
If you pipe a collection of GPO (Microsoft.GroupPolicy.Gpo) objects to this cmdlet, the DomainName property of the first GPO object in the collection specifies the domain for the cmdlet.
250-
This is because domainname is a built-in alias for the *Domain* parameter, and the *Domain* parameter can take its value by property name from the pipeline.
250+
This is because domainname is a built-in alias for the **Domain** parameter, and the **Domain** parameter can take its value by property name from the pipeline.
251251
A non-terminating error occurs for any GPOs in the collection that are not in this domain.
252252
If this domain is different from the domain of the user account (for startup or shutdown scripts, the computer account), a trust must exist between the two domains.
253253

docset/winserver2022-ps/grouppolicy/Get-GPOReport.md

Lines changed: 91 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -11,66 +11,81 @@ title: Get-GPOReport
1111
# Get-GPOReport
1212

1313
## SYNOPSIS
14+
1415
Generates a report either in XML or HTML format for a specified GPO or for all GPOs in a domain.
1516

1617
## SYNTAX
1718

1819
### ByGUID (Default)
20+
1921
```
2022
Get-GPOReport [-Guid] <Guid> [-ReportType] <ReportType> [[-Path] <String>] [[-Domain] <String>]
2123
[[-Server] <String>] [<CommonParameters>]
2224
```
2325

2426
### ByName
27+
2528
```
2629
Get-GPOReport [-Name] <String> [-ReportType] <ReportType> [[-Path] <String>] [[-Domain] <String>]
2730
[[-Server] <String>] [<CommonParameters>]
2831
```
2932

3033
### ReportAll
34+
3135
```
32-
Get-GPOReport [-ReportType] <ReportType> [[-Path] <String>] [[-Domain] <String>] [[-Server] <String>] [-All]
33-
[<CommonParameters>]
36+
Get-GPOReport [-ReportType] <ReportType> [[-Path] <String>] [[-Domain] <String>]
37+
[[-Server] <String>] [-All] [<CommonParameters>]
3438
```
3539

3640
## DESCRIPTION
37-
The **Get-GPOReport** cmdlet generates a report in either XML or HTML format that describes properties and policy settings for a specified Group Policy Object (GPO) or for all GPOs in a domain.
38-
The information that is reported for each GPO includes: details, links, security filtering, Windows Management Instrumentation (WMI) filtering, delegation, and computer and user configurations.
3941

40-
You can specify the *All* parameter to generate a report for every GPO in the domain, or you can specify either the *Name* or *Guid* parameter to generate a report for a single GPO.
41-
You can also pipe GPO objects into this cmdlet.
42-
If you specify a file through the *Path* parameter, the report is written to a file; otherwise, it is printed to the display.
42+
The **Get-GPOReport** cmdlet generates a report in either XML or HTML format that describes
43+
properties and policy settings for a specified Group Policy Object (GPO) or for all GPOs in a
44+
domain. The information that is reported for each GPO includes: details, links, security filtering,
45+
Windows Management Instrumentation (WMI) filtering, delegation, and computer and user
46+
configurations.
47+
48+
You can specify the **All** parameter to generate a report for every GPO in the domain, or you can
49+
specify either the **Name** or **Guid** parameter to generate a report for a single GPO. You can
50+
also pipe GPO objects into this cmdlet. If you specify a file through the **Path** parameter, the
51+
report is written to a file; otherwise, it is printed to the display.
4352

4453
## EXAMPLES
4554

4655
### Example 1: Generate an HTML report for the specified GPO
47-
```
48-
PS C:\> Get-GPOReport -Name "TestGPO1" -ReportType HTML -Path "C:\GPOReports\GPOReport1.html"
56+
57+
```powershell
58+
Get-GPOReport -Name "TestGPO1" -ReportType HTML -Path "C:\GPOReports\GPOReport1.html"
4959
```
5060

51-
This command generates a report in HTML format for the GPO TestGPO1 and writes it to the file C:\GPOReports\GPOReport1.html
61+
This command generates a report in HTML format for the GPO `TestGPO1` and writes it to the file `C:\GPOReports\GPOReport1.html`
5262

5363
### Example 2: Generate an XML report for each GPO in the specified domain
54-
```
55-
PS C:\> Get-GPOReport -All -Domain "sales.contoso.com" -Server "DC1" -ReportType XML -Path "C:\GPOReports\GPOReportsAll.xml"
64+
65+
```powershell
66+
Get-GPOReport -All -Domain "sales.contoso.com" -Server "DC1" -ReportType XML -Path "C:\GPOReports\GPOReportsAll.xml"
5667
```
5768

58-
This command generates a report in XML format for each GPO in the sales.contoso.com domain and writes it to the file C:\GPOReports\GPOReportsAll.xml.
59-
The DC1.sales.contoso.com domain controller is contacted to complete the operation.
69+
This command generates a report in XML format for each GPO in the `sales.contoso.com` domain and
70+
writes it to the file `C:\GPOReports\GPOReportsAll.xml`. The `DC1` domain controller is contacted to
71+
complete the operation.
6072

61-
If the domain of the user account (or, for startup and shutdown scripts, the computer account) is different from sales.contoso2.com, a trust must exist between the two domains.
73+
If the domain of the user account (or, for startup and shutdown scripts, the computer account) is
74+
different from `sales.contoso2.com`, a trust must exist between the two domains.
6275

6376
### Example 3: Generate an XML report for a GPO with the specified GUID
64-
```
65-
PS C:\> Get-GPOReport -GUID 73624cc9-e8f2-4f05-8802-193fae8773ce -ReportType XML
77+
78+
```powershell
79+
Get-GPOReport -GUID 73624cc9-e8f2-4f05-8802-193fae8773ce -ReportType XML
6680
```
6781

68-
This command generates a report in XML format for the GPO with the specified GUID.
69-
Because no *Path* parameter is supplied, the report is written to the display.
82+
This command generates a report in XML format for the GPO with the specified `GUID`.
83+
Because no **Path** parameter is supplied, the report is written to the display.
7084

7185
## PARAMETERS
7286

7387
### -All
88+
7489
Indicates that the cmdlet generates a report for all GPOs in the domain.
7590

7691
```yaml
@@ -86,23 +101,26 @@ Accept wildcard characters: False
86101
```
87102
88103
### -Domain
89-
Specifies the domain for this cmdlet.
90-
You must specify the fully qualified domain name (FQDN) of the domain.
104+
105+
Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the
106+
domain.
91107
92108
For the **Get-GPOReport** cmdlet:
93109
94110
- If a single GPO is specified, it must exist in this domain.
95111
96-
- If the *All* parameter is specified, a report is generated for each GPO in this domain.
112+
- If the **All** parameter is specified, a report is generated for each GPO in this domain.
97113
98-
If you do not specify the *Domain* parameter, the domain of the user that is running the current session is used.
99-
If the cmdlet is being run from a computer startup or shutdown script, the domain of the computer is used.
100-
For more information, see the Notes section in the full Help.
114+
If you do not specify the **Domain** parameter, the domain of the user that is running the current
115+
session is used. If the cmdlet is being run from a computer startup or shutdown script, the domain
116+
of the computer is used. For more information, see the Notes section in the full Help.
101117
102-
If you specify a domain that is different from the domain of the user that is running the current session or, (for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user or the computer.
118+
If you specify a domain that is different from the domain of the user that is running the current
119+
session or, (for a startup or shutdown script, the computer), a trust must exist between that domain
120+
and the domain of the user or the computer.
103121
104-
You can also refer to Domain by its built-in alias, **DomainName**.
105-
For more information, see [about_Aliases](????????????).
122+
You can also refer to Domain by its built-in alias, **DomainName**. For more information, see
123+
[about_Aliases](????????????).
106124
107125
```yaml
108126
Type: System.String
@@ -117,11 +135,12 @@ Accept wildcard characters: False
117135
```
118136
119137
### -Guid
120-
Specifies the GPO for which to generate the report by its globally unique identifier (GUID).
121-
The GUID uniquely identifies the GPO.
122138
123-
You can also refer to the *Guid* parameter by its built-in alias, **Id**.
124-
For more information, see **about_Aliases**.
139+
Specifies the GPO for which to generate the report by its globally unique identifier (GUID). The
140+
GUID uniquely identifies the GPO.
141+
142+
You can also refer to the **Guid** parameter by its built-in alias, **Id**.
143+
For more information, see [about_Aliases](????????).
125144
126145
```yaml
127146
Type: Guid
@@ -136,14 +155,15 @@ Accept wildcard characters: False
136155
```
137156
138157
### -Name
158+
139159
Specifies the GPO for which to generate the report by its display name.
140160
141-
The display name is not guaranteed to be unique in the domain.
142-
If another GPO with the same display name exists in the domain an error occurs.
143-
You can use the *Guid* parameter to uniquely identify a GPO.
161+
The display name is not guaranteed to be unique in the domain. If another GPO with the same display
162+
name exists in the domain an error occurs. You can use the **Guid** parameter to uniquely identify a
163+
GPO.
144164
145165
You can also refer to the **Name** parameter by its built-in alias, **DisplayName**.
146-
For more information, see **about_Aliases**.
166+
For more information, see [about_Aliases](????????).
147167
148168
```yaml
149169
Type: System.String
@@ -158,7 +178,8 @@ Accept wildcard characters: False
158178
```
159179
160180
### -Path
161-
Specifies the path to the report file; for instance, c:\Reports\GpoReport.xml.
181+
182+
Specifies the path to the report file; for instance, `c:\Reports\GpoReport.xml`.
162183
If no path is specified, the report is printed to the display.
163184

164185
```yaml
@@ -174,6 +195,7 @@ Accept wildcard characters: False
174195
```
175196

176197
### -ReportType
198+
177199
Specifies the format of the report.
178200
You must specify either Html (for HTML format) or Xml (for XML format).
179201
These values are not case sensitive.
@@ -194,13 +216,15 @@ Accept wildcard characters: False
194216
```
195217

196218
### -Server
197-
Specifies the name of the domain controller that this cmdlet contacts to complete the operation.
198-
You can specify either the fully qualified domain name (FQDN) or the host name.
199219

200-
If you do not specify the name by using the *Server* parameter, the primary domain controller (PDC) emulator is contacted.
220+
Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You
221+
can specify either the fully qualified domain name (FQDN) or the host name.
222+
223+
If you do not specify the name by using the **Server** parameter, the primary domain controller
224+
(PDC) emulator is contacted.
201225

202-
You can refer to this parameter by its built-in alias, **DC**.
203-
For more information, see **about_Aliases**.
226+
You can refer to this parameter by its built-in alias, **DC**. For more information, see
227+
[about_Aliases](????????).
204228

205229
```yaml
206230
Type: System.String
@@ -216,36 +240,45 @@ Accept wildcard characters: False
216240

217241
### CommonParameters
218242

219-
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).
243+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
244+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
245+
-WarningAction, and -WarningVariable. For more information, see
246+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
220247

221248
## INPUTS
222249

223250
### Microsoft.GroupPolicy.Gpo
251+
224252
An object that represents a GPO.
225253
Collections that contain GPOs from different domains are not supported.
226254

227255
## OUTPUTS
228256

229257
### None
258+
230259
This cmdlet does not generate any output.
231260

232261
## NOTES
233262

234-
* You can use the *Domain* parameter to explicitly specify the domain for this cmdlet.
235-
236-
If you do not explicitly specify the domain, the cmdlet uses a default domain.
237-
The default domain is the domain that is used to access network resources by the security context under which the current session is running.
238-
This domain is typically the domain of the user that is running the session.
239-
For instance, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command.
240-
However, computer startup and shutdown scripts run under the context of the LocalSystem account.
241-
The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account.
242-
Therefore, when this cmdlet is run from a startup or shutdown script, the default domain is the domain to which the computer is joined.
243-
244-
Only one domain can be used by an instance of this cmdlet.
245-
If you pipe a collection of GPO (Microsoft.GroupPolicy.Gpo) objects to this cmdlet, the **DomainName** property of the first GPO object in the collection specifies the domain for the cmdlet.
246-
This is because domainname is a built-in alias for the *Domain* parameter, and the *Domain* parameter can take its value by property name from the pipeline.
247-
A non-terminating error occurs for any GPOs in the collection that are not in this domain.
248-
If this domain is different from the domain of the user account, for startup or shutdown scripts, the computer account, a trust must exist between the two domains.
263+
* You can use the **Domain** parameter to explicitly specify the domain for this cmdlet.
264+
265+
If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain
266+
is the domain that is used to access network resources by the security context under which the
267+
current session is running. This domain is typically the domain of the user that is running the
268+
session. For instance, the domain of the user who started the session by opening Windows
269+
PowerShell from the Program Files menu, or the domain of a user that is specified in a runas
270+
command. However, computer startup and shutdown scripts run under the context of the LocalSystem
271+
account. The LocalSystem account is a built-in local account, and it accesses network resources
272+
under the context of the computer account. Therefore, when this cmdlet is run from a startup or
273+
shutdown script, the default domain is the domain to which the computer is joined.
274+
275+
Only one domain can be used by an instance of this cmdlet. If you pipe a collection of GPO
276+
(Microsoft.GroupPolicy.Gpo) objects to this cmdlet, the **DomainName** property of the first GPO
277+
object in the collection specifies the domain for the cmdlet. This is because domainname is a
278+
built-in alias for the **Domain** parameter, and the **Domain** parameter can take its value by
279+
property name from the pipeline. A non-terminating error occurs for any GPOs in the collection
280+
that are not in this domain. If this domain is different from the domain of the user account, for
281+
startup or shutdown scripts, the computer account, a trust must exist between the two domains.
249282

250283
## RELATED LINKS
251284

0 commit comments

Comments
 (0)