Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
Veeam Explorers PowerShell Reference

Starting from Windows PowerShell

You can run Veeam Exploreres cmdlets from the Windows PowerShell or Windows PowerShell ISE command-line shell. In this case, you must:

  • Add the Veeam PowerShell snap-in into the PowerShell console beforehand.

For more information on the Veeam PowerShell snap-in, see the Getting Started section of the PowerShell Reference.

  • [For Windows PS 2.0 and lower] Manually import all related PowerShell modules into active memory of your machine.

For more information on modules that can be installed with Veeam Explorers, see Getting started.

Using Veeam Explorer Cmdlets for Backups and Replicas Created with Veeam Backup & Replication

To use Veeam Explorers cmdlets for Veeam Backup & Replication:

  1. Start a PowerShell session on a machine that has the Veeam Backup & Replication solution or the Veeam Backup for Microsoft Office 365 Console component installed.
  2. Run the Add-PSSnapin cmdlet to add the Veeam PowerShell snap-in.

Add-PSSnapin VeeamPSSnapin

  1. Run the Connect-VBRServer cmdlet to connect to a local or remote Veeam backup server.

To learn how to connect to a Veeam backup server, see the Connecting to Veeam Backup Server section in the Veeam PowerShell Reference.

  1. Run the Import-Module cmdlet to import the necessary PowerShell module. For example, to import all Veeam Explorer modules, run the following commands:

Import-Module Veeam.Exchange.PowerShell

Import-Module Veeam.Sharepoint.PowerShell

Import-Module Veeam.Oracle.PowerShell

Import-Module Veeam.SQL.PowerShell

Using Veeam Explorers Cmdlets for Backups Created with Veeam Backup for Microsoft Office 365

To use Veeam Explorer cmdlets to manage application items backed up with Veeam Backup for Microsoft Office 365, perform the following steps:

  1. Start a PowerShell session on a machine that has the Veeam Backup for Microsoft Office 365 PowerShell installed.
  2. Run the Import-Module cmdlet to import the Veeam.Archiver.PowerShell module.

Import-Module Veeam.Archiver.PowerShell

  1. Run the Import-Module cmdlet to import the necessary PowerShell module. For example, to import all Veeam Explorer modules, run the following commands:

Import-Module Veeam.Exchange.PowerShell

Import-Module Veeam.Sharepoint.PowerShell

Import-Module Veeam.Oracle.PowerShell

Import-Module Veeam.SQL.PowerShell

  1. Connect to a local or remote Veeam Backup for Microsoft Office 365 server.

To learn how to connect to a Veeam Backup for Microsoft Office 365 server, see the Connecting to Veeam Backup for Microsoft Office 365 section of the PowerShell Reference.

 

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 Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation