veeam_backup_9_0_powershell_reference_en.pdf

(1)

Veeam Backup PowerShell

Version 9.0

Reference

(2)

No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language in any form by any means, without written permission from Veeam Software (Veeam). The information contained in this document represents the current view of Veeam on the issue discussed as of the date of publication and is subject to change without notice. Veeam shall not be liable for technical or editorial errors or omissions contained herein. Veeam makes no warranties, express or implied, in this document. Veeam may have patents, patent applications, trademark, copyright, or other intellectual property rights covering the subject matter of this

document. All other trademarks mentioned herein are the property of their respective owners. Except as expressly provided in any written license agreement from Veeam, the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other intellectual property. Important! Please read the End User Software License Agreement before using the accompanying software

program(s). Using any part of the software indicates that you accept the terms of the End User Software License Agreement.

(3)

ADD-VBRVICLOUDREPLICAJOB ... 138 ADD-VBRVIJOBOBJECT ... 141 ADD-VBRVIPROXY ... 143 ADD-VBRVIREPLICAJOB ... 145 ADD-VBRWANACCELERATOR ... 150 ADD-VBRWINSERVER ... 152 ADD-VNXHOST ... 154 ADD-VNXSNAPSHOT ... 156 ADD-VSBHVAPPLICATIONGROUP ... 157 ADD-VSBHVJOB... 159 ADD-VSBHVVIRTUALLAB ... 162 ADD-VSBJOB ... 163 ADD-VSBVIAPPLICATIONGROUP ... 166 ADD-VSBVIRTUALLAB ... 168

CLEAR-VBRWANCACHE ... 170

CONNECT-VBRSERVER ... 172

CONNECT-VSBHVVIRTUALLAB ... 174

CONNECT-VSBVIRTUALLAB ... 176

COPY-VBRJOB ... 178

DISABLE-VBRCLOUDGATEWAY ... 180

DISABLE-VBRCLOUDTENANT ... 182

DISABLE-VBREPJOB ... 184

DISABLE-VBRHVPROXY ... 186

DISABLE-VBRJOB ... 188

DISABLE-VBRJOBGUESTFSINDEXING ... 190

DISABLE-VBRJOBSCHEDULE ... 192

DISABLE-VBRJOBVSSINTEGRATION ... 194

DISABLE-VBRREPOSITORYEXTENTMAINTENANCEMODE ... 196

DISABLE-VBRTAPEDRIVE ... 198

DISABLE-VBRTAPEPROTECTION... 200

DISABLE-VBRVIPROXY ... 202

DISABLE-VSBJOB ... 204

(5)

DISCONNECT-VBRSERVER ... 206

EJECT-VBRTAPEMEDIUM ... 207

ENABLE-VBRCLOUDGATEWAY ... 209

ENABLE-VBRCLOUDTENANT ... 211

ENABLE-VBREPJOB ... 213

ENABLE-VBRHVPROXY ... 215

ENABLE-VBRJOB ... 217

ENABLE-VBRJOBGUESTFSINDEXING ... 219

ENABLE-VBRJOBSCHEDULE... 221

ENABLE-VBRJOBVSSINTEGRATION ... 223

ENABLE-VBRREPOSITORYEXTENTMAINTENANCEMODE ... 225

ENABLE-VBRTAPEDRIVE ... 227

ENABLE-VBRTAPEPROTECTION ... 229

ENABLE-VBRVIPROXY ... 231

ENABLE-VSBJOB ... 233

ENABLE-VSBJOBSCHEDULE ... 234

ERASE-VBRTAPEMEDIUM ... 235

EXPORT-VBRBACKUP ... 237

EXPORT-VBRLOGS ... 239

EXPORT-VBRTAPEMEDIUM ... 242

FIND-VBRHVENTITY ... 244

FIND-VBRVCLOUDENTITY ... 246

FIND-VBRVIDATASTORE ... 249

FIND-VBRVIDATASTORECLUSTER ... 251

FIND-VBRVIENTITY ... 253

FIND-VBRVIFOLDER ... 256

FIND-VBRVIRESOURCEPOOL ... 258

FIND-VBRVISTORAGEPOLICY ... 260

FIND-VSBHVVIRTUALLAB... 262 FIND-VSBVIRTUALLAB ... 264 GET-HP3SNAPSHOT ... 266 GET-HP3STORAGE ... 268 GET-HP3VOLUME ... 269 GET-HP4CLUSTER ... 271 GET-HP4SNAPSHOT ... 273 GET-HP4STORAGE ... 275 GET-HP4VOLUME ... 276 GET-NETAPPHOST... 278 GET-NETAPPSNAPSHOT ... 279 GET-NETAPPVOLUME ... 281

GET-VBRAPPLICATIONRESTOREPOINT ... 283

GET-VBRBACKUP ... 286

GET-VBRBACKUPREPOSITORY ... 288

GET-VBRBACKUPSESSION ... 290

GET-VBRCLOUDDATASTORE ... 292

(6)

GET-VBRCLOUDGATEWAYCERTIFICATE ... 296

GET-VBRCLOUDHARDWAREPLAN ... 297

GET-VBRCLOUDPROVIDER ... 299

GET-VBRCLOUDPROVIDERNETWORKAPPLIANCE ... 301

GET-VBRCLOUDPUBLICIP ... 302

GET-VBRCLOUDSERVER ... 303

GET-VBRCLOUDSERVERNETWORKINFO ... 305

GET-VBRCLOUDTENANT ... 307

GET-VBRCLOUDTENANTNETWORKAPPLIANCE ... 309

GET-VBRCLOUDVLANCONFIGURATION ... 311

GET-VBRCOMMAND ... 312

GET-VBRCONFIGURATIONBACKUPJOB ... 314

GET-VBRCREDENTIALS ... 315

GET-VBRDEFAULTGATEWAYCONFIGURATION ... 316

GET-VBRENCRYPTIONKEY ... 317

GET-VBREPJOB ... 319

GET-VBREPPERMISSION ... 321

GET-VBREPSESSION ... 323

GET-VBRFAILOVERPLAN ... 325

GET-VBRFILESINRESTOREPOINT ... 328

GET-VBRHVPROXY ... 330

GET-VBRHVREPLICAREIPRULE ... 332

GET-VBRHVSERVERNETWORKINFO ... 333

GET-VBRINSTANTRECOVERY ... 335

GET-VBRJOB ... 336 GET-VBRJOBOBJECT ... 338 GET-VBRJOBOBJECTVSSOPTIONS ... 340 GET-VBRJOBOPTIONS ... 342 GET-VBRJOBPROXY ... 343 GET-VBRJOBSCHEDULEOPTIONS ... 345 GET-VBRJOBVSSOPTIONS ... 347 GET-VBRLOCALHOST ... 349 GET-VBRREPLICA ... 350 GET-VBRREPOSITORYEXTENT ... 352 GET-VBRRESTOREPOINT ... 354 GET-VBRRESTORESESSION ... 356 GET-VBRSERVER ... 357 GET-VBRSERVERSESSION ... 359 GET-VBRSESSION ... 360 GET-VBRSQLDATABASE ... 362

GET-VBRSQLDATABASERESTOREINTERVAL ... 363

GET-VBRTAPEDRIVE ... 365

GET-VBRTAPEJOB ... 367

GET-VBRTAPELIBRARY ... 368

GET-VBRTAPEMEDIAPOOL ... 370

(7)

GET-VBRTAPESERVER ... 375 GET-VBRTAPEVAULT ... 377 GET-VBRTASKSESSION ... 379 GET-VBRTOOLKITDOCUMENTATION ... 381 GET-VBRVIPROXY ... 382 GET-VBRVIREPLICAREIPRULE ... 383

GET-VBRVISERVERNETWORKINFO ... 384

GET-VBRVIVIRTUALSWITCH ... 386

GET-VBRWANACCELERATOR ... 387

GET-VNXHOST ... 388

GET-VNXSNAPSHOT ... 389

GET-VNXVOLUME ... 390

