Veeam Backup & Replication comes with the PowerShell extension — a Veeam Backup PowerShell module that is added to your machine when you either install Veeam Backup & Replication server or the Veeam Backup & Replication Console. The Veeam Backup PowerShell module 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 using 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. In order to run Veeam PowerShell commands, you must start a PowerShell session.
Veeam PowerShell Reference does not document internal .NET classes and methods.
Consider the following requirements:
- To run Veeam PowerShell cmdlets, you must have Veeam Backup Administrator role. For more information, see Users and Roles.
- A machine that runs the PowerShell session must have Windows PowerShell version 5.1 installed.
Starting Veeam PowerShell Sessions
You can run Veeam PowerShell sessions using the following options:
- Run Veeam PowerShell session from Veeam Backup server
- Run Veeam PowerShell session from remote machine
You can start a Veeam PowerShell session either using the Veeam Backup & Replication UI, or directly from the Windows PowerShell console installed on your machine.
- Using the Veeam Backup & Replication UI: in the main menu of Veeam Backup & Replication, select Console > PowerShell.
- From Windows PowerShell console: start the console on your machine. For more information on starting the console, see Microsoft Docs.
The remote machine from which you run Veeam PowerShell commands must have the Veeam Backup & Replication Console installed. After you install the Veeam Backup & Replication Console, Veeam PowerShell module will be installed by default. For more information on how to install the Veeam Backup & Replication Console, see the Installing Veeam Backup & Replication Console section in the User Guide for VMware vSphere. After that you can run Veeam PowerShell cmdlets from a Veeam Backup & Replication Console, or directly from Windows PowerShell console installed on your machine.
To start the Veeam PowerShell session from a remote machine, you must connect to a local or a remote Veeam backup server. For more information on how to connect to a Veeam backup server, see Connecting to Veeam Backup Server.
To verify that Veeam PowerShell module is installed on your machine, run the Get-Module -Name Veeam.Backup.PowerShell -ListAvailable command. The cmdlet will return information on this module.
In This Section