Remove-GPOZaurrFolders

Namespace GPOZaurr

Removes specified GPOZaurr folders and backs them up to a specified path.

Remarks

This function removes specified GPOZaurr folders based on the provided criteria and backs them up to a specified path. It allows for filtering by folder type, domain, and other parameters.

Examples

Authored help example

EXAMPLE 1

PS >


Remove-GPOZaurrFolders -BackupPath "C:\Backups" -BackupDated -Type 'All' -FolderType 'NTFRS' -FolderName "Folder1" -LimitProcessing 10 -Forest "ExampleForest" -ExcludeDomains "Domain1" -IncludeDomains "Domain2" -ExtendedForestInformation $info
Removes GPOZaurr folders of type 'NTFRS' named "Folder1" from all domains in the forest "ExampleForest", backs them up to "C:\Backups" with a timestamp, and limits processing to 10 folders.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Remove-GPOZaurrFolders [-BackupDated] [-BackupPath <String>] [-ExcludeDomains <String[]>] [-ExtendedForestInformation <IDictionary>] [-FolderName <String[]>] -FolderType <NTFRS|Empty> [-Forest <String>] [-IncludeDomains <String[]>] [-LimitProcessing <Int32>] [-Type <All|Netlogon|Sysvol>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

BackupDated SwitchParameter optionalposition: namedpipeline: False: Indicates whether the backup path should include a timestamp.
BackupPath String optionalposition: 0pipeline: False: The path where the GPOZaurr folders will be backed up.
ExcludeDomains String[] optionalposition: 6pipeline: False: Specifies domains to exclude from processing.
ExtendedForestInformation IDictionary optionalposition: 8pipeline: False: Specifies additional forest information.
FolderName String[] optionalposition: 3pipeline: False: Specifies the name of the folder to remove.
FolderType String requiredposition: 2pipeline: Falsevalues: 2: Specifies the type of folders to remove. Options are 'NTFRS' or 'Empty'.; Possible values: NTFRS, Empty
Forest String optionalposition: 5pipeline: Falsealiases: ForestName: Specifies the forest to target.
IncludeDomains String[] optionalposition: 7pipeline: Falsealiases: Domain, Domains: Specifies domains to include in processing.
LimitProcessing Int32 optionalposition: 4pipeline: False: Limits the number of folders to process.
Type String[] optionalposition: 1pipeline: Falsevalues: 3: Specifies the type of folders to remove. Options are 'All', 'Netlogon', or 'Sysvol'.; Possible values: All, Netlogon, Sysvol