mirror of
https://github.com/EvotecIT/GPOZaurr.git
synced 2026-07-26 11:49:17 +00:00
docs: ✏️ Update documentation for GPOZaurr module
- 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.
This commit is contained in:
Przemysław Kłys
+165
-149
@@ -1,149 +1,165 @@
|
||||
---
|
||||
external help file: GPOZaurr-help.xml
|
||||
Module Name: GPOZaurr
|
||||
online version:
|
||||
schema: 2.0.0
|
||||
---
|
||||
|
||||
# Get-GPOZaurrNetLogon
|
||||
|
||||
## SYNOPSIS
|
||||
{{ Fill in the Synopsis }}
|
||||
|
||||
## SYNTAX
|
||||
|
||||
### Default (Default)
|
||||
```
|
||||
Get-GPOZaurrNetLogon [-Forest <String>] [-ExcludeDomains <String[]>] [-IncludeDomains <String[]>]
|
||||
[-ExtendedForestInformation <IDictionary>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### OwnerOnly
|
||||
```
|
||||
Get-GPOZaurrNetLogon [-OwnerOnly] [-Forest <String>] [-ExcludeDomains <String[]>] [-IncludeDomains <String[]>]
|
||||
[-ExtendedForestInformation <IDictionary>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### SkipOwner
|
||||
```
|
||||
Get-GPOZaurrNetLogon [-SkipOwner] [-Forest <String>] [-ExcludeDomains <String[]>] [-IncludeDomains <String[]>]
|
||||
[-ExtendedForestInformation <IDictionary>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
{{ Fill in the Description }}
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### Example 1
|
||||
```powershell
|
||||
PS C:\> {{ Add example code here }}
|
||||
```
|
||||
|
||||
{{ Add example description here }}
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -ExcludeDomains
|
||||
{{ Fill ExcludeDomains Description }}
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -ExtendedForestInformation
|
||||
{{ Fill ExtendedForestInformation Description }}
|
||||
|
||||
```yaml
|
||||
Type: IDictionary
|
||||
Parameter Sets: (All)
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -Forest
|
||||
{{ Fill Forest Description }}
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: (All)
|
||||
Aliases: ForestName
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -IncludeDomains
|
||||
{{ Fill IncludeDomains Description }}
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: (All)
|
||||
Aliases: Domain, Domains
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -OwnerOnly
|
||||
{{ Fill OwnerOnly Description }}
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: OwnerOnly
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### -SkipOwner
|
||||
{{ Fill SkipOwner Description }}
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: SkipOwner
|
||||
Aliases:
|
||||
|
||||
Required: False
|
||||
Position: Named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: False
|
||||
```
|
||||
|
||||
### 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
|
||||
|
||||
### System.Object
|
||||
## NOTES
|
||||
|
||||
## RELATED LINKS
|
||||
---
|
||||
external help file: GPOZaurr-help.xml
|
||||
Module Name: GPOZaurr
|
||||
online version: https://github.com/EvotecIT/GPOZaurr
|
||||
schema: 2.0.0
|
||||
---
|
||||
# Get-GPOZaurrNetLogon
|
||||
## SYNOPSIS
|
||||
Retrieves information about Group Policy Objects (GPO) stored in the Netlogon and SYSVOL directories.
|
||||
|
||||
## SYNTAX
|
||||
### Default (Default)
|
||||
```powershell
|
||||
Get-GPOZaurrNetLogon [-Forest <string>] [-ExcludeDomains <string[]>] [-IncludeDomains <string[]>] [-ExtendedForestInformation <IDictionary>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### OwnerOnly
|
||||
```powershell
|
||||
Get-GPOZaurrNetLogon [-OwnerOnly] [-Forest <string>] [-ExcludeDomains <string[]>] [-IncludeDomains <string[]>] [-ExtendedForestInformation <IDictionary>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
### SkipOwner
|
||||
```powershell
|
||||
Get-GPOZaurrNetLogon [-SkipOwner] [-Forest <string>] [-ExcludeDomains <string[]>] [-IncludeDomains <string[]>] [-ExtendedForestInformation <IDictionary>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## DESCRIPTION
|
||||
The Get-GPOZaurrNetLogon function retrieves details about GPOs stored in the Netlogon and SYSVOL directories of specified domains within a forest. It provides information about file ownership, status, domain, extension, creation time, and more.
|
||||
|
||||
## EXAMPLES
|
||||
|
||||
### EXAMPLE 1
|
||||
```powershell
|
||||
PS > Get-GPOZaurrNetLogon -Forest "contoso.com" -IncludeDomains "domain1", "domain2"
|
||||
Retrieves GPO information for the specified forest and domains.
|
||||
```
|
||||
|
||||
|
||||
### EXAMPLE 2
|
||||
```powershell
|
||||
PS > Get-GPOZaurrNetLogon -OwnerOnly
|
||||
Retrieves GPO information only for GPOs with identified owners.
|
||||
```
|
||||
|
||||
|
||||
### EXAMPLE 3
|
||||
```powershell
|
||||
PS > Get-GPOZaurrNetLogon -SkipOwner
|
||||
Retrieves GPO information while skipping the owner check.
|
||||
```
|
||||
|
||||
|
||||
## PARAMETERS
|
||||
|
||||
### -ExcludeDomains
|
||||
Specifies an array of domains to exclude from GPO retrieval.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default, OwnerOnly, SkipOwner
|
||||
Aliases:
|
||||
Possible values:
|
||||
|
||||
Required: False
|
||||
Position: named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: True
|
||||
```
|
||||
|
||||
### -ExtendedForestInformation
|
||||
Specifies additional forest information to include in the output.
|
||||
|
||||
```yaml
|
||||
Type: IDictionary
|
||||
Parameter Sets: Default, OwnerOnly, SkipOwner
|
||||
Aliases:
|
||||
Possible values:
|
||||
|
||||
Required: False
|
||||
Position: named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: True
|
||||
```
|
||||
|
||||
### -Forest
|
||||
Specifies the forest name to retrieve GPO information from.
|
||||
|
||||
```yaml
|
||||
Type: String
|
||||
Parameter Sets: Default, OwnerOnly, SkipOwner
|
||||
Aliases: ForestName
|
||||
Possible values:
|
||||
|
||||
Required: False
|
||||
Position: named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: True
|
||||
```
|
||||
|
||||
### -IncludeDomains
|
||||
Specifies an array of domains to include in GPO retrieval.
|
||||
|
||||
```yaml
|
||||
Type: String[]
|
||||
Parameter Sets: Default, OwnerOnly, SkipOwner
|
||||
Aliases: Domain, Domains
|
||||
Possible values:
|
||||
|
||||
Required: False
|
||||
Position: named
|
||||
Default value: None
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: True
|
||||
```
|
||||
|
||||
### -OwnerOnly
|
||||
Specifies whether to include only GPOs with identified owners.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: OwnerOnly
|
||||
Aliases:
|
||||
Possible values:
|
||||
|
||||
Required: False
|
||||
Position: named
|
||||
Default value: False
|
||||
Accept pipeline input: False
|
||||
Accept wildcard characters: True
|
||||
```
|
||||
|
||||
### -SkipOwner
|
||||
Specifies whether to skip checking the owner of GPOs.
|
||||
|
||||
```yaml
|
||||
Type: SwitchParameter
|
||||
Parameter Sets: SkipOwner
|
||||
Aliases:
|
||||
Possible values:
|
||||
|
||||
Required: False
|
||||
Position: named
|
||||
Default value: False
|
||||
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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user