Getting Started - Veeam Backup PowerShell Reference
Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Getting Started

Veeam Backup & Replication comes with PowerShell extension — a snap-in to Microsoft Windows PowerShell. The Veeam Backup PowerShell snap-in allows you to do almost all operations that are available in the user interface. 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. You will not be able to undo changes.

Requirements

Supports Windows PowerShell version 2.0 or later.

Getting Started Note:

We recommend that you use Windows PowerShell version 4.0 as more reliable for performing actions with Veeam PowerShell cmdlets.

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 in Veeam Backup & Replication or in Microsoft Windows.

PowerShell Sessions in Veeam Backup & Replication

To open the PowerShell console in Veeam Backup & Replication, in the main menu select Console > PowerShell. In this case, you will be able to run PowerShell sessions and perform actions with Veeam Backup & Replication cmdlets without adding the Veeam PSSnapIn into active memory. Veeam Backup & Replication does it automatically.

PowerShell Sessions in Microsoft Windows

To start the PowerShell session from the Windows PowerShell console, do the following:

  1. Add the Veeam PSSnapIn to get access to the Veeam Backup & Replication cmdlets library. Run the following command:

PS C:\PS> Add-PSSnapin VeeamPSSnapin

  1. Connect to local or remote Veeam backup server. See Connecting to Veeam Backup Server.

In This Section

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Backup Explorers User Guide

Backup and Restore of SQL Server Databases

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation