Skip to content

Commit 6672991

Browse files
author
David Curwin
committed
replace PS links
1 parent 4a385a8 commit 6672991

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

articles/backup/backup-client-automation.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ When the connectivity of the Windows machine to the internet is through a proxy
181181

182182
Bandwidth usage can also be controlled with the options of `work hour bandwidth` and `non-work hour bandwidth` for a given set of days of the week.
183183

184-
Setting the proxy and bandwidth details is done using the [Set-OBMachineSetting](https://docs.microsoft.com/powershell/module/msonlinebackup/set-obmachinesetting?view=winserver2012-ps) cmdlet:
184+
Setting the proxy and bandwidth details is done using the [Set-OBMachineSetting](https://docs.microsoft.com/powershell/module/msonlinebackup/set-obmachinesetting) cmdlet:
185185

186186
```powershell
187187
Set-OBMachineSetting -NoProxy
@@ -232,7 +232,7 @@ All backups from Windows Servers and clients to Azure Backup are governed by a p
232232
2. A **retention schedule** that specifies how long to retain the recovery points in Azure.
233233
3. A **file inclusion/exclusion specification** that dictates what should be backed up.
234234

235-
In this document, since we're automating backup, we'll assume nothing has been configured. We begin by creating a new backup policy using the [New-OBPolicy](https://docs.microsoft.com/powershell/module/msonlinebackup/new-obpolicy?view=winserver2012-ps) cmdlet.
235+
In this document, since we're automating backup, we'll assume nothing has been configured. We begin by creating a new backup policy using the [New-OBPolicy](https://docs.microsoft.com/powershell/module/msonlinebackup/new-obpolicy) cmdlet.
236236

237237
```powershell
238238
$NewPolicy = New-OBPolicy
@@ -242,7 +242,7 @@ At this time the policy is empty and other cmdlets are needed to define what ite
242242

243243
### Configuring the backup schedule
244244

245-
The first of the three parts of a policy is the backup schedule, which is created using the [New-OBSchedule](https://docs.microsoft.com/powershell/module/msonlinebackup/new-obschedule?view=winserver2012-ps) cmdlet. The backup schedule defines when backups need to be taken. When creating a schedule, you need to specify two input parameters:
245+
The first of the three parts of a policy is the backup schedule, which is created using the [New-OBSchedule](https://docs.microsoft.com/powershell/module/msonlinebackup/new-obschedule) cmdlet. The backup schedule defines when backups need to be taken. When creating a schedule, you need to specify two input parameters:
246246

247247
* **Days of the week** that the backup should run. You can run the backup job on just one day, or every day of the week, or any combination in between.
248248
* **Times of the day** when the backup should run. You can define up to three different times of the day when the backup will be triggered.
@@ -253,7 +253,7 @@ For instance, you could configure a backup policy that runs at 4PM every Saturda
253253
$Schedule = New-OBSchedule -DaysOfWeek Saturday, Sunday -TimesOfDay 16:00
254254
```
255255

256-
The backup schedule needs to be associated with a policy, and this can be achieved by using the [Set-OBSchedule](https://docs.microsoft.com/powershell/module/msonlinebackup/set-obschedule?view=winserver2012-ps) cmdlet.
256+
The backup schedule needs to be associated with a policy, and this can be achieved by using the [Set-OBSchedule](https://docs.microsoft.com/powershell/module/msonlinebackup/set-obschedule) cmdlet.
257257

258258
```powershell
259259
Set-OBSchedule -Policy $NewPolicy -Schedule $Schedule
@@ -265,13 +265,13 @@ BackupSchedule : 4:00 PM Saturday, Sunday, Every 1 week(s) DsList : PolicyName :
265265

266266
### Configuring a retention policy
267267

268-
The retention policy defines how long recovery points created from backup jobs are retained. When creating a new retention policy using the [New-OBRetentionPolicy](https://docs.microsoft.com/powershell/module/msonlinebackup/new-obretentionpolicy?view=winserver2012-ps) cmdlet, you can specify the number of days that the backup recovery points need to be retained with Azure Backup. The example below sets a retention policy of seven days.
268+
The retention policy defines how long recovery points created from backup jobs are retained. When creating a new retention policy using the [New-OBRetentionPolicy](https://docs.microsoft.com/powershell/module/msonlinebackup/new-obretentionpolicy) cmdlet, you can specify the number of days that the backup recovery points need to be retained with Azure Backup. The example below sets a retention policy of seven days.
269269

270270
```powershell
271271
$RetentionPolicy = New-OBRetentionPolicy -RetentionDays 7
272272
```
273273

274-
The retention policy must be associated with the main policy using the cmdlet [Set-OBRetentionPolicy](https://docs.microsoft.com/powershell/module/msonlinebackup/set-obretentionpolicy?view=winserver2012-ps):
274+
The retention policy must be associated with the main policy using the cmdlet [Set-OBRetentionPolicy](https://docs.microsoft.com/powershell/module/msonlinebackup/set-obretentionpolicy):
275275

276276
```powershell
277277
Set-OBRetentionPolicy -Policy $NewPolicy -RetentionPolicy $RetentionPolicy
@@ -308,7 +308,7 @@ An `OBFileSpec` object defines the files to be included and excluded in a backup
308308

309309
The latter is achieved by using the -NonRecursive flag in the New-OBFileSpec command.
310310

311-
In the example below, we'll back up volume C: and D: and exclude the OS binaries in the Windows folder and any temporary folders. To do so, we'll create two file specifications using the [New-OBFileSpec](https://docs.microsoft.com/powershell/module/msonlinebackup/new-obfilespec?view=winserver2012-ps) cmdlet - one for inclusion and one for exclusion. Once the file specifications have been created, they're associated with the policy using the [Add-OBFileSpec](https://docs.microsoft.com/powershell/module/msonlinebackup/add-obfilespec?view=winserver2012-ps) cmdlet.
311+
In the example below, we'll back up volume C: and D: and exclude the OS binaries in the Windows folder and any temporary folders. To do so, we'll create two file specifications using the [New-OBFileSpec](https://docs.microsoft.com/powershell/module/msonlinebackup/new-obfilespec) cmdlet - one for inclusion and one for exclusion. Once the file specifications have been created, they're associated with the policy using the [Add-OBFileSpec](https://docs.microsoft.com/powershell/module/msonlinebackup/add-obfilespec) cmdlet.
312312

313313
```powershell
314314
$Inclusions = New-OBFileSpec -FileSpec @("C:\", "D:\")
@@ -404,7 +404,7 @@ PolicyState : Valid
404404

405405
### Applying the policy
406406

407-
Now the policy object is complete and has an associated backup schedule, retention policy, and an inclusion/exclusion list of files. This policy can now be committed for Azure Backup to use. Before you apply the newly created policy, ensure that there are no existing backup policies associated with the server by using the [Remove-OBPolicy](https://docs.microsoft.com/powershell/module/msonlinebackup/remove-obpolicy?view=winserver2012-ps) cmdlet. Removing the policy will prompt for confirmation. To skip the confirmation, use the `-Confirm:$false` flag with the cmdlet.
407+
Now the policy object is complete and has an associated backup schedule, retention policy, and an inclusion/exclusion list of files. This policy can now be committed for Azure Backup to use. Before you apply the newly created policy, ensure that there are no existing backup policies associated with the server by using the [Remove-OBPolicy](https://docs.microsoft.com/powershell/module/msonlinebackup/remove-obpolicy) cmdlet. Removing the policy will prompt for confirmation. To skip the confirmation, use the `-Confirm:$false` flag with the cmdlet.
408408

409409
```powershell
410410
Get-OBPolicy | Remove-OBPolicy
@@ -414,7 +414,7 @@ Get-OBPolicy | Remove-OBPolicy
414414
Microsoft Azure Backup Are you sure you want to remove this backup policy? This will delete all the backed up data. [Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default is "Y"):
415415
```
416416

417-
Committing the policy object is done using the [Set-OBPolicy](https://docs.microsoft.com/powershell/module/msonlinebackup/set-obpolicy?view=winserver2012-ps) cmdlet. This will also ask for confirmation. To skip the confirmation, use the `-Confirm:$false` flag with the cmdlet.
417+
Committing the policy object is done using the [Set-OBPolicy](https://docs.microsoft.com/powershell/module/msonlinebackup/set-obpolicy) cmdlet. This will also ask for confirmation. To skip the confirmation, use the `-Confirm:$false` flag with the cmdlet.
418418

419419
```powershell
420420
Set-OBPolicy -Policy $NewPolicy
@@ -462,7 +462,7 @@ RetentionPolicy : Retention Days : 7
462462
State : Existing PolicyState : Valid
463463
```
464464

465-
You can view the details of the existing backup policy using the [Get-OBPolicy](https://docs.microsoft.com/powershell/module/msonlinebackup/get-obpolicy?view=winserver2012-ps) cmdlet. You can drill down further using the [Get-OBSchedule](https://docs.microsoft.com/powershell/module/msonlinebackup/get-obschedule?view=winserver2012-ps) cmdlet for the backup schedule and the [Get-OBRetentionPolicy](https://docs.microsoft.com/powershell/module/msonlinebackup/get-obretentionpolicy?view=winserver2012-ps) cmdlet for the retention policies
465+
You can view the details of the existing backup policy using the [Get-OBPolicy](https://docs.microsoft.com/powershell/module/msonlinebackup/get-obpolicy) cmdlet. You can drill down further using the [Get-OBSchedule](https://docs.microsoft.com/powershell/module/msonlinebackup/get-obschedule) cmdlet for the backup schedule and the [Get-OBRetentionPolicy](https://docs.microsoft.com/powershell/module/msonlinebackup/get-obretentionpolicy) cmdlet for the retention policies
466466

467467
```powershell
468468
Get-OBPolicy | Get-OBSchedule
@@ -517,7 +517,7 @@ IsRecursive : True
517517

518518
### Performing an on-demand backup
519519

520-
Once a backup policy has been set, the backups will occur per the schedule. Triggering an on-demand backup is also possible using the [Start-OBBackup](https://docs.microsoft.com/powershell/module/msonlinebackup/start-obbackup?view=winserver2012-ps) cmdlet:
520+
Once a backup policy has been set, the backups will occur per the schedule. Triggering an on-demand backup is also possible using the [Start-OBBackup](https://docs.microsoft.com/powershell/module/msonlinebackup/start-obbackup) cmdlet:
521521

522522
```powershell
523523
Get-OBPolicy | Start-OBBackup
@@ -575,7 +575,7 @@ This section will guide you through the steps for automating recovery of data fr
575575

576576
### Picking the source volume
577577

578-
In order to restore an item from Azure Backup, you first need to identify the source of the item. Since we're executing the commands in the context of a Windows Server or a Windows client, the machine is already identified. The next step in identifying the source is to identify the volume containing it. A list of volumes or sources being backed up from this machine can be retrieved by executing the [Get-OBRecoverableSource](https://docs.microsoft.com/powershell/module/msonlinebackup/get-obrecoverablesource?view=winserver2012-ps) cmdlet. This command returns an array of all the sources backed up from this server/client.
578+
In order to restore an item from Azure Backup, you first need to identify the source of the item. Since we're executing the commands in the context of a Windows Server or a Windows client, the machine is already identified. The next step in identifying the source is to identify the volume containing it. A list of volumes or sources being backed up from this machine can be retrieved by executing the [Get-OBRecoverableSource](https://docs.microsoft.com/powershell/module/msonlinebackup/get-obrecoverablesource) cmdlet. This command returns an array of all the sources backed up from this server/client.
579579

580580
```powershell
581581
$Source = Get-OBRecoverableSource
@@ -594,7 +594,7 @@ ServerName : myserver.microsoft.com
594594

595595
### Choosing a backup point from which to restore
596596

597-
You retrieve a list of backup points by executing the [Get-OBRecoverableItem](https://docs.microsoft.com/powershell/module/msonlinebackup/get-obrecoverableitem?view=winserver2012-ps) cmdlet with appropriate parameters. In our example, we'll choose the latest backup point for the source volume *C:* and use it to recover a specific file.
597+
You retrieve a list of backup points by executing the [Get-OBRecoverableItem](https://docs.microsoft.com/powershell/module/msonlinebackup/get-obrecoverableitem) cmdlet with appropriate parameters. In our example, we'll choose the latest backup point for the source volume *C:* and use it to recover a specific file.
598598

599599
```powershell
600600
$Rps = Get-OBRecoverableItem $Source[0]
@@ -653,13 +653,13 @@ ItemLastModifiedTime : 21-Jun-14 6:43:02 AM
653653

654654
### Triggering the restore process
655655

656-
To trigger the restore process, we first need to specify the recovery options. This can be done by using the [New-OBRecoveryOption](https://docs.microsoft.com/powershell/module/msonlinebackup/new-obrecoveryoption?view=winserver2012-ps) cmdlet. For this example, let's assume that we want to restore the files to *C:\temp*. Let's also assume that we want to skip files that already exist on the destination folder *C:\temp*. To create such a recovery option, use the following command:
656+
To trigger the restore process, we first need to specify the recovery options. This can be done by using the [New-OBRecoveryOption](https://docs.microsoft.com/powershell/module/msonlinebackup/new-obrecoveryoption) cmdlet. For this example, let's assume that we want to restore the files to *C:\temp*. Let's also assume that we want to skip files that already exist on the destination folder *C:\temp*. To create such a recovery option, use the following command:
657657

658658
```powershell
659659
$RecoveryOption = New-OBRecoveryOption -DestinationPath "C:\temp" -OverwriteType Skip
660660
```
661661

662-
Now trigger the restore process by using the [Start-OBRecovery](https://docs.microsoft.com/powershell/module/msonlinebackup/start-obrecovery?view=winserver2012-ps) command on the selected `$Item` from the output of the `Get-OBRecoverableItem` cmdlet:
662+
Now trigger the restore process by using the [Start-OBRecovery](https://docs.microsoft.com/powershell/module/msonlinebackup/start-obrecovery) command on the selected `$Item` from the output of the `Get-OBRecoverableItem` cmdlet:
663663

664664
```powershell
665665
Start-OBRecovery -RecoverableItem $Item -RecoveryOption $RecoveryOption

articles/backup/backup-dpm-automation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ $credsfilename
148148
C:\downloads\testvault\_Sun Apr 10 2016.VaultCredentials
149149
```
150150

151-
On the DPM server, run the [Start-OBRegistration](https://docs.microsoft.com/powershell/module/msonlinebackup/start-obregistration?view=winserver2012-ps) cmdlet to register the machine with the vault.
151+
On the DPM server, run the [Start-OBRegistration](https://docs.microsoft.com/powershell/module/msonlinebackup/start-obregistration) cmdlet to register the machine with the vault.
152152

153153
```powershell
154154
$cred = $credspath + $credsfilename

0 commit comments

Comments
 (0)