Getting Started

In this article

    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.

    Requirements

    A machine that runs the PowerShell session must have Windows PowerShell version 5.1 or later installed.

    Starting Veeam PowerShell Sessions

    You can run Veeam PowerShell sessions using the following options:

    Running Veeam PowerShell Session from Veeam Backup Server

    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.

    Starting PowerShell Session

    Running Veeam PowerShell Session from Remote Machine

    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.

    Tip

    To verify that Veeam PowerShell module is installed on your machine, run the Get-Module -Name Veeam.Backup.PowerShell command. The cmdlet will return information on this module.

    In This Section