GET-VSBAPPLICATIONGROUP ... 391

GET-VSBHVVIRTUALLAB ... 392 GET-VSBJOB ... 393 GET-VSBJOBOPTIONS... 394 GET-VSBJOBSCHEDULEOPTIONS ... 395 GET-VSBSESSION ... 396 GET-VSBTASKSESSION ... 397 GET-VSBVIRTUALLAB ... 399 IMPORT-VBRBACKUP ... 400

IMPORT-VBRTAPEMEDIUM ... 402

MOVE-VBRTAPEMEDIUM ... 404

NEW-VBRBACKUPTOTAPESCHEDULEOPTIONS ... 407

NEW-VBRBACKUPWINDOWOPTIONS ... 409

NEW-VBRCLOUDFAILOVERPLANOBJECT... 411

NEW-VBRCLOUDPROVIDERNETWORKAPPLIANCE ... 413

NEW-VBRCLOUDTENANTHWPLANOPTIONS ... 415

NEW-VBRCLOUDTENANTREPLICATIONRESOURCES ... 417

NEW-VBRCLOUDTENANTRESOURCE ... 419

NEW-VBRCLOUDVLANCONFIGURATION... 421

NEW-VBRCONFIGURATIONBACKUPSCHEDULEOPTIONS ... 423

NEW-VBRDAILYOPTIONS ... 426

NEW-VBRFAILOVERPLANOBJECT ... 428

NEW-VBRFAILOVERPLANPUBLICIPRULE ... 431

NEW-VBRFILETOTAPEBACKUPPOLICY ... 432

NEW-VBRFILETOTAPEOBJECT ... 434

NEW-VBRFULLBACKUPTOTAPEPOLICY ... 436

NEW-VBRHVCLOUDHWPLANDATASTORE ... 438

NEW-VBRHVREPLICAREIPRULE ... 439 NEW-VBRJOBOPTIONS ... 441 NEW-VBRJOBSCHEDULEOPTIONS ... 443 NEW-VBRJOBSCRIPTOPTIONS ... 444 NEW-VBRJOBVSSOPTIONS ... 446 NEW-VBRMONTHLYOPTIONS ... 449 NEW-VBRNOTIFICATIONOPTIONS ... 451

(8)

NEW-VBRTAPEGFSMEDIASETPOLICY ... 453

NEW-VBRTAPEGFSSCHEDULEOPTIONS ... 455

NEW-VBRTAPEMEDIAPOOLRETENTIONPOLICY ... 459

NEW-VBRTAPEMEDIASETCREATIONPOLICY ... 461

NEW-VBRVCLOUDVAPPRESTORESETTINGS ... 463

NEW-VBRVICLOUDHWPLANDATASTORE ... 466

NEW-VBRVIREPLICAREIPRULE... 467 NEW-VSBJOBOPTIONS ... 469 REMOVE-HP3SNAPSHOT ... 470 REMOVE-HP3STORAGE ... 472 REMOVE-HP4SNAPSHOT ... 474 REMOVE-HP4STORAGE ... 476 REMOVE-NETAPPHOST ... 478 REMOVE-NETAPPSNAPSHOT ... 479 REMOVE-VBRBACKUP ... 480

REMOVE-VBRBACKUPREPOSITORY ... 482

REMOVE-VBRCLOUDGATEWAY ... 484

REMOVE-VBRCLOUDHARDWAREPLAN ... 486

REMOVE-VBRCLOUDPROVIDER ... 488

REMOVE-VBRCLOUDPUBLICIP ... 490

REMOVE-VBRCLOUDTENANT ... 491

REMOVE-VBRCLOUDVLANCONFIGURATION ... 493

REMOVE-VBRCREDENTIALS ... 494

REMOVE-VBRDEFAULTGATEWAY ... 495

REMOVE-VBRENCRYPTIONKEY ... 496

REMOVE-VBRFAILOVERPLAN ... 498

REMOVE-VBRHVPROXY ... 500

REMOVE-VBRJOB ... 502

REMOVE-VBRJOBOBJECT ... 504

REMOVE-VBRREPLICA ... 506

REMOVE-VBRRESTOREPOINT ... 508

REMOVE-VBRRESTORESESSION ... 510

REMOVE-VBRSERVER ... 512

REMOVE-VBRTAPELIBRARY ... 514

REMOVE-VBRTAPEMEDIAPOOL... 516

REMOVE-VBRTAPEMEDIUM ... 518

REMOVE-VBRTAPESERVER... 519

REMOVE-VBRTAPEVAULT ... 521

REMOVE-VBRVIPROXY ... 523

REMOVE-VBRWANACCELERATOR ... 525

REMOVE-VNXHOST... 527

REMOVE-VNXSNAPSHOT ... 528

REMOVE-VSBAPPLICATIONGROUP ... 529

REMOVE-VSBHVVIRTUALLAB... 531

REMOVE-VSBJOB ... 533

(9)

RESCAN-VBRENTITY ... 537

RESET-HVVMCHANGETRACKING ... 540

RESET-VBRCLOUDTENANT ... 542

RESET-VBRJOBOPTIONS ... 544

RESET-VBRJOBSCHEDULEOPTIONS ... 546

RESET-VBRJOBVSSOPTIONS ... 548

RESET-VSBJOBOPTIONS ... 550

RESTART-VBRINSTANTRECOVERY ... 552

SET-NETAPPHOST ... 554

SET-VBRBACKUPREPOSITORY ... 556

SET-VBRBACKUPTOTAPEJOB ... 560

SET-VBRBACKUPWINDOWOPTIONS ... 564

SET-VBRCLOUDFAILOVERPLANOBJECT ... 566

SET-VBRCLOUDGATEWAY ... 568

SET-VBRCLOUDPROVIDER... 570

SET-VBRCLOUDPROVIDERNETWORKAPPLIANCE ... 573

SET-VBRCLOUDTENANT ... 575

SET-VBRCLOUDTENANTNETWORKAPPLIANCE ... 579

SET-VBRCLOUDTENANTRESOURCE ... 581

SET-VBRCLOUDVLANCONFIGURATION ... 583

SET-VBRCONFIGURATIONBACKUPJOB ... 585

SET-VBRCREDENTIALS ... 588

SET-VBRDEFAULTGATEWAY ... 591

SET-VBRDEFAULTGATEWAYCONFIGURATION ... 592

SET-VBRENCRYPTIONKEY ... 593

SET-VBREPPERMISSION ... 595

SET-VBRFAILOVERPLAN ... 598

SET-VBRFAILOVERPLANOBJECT ... 601

SET-VBRFILETOTAPEJOB... 603

SET-VBRHVCLOUDHARDWAREPLAN ... 607

SET-VBRHVCLOUDREPLICAJOB ... 609

SET-VBRJOBADVANCEDBACKUPOPTIONS ... 612

SET-VBRJOBADVANCEDHVOPTIONS ... 615

SET-VBRJOBADVANCEDNOTIFICATIONOPTIONS ... 617

SET-VBRJOBADVANCEDOPTIONS ... 619

SET-VBRJOBADVANCEDSTORAGEOPTIONS ... 622

SET-VBRJOBADVANCEDVIOPTIONS ... 624 SET-VBRJOBOBJECTVSSOPTIONS ... 626 SET-VBRJOBOPTIONS ... 629 SET-VBRJOBPROXY ... 631 SET-VBRJOBSCHEDULE... 633 SET-VBRJOBSCHEDULEOPTIONS ... 637 SET-VBRJOBVSSOPTIONS ... 639 SET-VBRREPOSITORYEXTENT ... 641

SET-VBRSCALEOUTBACKUPREPOSITORY ... 643

(10)

SET-VBRTAPEGFSSCHEDULEOPTIONS ... 649

SET-VBRTAPELIBRARY ... 653

SET-VBRTAPEMEDIAPOOL ... 655

SET-VBRTAPEMEDIUM ... 660

SET-VBRTAPESERVER ... 662

SET-VBRTAPEVAULT ... 664

SET-VBRVICLOUDHARDWAREPLAN... 666

