Help Center
Choose product document...
Veeam Backup for Microsoft Office 365
PowerShell Reference

Add-VBOOrganization

Short Description

Adds Exchange organizations to Veeam Backup for Microsoft Office 365.

Syntax

This cmdlet provides 3 parameter sets.

  • For adding Microsoft Office 365 organization:

Add-VBOOrganization -Type <VBOOrganizationType> {OnPremises | Office365 | Hybrid} -Office365Credential <pscredential> [-Office365Region <VBOOffice365Region> {Worldwide | Germany | China | USDefence | USGovernment}] [-Office365GrantImpersonation]  [<CommonParameters>]

  • For adding On-Premises Microsoft Exchange organization:

Add-VBOOrganization -Type <VBOOrganizationType> -Server <String> -OnPremisesCredential <PSCredential> [-UseSSL [<SwitchParameter>]] [-SkipCAVerification [<SwitchParameter>]] [-SkipCommonNameVerification [<SwitchParameter>]] [-SkipRevocationCheck [<SwitchParameter>]] [-OnPremisesGrantImpersonation [<SwitchParameter>]] [-ConfigureThrottlingPolicy [<SwitchParameter>]] [<CommonParameters>]

  • For adding Hybrid organization:

Add-VBOOrganization -Type <VBOOrganizationType> [-Office365Region <VBOOffice365Region>] -Office365Credential <PSCredential> [-Office365GrantImpersonation [<SwitchParameter>]] -Server <String> -OnPremisesCredential <PSCredential> [-UseSSL [<SwitchParameter>]] [-SkipCAVerification [<SwitchParameter>]] [-SkipCommonNameVerification [<SwitchParameter>]] [-SkipRevocationCheck [<SwitchParameter>]] [-OnPremisesGrantImpersonation [<SwitchParameter>]] [-ConfigureThrottlingPolicy [<SwitchParameter>]] [<CommonParameters>]

Detailed Description

This cmdlet adds Exchange organizations to Veeam Backup for Microsoft Office 365. You can add the following types of organizations:

  • Microsoft Office 365
  • On-Premises Microsoft Exchange
  • Hybrid

Add-VBOOrganization Note:

This cmdlet requires a PSCredential object. Use Get-Credential to create the PSCredentials object.

For more information on Get-Credential, see https://msdn.microsoft.com/en-us/powershell/reference/5.1/microsoft.powershell.security/get-credential.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Type

Specifies the type of Exchange organization:

  • Office365
  • OnPremises
  • Hybrid

True

Named

False

False

Office365
Region

Specifies Microsoft Azure region where Microsoft Office 365 organization datacenter is located:

  • Worldwide
  • USGovernment
  • Germany
  • China
  • USDefence

Default: Worldwide.

False

Named

False

False

Office365
Credential

Specifies the credentials you want to use for authenticating with Microsoft Office 365 organization.

NOTE: type the organization username in one of the formats: "username@domain.com" or "user@domain.onmicrosoft.com".

True

Named

False

False

Office365
Grant
Impersonation

Indicates that backup jobs will be able to process all mailboxes within Microsoft Office 365 organization.

False

Named

False

False

Server

Specifies Microsoft Exchange server EWS endpoint URL.

True

Named

False

False

OnPremises
Credential

Specifies the credentials you want to use for authenticating with On-Premises Microsoft Exchange organization.

NOTE: type the organization username in the domain\account format.

True

Named

False

False

UseSSL

Indicates that the cmdlet will use a secure connection with Microsoft Exchange organization server.

False

Named

False

False

SkipCA
Verification

For SSL connection.

Indicates that the cmdlet will skip Certificate Authority verification.

False

Named

False

False

Skip
CommonName
Verification

For SSL connection.

Indicates that the cmdlet will skip Common Name verification.

False

Named

False

False

Skip
Revocation
Check

For SSL connection.

Indicates that the cmdlet will skip the check of certificate expiration against the certificate revocation list.

False

Named

False

False

OnPremises
Grant
Impersonation

Indicates that backup jobs will be able to process all mailboxes within On-Premises Microsoft Exchange organization.

False

Named

False

False

Configure
Throttling
Policy

Indicates that the cmdlet will configure VeeamArchiverThrottlingPolicy for connecting with Microsoft Exchange organization server.

VeeamArchiverThrottlingPolicy substitutes existing Exchange throttling policies and provides unlimited network bandwidth.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

This example shows how to add Microsoft Office 365 organization to Veeam Backup for Microsoft Office 365. Organization's Microsoft Office 365 datacenter is in Germany.

You will need to perform the following steps:

  1. Run Get-Credential to create a credential object. Type the credentials you want to use for authenticating with Microsoft Office 365 organization. Save the result to the $ocreds variable.
  2. Run Add-VBOOrganization with the $ocreds variable. Use Office365GrantImpersonation parameter to make all mailboxes within Microsoft Office 365 organization available for processing.

PS C:\PS> $ocreds = Get-Credential

PS C:\PS> Add-VBOOrganization -Type Office365 -Office365Region Germany -Office365Credential $ocreds -Office365GrantImpersonation

Example 2

This example shows how to add On-Premises Microsoft Exchange organization to Veeam Backup for Microsoft Office 365.

You will need to perform the following steps:

  1. Run Get-Credential to create a credential object. Type the credentials you want to use for authenticating with On-Premises Microsoft Exchange organization. Save the result to the $pcreds variable.
  2. Run Add-VBOOrganization with the $pcreds variable. Use the following parameters:
  • UseSSL if Microsoft Exchange organization server requires SSL connection
  • OnPremisesGrantImpersonation to make all mailboxes within On-Premises Microsoft Exchange organization available for processing
  • ConfigureThrottlingPolicy to set unlimited network bandwidth for connecting with Microsoft Exchange organization server

PS C:\PS> $ocreds = Get-Credential

PS C:\PS> Add-VBOOrganization -Type OnPremises -Server yourmail.migrationendpoint.com -OnPremisesCredential $pcreds -UseSSL -OnPremisesGrantImpersonation -ConfigureThrottlingPolicy

Example 3

This example shows how to add Hybrid organization to Veeam Backup for Microsoft Office 365.

You will need to perform the following steps:

  1. Run Get-Credential to create a credential object. Type the credentials you want to use for authenticating with Microsoft Office 365 organization. Save the result to the $ocreds variable.
  2. Run Get-Credential to create a credential object. Type the credentials you want to use for authenticating with On-Premises Microsoft Exchange organization. Save the result to the $pcreds variable.
  3. Run Add-VBOOrganization with the $ocreds and $pcreds variables. Use the following parameters:
  • Office365GrantImpersonation to make all mailboxes within Microsoft Office 365 organization available for processing
  • UseSSL if Microsoft Exchange organization server requires SSL connection
  • OnPremisesGrantImpersonation to make all mailboxes within On-Premises Microsoft Exchange organization available for processing
  • ConfigureThrottlingPolicy to set unlimited network bandwidth for connecting with Microsoft Exchange organization server

PS C:\PS> $ocreds = Get-Credential

PS C:\PS> $pcreds = Get-Credential

PS C:\PS> Add-VBOOrganization -Type Hybrid -Office365Region Worldwide -Office365Credential $ocreds -Office365GrantImpersonation -Server yourmail.migrationendpoint.com -OnPremisesCredential $pcreds -UseSSL -OnPremisesGrantImpersonation -ConfigureThrottlingPolicy

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference