From 384cda8c44679176c95c1e25dadeda4ea7d8ab59 Mon Sep 17 00:00:00 2001 From: Przemyslaw Klys Date: Sun, 6 Dec 2020 10:38:27 +0100 Subject: [PATCH] Update MD --- Docs/Backup-GPOZaurr.md | 2 +- Docs/Get-GPOZaurrBackupInformation.md | 2 +- Docs/Get-GPOZaurrPassword.md | 29 +++---- Docs/Get-GPOZaurrWMI.md | 31 ++++---- Docs/Optimize-GPOZaurr.md | 2 +- Docs/Readme.md | 104 +++++++++++++------------- Docs/Remove-GPOZaurrWMI.md | 2 +- Docs/Restore-GPOZaurr.md | 2 +- Docs/Save-GPOZaurrFiles.md | 2 +- Docs/Set-GPOZaurrOwner.md | 48 ++++++------ 10 files changed, 115 insertions(+), 109 deletions(-) diff --git a/Docs/Backup-GPOZaurr.md b/Docs/Backup-GPOZaurr.md index 441830d..cb1d4b2 100644 --- a/Docs/Backup-GPOZaurr.md +++ b/Docs/Backup-GPOZaurr.md @@ -1,6 +1,6 @@ --- external help file: GPOZaurr-help.xml -Module Name: GPoZaurr +Module Name: GPOZaurr online version: schema: 2.0.0 --- diff --git a/Docs/Get-GPOZaurrBackupInformation.md b/Docs/Get-GPOZaurrBackupInformation.md index 109f8a1..3f2a0b4 100644 --- a/Docs/Get-GPOZaurrBackupInformation.md +++ b/Docs/Get-GPOZaurrBackupInformation.md @@ -1,6 +1,6 @@ --- external help file: GPOZaurr-help.xml -Module Name: GPoZaurr +Module Name: GPOZaurr online version: schema: 2.0.0 --- diff --git a/Docs/Get-GPOZaurrPassword.md b/Docs/Get-GPOZaurrPassword.md index 816c045..886afd6 100644 --- a/Docs/Get-GPOZaurrPassword.md +++ b/Docs/Get-GPOZaurrPassword.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-GPOZaurrPassword ## SYNOPSIS -{{ Fill in the Synopsis }} +Tries to find CPassword in Group Policies or given path and translate it to readable value ## SYNTAX @@ -18,21 +18,24 @@ Get-GPOZaurrPassword [[-Forest] ] [[-ExcludeDomains] ] [[-Incl ``` ## DESCRIPTION -{{ Fill in the Description }} +Tries to find CPassword in Group Policies or given path and translate it to readable value ## EXAMPLES -### Example 1 -```powershell -PS C:\> {{ Add example code here }} +### EXAMPLE 1 +``` +Get-GPOZaurrPassword -GPOPath 'C:\Users\przemyslaw.klys\Desktop\GPOExport_2020.10.12' ``` -{{ Add example description here }} +### EXAMPLE 2 +``` +Get-GPOZaurrPassword +``` ## PARAMETERS ### -Forest -{{ Fill Forest Description }} +Target different Forest, by default current forest is used ```yaml Type: String @@ -47,7 +50,7 @@ Accept wildcard characters: False ``` ### -ExcludeDomains -{{ Fill ExcludeDomains Description }} +Exclude domain from search, by default whole forest is scanned ```yaml Type: String[] @@ -62,7 +65,7 @@ Accept wildcard characters: False ``` ### -IncludeDomains -{{ Fill IncludeDomains Description }} +Include only specific domains, by default whole forest is scanned ```yaml Type: String[] @@ -77,7 +80,7 @@ Accept wildcard characters: False ``` ### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} +Ability to provide Forest Information from another command to speed up processing ```yaml Type: IDictionary @@ -92,7 +95,7 @@ Accept wildcard characters: False ``` ### -GPOPath -{{ Fill GPOPath Description }} +Path where Group Policy content is located or where backup is located ```yaml Type: String[] @@ -111,11 +114,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### None - ## OUTPUTS -### System.Object ## NOTES +General notes ## RELATED LINKS diff --git a/Docs/Get-GPOZaurrWMI.md b/Docs/Get-GPOZaurrWMI.md index 3173f79..e483b4c 100644 --- a/Docs/Get-GPOZaurrWMI.md +++ b/Docs/Get-GPOZaurrWMI.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Get-GPOZaurrWMI ## SYNOPSIS -{{ Fill in the Synopsis }} +Get Group Policy WMI filter ## SYNTAX @@ -19,21 +19,24 @@ Get-GPOZaurrWMI [[-Guid] ] [[-Name] ] [[-Forest] ] [[- ``` ## DESCRIPTION -{{ Fill in the Description }} +Get Group Policy WMI filter ## EXAMPLES -### Example 1 -```powershell -PS C:\> {{ Add example code here }} +### EXAMPLE 1 +``` +Get-GPOZaurrWMI -AsHashtable ``` -{{ Add example description here }} +### EXAMPLE 2 +``` +Get-GPOZaurrWMI | Format-Table +``` ## PARAMETERS ### -Guid -{{ Fill Guid Description }} +Search for specific filter using GUID ```yaml Type: Guid[] @@ -48,7 +51,7 @@ Accept wildcard characters: False ``` ### -Name -{{ Fill Name Description }} +Search for specific filter using Name ```yaml Type: String[] @@ -63,7 +66,7 @@ Accept wildcard characters: False ``` ### -Forest -{{ Fill Forest Description }} +Target different Forest, by default current forest is used ```yaml Type: String @@ -78,7 +81,7 @@ Accept wildcard characters: False ``` ### -ExcludeDomains -{{ Fill ExcludeDomains Description }} +Exclude domain from search, by default whole forest is scanned ```yaml Type: String[] @@ -93,7 +96,7 @@ Accept wildcard characters: False ``` ### -IncludeDomains -{{ Fill IncludeDomains Description }} +Include only specific domains, by default whole forest is scanned ```yaml Type: String[] @@ -108,7 +111,7 @@ Accept wildcard characters: False ``` ### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} +Ability to provide Forest Information from another command to speed up processing ```yaml Type: IDictionary @@ -142,11 +145,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### None - ## OUTPUTS -### System.Object ## NOTES +General notes ## RELATED LINKS diff --git a/Docs/Optimize-GPOZaurr.md b/Docs/Optimize-GPOZaurr.md index d055653..369a929 100644 --- a/Docs/Optimize-GPOZaurr.md +++ b/Docs/Optimize-GPOZaurr.md @@ -34,7 +34,7 @@ Optimize-GPOZaurr [[-ExcludeGroupPolicies] ] [-All] [-LimitProcessi ``` ## DESCRIPTION -Long description +Enables or disables user/computer section of group policy based on it's content. ## EXAMPLES diff --git a/Docs/Readme.md b/Docs/Readme.md index 3caee63..ca1444c 100644 --- a/Docs/Readme.md +++ b/Docs/Readme.md @@ -12,157 +12,155 @@ Locale: en-US ## GPOZaurr Cmdlets ### [Add-GPOPermission](Add-GPOPermission.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Add-GPOZaurrPermission](Add-GPOZaurrPermission.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Backup-GPOZaurr](Backup-GPOZaurr.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Clear-GPOZaurrSysvolDFSR](Clear-GPOZaurrSysvolDFSR.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [ConvertFrom-CSExtension](ConvertFrom-CSExtension.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Find-CSExtension](Find-CSExtension.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Get-GPOZaurr](Get-GPOZaurr.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Get-GPOZaurrAD](Get-GPOZaurrAD.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Get-GPOZaurrBackupInformation](Get-GPOZaurrBackupInformation.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Get-GPOZaurrBroken](Get-GPOZaurrBroken.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Get-GPOZaurrDictionary](Get-GPOZaurrDictionary.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Get-GPOZaurrDuplicateObject](Get-GPOZaurrDuplicateObject.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Get-GPOZaurrFiles](Get-GPOZaurrFiles.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Get-GPOZaurrFilesPolicyDefinition](Get-GPOZaurrFilesPolicyDefinition.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Get-GPOZaurrFolders](Get-GPOZaurrFolders.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Get-GPOZaurrInheritance](Get-GPOZaurrInheritance.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Get-GPOZaurrLegacyFiles](Get-GPOZaurrLegacyFiles.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Get-GPOZaurrLink](Get-GPOZaurrLink.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Get-GPOZaurrLinkSummary](Get-GPOZaurrLinkSummary.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Get-GPOZaurrNetLogon](Get-GPOZaurrNetLogon.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Get-GPOZaurrOwner](Get-GPOZaurrOwner.md) -Gets owners of GPOs from Active Directory and SYSVOL +{{ Fill in the Description }} ### [Get-GPOZaurrPassword](Get-GPOZaurrPassword.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Get-GPOZaurrPermission](Get-GPOZaurrPermission.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Get-GPOZaurrPermissionConsistency](Get-GPOZaurrPermissionConsistency.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Get-GPOZaurrPermissionIssue](Get-GPOZaurrPermissionIssue.md) -Detects Group Policy missing Authenticated Users permission while not having higher permissions. +{{ Fill in the Description }} ### [Get-GPOZaurrPermissionRoot](Get-GPOZaurrPermissionRoot.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Get-GPOZaurrPermissionSummary](Get-GPOZaurrPermissionSummary.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Get-GPOZaurrSysvolDFSR](Get-GPOZaurrSysvolDFSR.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Get-GPOZaurrWMI](Get-GPOZaurrWMI.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Invoke-GPOZaurr](Invoke-GPOZaurr.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Invoke-GPOZaurrContent](Invoke-GPOZaurrContent.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Invoke-GPOZaurrPermission](Invoke-GPOZaurrPermission.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Invoke-GPOZaurrSupport](Invoke-GPOZaurrSupport.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [New-GPOZaurrWMI](New-GPOZaurrWMI.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Optimize-GPOZaurr](Optimize-GPOZaurr.md) -Enables or disables user/computer section of group policy based on it's content. +{{ Fill in the Description }} ### [Remove-GPOPermission](Remove-GPOPermission.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Remove-GPOZaurr](Remove-GPOZaurr.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Remove-GPOZaurrBroken](Remove-GPOZaurrBroken.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Remove-GPOZaurrDuplicateObject](Remove-GPOZaurrDuplicateObject.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Remove-GPOZaurrFolders](Remove-GPOZaurrFolders.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Remove-GPOZaurrLegacyFiles](Remove-GPOZaurrLegacyFiles.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Remove-GPOZaurrPermission](Remove-GPOZaurrPermission.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Remove-GPOZaurrWMI](Remove-GPOZaurrWMI.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Repair-GPOZaurrNetLogonOwner](Repair-GPOZaurrNetLogonOwner.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Repair-GPOZaurrPermissionConsistency](Repair-GPOZaurrPermissionConsistency.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Restore-GPOZaurr](Restore-GPOZaurr.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Save-GPOZaurrFiles](Save-GPOZaurrFiles.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Set-GPOOwner](Set-GPOOwner.md) -Used within Invoke-GPOZaurrPermission only. -Set new group policy owner. +{{ Fill in the Description }} ### [Set-GPOZaurrOwner](Set-GPOZaurrOwner.md) -{{ Fill in the Synopsis }} +{{ Fill in the Description }} ### [Set-GPOZaurrStatus](Set-GPOZaurrStatus.md) -Enables or disables user/computer section of Group Policy. +{{ Fill in the Description }} ### [Skip-GroupPolicy](Skip-GroupPolicy.md) -Used within ScriptBlocks only. -Allows to exclude Group Policy from being affected by fixes +{{ Fill in the Description }} diff --git a/Docs/Remove-GPOZaurrWMI.md b/Docs/Remove-GPOZaurrWMI.md index 051692d..6622caf 100644 --- a/Docs/Remove-GPOZaurrWMI.md +++ b/Docs/Remove-GPOZaurrWMI.md @@ -1,6 +1,6 @@ --- external help file: GPOZaurr-help.xml -Module Name: GPoZaurr +Module Name: GPOZaurr online version: schema: 2.0.0 --- diff --git a/Docs/Restore-GPOZaurr.md b/Docs/Restore-GPOZaurr.md index 80080ed..c75e704 100644 --- a/Docs/Restore-GPOZaurr.md +++ b/Docs/Restore-GPOZaurr.md @@ -1,6 +1,6 @@ --- external help file: GPOZaurr-help.xml -Module Name: GPoZaurr +Module Name: GPOZaurr online version: schema: 2.0.0 --- diff --git a/Docs/Save-GPOZaurrFiles.md b/Docs/Save-GPOZaurrFiles.md index 786846a..822c763 100644 --- a/Docs/Save-GPOZaurrFiles.md +++ b/Docs/Save-GPOZaurrFiles.md @@ -1,6 +1,6 @@ --- external help file: GPOZaurr-help.xml -Module Name: GPoZaurr +Module Name: GPOZaurr online version: schema: 2.0.0 --- diff --git a/Docs/Set-GPOZaurrOwner.md b/Docs/Set-GPOZaurrOwner.md index 5afbc5d..9f5cf01 100644 --- a/Docs/Set-GPOZaurrOwner.md +++ b/Docs/Set-GPOZaurrOwner.md @@ -8,7 +8,7 @@ schema: 2.0.0 # Set-GPOZaurrOwner ## SYNOPSIS -{{ Fill in the Synopsis }} +Sets GPO Owner to Domain Admins or other choosen account ## SYNTAX @@ -27,21 +27,25 @@ Set-GPOZaurrOwner [-GPOName ] [-GPOGuid ] [-Forest ] [-E ``` ## DESCRIPTION -{{ Fill in the Description }} +Sets GPO Owner to Domain Admins or other choosen account. +GPO Owner is set in AD and SYSVOL unless specified otherwise. +If account doesn't require change, no change is done. ## EXAMPLES -### Example 1 -```powershell -PS C:\> {{ Add example code here }} +### EXAMPLE 1 +``` +Set-GPOZaurrOwner -Type All -Verbose -WhatIf -LimitProcessing 2 ``` - -{{ Add example description here }} ## PARAMETERS ### -Type -{{ Fill Type Description }} +Unknown - finds unknown Owners and sets them to Administrative (Domain Admins) or chosen principal +NotMatching - find administrative groups only and if sysvol and gpo doesn't match - replace with chosen principal or Domain Admins if not specified +NotAdministrative - combination of Unknown/NotMatching and NotAdministrative - replace with chosen principal or Domain Admins if not specified +All - if Owner is known it checks if it's Administrative, if it sn't it fixes that. +If owner is unknown it fixes it ```yaml Type: String @@ -56,7 +60,8 @@ Accept wildcard characters: False ``` ### -GPOName -{{ Fill GPOName Description }} +Name of GPO. +By default all GPOs are targetted ```yaml Type: String @@ -71,7 +76,8 @@ Accept wildcard characters: False ``` ### -GPOGuid -{{ Fill GPOGuid Description }} +GUID of GPO. +By default all GPOs are targetted ```yaml Type: String @@ -86,7 +92,7 @@ Accept wildcard characters: False ``` ### -Forest -{{ Fill Forest Description }} +Target different Forest, by default current forest is used ```yaml Type: String @@ -101,7 +107,7 @@ Accept wildcard characters: False ``` ### -ExcludeDomains -{{ Fill ExcludeDomains Description }} +Exclude domain from search, by default whole forest is scanned ```yaml Type: String[] @@ -116,7 +122,7 @@ Accept wildcard characters: False ``` ### -IncludeDomains -{{ Fill IncludeDomains Description }} +Include only specific domains, by default whole forest is scanned ```yaml Type: String[] @@ -131,7 +137,7 @@ Accept wildcard characters: False ``` ### -ExtendedForestInformation -{{ Fill ExtendedForestInformation Description }} +Ability to provide Forest Information from another command to speed up processing ```yaml Type: IDictionary @@ -146,7 +152,7 @@ Accept wildcard characters: False ``` ### -Principal -{{ Fill Principal Description }} +Parameter description ```yaml Type: String @@ -161,7 +167,8 @@ Accept wildcard characters: False ``` ### -SkipSysvol -Set GPO Owner only in Active Directory. By default GPO Owner is being set in both places +Set GPO Owner only in Active Directory. +By default GPO Owner is being set in both places ```yaml Type: SwitchParameter @@ -176,7 +183,8 @@ Accept wildcard characters: False ``` ### -LimitProcessing -{{ Fill LimitProcessing Description }} +Allows to specify maximum number of items that will be fixed in a single run. +It doesn't affect amount of GPOs processed ```yaml Type: Int32 @@ -185,7 +193,7 @@ Aliases: Required: False Position: Named -Default value: None +Default value: 2147483647 Accept pipeline input: False Accept wildcard characters: False ``` @@ -241,11 +249,9 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### None - ## OUTPUTS -### System.Object ## NOTES +General notes ## RELATED LINKS