SET-VBRVICLOUDREPLICAJOB ... 668 SET-VBRVIREPLICAJOB ... 671 SET-VNXHOST ... 675 SET-VSBJOBOPTIONS ... 677 SET-VSBJOBSCHEDULE ... 679 SET-VSBJOBSCHEDULEOPTIONS ... 682

START-VBRCONFIGURATIONBACKUPJOB ... 684

START-VBRFAILOVERPLAN ... 685

START-VBRHVINSTANTRECOVERY ... 688

START-VBRHVINSTANTRECOVERYMIGRATION ... 691

START-VBRHVREPLICAFAILBACK ... 693

START-VBRHVREPLICAFAILOVER ... 695

START-VBRHVRESTOREVM... 697

START-VBRINSTANTRECOVERY ... 700

START-VBRJOB ... 703

START-VBRLINUXFILERESTORE ... 705

START-VBRQUICKBACKUP ... 709

START-VBRQUICKMIGRATION ... 710

START-VBRREPOSITORYEXTENTBACKUPEVACUATION ... 713

START-VBRRESTOREVIRTUALDISKS ... 715

START-VBRRESTOREVM ... 718

START-VBRRESTOREVMFILES ... 721

START-VBRSQLDATABASERESTORE ... 723

START-VBRTAPECATALOG ... 726

START-VBRTAPEINVENTORY ... 728

START-VBRVCLOUDINSTANTRECOVERY ... 730

START-VBRVCLOUDRESTOREVAPP ... 732

START-VBRVCLOUDRESTOREVM ... 735

START-VBRVIREPLICAFAILBACK ... 738

START-VBRVIREPLICAFAILOVER ... 741

START-VBRWINDOWSFILERESTORE ... 744

START-VBRZIP ... 746

START-VSBJOB ... 749

STOP-VBRINSTANTRECOVERY ... 751

STOP-VBRJOB ... 753

STOP-VBRLINUXFILERESTORE... 755

STOP-VBRREPLICAFAILOVER ... 756

STOP-VBRVIREPLICAFAILBACK ... 758

(11)

STOP-VSBJOB ... 762 SYNC-HP3STORAGE ... 764 SYNC-HP3VOLUME ... 766 SYNC-HP4STORAGE ... 768 SYNC-HP4VOLUME ... 770 SYNC-NETAPPHOST ... 772 SYNC-NETAPPVOLUME ... 773

SYNC-VBRBACKUPCOPYJOB ... 774

SYNC-VBRBACKUPREPOSITORY ... 776

SYNC-VBRBACKUPTOTAPEJOB ... 778

SYNC-VNXHOST ... 780

SYNC-VNXVOLUME... 781

UNDO-VBRFAILOVERPLAN ... 782

VEEAM POWERSHELL OBJECTS ... 784

PSCRYPTOKEY ... 785

VBRAPPLICATIONRESTOREPOINT ... 786

VBRBACKUPSESSION ... 787

VBRBACKUPTOTAPEJOB ... 788

VBRBACKUPTOTAPESCHEDULEOPTIONS ... 790

VBRBACKUPWINDOWOPTIONS ... 791

VBRCLOUDCERTIFICATE ... 792

VBRCLOUDDATASTORE ... 793

VBRCLOUDFAILOVERPLAN ... 794

VBRCLOUDFAILOVERPLANOBJECT ... 795

VBRCLOUDGATEWAY ... 796

VBRCLOUDIP ... 797

VBRCLOUDPROVIDER ... 798

VBRCLOUDPROVIDERDATASTORE ... 799

VBRCLOUDPROVIDERREPLICATIONRESOURCE ... 800

VBRCLOUDPROVIDERRESOURCE ... 801

VBRCLOUDSERVER ... 802

VBRCLOUDSERVERNETWORKINFO ... 803

VBRCLOUDTENANT ... 804

VBRCLOUDTENANTHWPLANOPTIONS ... 805

VBRCLOUDTENANTNETWORKAPPLIANCE ... 806

VBRCLOUDTENANTREPLICATIONRESOURCES ... 807

VBRCLOUDTENANTRESOURCE ... 808

VBRCONFIGURATIONBACKUPJOB ... 809

VBRCONFIGURATIONBACKUPSCHEDULEOPTIONS ... 810

VBRDAILYOPTIONS ... 811

VBRDATABASERESTOREINTERVAL ... 812

VBRDATALOCALITYEXTENT ... 813

VBRDEFAULTGATEWAY ... 814

VBRDEFAULTGATEWAYCONFIGURATION ... 815

VBRENCRYPTIONOPTIONS ... 816

(12)

VBREPPERMISSION ... 818

VBRFAILOVERPLAN ... 819

VBRFAILOVERPLANOBJECT ... 820

VBRFAILOVERPLANPUBLICIPRULE ... 821

VBRFILETOTAPEBACKUPPOLICY ... 822

VBRFILETOTAPEJOB ... 823

VBRFILETOTAPEOBJECT ... 825

VBRFULLBACKUPTOTAPEPOLICY ... 826

VBRGLOBALMEDIAPOOLOPTIONS ... 827

VBRHVCLOUDHARDWAREPLAN ... 828

VBRHVCLOUDHARDWAREPLANDATASTORE ... 829

VBRHVCLOUDPROVIDERNETWORKAPPLIANCE ... 830

VBRHVCLOUDVLANCONFIGURATION ... 831

VBRJOB ... 832

VBRJOBSCRIPTOPTIONS ... 833

VBRLOGITEM ... 834

VBRMONTHLYOPTIONS ... 835

VBRMULTISTREAMINGOPTIONS ... 836

VBRNOTIFICATIONOPTIONS ... 837

VBRPERFORMANCEEXTENT ... 838

VBRREPOSITORYEXTENT ... 839

VBRSCALEOUTBACKUPREPOSITORY ... 840

VBRSESSION ... 841

VBRSQLDATABASE ... 842

VBRTAPEDRIVE ... 843

VBRTAPEGFSMEDIAPOOL ... 844

VBRTAPEGFSMEDIASETOPTIONS ... 845

VBRTAPEGFSMEDIASETPOLICY ... 846

VBRTAPEGFSSCHEDULEMONTHLYOPTIONS ... 847

VBRTAPEGFSSCHEDULEOPTIONS ... 848

VBRTAPEGFSSCHEDULEQUARTERLYOPTIONS ... 849

VBRTAPEGFSSCHEDULEWEEKLYOPTIONS ... 850

VBRTAPEGFSSCHEDULEYEARLYOPTIONS... 851

VBRTAPELIBRARY ... 852

VBRTAPEMEDIAPOOL... 853

VBRTAPEMEDIAPOOLRETENTIONPOLICY ... 855

VBRTAPEMEDIASETCREATIONPOLICY ... 856

VBRTAPEMEDIUM ... 857

VBRTAPESERVER... 859

VBRTAPEVAULT ... 860

VBRTENANTFAILOVERPLAN ... 861

VBRVICLOUDHARDWAREPLAN ... 862

VBRVICLOUDHARDWAREPLANDATASTORE ... 863

VBRVICLOUDPROVIDERNETWORKAPPLIANCE ... 864

VBRVICLOUDVLANCONFIGURATION ... 865

(13)

VBRVISTORAGEPOLICY ... 867 VBRVIVIRTUALSWITCH ... 868 OBSOLETE CMDLETS ... 869 ADD-VBRBACKUPJOB (OBSOLETE) ... 870 ADD-VBRJOBOBJECT (OBSOLETE) ... 872 ADD-VBRREPLICAJOB (OBSOLETE) ... 874

ADD-VBRTAPEFILESJOB (OBSOLETE) ... 876

ADD-VBRTAPEVMJOB (OBSOLETE) ... 878

ADD-VSBAPPLICATIONGROUP (OBSOLETE) ... 881

EJECT-VBRTAPEDRIVE (OBSOLETE)... 883

EXPORT-VBRCONFIGURATION (OBSOLETE) ... 885

