A-Z Cmdlets List
Add
Add-VBOAmazonS3AccountCreates Amazon S3 storage account credentials.Add-VBOAmazonS3CompatibleAccountCreates S3 Compatible storage account credentials.Add-VBOAmazonS3CompatibleObjectStorageRepositoryAdds S3 Compatible object storage repository to the Veeam Backup for Microsoft 365 infrastructure. In Veeam Backup for Microsoft 365 8, this cmdlet became deprecated. Use the New-VBOAmazonS3CompatibleObjectStorageSettings and Add-VBOAmazonS3CompatibleRepository cmdlets instead.Add-VBOAmazonS3CompatibleRepositoryAdds S3 Compatible object storage repository to the Veeam Backup for Microsoft 365 infrastructure.Add-VBOAmazonS3FolderCreates Amazon S3 folders.Add-VBOAmazonS3GlacierRepositoryAdds Amazon S3 object storage repository (Amazon S3 Glacier Instant Retrieval, Amazon S3 Glacier Flexible Retrieval and Amazon S3 Glacier Deep Archive storage classes) to the Veeam Backup for Microsoft 365 infrastructure.Add-VBOAmazonS3ObjectStorageRepositoryAdds Amazon S3 object storage repository to the Veeam Backup for Microsoft 365 infrastructure. In Veeam Backup for Microsoft 365 8, this cmdlet became deprecated. Use the New-VBOAmazonS3ObjectStorageSettings, and Add-VBOAmazonS3Repository or Add-VBOAmazonS3GlacierRepository cmdlets instead.Add-VBOAmazonS3RepositoryAdds Amazon S3 object storage repository (Amazon S3 Standard, Amazon S3 Standard-Infrequent Access and Amazon S3 One Zone-Infrequent Access storage classes) to the Veeam Backup for Microsoft 365 infrastructure.Add-VBOAzureArchiveRepositoryAdds Azure Blob Storage Archive to the Veeam Backup for Microsoft 365 infrastructure.Add-VBOAzureBlobAccountCreates Microsoft Azure Blob Storage account credentials.Add-VBOAzureBlobFolderCreates Microsoft Azure Blob folders.Add-VBOAzureBlobObjectStorageRepositoryAdds Azure Blob Storage to the Veeam Backup for Microsoft 365 infrastructure. In Veeam Backup for Microsoft 365 8, this cmdlet became deprecated. Use the New-VBOAzureBlobObjectStorageSettings, and Add-VBOAzureBlobRepository or Add-VBOAzureArchiveRepository cmdlets instead.Add-VBOAzureBlobRepositoryAdds Azure Blob Storage to the Veeam Backup for Microsoft 365 infrastructure.Add-VBOAzureServiceAccountCreates Microsoft Azure service accounts that are required to use the Azure archiver appliance when transferring backed-up data between different instances of Azure Blob Storage or to Azure Blob Storage Archive.Add-VBOBackupApplicationAdds backup application settings to an application pool.Add-VBOBackupItemAdds a list of objects to a backup job.Add-VBOCopyJobCreates a backup copy job.Add-VBOEncryptionKeyCreates encryption keys for object storage repositories.Add-VBOExcludedBackupItemCreates a list of objects excluded from a backup job.Add-VBOFederatedAuthenticationAuthorityAdds an external authentication provider.Add-VBOJobCreates a backup job.Add-VBOOrganizationAdds Microsoft organizations to the Veeam Backup for Microsoft 365 infrastructure.Add-VBOOrganizationRetentionExclusionAdds retention policy settings for contacts and calendars of a specific organization.Add-VBOProxyAdds a backup proxy server to the Veeam Backup for Microsoft 365 infrastructure.Add-VBOProxyPoolAdds a backup proxy pool to the Veeam Backup for Microsoft 365 infrastructure.Add-VBORbacRoleAdds a restore operator role to Veeam Backup for Microsoft 365.Add-VBORepositoryAdds a JET-based backup repository or an object storage repository to the Veeam Backup for Microsoft 365 infrastructure.
Connect
Connect-VBOServerConnects to the Veeam Backup for Microsoft 365 server.
Disable
Disable-VBOCopyJobTemporarily disables a backup copy job.Disable-VBOJobTemporarily disables a backup job.
Disconnect
Disconnect-VBOServerEnds current PowerShell session with the Veeam Backup for Microsoft 365 server.
Enable
Enable-VBOCopyJobEnables a backup copy job.Enable-VBOJobEnables a backup job.
Export
Export-VBOJobLogExports the Veeam Backup for Microsoft 365 job log files.Export-VBOLogExports the Veeam Backup for Microsoft 365 server log files.
Get
Get-VBOAmazonInstanceTypeReturns an instance type that the Amazon archiver appliance will use.Get-VBOAmazonS3AccountReturns Amazon S3 storage account credentials.Get-VBOAmazonS3BucketReturns Amazon S3 buckets.Get-VBOAmazonS3CompatibleAccountReturns S3 Compatible storage account credentials.Get-VBOAmazonS3FolderReturns Amazon S3 folders.Get-VBOAmazonSecurityGroupReturns a security group that will be associated with the Amazon archiver appliance.Get-VBOAmazonSubnetReturns the Amazon archiver appliance subnet.Get-VBOAmazonVPCReturns the Amazon Virtual Private Cloud (Amazon VPC).Get-VBOApplicationReturns Microsoft Entra applications added to Microsoft 365 organizations.Get-VBOAzureBlobAccountReturns Microsoft Azure Blob Storage account credentials.Get-VBOAzureBlobContainerReturns Microsoft Azure Blob containers.Get-VBOAzureBlobFolderReturns Microsoft Azure Blob folders.Get-VBOAzureLocationReturns a Microsoft Entra region.Get-VBOAzureResourceGroupReturns a resource group that will be associated with the Azure archiver appliance.Get-VBOAzureServiceAccountReturns Microsoft Azure service account details.Get-VBOAzureSubNetReturns the Azure archiver appliance subnet.Get-VBOAzureSubscriptionReturns Microsoft Azure subscriptions associated with a user account that will be used to access Azure Blob Storage.Get-VBOAzureVirtualMachineSizeReturns the Azure archiver appliance size.Get-VBOAzureVirtualNetworkReturns a network to which the Azure archiver appliance will be connected.Get-VBOBackupApplicationReturns backup application settings that are added to Microsoft organizations.Get-VBOBackupItemReturns a list of objects included in a backup job.Get-VBOCommandReturns a set of the available cmdlets.Get-VBOCopyJobReturns backup copy jobs.Get-VBODataManagementSessionReturns entity data management sessions.Get-VBODataRetrievalReturns retrieval jobs.Get-VBODataRetrievalObjectReturns objects whose backed-up data was retrieved from an object storage repository by retrieval job.Get-VBODataRetrievalSessionReturns data retrieval sessions.Get-VBOEmailSettingsReturns email notification settings. Email notifications are sent from a backup proxy server upon each execution of a backup or backup copy job.Get-VBOEncryptionKeyReturns encryption keys.Get-VBOEntityDataReturns a user, group, site, team or organization backed-up data.Get-VBOExcludedBackupItemReturns a list of objects excluded from a backup job.Get-VBOFederatedAuthenticationAuthorityReturns external authentication providers.Get-VBOFolderExclusionsReturns folder exclusion settings.Get-VBOGlobalRetentionExclusionReturns global retention policy settings for contacts and calendars.Get-VBOHistorySettingsReturns history settings for backup and backup copy job sessions.Get-VBOInternetProxySettingsReturns global internet proxy server settings.Get-VBOJobReturns backup jobs.Get-VBOJobSessionReturns backup and backup copy job sessions.Get-VBOLicenseReturns an installed product license for Veeam Backup for Microsoft 365.Get-VBOLicensedUserReturns licensed Veeam Backup for Microsoft 365 users.Get-VBOLicenseOverviewReportGenerates reports on the Veeam Backup for Microsoft 365 license usage.Get-VBOMailboxProtectionReportGenerates reports on protected and unprotected mailboxes of the Microsoft 365 and on-premises Microsoft Exchange organizations.Get-VBOObjectStorageRepositoryReturns object storage repositories added to the Veeam Backup for Microsoft 365 infrastructure. In Veeam Backup for Microsoft 365 8, this cmdlet became deprecated. Use the Get-VBORepository cmdlet instead.Get-VBOOperatorAuthenticationSettingsReturns restore operator authentication settings.Get-VBOOrganizationReturns Microsoft organizations added to the Veeam Backup for Microsoft 365 infrastructure.Get-VBOOrganizationGroupReturns organization groups.Get-VBOOrganizationGroupMemberReturns members of organization groups.Get-VBOOrganizationRetentionExclusionReturns retention policy settings for contacts and calendars of a specific organization.Get-VBOOrganizationSiteReturns organization sites.Get-VBOOrganizationSynchronizationStateReturns status of synchronization of Microsoft organization objects with the organization cache database. Synchronization of objects with the organization cache database is only available for Microsoft organizations with modern app-only authentication.Get-VBOOrganizationTeamReturns organization teams.Get-VBOOrganizationUserReturns organization users.Get-VBOProxyReturns backup proxy servers added to the Veeam Backup for Microsoft 365 infrastructure.Get-VBOProxyPoolReturns backup proxy pools added to the Veeam Backup for Microsoft 365 infrastructure.Get-VBORbacRoleReturns settings of restore operator roles.Get-VBORepositoryReturns backup repositories.Get-VBORepositoryMaintenanceSessionReturns maintenance sessions started for backup repositories.Get-VBORepositoryOwnerChangeSessionReturns a change owner session started to move a backup repository to another backup proxy server or backup proxy pool.Get-VBORepositorySynchronizeSessionReturns sessions that are running to synchronize cache between object storage repositories and the PersistentCache database on the PostgreSQL instance.Get-VBORepositoryUpgradeSessionReturns sessions started to upgrade backup repositories.Get-VBORestAPISettingsReturns REST API settings.Get-VBORestorePointReturns restore points.Get-VBORestorePortalSettingsReturns connection settings to access Restore Portal.Get-VBORestoreSessionReturns Veeam Backup for Microsoft 365 restore sessions.Get-VBOSecuritySettingsReturns security settings.Get-VBOServerReturns information about the Veeam Backup for Microsoft 365 server.Get-VBOServerComponentsReturns components of the Veeam Backup for Microsoft 365 server.Get-VBOStorageConsumptionReportGenerates reports on the Veeam Backup for Microsoft 365 storage consumption.Get-VBOTenantAuthenticationSettingsReturns the Veeam Backup for Microsoft 365 tenant authentication settings.Get-VBOUsageDataReturns information on the used space in backup repositories.Get-VBOUserProtectionReportGenerates reports on protected and unprotected user accounts of the Microsoft 365 and on-premises Microsoft organizations.Get-VBOVersionReturns Veeam Backup for Microsoft 365 version.Get-VBOVersionBackupOptionsReturns the version backup options for Microsoft organizations.
Install
Install-VBOLicenseInstalls the license on the Veeam Backup for Microsoft 365 server.
Move
Move-VBOEntityDataMoves organization data from a JET-based backup repository to another JET-based backup repository or object storage repository.
New
New-VBOAmazonArchiverApplianceDefines the Amazon archiver appliance settings.New-VBOAmazonS3CompatibleConnectionSettingsDefines connection settings to S3 Compatible object storage repository.New-VBOAmazonS3CompatibleObjectStorageSettingsDefines the S3 Compatible object storage repository settings.New-VBOAmazonS3ConnectionSettingsDefines connection settings to Amazon S3 object storage repository.New-VBOAmazonS3ObjectStorageSettingsDefines the Amazon S3 object storage repository settings.New-VBOAmazonS3ServiceConnectionSettingsDefines connection settings to Amazon S3 object storage repository. In Veeam Backup for Microsoft 365 8, this cmdlet became deprecated. Use the New-VBOAmazonS3ConnectionSettings cmdlet to define connection settings to Amazon S3 object storage repository.New-VBOAzureArchiverApplianceDefines the Azure archiver appliance settings.New-VBOAzureBlobConnectionSettingsDefines connection settings to Microsoft Azure Blob Storage.New-VBOAzureBlobObjectStorageSettingsDefines the Azure Blob Storage settings.New-VBOBackupAccountCreates auxiliary backup accounts to back up SharePoint and OneDrive.New-VBOBackupApplicationDefines backup application settings to back up SharePoint and OneDrive.New-VBOBackupItemCreates organization objects.New-VBOBackupWindowSettingsCreates a backup window.New-VBOCopyJobSchedulePolicyCreates a backup copy job schedule.New-VBOJobSchedulePolicyCreates a backup job schedule.New-VBOLinuxCredentialCreates the Linux credentials record to connect to a Linux-based backup proxy server.New-VBOOffice365ApplicationOnlyConnectionSettingsDefines Microsoft Entra application settings.New-VBOOffice365ConnectionSettingsDefines connection settings to access Microsoft 365 organizations.New-VBOOnPremConnectionSettingsDefines connection settings to access on-premises Microsoft organizations.New-VBORbacOperatorDefines users or groups that will act as restore operators.New-VBORbacRoleItemDefines Microsoft 365 organization users, groups, sites or teams that will be managed by restore operators or excluded.
Remove
Remove-VBOAmazonS3AccountRemoves Amazon S3 storage account credentials from Veeam Backup for Microsoft 365.Remove-VBOAmazonS3CompatibleAccountRemoves S3 Compatible storage account credentials from Veeam Backup for Microsoft 365.Remove-VBOAzureBlobAccountRemoves Microsoft Azure Blob Storage account credentials.Remove-VBOAzureServiceAccountRemoves Microsoft Azure service accounts.Remove-VBOBackupApplicationRemoves backup application settings from Microsoft organizations.Remove-VBOBackupItemRemoves an object from a backup job.Remove-VBOCopyJobRemoves backup copy jobs.Remove-VBOEncryptionKeyRemoves encryption keys.Remove-VBOEntityDataRemoves an organization entity data from a backup repository including an object storage repository that was specified as a target for backup copy jobs.Remove-VBOExcludedBackupItemRemoves objects from a list of exclusions specified for a backup job.Remove-VBOFederatedAuthenticationAuthorityRemoves external authentication providers.Remove-VBOJobRemoves backup jobs.Remove-VBOLicensedUserRemoves licenses from Veeam Backup for Microsoft 365 users. You must remove user data from the backup repository before removing a license from Veeam Backup for Microsoft 365 users. Run the Remove-VBOEntityData cmdlet to remove the user data.Remove-VBOObjectStorageRepositoryRemoves an object storage repository from the Veeam Backup for Microsoft 365 infrastructure. In Veeam Backup for Microsoft 365 8, this cmdlet became deprecated. Use the Remove-VBORepository cmdlet with the Force:$true parameter instead.Remove-VBOOrganizationRemoves Microsoft organizations from the Veeam Backup for Microsoft 365 infrastructure. Before removing an organization, make sure all jobs that are configured for that organization are set to the Disabled state.Remove-VBOOrganizationRetentionExclusionRemoves retention policy settings for contacts and calendars of a specific organization.Remove-VBOProxyRemoves backup proxy servers.Remove-VBOProxyPoolRemoves backup proxy pools.Remove-VBORbacRoleRemoves restore operator roles from Veeam Backup for Microsoft 365.Remove-VBORepositoryRemoves backup repositories.
Set
Set-VBOAmazonS3AccountModifies Amazon S3 storage account credentials.Set-VBOAmazonS3CompatibleAccountModifies S3 Compatible storage account credentials.Set-VBOAmazonS3CompatibleRepositoryModifies settings of S3 Compatible object storage repository.Set-VBOAmazonS3GlacierRepositoryModifies settings of Amazon S3 object storage repository (Amazon S3 Glacier Instant Retrieval, Amazon S3 Glacier Flexible Retrieval and Amazon S3 Glacier Deep Archive storage classes).Set-VBOAmazonS3RepositoryModifies settings of Amazon S3 object storage repository (Amazon S3 Standard, Amazon S3 Standard-Infrequent Access and Amazon S3 One Zone-Infrequent Access storage classes).Set-VBOAzureArchiveRepositoryModifies settings of Azure Blob Storage Archive.Set-VBOAzureBlobAccountModifies Microsoft Azure Blob Storage account credentials.Set-VBOAzureBlobRepositoryModifies settings of Azure Blob Storage.Set-VBOAzureServiceAccountModifies Microsoft Azure service account settings.Set-VBOBackupApplicationModifies backup application settings that are added to Microsoft organizations.Set-VBOBackupItemModifies organization object settings.Set-VBOBackupWindowSettingsModifies the backup window settings.Set-VBOConfigurationParameterModifies configuration of the Veeam Backup for Microsoft 365 controller, backup proxy servers and backup proxy pools.Set-VBOCopyJobModifies settings of a backup copy job.Set-VBOCopyJobSchedulePolicyModifies the backup copy job schedule settings.Set-VBODataRetrievalModifies retrieval job settings.Set-VBOEmailSettingsModifies email notification settings. Email notifications are sent from a backup proxy server upon each execution of a backup or backup copy job.Set-VBOFolderExclusionsModifies folder exclusion settings.Set-VBOGlobalRetentionExclusionModifies global retention policy settings for contacts and calendars.Set-VBOHistorySettingsModifies history settings for backup and backup copy job sessions.Set-VBOInternetProxySettingsModifies global internet proxy server settings.Set-VBOJobModifies settings of a backup job.Set-VBOJobSchedulePolicyModifies the backup job schedule settings.Set-VBOObjectStorageRepositoryModifies settings of an object storage repository added to the Veeam Backup for Microsoft 365 infrastructure. In Veeam Backup for Microsoft 365 8, this cmdlet became deprecated. Use the Set-VBOAmazonS3Repository, Set-VBOAmazonS3CompatibleRepository, Set-VBOAmazonS3GlacierRepository, Set-VBOAzureBlobRepository and Set-VBOAzureArchiveRepository cmdlets instead.Set-VBOOffice365ApplicationOnlyConnectionSettingsModifies Microsoft Entra application settings.Set-VBOOffice365ConnectionSettingsModifies connection settings to access Microsoft 365 organizations.Set-VBOOnPremConnectionSettingsModifies connection settings to access on-premises Microsoft organizations.Set-VBOOperatorAuthenticationSettingsModifies restore operator authentication settings.Set-VBOOrganizationModifies Microsoft organization settings.Set-VBOOrganizationRetentionExclusionModifies retention policy settings for contacts and calendars of a specific organization.Set-VBOProxyModifies settings of a backup proxy server.Set-VBOProxyMaintenanceEnables or disables maintenance mode for backup proxy servers that are already added to a backup proxy pool.Set-VBOProxyPoolModifies settings of a backup proxy pool.Set-VBOPSQLDatabaseServerLimitsModifies settings of the PostgreSQL instance.Set-VBORbacRoleModifies settings of restore operator roles that are added to Veeam Backup for Microsoft 365.Set-VBORepositoryModifies settings of a backup repository.Set-VBORestAPISettingsModifies REST API settings.Set-VBORestorePortalSettingsModifies connection settings to access Restore Portal.Set-VBOSecuritySettingsModifies security settings.Set-VBOServerAllows you to specify temporary storage for export and save operations.Set-VBOServerComponentsEnables or disables the extended logging mode and distributed tracing for an array of the Veeam Backup for Microsoft 365 server components.Set-VBOTenantAuthenticationSettingsModifies the Veeam Backup for Microsoft 365 tenant authentication settings.Set-VBOVersionBackupOptionsModifies the version backup options for Microsoft organizations.
Start
Start-VBOCopyJobStarts backup copy jobs.Start-VBODataRetrievalCreates and starts retrieval jobs. Data retrieval is unavailable for Amazon S3 Glacier Instant Retrieval storage class. You can explore and restore data directly from backup copies using Veeam Explorers.Start-VBOJobStarts backup jobs.Start-VBOOrganizationSynchronizationStarts to synchronize Microsoft organization objects with the organization cache database. Synchronization of objects with the organization cache database is only available for Microsoft organizations with modern app-only authentication.Start-VBORepositoryIndexingSessionCreates and starts an indexing session when a backup proxy server collects and sends the restore points metadata of a backup repository associated with this backup proxy server to the Veeam Backup for Microsoft 365 controller.Start-VBORepositoryMaintenanceSessionCreates and starts a maintenance session to suspend operations on backup repositories.Start-VBORepositoryOwnerChangeSessionCreates and starts a change owner session to move a backup repository to another backup proxy server or backup proxy pool.Start-VBORepositorySynchronizeSessionCreates and starts a session to synchronize cache between object storage repositories and the PersistentCache database on the PostgreSQL instance.Start-VBORepositoryUpgradeSessionCreates and starts a session to upgrade backup repositories.
Stop
Stop-VBOCopyJobStops running backup copy jobs.Stop-VBOJobStops running backup jobs.Stop-VBORepositoryMaintenanceSessionStops maintenance sessions.Stop-VBORepositoryOwnerChangeSessionStops change owner sessions.Stop-VBORepositorySynchronizeSessionStops sessions that are running to synchronize cache between object storage repositories and the PersistentCache database on the PostgreSQL instance.Stop-VBORepositoryUpgradeSessionStops sessions started to upgrade backup repositories.Stop-VBORestoreSessionStops Veeam Backup for Microsoft 365 restore sessions.
Sync
Sync-VBOProxyRescans backup proxy servers.
Test
Test-VBORepositoryVerifies the integrity of backed-up Exchange, SharePoint and Teams data in backup repositories.
Uninstall
Uninstall-VBOLicenseRemoves the currently installed license from Veeam Backup for Microsoft 365.
Update
Update-VBOLicenseUpdates the product license for Veeam Backup for Microsoft 365.Update-VBOProxyUpgrades backup proxy servers.