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.
181 lines
4.0 KiB
Markdown
181 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
|
|
---
|
|
# Backup-GPOZaurr
|
|
## SYNOPSIS
|
|
Provides Backup functionality to Group Policies
|
|
|
|
## SYNTAX
|
|
### __AllParameterSets
|
|
```powershell
|
|
Backup-GPOZaurr [[-LimitProcessing] <int>] [[-Type] <string[]>] [[-Forest] <string>] [[-ExcludeDomains] <string[]>] [[-IncludeDomains] <string[]>] [[-ExtendedForestInformation] <IDictionary>] [[-BackupPath] <string>] [-BackupDated] [-WhatIf] [-Confirm] [<CommonParameters>]
|
|
```
|
|
|
|
## DESCRIPTION
|
|
Provides Backup functionality to Group Policies
|
|
|
|
## EXAMPLES
|
|
|
|
### EXAMPLE 1
|
|
```powershell
|
|
PS > $GPOSummary = Backup-GPOZaurr -BackupPath "$Env:UserProfile\Desktop\GPO" -Verbose -Type All
|
|
$GPOSummary | Format-Table # only if you want to display output of backup
|
|
```
|
|
|
|
|
|
### EXAMPLE 2
|
|
```powershell
|
|
PS > $GPOSummary = Backup-GPOZaurr -BackupPath "$Env:UserProfile\Desktop\GPO" -Verbose -Type All -BackupDated
|
|
$GPOSummary | Format-Table # only if you want to display output of backup
|
|
```
|
|
|
|
|
|
## PARAMETERS
|
|
|
|
### -BackupDated
|
|
Whether cmdlet should created Dated folders for executed backup or not. Keep in mind it's not nessecary and two backups made to same folder have their dates properly tagged
|
|
|
|
```yaml
|
|
Type: SwitchParameter
|
|
Parameter Sets: __AllParameterSets
|
|
Aliases:
|
|
Possible values:
|
|
|
|
Required: False
|
|
Position: named
|
|
Default value: False
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: True
|
|
```
|
|
|
|
### -BackupPath
|
|
Path where to keep the backup
|
|
|
|
```yaml
|
|
Type: String
|
|
Parameter Sets: __AllParameterSets
|
|
Aliases:
|
|
Possible values:
|
|
|
|
Required: False
|
|
Position: 6
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: True
|
|
```
|
|
|
|
### -ExcludeDomains
|
|
Exclude domain from search, by default whole forest is scanned
|
|
|
|
```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
|
|
Ability to provide Forest Information from another command to speed up processing
|
|
|
|
```yaml
|
|
Type: IDictionary
|
|
Parameter Sets: __AllParameterSets
|
|
Aliases:
|
|
Possible values:
|
|
|
|
Required: False
|
|
Position: 5
|
|
Default value: None
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: True
|
|
```
|
|
|
|
### -Forest
|
|
Target different Forest, by default current forest is used
|
|
|
|
```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
|
|
Include only specific domains, by default whole forest is scanned
|
|
|
|
```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
|
|
```
|
|
|
|
### -LimitProcessing
|
|
Limits amount of GPOs that are backed up
|
|
|
|
```yaml
|
|
Type: Int32
|
|
Parameter Sets: __AllParameterSets
|
|
Aliases:
|
|
Possible values:
|
|
|
|
Required: False
|
|
Position: 0
|
|
Default value: 0
|
|
Accept pipeline input: False
|
|
Accept wildcard characters: True
|
|
```
|
|
|
|
### -Type
|
|
Provides a way to backup only Empty or Unlinked GPOs. The default is All.
|
|
|
|
```yaml
|
|
Type: String[]
|
|
Parameter Sets: __AllParameterSets
|
|
Aliases:
|
|
Possible values: Empty, Unlinked, Disabled, All
|
|
|
|
Required: False
|
|
Position: 1
|
|
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
|
|
|