FIND-VBRDATASTORE (OBSOLETE) ... 886

FIND-VBROBJECT (OBSOLETE) ... 888

FIND-VBRRESOURCEPOOL (OBSOLETE) ... 890

FIND-VBRTAPECATALOG (OBSOLETE) ... 891

FIND-VBRTAPECATALOGVERSION (OBSOLETE) ... 892

GET-VBRTAPEBACKUP (OBSOLETE) ... 894

GET-VBRTAPEMEDIAPOOLOPTIONS (OBSOLETE) ... 896

IMPORT-VBRCONFIGURATION (OBSOLETE) ... 897

REMOVE-VBRBACKUPSESSION (OBSOLETE) ... 899

REMOVE-VSBSESSION (OBSOLETE) ... 901

START-VBRREPLICAFAILOVER (OBSOLETE) ... 903

START-VBRTAPERESTORE (OBSOLETE) ... 905

(14)

CONTACTING VEEAM SOFTWARE

At Veeam Software we value the feedback from our customers. It is important not only to help you quickly with your technical issues, but it is our mission to listen to your input, and build products that incorporate your suggestions.

Customer Support

Should you have a technical concern, suggestion or question, please visit our Customer Center Portal at www.veeam.com/support.html to open a case, search our knowledge base, reference

documentation, manage your license or obtain the latest product release.

Company Contacts

For the most up to date information about company contacts and offices location, please visit www.veeam.com/contacts.html.

Online Support

If you have any questions about Veeam Backup PowerShell, you can use the following resources:  Full documentation set: www.veeam.com/documentation-guides-datasheets.html  Community forum at forums.veeam.com

(15)

GETTING STARTED

Veeam Backup & Replication comes with PowerShell extension — a snap-in to Microsoft Windows PowerShell 2.0. The Veeam Backup PowerShell snap-in allows you to do almost all operations that are available in the user interface.

Veeam PowerShell cmdlets mirror actions you can perform via Veeam Backup & Replication UI. Keep in mind that actions performed with PowerShell have the same force as actions performed via Veeam Backup & Replication: for example, if you delete a job with a PowerShell script, the job will be removed from the Veeam Backup & Replication database, and you will not be able to undo changes.

Starting Veeam PowerShell Sessions

You can run the Veeam PowerShell sessions from the Veeam backup server (locally) or from a remote machine. The remote machine must have the Veeam Backup & Replication Console installed. The Veeam PowerShell component is installed by default as a part of the Veeam Backup & Replication or the Veeam Backup & Replication Console.

You can open the PowerShell console from the Veeam Backup & Replication main menu. In this case, the Veeam PSSnapIn is added automatically.

You can run Veeam PowerShell commands from any Windows PowerShell session, for example from the Windows PowerShell console installed on your machine. To start the session, do the following: 1. To get access to the Veeam Backup & Replication cmdlets library, you need to add the PSSnapIn.

Run the following command:

PS C:\PS> Add-PSSnapin VeeamPSSnapin

2. Connect to local or remote Veeam backup server. See Connect-VBRServer.

Note: If your machine is running Microsoft Windows 2008, make sure that the Microsoft Windows PowerShell 2.0 is installed on your machine. To download Microsoft Windows PowerShell, use the following link: http://support.microsoft.com/kb/968929.

(16)

Understanding Veeam Cmdlets

The Veeam cmdlets are developed to behave like other Microsoft Windows cmdlets. Each cmdlet is a simple single-function command that is a specialized .NET class implementing specific actions. Most of the cmdlets have parameters that pass additional data to the command. The cmdlets and their parameters are named after the Microsoft naming conditions.

Working with Veeam PowerShell cmdlets and scripts in many respects depends on your imagination, skills and expertise in Windows PowerShell 2.0. To learn more about Windows PowerShell 2.0 and its basics, use the book by Dr. Tobias Weltner: Microsoft Master-PowerShell.

Note: Veeam Support team does not write PowerShell scripts on demand.

Platform

Some Veeam cmdlets differ for VMware and Hyper platforms. A prefix indicates the platform: 'Vi' stands for VMware, and 'Hv' stands for Hyper-V. A Vi-cmdlet will not work for Hyper-V instances, and vice versa. For example, Add-VBRViBackupJob creates a backup job for VMware VMs, but if you need to back up Hyper-V VMs, you need Add-VBRHvBackupJob. Some cmdlet work for both platforms, like Get-VBRJob. You can additionally check the platform in the Applies to section on the online help page for each cmdlet.

Input and Output

As an input, the cmdlets expect objects, and they output objects. The objects mostly represent instances of the backup infrastructure: VMs, jobs, job settings, failover plans and so on. See Veeam PowerShell Objects for objects properties. The objects can be part of a pipeline.

You can use the cmdlet help to understand what kind of input is needed. The cmdlets have syntax that shows the whole set of parameters available in the cmdlet and what each parameter expects as input. For example, Add-VBRHvProxy has the following syntax:

Add-VBRHvProxy -Server <CHost> [-Description <String>] [-MaxTasks <Int32>] [-WarningAction <ActionPreference>] [-WarningVariable <String>]

[<CommonParameters>]

That means that to add a new Hyper-V proxy, you need to indicate a server that will act as the proxy, the description of the new proxy and a number of tasks that the proxy can perform simultaneously. Some cmdlets have two or more parameter sets. For example, restore cmdlets offer a 'simplified' parameter set for restoring to original location, while the parameter set for restoring to another location allows to indicate the target server and other detail and these parameters are mandatory for this set.

Note: Since Veeam Backup & Replication v5 uses Windows PowerShell 2.0, scripts that you have created with previous versions of Veeam Backup & Replication which used Windows PowerShell 1.0 may not work.

(17)

Using Get-VBRCommand

The Get-VBRCommand cmdlet returns the list of cmdlets available in the Veeam PowerShell SnapIn. Note: This cmdlet is available only in sessions started from Veeam Backup & Replication main menu.

(18)

Using Get-Help

The Get-Help cmdlet is a Microsoft cmdlet that works for Veeam PowerShell SnapIn as well. Get-Help <cmdletname> displays a full description of the specified cmdlet along with its syntax and full parameter description.

Note: The online help is always a more accurate source of information than the help integrated in the product. The online help is updated regularly and contains all fixes based on customers' feedback.

(19)

Examples of Use

In this example, we will review how to restore a VM to another location by means of the Veeam PowerShell script. To let you get most out of this example, each command will be illustrated by the action from the Veeam Backup & Replication UI that provides the result similar to execution of the PowerShell script.

To restore a VM, you will need the Start-VBRRestoreVm cmdlet. The cmdlet has two parameter sets: to restore to the original location or to another location. The parameters of the cmdlet allows you to choose various restore details, but for a basic restore the following settings will be enough:

 The restore point: choose the restore point to restore the VM to a particular date.  The target server: choose the server where the VM will be registered.

 The target resource pool: choose the resource pool on the target server where you want to restore the VM.

We will get all these objects and save them to variables:

1. To get the restore point, we will need first to get the backup job that processed the VM. Get the backup job and save it to a variable:

PS C:\PS> $backup = Get-VBRBackup -Name "Daily Server Backup"

Then get the restore point of this backup. Remember that the backup contains all VM processed by the job, so use the -Name parameter to indicate the name of the needed VM. The command returns the list of the restore points. We will need the last one and we will save it to another variable:

PS C:\PS> $restorepoint = Get-VBRRestorePoint -Backup $backup -Name "vdi001" | Select -Last 1

2. Now you will need to get the server. Save it to yet another variable:

PS C:\PS> $server = $server = Get-VBRServer -Name "esx18.tech.local"

3. And now we need to get the resource pool on this server. We will save it to the variable, too: PS C:\PS> $resourcepool = Find-VBRViResourcePool -Server $server -Name "Webservers"

4. Finally, we can start the restore. We will need the saved variables:

PS C:\PS> Start-VBRRestoreVM –RestorePoint $restorepoint –Server $server –ResourcePool $resourcepool

(20)

