mirror of
https://github.com/EvotecIT/GPOZaurr.git
synced 2026-07-26 11:49:17 +00:00
Przemysław Kłys
f7bdaca724
- Revised `Set-GPOZaurrOwner.md` to enhance clarity and detail for parameters and examples. - Updated `Set-GPOZaurrStatus.md` with a new online version link and improved structure. - Refined `Skip-GroupPolicy.md` to clarify usage within script blocks and added examples. - Adjusted `GPOZaurr.psd1` for version updates and improved module dependencies. - Enhanced `GPOZaurr.psm1` for better error handling during function imports. - Modified `Invoke-GPOZaurrSupport.ps1` examples to use `Join-Path` for path construction.
165 lines
4.0 KiB
Markdown
165 lines
4.0 KiB
Markdown
---
|
|
external help file: GPOZaurr-help.xml
|
|
Module Name: GPOZaurr
|
|
online version: https://github.com/EvotecIT/GPOZaurr
|
|
schema: 2.0.0
|
|
---
|
|
# Get-GPOZaurrFolders
|
|
## SYNOPSIS
|
|
Retrieves information about GPO folders within specified domains.
|
|
|
|
## SYNTAX
|
|
### __AllParameterSets
|
|
```powershell
|
|
Get-GPOZaurrFolders [[-Type] <string[]>] [[-FolderType] <string>] [[-Forest] <string>] [[-ExcludeDomains] <string[]>] [[-IncludeDomains] <string[]>] [[-ExtendedForestInformation] <IDictionary>] [-AsHashTable] [<CommonParameters>]
|
|
```
|
|
|
|
## DESCRIPTION
|
|
This function retrieves information about various GPO folders within specified domains, such as PolicyDefinitions, Policies, Scripts, GPO Starters, NETLOGON Scripts, DfsrPrivate, and SYSVOL Root.
|
|
|
|
## EXAMPLES
|
|
|
|
### EXAMPLE 1
|
|
```powershell
|
|
PS > Get-GPOZaurrFolders -Type All -FolderType All -Forest 'example.com' -IncludeDomains 'domain1', 'domain2' -ExcludeDomains 'domain3' -ExtendedForestInformation $info -AsHashTable
|
|
Retrieves information about all types of GPO folders within the specified domains in the forest 'example.com', excluding 'domain3', and including 'domain1' and 'domain2', with extended forest information.
|
|
```
|
|
|
|
|
|
### EXAMPLE 2
|
|
```powershell
|
|
PS > Get-GPOZaurrFolders -Type Sysvol -FolderType NTFRS -Forest 'example.com' -IncludeDomains 'domain1' -AsHashTable
|
|
Retrieves information about Sysvol folders using NTFRS type within the specified domain 'domain1' in the forest 'example.com' and returns the output as a hashtable.
|
|
```
|
|
|
|
|
|
## PARAMETERS
|
|
|
|
### -AsHashTable
|
|
Indicates whether to return the output as a hashtable.
|
|
|
|
```yaml
|
|
Type: SwitchParameter
|
|
Parameter Sets: __AllParameterSets
|
|
Aliases:
|
|
Possible values:
|
|
|
|
Required: False
|
|
Position: named
|
|
Default value: False
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: True
|
|
```
|
|
|
|
### -ExcludeDomains
|
|
Specifies domains to exclude from the retrieval.
|
|
|
|
```yaml
|
|
Type: String[]
|
|
Parameter Sets: __AllParameterSets
|
|
Aliases:
|
|
Possible values:
|
|
|
|
Required: False
|
|
Position: 3
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: True
|
|
```
|
|
|
|
### -ExtendedForestInformation
|
|
Specifies additional information about the forest.
|
|
|
|
```yaml
|
|
Type: IDictionary
|
|
Parameter Sets: __AllParameterSets
|
|
Aliases:
|
|
Possible values:
|
|
|
|
Required: False
|
|
Position: 5
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: True
|
|
```
|
|
|
|
### -FolderType
|
|
Specifies the type of folders to retrieve. Valid values are 'All', 'NTFRS', 'Empty'.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: __AllParameterSets
|
|
Aliases:
|
|
Possible values: All, NTFRS, Empty
|
|
|
|
Required: False
|
|
Position: 1
|
|
Default value: All
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: True
|
|
```
|
|
|
|
### -Forest
|
|
Specifies the forest name to retrieve information for.
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: __AllParameterSets
|
|
Aliases: ForestName
|
|
Possible values:
|
|
|
|
Required: False
|
|
Position: 2
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: True
|
|
```
|
|
|
|
### -IncludeDomains
|
|
Specifies domains to include in the retrieval.
|
|
|
|
```yaml
|
|
Type: String[]
|
|
Parameter Sets: __AllParameterSets
|
|
Aliases: Domain, Domains
|
|
Possible values:
|
|
|
|
Required: False
|
|
Position: 4
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: True
|
|
```
|
|
|
|
### -Type
|
|
Specifies the type of folders to retrieve. Valid values are 'All', 'Netlogon', 'Sysvol'.
|
|
|
|
```yaml
|
|
Type: String[]
|
|
Parameter Sets: __AllParameterSets
|
|
Aliases:
|
|
Possible values: All, Netlogon, Sysvol
|
|
|
|
Required: False
|
|
Position: 0
|
|
Default value: All
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: True
|
|
```
|
|
|
|
### CommonParameters
|
|
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
|
|
|
|
## INPUTS
|
|
|
|
- `None`
|
|
|
|
## OUTPUTS
|
|
|
|
- `None`
|
|
|
|
## RELATED LINKS
|
|
|
|
- None
|
|
|