Skip to content

Commit ca6afa4

Browse files
authored
Merge pull request MicrosoftDocs#2758 from MicrosoftDocs/master
Publish 11/05/2021, 10:30 AM
2 parents 439b556 + f87333c commit ca6afa4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+440
-167
lines changed

docset/winserver2022-ps/windowsserverbackup/Add-WBBackupTarget.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,15 +104,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
104104
105105
## INPUTS
106106
107-
### WBBackupTarget, WBPolicy
107+
### Microsoft.Windows.ServerBackup.Commands.WBPolicy
108+
109+
### Microsoft.Windows.ServerBackup.Commands.WBBackupTarget
110+
108111
This cmdlet adds a **WBBackupTarget** object, which contains new backup storage locations, to a **WBPolicy** object that contains a backup policy.
109112
To add more than one storage location, you must call the **Add-WBBackupTarget** cmdlet separately for each location.
110113
111114
## OUTPUTS
112115
113-
### WBBackupTarget[]
114-
This cmdlet returns a list of storage locations from the **WBPolicy** objects that contain the backup policies.
115-
116+
### System.Object
116117
## NOTES
117118
118119
## RELATED LINKS

docset/winserver2022-ps/windowsserverbackup/Add-WBBareMetalRecovery.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,13 +67,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
6767
6868
## INPUTS
6969
70-
### WBPolicy
71-
This cmdlet accepts a **WBPolicy** object as input.
70+
### Microsoft.Windows.ServerBackup.Commands.WBPolicy
7271
7372
## OUTPUTS
7473
75-
### None
76-
None
74+
### System.Object
7775
7876
## NOTES
7977

docset/winserver2022-ps/windowsserverbackup/Add-WBFileSpec.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,14 +101,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
101101
102102
## INPUTS
103103
104-
### WBFileSpec [], WBPolicy
104+
### Microsoft.Windows.ServerBackup.Commands.WBPolicy
105+
106+
### Microsoft.Windows.ServerBackup.Commands.WBFileSpec[]
107+
105108
This cmdlet adds a list of items from a **WBFileSpec** object that contains a backup file specification to a **WBPolicy** object that contains a backup policy.
106109
107110
## OUTPUTS
108111
109-
### None
110-
None
111-
112+
### System.Object
112113
## NOTES
113114
114115
## RELATED LINKS

docset/winserver2022-ps/windowsserverbackup/Add-WBSystemState.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
6565
6666
## INPUTS
6767
68-
### WBPolicy
69-
This cmdlet accepts a **WBPolicy** object as input.
68+
### Microsoft.Windows.ServerBackup.Commands.WBPolicy
7069
7170
## OUTPUTS
7271
73-
### None
72+
### System.Object
7473
7574
## NOTES
7675

docset/winserver2022-ps/windowsserverbackup/Add-WBVirtualMachine.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
129129
130130
## INPUTS
131131
132+
### Microsoft.Windows.ServerBackup.Commands.WBVirtualMachine[]
133+
132134
## OUTPUTS
133135
136+
### System.Object
137+
134138
## NOTES
135139
136140
## RELATED LINKS