PowerShell Remoting

Veeam PowerShell supports remote execution of cmdlets and scripts. That is, you can run cmdlets and scripts directly on the Veeam Backup & Replication, or against remote computers. A remote session can be started on one remote computer, or a number of remote computers at a time.

To enable PowerShell remoting:  Install the WinRM Service.

 Enable PowerShell remoting. Start Windows PowerShell 2.0 as an administrator and type in Enable-PSRemoting

To learn more about PowerShell remoting and its configuration, see:

http://blogs.msdn.com/b/powershell/archive/2008/05/10/remoting-with-powershell-quickstart.aspx

(21)

VEEAM POWERSHELL CMDLETS

Veeam PowerShell allows you to perform almost all operations that are available with the Veeam Backup & Replication UI.

(22)

Add-HP3Snapshot

Short Description

Creates a HPE 3PAR StoreServ storage snapshot.

Applies to

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus Storage system: HPE 3PAR StoreServ

Syntax

Add-HP3Snapshot -Volume <CSanVolume> [-Name <string>][-Description <string>][<CommonParameters>]

Related Commands

Get-HP3Volume

Detailed Description

This cmdlet creates a snapshot of the selected HPE 3PAR StoreServ storage volume.

Parameters

Parameter Description Required Position Accept Pipeline

Input

Accept Wildcard Characters Volume Specifies the HPE 3PAR

StoreServ storage volume for which you want to take snapshot.

True Named True (by Value FromPipeline, ValueFromPipeline

ByPropertyName)

False

Name Specifies the name you want to

assign to the snapshot. False Named False False

Description Specifies the description of the

snapshot.

If not set, Veeam Backup & Replication will enter date and time of creation by default.

False Named False False

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

(23)

Example 1

This command creates a snapshot of the "Vol 01" volume. The snapshot is named "vol_SS_01". The target volume object is obtained with Get-HP3Volume and piped down. The description is "Vol 01 snapshot".

PS C:\PS> Get-HP3Volume -Name "Vol 01" | Add-HP3Snapshot -Name "vol_SS_01" -Description "Vol 01 snapshot"

Example 2

This command creates a snapshot of the "Vol 01" volume. The snapshot is named "vol_SS_01". The target volume object is obtained with Get-HP3Volume and assigned to the $volume variable beforehand. The description is "Vol 01 snapshot".

PS C:\PS> Add-HP3Snapshot -Volume $volume -Name "vol_SS_01" -Description "Vol 01 snapshot"

(24)

Add-HP3Storage

Short Description

Adds HPE 3PAR StoreServ storage to Veeam Backup & Replication.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus Storage system: HPE 3PAR StoreServ

Syntax

Add-HP3Storage -UserName <string> -Password <string> Name <string>] [-Description <string>] [-Url <string>][<CommonParameters>]

-OR-Add-HP3Storage -Credentials <CCredentials> [-Name <string>] [-Description <string>] [-Url <string>][<CommonParameters>]

Related Commands

Get-VBRCredentials

Detailed Description

This cmdlet adds the selected HPE 3PAR StoreServ storage to Veeam Backup & Replication. When you add a storage to your management console, Veeam Backup & Replication automatically rescans the storage infrastructure. To rescan the storage infrastructure manually, run Sync-HP3Storage or Sync-HP3Volume.

When adding a storage, you will need to provide either username/password or credentials. This cmdlet provides syntax for both scenarios accordingly.

Parameters

Input

Accept Wildcard Characters UserName Specifies the user name you want to use for

authenticating with the storage.

If you use the Username/Password scenario, the -Credentials parameter must be omitted.

True Named False False

Password Specifies the password you want to use for authenticating with the storage.

Credentials Specifies credentials you want to use for

If you use the Credentials scenario, the -User and

(25)

-Password parameters must be omitted.

Name Specifies the storage IP address or DNS name. True Named False False

Description Specifies the description of the storage.

Url Specifies the HPE 3PAR Web Services API URL. The HPE 3PAR Web Services API delivers a programming interface for performing storage management tasks with HPE 3PAR StoreServ storage systems.

Example 1

This command adds a HPE 3PAR StoreServ storage with IP address 167.16.2.134 specified in the -Name parameter. The username is "Administrator" and the password is "Password". The URL is

https://172.18.44.8:8080.

PS C:\PS> AddHP3Storage UserName "Administrator" Password "Password" -Name 167.16.2.134 -Description "SAN Storage" -Url https://172.18.44.8:8080

Example 2

This command adds a HPE 3PAR StoreServ storage with IP address 167.16.2.134 specified in -Name parameter. The credentials object is obtained with Get-VBRCredentials and assigned to the $creds variable beforehand. The URL is https://172.18.44.8:8080.

PS C:\PS> AddHP3Storage Credentials $creds Name 167.16.2.134 -Description "HPE 3PAR Storage" -Url https://172.18.44.8:8080

(26)

Add-HP4Snapshot

Short Description

Creates a HPE StoreVirtual storage snapshot.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus Storage system: HPE StoreVirtual

Syntax

Add-HP4Snapshot -Volume <CSanVolume> [-Name <string>] [-Description <string>][-ApplicationManagedShapshot] [<CommonParameters>]

Related Commands

Get-HP4Volume

Detailed Description

This cmdlet creates a snapshot of the selected HPE StoreVirtual storage volume.

Alias

Add-VBRHPSnapshot

Parameters

Input

Accept Wildcard Characters Volume Specifies the storage volume you want to take

snapshot of. True Named False False

Name Specifies the name you want to assign to the

snapshot. False Named False False

Description Specifies the description of the snapshot.

Application Managed Shapshot

Indicates if the VM on the target volume should be quiesced to bring VM data to a consistent state.

If omitted, Veeam Backup & Replication will create a point-in-time snapshot.

(27)

Example 1

This command creates a snapshot of the "Vol 01" volume. The snapshot is named "vol_SS_01". The target volume object is obtained with Get-HP4Volume and piped down. The application-managed snapshot is enabled. The description is "Vol 01 snapshot".

PS C:\PS> Get-HP4Volume -Name "Vol 01" | Add-HP4Snapshot -Name "vol_SS_01" -ApplicationManagedShapshot -Description "Vol 01 snapshot"

Example 2

This command creates a snapshot of the "Vol 01" volume. The snapshot is named "vol_SS_01". The target volume object is obtained with Get-HP4Volume and assigned to the $volume variable beforehand. The application-managed snapshot is enabled. The description is "Vol 01 snapshot".

PS C:\PS> AddHP4Snapshot Volume $volume Name "vol_SS_01" -ApplicationManagedShapshot -Description "Vol 01 snapshot"

(28)

Add-HP4Storage

Short Description

Adds HPE StoreVirtual storage to Veeam Backup & Replication.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus Storage system: HPE StoreVirtual

Syntax

Add-HP4Storage -DnsOrIpAddress <string> -UserName <string> -Password <string> [-Name <string>] [-Description <string>] [<CommonParameters>]

-OR-Add-HP4Storage -DnsOrIpAddress <string> -Credentials <CCredentials> [-Name <string>] [-Description <string>] [<CommonParameters>]

Related Commands

Get-VBRCredentials

Detailed Description

This cmdlet adds the selected HPE StoreVirtual storage to Veeam Backup & Replication.

When you add a storage to your management console, Veeam Backup & Replication automatically rescans the storage infrastructure. To rescan the storage infrastructure manually, run Sync-HP4Storage or Sync-HP4Volume.

Alias

Add-VBRHPStorage

Parameters

Parameter Description Required Position Accept Pipeline Input Accept Wildcard Characters DnsOr IpAddress

Specifies the string with a full DNS name or IP

address of the storage. True Named (ByValue, True ByProperty

Name)

False

UserName Specifies the user name you want to use for authenticating with the storage.

(29)

Name Specifies the name of the management group the storage belongs to.

Credentials Specifies the credentials you want to use for

If you use the Credentials scenario, the -User and -Password parameters must be omitted.

Example 1

