Starting PowerShell Sessions from PowerShell Console
You can run Veeam Explorers cmdlets from the PowerShell command-line shell.
Using Veeam Explorers Cmdlets for Backups and Replicas Created with Veeam Backup & Replication
You can run Veeam Explorers cmdlets on machines where the Veeam Backup & Replication console is installed and on Linux machines.
Machines With Veeam Backup & Replication Console
To use Veeam Explorers cmdlets on a machine where the Veeam Backup & Replication console is installed, perform the following steps:
- Start a PowerShell session. For more information on starting the session, see Microsoft Docs.
- Check whether Veeam Backup PowerShell module is installed on your machine by running the following command:
Get-Module -Name Veeam.Backup.PowerShell |
- Run the Connect-VBRServer cmdlet to connect to a local or remote backup server.
To use Veeam Explorers cmdlets on a Linux machine, perform the following steps:
- Create optional Linux repository:
dnf install https://www.veeam.com/veeam-optional-release-latest-13.0.noarch.rpm -y |
- Install the Veeam Explorers PowerShell modules:
dnf install veeam-vbr-pkg-mount.x86_64 veeam-vbr-pkg-transport.x86_64 veeam-vbr-pkg-deployment.x86_64 -y dnf install /opt/veeam/vbr/Packages/veeamdeployment-<vbr_version> -y dnf install /opt/veeam/vbr/Packages/veeamtransport-<vbr_version> -y dnf install /opt/veeam/vbr/Packages/veeam-mount-<vbr_version> -y |
where <vbr_version> is the version whose module you want to install. For example, 13.0.0.4999.
- Run the Import-Module cmdlet to import the necessary PowerShell module. For example, to import all Veeam Explorer modules available on Linux machines, run the following commands:
Import-Module /opt/veeam/veeam-saphana-powershell/Veeam.SapHana.PowerShell/Veeam.SapHana.PowerShell.psd1 Import-Module /opt/veeam/veeam-oracle-powershell/Veeam.Oracle.PowerShell/Veeam.Oracle.PowerShell.psd1 Import-Module /opt/veeam/veeam-postgresql-powershell/Veeam.PostgreSQL.PowerShell/Veeam.PostgreSQL.PowerShell.psd1 Import-Module /opt/veeam/veeam-mongodb-powershell/Veeam.MongoDB.PowerShell/Veeam.MongoDB.PowerShell.psd1 |
The remaining Veeam Explorers PowerShell modules are not supported on Linux machines.
- Run the Connect-VBRServer cmdlet to connect to a backup server.
Using Veeam Explorers Cmdlets for Backups Created with Veeam Backup for Microsoft 365
When you install Veeam Backup for Microsoft 365 and Veeam Explorers, all related PowerShell modules are automatically imported into the 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 Explorer cmdlets for Veeam Backup for Microsoft 365, perform the following steps:
- Start a PowerShell session on a machine that has Veeam Backup for Microsoft 365 PowerShell installed. For more information on starting the session, see Microsoft Docs.
- Connect to a local or remote Veeam Backup for Microsoft 365 server.
For more information on how to connect to Veeam Backup for Microsoft 365 server, see Connect-VBOServer.