From a566d4716af79eb0afea695787c12f0f4ae51cfe Mon Sep 17 00:00:00 2001 From: Przemyslaw Klys Date: Sun, 5 Dec 2021 11:26:47 +0100 Subject: [PATCH] Update docs --- Docs/Get-GPOZaurr.md | 298 ++++++++++++++++++++++--------------------- 1 file changed, 152 insertions(+), 146 deletions(-) diff --git a/Docs/Get-GPOZaurr.md b/Docs/Get-GPOZaurr.md index 0e3c147..a47e011 100644 --- a/Docs/Get-GPOZaurr.md +++ b/Docs/Get-GPOZaurr.md @@ -8,7 +8,8 @@ schema: 2.0.0 # Get-GPOZaurr ## SYNOPSIS -{{ Fill in the Synopsis }} +Gets information about all Group Policies. +Similar to what Get-GPO provides by default. ## SYNTAX @@ -16,121 +17,52 @@ schema: 2.0.0 Get-GPOZaurr [[-ExcludeGroupPolicies] ] [[-GPOName] ] [[-GPOGuid] ] [[-Type] ] [[-Forest] ] [[-ExcludeDomains] ] [[-IncludeDomains] ] [[-ExtendedForestInformation] ] [[-GPOPath] ] [-PermissionsOnly] [-OwnerOnly] - [-Limited] [-ReturnObject] [[-ADAdministrativeGroups] ] [] + [-Limited] [[-ADAdministrativeGroups] ] [] ``` ## DESCRIPTION -{{ Fill in the Description }} +Gets information about all Group Policies. +Similar to what Get-GPO provides by default. ## EXAMPLES -### Example 1 -```powershell -PS C:\> {{ Add example code here }} +### EXAMPLE 1 +``` +$GPOs = Get-GPOZaurr ``` -{{ Add example description here }} +$GPOs | Format-Table DisplayName, Owner, OwnerSID, OwnerType + +### EXAMPLE 2 +``` +$GPO = Get-GPOZaurr -GPOName 'ALL | Allow use of biometrics' +``` + +$GPO | Format-List * + +### EXAMPLE 3 +``` +$GPOS = Get-GPOZaurr -ExcludeGroupPolicies { +``` + +Skip-GroupPolicy -Name 'de14_usr_std' + Skip-GroupPolicy -Name 'de14_usr_std' -DomaiName 'ad.evotec.xyz' + Skip-GroupPolicy -Name 'All | Trusted Websites' #-DomaiName 'ad.evotec.xyz' + '{D39BF08A-87BF-4662-BFA0-E56240EBD5A2}' + 'COMPUTERS | Enable Sets' +} +$GPOS | Format-Table -AutoSize * ## PARAMETERS -### -ADAdministrativeGroups -{{ Fill ADAdministrativeGroups Description }} - -```yaml -Type: IDictionary -Parameter Sets: (All) -Aliases: - -Required: False -Position: 9 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ExcludeDomains -{{ Fill ExcludeDomains Description }} - -```yaml -Type: String[] -Parameter Sets: (All) -Aliases: - -Required: False -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ExcludeGroupPolicies -{{ Fill ExcludeGroupPolicies Description }} +Marks the GPO as excluded from the list. ```yaml Type: ScriptBlock Parameter Sets: (All) Aliases: -Required: False -Position: 0 -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: 7 -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: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOGuid -{{ Fill GPOGuid Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: GUID, GPOID - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GPOName -{{ Fill GPOName Description }} - -```yaml -Type: String -Parameter Sets: (All) -Aliases: - Required: False Position: 1 Default value: None @@ -138,14 +70,106 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GPOPath -{{ Fill GPOPath Description }} +### -GPOName +Provide a GPOName to get information about a specific GPO. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -GPOGuid +Provide a GPOGuid to get information about a specific GPO. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: GUID, GPOID + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Choose a specific type of GPO. +Options are: 'Empty', 'Unlinked', 'Disabled', 'NoApplyPermission', 'All'. +Default is All. ```yaml Type: String[] Parameter Sets: (All) Aliases: +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Forest +Target different Forest, by default current forest is used + +```yaml +Type: String +Parameter Sets: (All) +Aliases: ForestName + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExcludeDomains +Exclude domain from search, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: 6 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeDomains +Include only specific domains, by default whole forest is scanned + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: Domain, Domains + +Required: False +Position: 7 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ExtendedForestInformation +Ability to provide Forest Information from another command to speed up processing + +```yaml +Type: IDictionary +Parameter Sets: (All) +Aliases: + Required: False Position: 8 Default value: None @@ -153,53 +177,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeDomains -{{ Fill IncludeDomains Description }} +### -GPOPath +Define GPOPath where the XML files are located to be analyzed instead of asking Active Directory ```yaml Type: String[] Parameter Sets: (All) -Aliases: Domain, Domains - -Required: False -Position: 6 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Limited -{{ Fill Limited Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) Aliases: Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OwnerOnly -{{ Fill OwnerOnly Description }} - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named +Position: 9 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -PermissionsOnly -{{ Fill PermissionsOnly Description }} +Only show permissions, by default all information is shown ```yaml Type: SwitchParameter @@ -208,13 +202,13 @@ Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ReturnObject -{{ Fill ReturnObject Description }} +### -OwnerOnly +only show owner information, by default all information is shown ```yaml Type: SwitchParameter @@ -223,22 +217,36 @@ Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -{{ Fill Type Description }} +### -Limited +Provide limited output without analyzing XML data ```yaml -Type: String[] +Type: SwitchParameter Parameter Sets: (All) Aliases: -Accepted values: Empty, Unlinked, Disabled, NoApplyPermission, All Required: False -Position: 3 +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ADAdministrativeGroups +Ability to provide ADAdministrativeGroups from different function to speed up processing + +```yaml +Type: IDictionary +Parameter Sets: (All) +Aliases: + +Required: False +Position: 10 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -249,11 +257,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### None - ## OUTPUTS -### System.Object ## NOTES +General notes ## RELATED LINKS