This command adds a storage with IP address 167.16.2.134. The username is "Administrator" and the password is "Password".

PS C:\PS> Add-HP4Storage -DnsOrIpAddress 167.16.2.134 -UserName "Administrator" -Password "Password" -Description "HPE Storage"

Example 2

This command adds a storage with IP address 167.16.2.134. The credentials object is obtained with Get-VBRCredentials and assigned to the $creds variable beforehand.

PS C:\PS> AddHP4Storage DnsOrIpAddress 167.16.2.134 Credentials $creds -Description "HPE Storage"

(30)

Add-NetAppHost

Short Description

Adds NetApp storage.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

AddNetAppHost Name <String> [Description <String>] UserName <String> -Password <String> [-IsHTTP [<Boolean>]] [-Port <Int32>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

-OR-Add-NetAppHost -Name <String> [-Description <String>] -Credentials <CCredentials> [-IsHTTP [<Boolean>]] [-Port <Int32>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Related Commands

Get-VBRCredentials

Detailed Description

This cmdlet adds the selected NetApp storage to Veeam Backup & Replication.

Parameters

Input

Accept Wildcard Characters Name Specifies the storage IP address or DNS name. True Named False False

UserName Specifies the user name you want to use for authenticating with the storage.

If you use username/password scenario,

-Credentials parameter must be omitted.

Password Specifies the password you want to use for authenticating with the storage.

If you use username/password scenario,

-Credentials parameter must be omitted.

IsHTTP If set to TRUE, HTTP protocol will be used to

(31)

HTTPS protocol will be selected. By default, HTTPS is used.

Port Sets a port used to connect to the NetApp

storage. By default, port 443 is used. False Named False False

Credentials Specifies the CCredentials object containing the

credentials record you want to use for authenticating with the storage. If you use credentials scenario, User and

Password parameters must be omitted.

Example 1

This command adds a NetApp storage with IP address 167.16.2.134. The username is "Administrator" and the password is "_Password_".

PS C:\PS> AddNetAppHost UserName "Administrator" Password "_Password_" -Name 167.16.2.134 -Description "NetApp Storage"

Example 2

This command adds a NetApp storage with IP address 167.16.2.134. The credentials object is obtained with Get-VBRCredentials and assigned to the $creds variable beforehand.

PS C:\PS> AddNetAppHost Credentials $creds Name 167.16.2.134 -Description "NetApp Storage"

(32)

Add-NetAppSnapshot

Short Description

Creates storage snapshot.

Applies to

Syntax

Add-NetAppSnapshot -Volume <CSanVolume> [-Name <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Related Commands

Get-NetAppVolume

Detailed Description

This cmdlet creates a snapshot of the selected NetApp volume.

Parameters

Input

Accept Wildcard Characters Volume Specifies the CSanVolume object

containing the SAN volume you want to take snapshot of.

True Named True (by Value FromPipeline, ValueFromPipeline

ByPropertyName)

False

Name Specifies the name you want to

assign to the snapshot. False Named False False

(33)

Example

This command creates a snapshot of the "Vol 01" volume. The snapshot is named "vol_SS_01". • Run Get-NetAppHost to get the host where the volume is located. Save the result to the

$apphost variable.

• Run Get-NetAppVolume with the $apphost variable to get the volume. Pipe it down to Add-NetAppSnapshot.

PS C:\PS> $apphost = Get-NetAppHost -Name "NetApp Store"

PS C:\PS> Get-NetAppVolume -Host $apphost -Name "Vol 01" | Add-NetAppSnapshot -Name "vol_SS_01"

(34)

Add-VBRBackupRepository

Short Description

Adds a new backup repository.

Applies to

Syntax

Add-VBRBackupRepository [-Name <String>] [-Description <String>] [-Server <CHost>] [-MountServer <CHost>] -Folder <String> -Type

<CBackupRepositoryInfo+EType> ImportIndex] ImportBackup]

[-RotatedDrive] [-VPowerNFSFolder <String>] [-UseFc] [-DDServerName <String>] LimitConcurrentJobs] MaxConcurrentJobs <Int32>] LimitDatarate] DataRateLimit <Int32>] AlignDataBlocks] DecompressDataBlocks] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

-OR-Add-VBRBackupRepository [-Name <String>] [-Description <String>] [-Server <CHost>] [-MountServer <CHost>] -Folder <String> -Type

[-RotatedDrive] [-VPowerNFSFolder <String>] [-UseFc] [-DDServerName <String>] UserName <String>] Password <String>] LimitConcurrentJobs]

[-MaxConcurrentJobs <Int32>] [-LimitDatarate] [-DataRateLimit <Int32>] [AlignDataBlocks] [-DecompressDataBlocks] [-WarningAction

<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

-OR-Add-VBRBackupRepository [-Name <String>] [-Description <String>] [-Server <CHost>] [-MountServer <CHost>] -Folder <String> -Type

[-RotatedDrive] [-VPowerNFSFolder <String>] [-UseFc] [-DDServerName <String>] [-Credentials <CCredentials>] [-LimitConcurrentJobs] [-MaxConcurrentJobs <Int32>] LimitDatarate] DataRateLimit <Int32>] AlignDataBlocks] [-DecompressDataBlocks] [-WarningAction <ActionPreference>] [-WarningVariable <String>][<CommonParameters>]

Related Commands

Get-VBRServer Get-VBRCredentials

Detailed Description

This cmdlet adds a new backup repository to Veeam Backup & Replication.

When adding a backup repository, you may need to provide username/password or credentials to authenticate with the source server. This cmdlet provides three scenarios for each case including no authentication.

(35)

Parameters

Parameter Description Required Position PipelineAccept Input

Accept Wildcard Characters Name Specifies the name you want to assign to the

new backup repository. False Named False False

Description Specifies the description of the backup

repository.

Type Specifies the type you want to assign to the repository:  CifsShare  DataDomain  ExaGrid  HPStoreOnce  LinuxLocal  WinLocal

Server Specifies the host where the backup repository you want to add is located.

Use this parameter to explicitly set the host for the following repository types:

— For the WinLocal type: indicate the Windows based server where you want to create the backup repository or to which you want to connect the rotated drives.

— For the LinuxLocal type: indicate the Linux based server where you want to create the backup repository or to which you want to connect the rotated drives.

— For the CifsShare, DataDomain or

HPStoreOnce types: indicate a

Windows based server that to which the storage appliance is connected and which will be used as a gateway server.

Default: This server.

Mount

Server Used to enable the vPower NFS. _{Specifies the host where the NFS service must}

be installed.

By default, the vPower NFS folder is created on the mounted host. If you want to locate the vPower NFS folder elsewhere, use the

VPowerNFSFolder parameter to set the path.

Folder Specifies the full path to the folder where you

(36)

Import

Index If indicated, the guest OS file system index will be imported automatically. False Named False False

Import

Backup If indicated, the existing backups located on the repository you are adding will be imported automatically. Otherwise, you will need to import the backups manually.

Rotated Drive

Indicates if the repository you want to add is a rotated drive (removable media).

VPower NFSFolder

Specifies the path to the vPower NFS root folder. To enable the vPower NFS, the MountServer parameter must be set.

DDServer Name

Specifies the Data Domain server name according to the connection mode:

— If EMC Data Domain works over TCP, enter a full DNS name or IP address of the EMC Data Domain server. — If EMC Data Domain works over Fibre

Channel, enter a name of the Data Domain server starting with a 'DFC-' prefix, for example,

"DFC-DataDomain690".

Limit Concurrent Jobs

Indicates if the number of concurrent jobs using this repository must be limited.

Use the MaxConcurrentJobs parameter to set the maximum value.

Max Concurrent Jobs

Used for setting maximum value for the

LimitConcurrentJobs parameter.

Specifies the maximum allowed number of concurrent tasks for the backup repository. Accepts int type.

Permitted values: 1 to 99.

Limit Datarate

Indicates that the total speed of writing data to the backup repository disk must be restricted. Use the DataRateLimit parameter to set the maximum value.

Data Rate Limit