docset/winserver2022-ps/windowsserverbackup/Add-WBVolume.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,13 +78,15 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
7878
7979
## INPUTS
8080
81-
### WBVolume [], WBPolicy
81+
### Microsoft.Windows.ServerBackup.Commands.WBPolicy
82+
83+
### Microsoft.Windows.ServerBackup.Commands.WBVolume[]
84+
8285
Ths cmdlet accepts **WBVolume** objects, which contain a new list of source volumes for the backup, and **WBPolicy** objects as input.
8386
8487
## OUTPUTS
8588
86-
### WBVolume[]
87-
This cmdlet returns a list of **WBVolume** objects in the **WBPolicy** object, including the **WBVolume** objects that the cmdlet just added.
89+
### System.Object
8890
8991
## NOTES
9092
* The **WBPolicy** object must be in edit mode. To put the **WBPolicy** object in edit mode for a policy that you set as the scheduled backup policy, use the Get-WBPolicy cmdlet with the *Editable* parameter. The New-WBPolicy cmdlet creates a new **WBPolicy** object that is already in edit mode.
Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
---
2+
description: The Backup-Acl cmdlet backs up the security descriptor of a specified item, such as a file or a registry key.
3+
external help file: wsbcmdlet.dll-help.xml
4+
Module Name: WindowsServerBackup
5+
ms.date: 09/10/2021
6+
online version: https://docs.microsoft.com/powershell/module/windowsserverbackup/backup-acl?view=windowsserver2022-ps&wt.mc_id=ps-gethelp
7+
schema: 2.0.0
8+
title: Backup-ACL
9+
---
10+
11+
# Backup-ACL
12+
13+
## SYNOPSIS
14+
Backs up the security descriptor of an item.
15+
16+
## SYNTAX
17+
18+
```
19+
Backup-ACL [-Path] <String> [-DestinationPath] <String> [-LogPath] <String> [[-ScheduleTrigger] <Object>]
20+
[-WhatIf] [-Confirm] [<CommonParameters>]
21+
```
22+
23+
## DESCRIPTION
24+
The **Backup-Acl** cmdlet backs up the security descriptor of a specified item, such as a file or a registry key.
25+
26+
To back up an ACL, specify the **Path** parameter to identify the item. Use the **DestinationPath** parameter to specify the location for the backup.
27+
28+
## EXAMPLES
29+
30+
### Example 1: Back up the ACL for a file
31+
```powershell
32+
Backup-ACL -Path "C:\file01.txt" -DestinationPath "C:\AclBackups\file01.xml" -LogPath "C:\AclBackupLogs\"
33+
```
34+
35+
This command backs up the ACL for the specified file.
36+
The command also specifies the location for the backup and the log.
37+
38+
### Example 2: Back up on a schedule
39+
```powershell
40+
$TaskTrigger = New-ScheduledTaskTrigger -Daily -At 6am
41+
Backup-ACL -Path "C:\file02.txt" -DestinationPath "C:\AclBackups\" -LogPath "C:\AclBackups\" -ScheduleTrigger $TaskTrigger
42+
```
43+
44+
This example backs up the ACL on a regular schedule.
45+
46+
The first command creates a scheduled task trigger by using the **New-ScheduledTaskTrigger** cmdlet and stores it in the `$TaskTrigger` variable.
47+
48+
The second command backs up the ACL according to the schedule object, in this case, daily at 6:00 AM.
49+
50+
## PARAMETERS
51+
52+
### -DestinationPath
53+
Specifies a full path to store the permission backup.
54+
55+
```yaml
56+
Type: String
57+
Parameter Sets: (All)
58+
Aliases:
59+
60+
Required: True
61+
Position: 1
62+
Default value: None
63+
Accept pipeline input: True (ByValue)
64+
Accept wildcard characters: False
65+
```
66+
67+
### -LogPath
68+
Specifies a full path for the log file.
69+
70+
```yaml
71+
Type: String
72+
Parameter Sets: (All)
73+
Aliases:
74+
75+
Required: True
76+
Position: 2
77+
Default value: None
78+
Accept pipeline input: True (ByValue)
79+
Accept wildcard characters: False
80+
```
81+
82+
### -Path
83+
Specifies the full path of the object for which the cmdlet backs up permissions.
84+
85+
```yaml
86+
Type: String
87+
Parameter Sets: (All)
88+
Aliases:
89+
90+
Required: True
91+
Position: 0
92+
Default value: None
93+
Accept pipeline input: True (ByValue)
94+
Accept wildcard characters: False
95+
```
96+
97+
### -ScheduleTrigger
98+
Specifies a **ScheduleTrigger** object.
99+
A trigger creates pipeline runs periodically, on schedule.
100+
101+
```yaml
102+
Type: Object
103+
Parameter Sets: (All)
104+
Aliases:
105+
106+
Required: False
107+
Position: 3
108+
Default value: None
109+
Accept pipeline input: True (ByValue)
110+
Accept wildcard characters: False
111+
```
112+
113+
### -Confirm
114+
Prompts you for confirmation before running the cmdlet.
115+
116+
```yaml
117+
Type: SwitchParameter
118+
Parameter Sets: (All)
119+
Aliases: cf
120+
121+
Required: False
122+
Position: Named
123+
Default value: None
124+
Accept pipeline input: False
125+
Accept wildcard characters: False
126+
```
127+
128+
### -WhatIf
129+
Shows what would happen if the cmdlet runs.
130+
The cmdlet is not run.
131+
132+
```yaml
133+
Type: SwitchParameter
134+
Parameter Sets: (All)
135+
Aliases: wi
136+
137+
Required: False
138+
Position: Named
139+
Default value: None
140+
Accept pipeline input: False
141+
Accept wildcard characters: False
142+
```
143+
144+
### CommonParameters
145+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
146+
147+
## INPUTS
148+
149+
### System.String
150+
151+
### System.Object
152+
153+
## OUTPUTS
154+
155+
### System.Object
156+
## NOTES
157+
158+
## RELATED LINKS
159+
160+
[Get-ACL](/powershell/module/microsoft.powershell.security/get-acl)
161+
162+
[New-ScheduledTaskTrigger](../scheduledtasks/New-ScheduledTaskTrigger.md)
163+
164+
[Restore-ACL](Restore-ACL.md)

docset/winserver2022-ps/windowsserverbackup/Get-WBBackupSet.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,14 +96,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
9696
9797
## INPUTS
9898
99-
### WBBackupTarget
100-
This cmdlet uses a **WBBackupTarget** object to determine the computer from which to load the catalog and get backup information.
99+
### None
101100
102101
## OUTPUTS
103102
104-
### WBBackupSet[]
105-
This cmdlet returns alist of **WBBackupSet** objects from the local system catalog or from the catalog on the computer that stores the backup sets.
106-
The *WBBackupTarget* parameter specifies the location of this computer.
103+
### System.Object
107104
108105
## NOTES
109106

docset/winserver2022-ps/windowsserverbackup/Get-WBBackupTarget.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
6464
6565
## INPUTS
6666
67-
### WBPolicy
68-
This cmdlet queries the backup policy contained in the specified **WBPolicy** object.
67+
### Microsoft.Windows.ServerBackup.Commands.WBPolicy
6968
7069
## OUTPUTS
7170
72-
### WBBackupTarget []
73-
This cmdlet returns a list of the storage locations that the backup policy object contains.
71+
### System.Object
7472
7573
## NOTES
7674

docset/winserver2022-ps/windowsserverbackup/Get-WBBackupVolumeBrowsePath.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,12 +77,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
7777
7878
## INPUTS
7979
80-
### WBBackup, WBVolume
80+
### Microsoft.Windows.ServerBackup.Commands.WBBackupSet
81+
82+
### Microsoft.Windows.ServerBackup.Commands.WBVolume
83+
8184
You must specify the **WBBackupSet** object that contains the backup set along with the **WBVolume** object that contains the volume inside the backup set.
8285
8386
## OUTPUTS
8487
85-
### System.String
88+
### System.Object
89+
8690
This cmdlet returns the mount path for the volume that you back up if the mount is successful.
8791
You can use the mount path with a dir command to browse the volume or specify the file recovery path as a parameter to the **Start-WBFileRecovery** cmdlet.
8892
This path is valid for only 10 minutes, and Windows Server® 2012 Backup deletes the mount path after that.

0 commit comments

Comments
 (0)