Getting Started

In this article

    Veeam Backup for Microsoft 365 solution comes with four PowerShell modules:

    • Veeam.Archiver.PowerShell for Veeam Backup for Microsoft 365
    • Veeam.Exchange.PowerShell as part of Veeam Explorer for Microsoft Exchange
    • Veeam.Sharepoint.PowerShell as part of Veeam Explorer for Microsoft SharePoint and Veeam Explorer for Microsoft OneDrive for Business
    • Veeam.Teams.PowerShell as part of Veeam Explorer for Microsoft Teams

    These modules include sets of related PowerShell cmdlets that allow you to perform backup, backup copy, retrieve, configuration and restore operations. Modules are installed by default as part of Veeam Backup for Microsoft 365 and Veeam Explorers.

    Mind that actions performed with PowerShell have the same force as actions performed in user interface. For example, if you delete a job with a PowerShell script, the job will be removed from the Veeam Backup for Microsoft 365 database. You will not be able to undo changes.

    Requirements

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

    Starting Veeam Backup for Microsoft 365 PowerShell Sessions

    You can run Veeam Backup for Microsoft 365 PowerShell sessions locally or from a remote machine. The remote machine must have the Veeam Backup for Microsoft 365 console installed.

    You can open the PowerShell console in Veeam Backup for Microsoft 365 or in Windows PowerShell

    PowerShell Sessions in Veeam Backup for Microsoft 365

    You can start a PowerShell session directly from Veeam Backup for Microsoft 365 user interface.

    In this case, you will be able to perform actions with Veeam Backup for Microsoft 365 cmdlets without any additional configuration steps. As soon as you run a PowerShell session from Veeam Backup for Microsoft 365, all related PowerShell modules are automatically imported into an active memory.

    To start a PowerShell session, click Console > PowerShell in the main menu of Veeam Backup for Microsoft 365.

    PowerShell Sessions in Windows PowerShell

    When you install Veeam Backup for Microsoft 365 and Veeam Explorers, all related PowerShell modules are automatically imported into an active memory. If your PowerShell session was opened before you start installation of Veeam Backup for Microsoft 365, run the Import-Module cmdlet to import the Veeam.Archiver.PowerShell module and Veeam Explorers modules. For example:

    Import-Module "C:\Program Files\Veeam\Backup365\Veeam.Archiver.PowerShell\Veeam.Archiver.PowerShell.psd1"

    Import-Module "C:\Program Files\Veeam\Backup and Replication\Explorers\Exchange\Veeam.Exchange.PowerShell\Veeam.Exchange.PowerShell.psd1"

    Import-Module "C:\Program Files\Veeam\Backup and Replication\Explorers\SharePoint\Veeam.SharePoint.PowerShell\Veeam.SharePoint.PowerShell.psd1"

    Import-Module "C:\Program Files\Veeam\Backup and Replication\Explorers\Teams\Veeam.Teams.PowerShell\Veeam.Teams.PowerShell.psd1"

    To use Veeam Backup for Microsoft 365 cmdlets, do the following:

    1. Start a PowerShell session on a machine that has the Veeam Backup for Microsoft 365 PowerShell installed.
    2. Connect to a local or remote Veeam Backup for Microsoft 365 server.

    For more information on how to connect to a Veeam Backup for Microsoft 365 server, see Managing Veeam Backup for Microsoft 365 Server.

    In This Section