Used for setting combined data ingestion rate for the LimitDatarate parameter.

Specifies the combined data ingestion rate for the repository.

Accepts int32 type.

Permitted value: 1 to 1024 (MByte/s).

Align Data Blocks

If set, the backup blocks size will be aligned by a 4Kb block boundary. Data alignment provides better deduplication on storage systems with fixed block size.

Decompress DataBlocks

If set, backup data blocks will be decompressed before storing the backup to the repository. Decompression helps to achieve a better

(37)

deduplication ratio.

UserName Specifies the user name you want to use for authenticating with the backup repository host. If you use the Username/Password scenario, the

Credentials parameter must be omitted.

Password Specifies the password you want to use for authenticating with the backup repository host. If you use the Username/Password scenario, the

Credentials parameter must be omitted.

Credentials Specifies credentials you want to use for

authenticating with the backup repository host. If you use the Credentials scenario, the User and

Password parameters must be omitted.

Example 1

This command adds a Windows server as a new backup repository named "Win2012Repo". No authentication is used. All repository settings are used as set default.

• The server to add is obtained with Get-VBRServer and assigned to the $server variable beforehand.

• The folder that is used as the backup repository is located on "C:\Backup Repository". • The server type is set to "WinLocal".

Add-VBRBackupRepository -Name "Win2012Repo" -Server $server -Folder "c:\Backup Repository" -Type WinLocal

Example 2

This command adds a Windows server as a new backup repository named "Backups Vol 01". The authentication with the server is provided with the credentials record.

• The server to add is obtained with Get-VBRServer and assigned to the $server variable beforehand.

• The folder that is used as the backup repository is located on "C:\Backup Repository". • The server type is set to "WinLocal".

• The -ImportBackup parameter is set to adopt the existing backup files. • The Max concurrent tasks number is set to 6.

• The credentials to authenticate with the source server are obtained with Get-VBRCredentials and assigned to the $Administrator variable beforehand.

Add-VBRBackupRepository -Name "Backups Vol 01" -Server $server -Folder "C:\Backup Repository" Type WinLocal ImportBackup MaxConcurrentJobs 6 -Credentials $Administrator

(38)

Example 3

This command adds an EMC DataDomain storage appliance as a backup repository. The DataDomain storage is connected over the TCP. The storage appliance is connected to an explicitly set gateway server.

• The folder path is set to "DataDomain://10.0.0.80:storage/".

• The DataDomain appliance is set with the IP address. The "DFC-" prefix is not set to enable the connection over TCP.

• The server type is set to "DataDomain".

• The host that will be used as the gateway server is obtained with Get-VBRServer and assigned to the $server variable beforehand.

• The Username/Password is used to get access to the appliance.

Add-VBRBackupRepository -Folder DataDomain://10.0.0.80:storage/ -Type DataDomain DDServerName 10.0.0.80 Server $server UserName sysadmin -Password Pa55word

Example 4

This command adds backup repository on a rotated drive connected to a Windows server. • The server type is set to "WinLocal".

• The "Rotated Drive" switch parameter is used to enable the rotated drive repository technology.

• The host to which the rotated drive is connected is obtained with Get-VBRServer and assigned to the $server variable beforehand.

• The folder path is "F:\Repo".

Add-VBRBackupRepository -Name RDX -Type WinLocal -RotatedDrive -Description "Rotated drive" -Server $server -Folder F:\Repo

(39)

Add-VBRBackupToTapeJob

Short Description

Creates backup to tape job or a GFS job.

Applies to

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus

Syntax

This cmdlet provides two parameter sets.

 For creating a job targeted to a simple media pool:

Add-VBRBackupToTapeJob -Name <String> Description <String>] [-EjectCurrentMedium] [-ExportCurrentMediaSet] -FullBackupMediaPool <VBRTapeMediaPool> IncrementalBackupMediaPool <VBRTapeMediaPool>] [-ExportDays <DayOfWeek[]>] [-FullBackupPolicy <VBRFullBackupToTapePolicy>] ScheduleOptions <VBRBackupToTapeScheduleOptions>] Object <Object[]>] [-ProcessIncrementalBackup] [-UseHardwareCompression] [-WaitPeriod

<TimeSpan>] [-WaitForBackupJob] [-NotificationOptions

<VBRNotificationOptions>] JobScriptOptions <VBRJobScriptOptions>] [-CopyFromLatestFull] [-Always[-CopyFromLatestFull] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-PipelineVariable <String>] [<CommonParameters>]

 For creating a GFS job:

Add-VBRBackupToTapeJob -Name <String> Description <String>] [-EjectCurrentMedium] [-ExportCurrentMediaSet] -GFSMediaPool

<VBRTapeGFSMediaPool> [-ExportDays <DayOfWeek[]>] [-FullBackupPolicy <VBRFullBackupToTapePolicy>] [-ScheduleOptions

<VBRBackupToTapeScheduleOptions>] Object <Object[]>]

[-ProcessIncrementalBackup] [-UseHardwareCompression] [-WaitPeriod <TimeSpan>] [-WaitForBackupJob] [-NotificationOptions

<VBRNotificationOptions>] JobScriptOptions <VBRJobScriptOptions>] [-CopyFromLatestFull] [-Always[-CopyFromLatestFull] [-GFSScheduleOptions <VBRTapeGFSScheduleOptions>] WarningAction <ActionPreference>]

[-WarningVariable <String>] [-PipelineVariable <String>] [<CommonParameters>]

Related Commands

Get-VBRTapeMediaPool New-VBRFullBackupToTapePolicy New-VBRBackupToTapeScheduleOptions Get-VBRJob Get-VBREPJob New-VBRNotificationOptions New-VBRJobScriptOptions New-VBRBackupToTapeScheduleOptions

(40)

New-VBRTapeGFSScheduleOptions Get-VBRBackupRepository

Return Type

VBRBackupToTapeJob

Detailed Description

This cmdlet creates a new backup to tape job or a GFS job. Target the job to a simple or a GFS media pool respectively.

The backup to tape job archives backups that were produced by particular backup or Endpoint jobs or stored on particular backup repositories. Use the Object parameter to set a backup job or a backup repository as source to the tape job.

Note: If you choose to archive data from backup repositories, the backup to tape job will process only the backups that were created with backup jobs configured on this Veeam backup server. Imported backups and configuration backups will be skipped from processing.

Parameters

Input

Accept Wildcard Characters Name Specifies the name you want to assign to the

backup to tape job. Accepts string type.

Description Specifies the description of the backup to tape job.

Eject Current Medium

Indicates that the tape(s) will be automatically ejected from drive after the job finishes. The ejected tape is moved to a standard library slot.

Export Current MediaSet

Indicates that the tapes belonging to the media set will be automatically placed to Import/Export (Mail) slot for further export. Use the ExportDays parameter to set days on which you want to export tapes.

If you use this parameter, but do not set the

ExportDays parameter, the tapes will be

exported every day.

Full Backup Media Pool

Specifies the media pool where you want to store full backups produced by this tape job. Accepts VBRTapeMediaPool object, GUID or string type.

Incremental Backup Media Pool

Used to set media pool for the

ProcessIncrementalBackup parameter.

Specifies the media pool where you want to store incremental backups produced by this

(41)

tape job.

Accepts VBRTapeMediaPool object, GUID or string type.

GFSMedia Pool

Specifies the target GFS media pool.

Accepts VBRTapeGFSMediaPool object, GUID or string type.

ExportDays Used to set days for exporting tapes for the

ExportCurrentMediaSet parameter.

Specifies days on which the tapes written by this tape job will be automatically exported: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.

FullBackup Policy

Specifies virtualized synthetic full backup for tape settings.

Accepts VBRFullBackupToTapePolicy object.

Schedule Options

Specifies backup to tape job schedule. By default, the following settings are applied:

Enabled: False. Type: Daily.

DailyOptions: Type: SelectedDays, Period:

18:00, DayOfWeek: Saturday.

MonthlyOptions: Period: 22:00,

DayNumberInMonth: Fourth, DayOfWeek: Saturday, Months: January, February, March, April, May, June, July, August, September, October, November, December.

ScheduleOptions: From Sunday to Saturday,

from 00:00 to 23:00, Enabled: True.

JobId: Null.

Object Specifies the backup job or backup repository that will be the source for this tape job. Accepts CBackupJob, VBREPJob or CBackupRepository objects.

You can assign multiple jobs or repositories to this object.

Process Incremental Backup

Indicates that this tape job will archive incremental backups.

Use the IncrementalBackupMediaPool parameter to specify a separate media pool for storing incremental backups. If you do not set the IncrementalBackupMediaPool

parameter, incremental backups will be stored to the media pool the you set for full backups.

UseHardware

Compression Indicates that tape library must perform hardware compression for archives. Do not use this option for archiving Veeam backups or other already compressed files.

(42)

WaitPeriod Used to set time period for the

WaitForBackupJob parameter.

Specifies the time period for which the tape job must wait for the source backup jobs to finish.

Can be set to 1-777 minutes.

Accepts TipeSpan, integer or string types.

WaitFor BackupJob

Indicates that the tape job must wait for the source backup job to finish. Use the

WaitPeriod parameter to set the time period.

Notification Options

Specifies the email notification options. Accepts VBRNotificationOptions object.

JobScript Options

Specifies scripting options.

Accepts VBRJobScriptOptions object.

CopyFrom LatestFull

Indicates that on the first run the tape job must copy only the latest backup chain.

Otherwise,on the first run the job will copy all restore points produced by the source backup job(s) that are available on disk.

AlwaysCopy FromLatest Full

Indicates that on each run the tape job must copy only the latest backup chain. Otherwise, on each run the tape job will copy all restore points produced by the source backup job(s) that are available on disk.

GFS Schedule Options

Specifies the schedule settings for the GFS media pool.

Accepts the VBRTapeGFSScheduleOptions object.

(43)

Example

This example shows how to create a tape job that has a backup job as source. The tape job will use the same media pool to back up full and incremental backups.

1. Run Get-VBRJob to get the backup job that will be the source. Save the job to the $sqljob variable.

2. Run Get-VBRTapeMediaPool to get the media pool. Use the same media pool to write full and incremental backups. Save the media pool to the $mediapool variable.

3. Create an object containing the job schedule. First run New-VBRDailyOptions to set the day and time. Save the result to the $dailyoptions variable. Then run

New-VBRBackupToTapeScheduleOptions to create the schedule object. Save the schedule to the $scheduleoptions variable.

4. Run Add-VBRBackupToTapeJob to create the tape job. Use the saved variables. PS C:\PS> $sqljob = Get-VBRJob -Name "SQL 1 Backup"

PS C:\PS> $mediapool = Get-VBRTapeMediaPool -Name "SQL Backups Media Pool" PS C:\PS> $dailyoptions = New-VBRDailyOptions -DayOfWeek Friday -Period 23:00

PS C:\PS> $scheduleoptions = NewVBRBackupToTapeScheduleOptions -DailyOptions $dailyoptions -Enabled

PS C:\PS> Add-VBRBackupToTapeJob -Name "SQL to Tape" -Description "SQL archive" Object $sqljob FullBackupMediaPool $mediapool

-ProcessIncrementalBackup -IncrementalBackupMediaPool $mediapool -ExportDays Monday -ScheduleOptions $scheduleoptions

(44)

Add-VBRCloudGateway

Short Description

Adds a new cloud gateway.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus Requires a cloud provider license.

Syntax

Add-VBRCloudGateway [-Description <string>] [-Server <CHost>] [-IpAddress <ipaddress>] [-IncomingPort <int>] [-NATPort <int>] [-NetworkMode

<VBRGatewayNetworkMode> {Direct | NAT}] [<CommonParameters>]

Related Commands

Get-VBRServer

Return Type

VBRCloudGateway

Detailed Description

This cmdlet creates a cloud gateway.

Parameters

Input

Accept Wildcard Characters Description Specifies the description of the cloud gateway.

Server Specifies server that will perform the role of a cloud gateway. You can select any server added to Veeam Backup & Replication on assign the cloud gateway role to the Veeam backup server itself.

Accepts CHost object.

Accepted server types: Windows, Local. Default: Local.

IpAddress Specifies an external IP address of the NAT or network interface gateway.

Accepts IPAddress object or string type.

(45)

Port backup server to connect to the gateway. Accepts int type.

Permitted values: 1 to 65535. Default: 6180.

NATPort Specifies a port on the NAT gateway used for listening to connections from users and passing cloud commands from users to the SP Veeam backup server.

Accepts int type.

Permitted values: 1 to 65535.

Default: (for Direct) null, (for NAT) 8080.

Network Mode

Specifies the network mode: Direct, NAT. False Named False False

Example 1

This command adds a new cloud gateway with a direct network connection.

• The server that will be used as the cloud gateway is obtained with Get-VBRServer and assigned to the '$server' variable beforehand.

• The external network gateway IP is 104.45.95.227.

• The port that will be used by Veeam Backup & Replication to connect to the gateway server is '6260'.

• The network mode is set to 'Direct'.

PS C:\PS> Add-VBRCloudGateway -Server $server -Description "Gateway

directly connected to Internet" -IpAddress 104.45.85.123 -IncomingPort 6260 -NetworkMode Direct

Example 2

This command adds a new cloud gateway in the local network behind the NAT gateway. • The server that will be used as the cloud gateway is obtained with Get-VBRServer and

assigned to the '$server' variable beforehand. • The external NAT gateway IP is 104.45.95.227.

• The port that will be used by Veeam Backup & Replication to connect to the gateway server is '6180'.

• The port that will be used by the NAT gateway is '7180'. • The network mode is set to 'NAT'.

PS C:\PS> Add-VBRCloudGateway -Server $server -Description "Gateway behind NAT" -IpAddress 104.45.95.227 -IncomingPort 6180 -NATPort 7180 -NetworkMode NAT

(46)

Add-VBRCloudGatewayCertificate

Short Description

Sets the SSL certificate on the service provider side.

Applies to

Syntax

Add-VBRCloudGatewayCertificate -Certificate <VBRCloudCertificate> [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Get-VBRCloudGatewayCertificate

Detailed Description

This cmdlet sets the SSL certificate on the service provider side. This certificate will be used to authenticate with the users.

Parameters

Input

Accept Wildcard Characters Certificate Specifies the certificate you want to

use. True Named True (by Value FromPipeline,

ValueFromPipeline ByPropertyName)

False

WhatIf Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

Confirm Specifies whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.

veeam_backup_9_0_powershell_reference_en.pdf

Veeam Backup PowerShell

Version 9.0

Reference

CONTENTS

CONTACTING VEEAM SOFTWARE

Customer Support

Company Contacts

Online Support

GETTING STARTED

Starting Veeam PowerShell Sessions

Understanding Veeam Cmdlets

Platform

Input and Output

Using Get-VBRCommand

Using Get-Help

Examples of Use

PowerShell Remoting

VEEAM POWERSHELL CMDLETS

Add-HP3Snapshot

Short Description

Applies to

Syntax

Related Commands

Detailed Description

Parameters

Example 1

Example 2

Add-HP3Storage

Short Description

Applies to

Syntax

Related Commands

Detailed Description

Parameters

Example 1

Example 2

Add-HP4Snapshot

Short Description

Applies to

Syntax

Related Commands

Detailed Description

Alias

Parameters

Example 1

Example 2

Add-HP4Storage

Short Description

Applies to

Syntax

Related Commands

Detailed Description

Alias

Parameters

Example 1

Example 2

Add-NetAppHost

Short Description

Applies to

Syntax

Related Commands

Detailed Description

Parameters

Example 1

Example 2

Add-NetAppSnapshot

Short Description

Applies to

Syntax

Related Commands

Detailed Description

Parameters

Example

Add-VBRBackupRepository

Short Description

Applies to

Syntax

Related Commands

Detailed Description