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

Add-VBOOrganization

Short Description

Adds organizations to Veeam Backup for Microsoft Office 365.

Syntax

This cmdlet provides 7 parameter sets.

  • For adding Microsoft Office 365 organization:

Add-VBOOrganization -Type <VBOOrganizationType> -Office365Credential <PSCredential> [-Office365Region <VBOOffice365Region>] [-Office365GrantImpersonation] [-Office365GrantAccessToSiteCollections] [-Office365UseVeeamAADApplication]  [<CommonParameters>]

  • For adding On-Premise organization with Microsoft Exchange components:

Add-VBOOrganization -Type <VBOOrganizationType> -ExchangeServerName <String> -ExchangeOnPremisesCredential <PSCredential> [-ExchangeUseSSL [<SwitchParameter>]] [-ExchangeSkipCAVerification [<SwitchParameter>]] [-ExchangeSkipCommonNameVerification [<SwitchParameter>]] [-ExchangeSkipRevocationCheck [<SwitchParameter>]] [-ExchangeOnPremisesGrantImpersonation [<SwitchParameter>]] [-ExchangeConfigureThrottlingPolicy [<SwitchParameter>]] [<CommonParameters>]

  • For adding On-Premise organization with Microsoft SharePoint components:

Add-VBOOrganization -Type <VBOOrganizationType> -SharePointServerName <String> -SharePointCredential <PSCredential> [-SharePointServerPort <Int32>] [-SharePointGrantAccessToSiteCollections [<SwitchParameter>]] [-SharePointUserSSL [<SwitchParameter>]] [-SharePointSkipCARevocationCheck [<SwitchParameter>]] [-SharePointSkipCommonNameVerification [<SwitchParameter>]] [-SharePointSkipRevocationCheck [<SwitchParameter>]]  [<CommonParameters>]

  • For adding On-Premise organization with both Microsoft Exchange and Microsoft SharePoint components:

Add-VBOOrganization -Type <VBOOrganizationType> -ExchangeServerName <String> -ExchangeOnPremisesCredential <PSCredential> -SharePointServerName <String> -SharePointCredential <PSCredential> [-SharePointSkipCARevocationCheck [<SwitchParameter>]] [-SharePointUserSSL [<SwitchParameter>]] [-SharePointGrantAccessToSiteCollections [<SwitchParameter>]] [-SharePointServerPort <Int32>] [-ExchangeConfigureThrottlingPolicy [<SwitchParameter>]] [-ExchangeSkipRevocationCheck [<SwitchParameter>]] [-SharePointSkipCommonNameVerification [<SwitchParameter>]] [-ExchangeSkipCommonNameVerification [<SwitchParameter>]] [-ExchangeSkipCAVerification [<SwitchParameter>]] [-ExchangeUseSSL [<SwitchParameter>]] [-ExchangeOnPremisesGrantImpersonation [<SwitchParameter>]] [-SharePointSkipRevocationCheck [<SwitchParameter>]]  [<CommonParameters>]

  • For adding Hybrid organization with On-Premise Microsoft Exchange components:

Add-VBOOrganization -Type <VBOOrganizationType> -Office365Credential <PSCredential> -ExchangeServerName <String> -ExchangeOnPremisesCredential <PSCredential> [-Office365Region <VBOOffice365Region>] [-Office365GrantImpersonation [<SwitchParameter>]] [-Office365GrantAccessToSiteCollections [<SwitchParameter>]] [-Office365UseVeeamAADApplication] [-ExchangeUseSSL [<SwitchParameter>]] [-ExchangeSkipCAVerification [<SwitchParameter>]] [-ExchangeSkipCommonNameVerification [<SwitchParameter>]] [-ExchangeSkipRevocationCheck [<SwitchParameter>]] [-ExchangeOnPremisesGrantImpersonation [<SwitchParameter>]] [-ExchangeConfigureThrottlingPolicy [<SwitchParameter>]]  [<CommonParameters>]

  • For adding Hybrid organization with On-Premise Microsoft SharePoint components:

Add-VBOOrganization -Type <VBOOrganizationType> -Office365Credential <PSCredential> -SharePointServerName <String> -SharePointCredential <PSCredential> [-Office365Region <VBOOffice365Region>] [-Office365GrantImpersonation [<SwitchParameter>]] [-Office365GrantAccessToSiteCollections [<SwitchParameter>]] [-Office365UseVeeamAADApplication] [-SharePointServerPort <Int32>] [-SharePointGrantAccessToSiteCollections [<SwitchParameter>]] [-SharePointUserSSL [<SwitchParameter>]] [-SharePointSkipCARevocationCheck [<SwitchParameter>]] [-SharePointSkipCommonNameVerification [<SwitchParameter>]] [-SharePointSkipRevocationCheck [<SwitchParameter>]]  [<CommonParameters>]

  • For adding Hybrid organization with both On-Premise Microsoft Exchange and Microsoft SharePoint components:

Add-VBOOrganization -Type <VBOOrganizationType> -Office365Credential <PSCredential> -ExchangeServerName <String> -ExchangeOnPremisesCredential <PSCredential> -SharePointServerName <String> -SharePointCredential <PSCredential> [-SharePointSkipCARevocationCheck [<SwitchParameter>]] [-SharePointUserSSL [<SwitchParameter>]] [-SharePointGrantAccessToSiteCollections [<SwitchParameter>]] [-SharePointServerPort <Int32>] [-ExchangeConfigureThrottlingPolicy [<SwitchParameter>]] [-ExchangeOnPremisesGrantImpersonation [<SwitchParameter>]] [-ExchangeSkipCAVerification [<SwitchParameter>]] [-ExchangeSkipCommonNameVerification [<SwitchParameter>]] [-SharePointSkipCommonNameVerification [<SwitchParameter>]] [-ExchangeUseSSL [<SwitchParameter>]] [-Office365UseVeeamAADApplication] [-Office365GrantAccessToSiteCollections [<SwitchParameter>]] [-Office365GrantImpersonation [<SwitchParameter>]] [-Office365Region <VBOOffice365Region>] [-ExchangeSkipRevocationCheck [<SwitchParameter>]] [-SharePointSkipRevocationCheck [<SwitchParameter>]]  [<CommonParameters>]

  • [OBSOLETE] For adding On-Premises Microsoft Exchange organization. This parameter set is obsolete. Use parameter "ExchangeServerName" instead of "Server" when adding an 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>]

  • [OBSOLETE] For adding Hybrid organization with an On-Premises Microsoft Exchange components. This parameter set is obsolete. Use parameter "ExchangeServerName" instead of "Server" when adding an On-Premises Microsoft Exchange organization.

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

Detailed Description

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

  • Microsoft Office 365
  • On-Premises
  • 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 the organization deployment:

  • Office365
  • On-Premises
  • 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

Office365
Grant
AccessToSite
Collections

Indicates that the cmdlet will assign user Site Collection Admin rights for accessing site collections and sites.

False

Named

False

False

Office365
UseVeeam
AADApplication

Indicates that the cmdlet will use Veeam AAD application.

False

Named

False

False

Server

OBSOLETE: Specifies Microsoft Exchange server EWS endpoint URL.

True

Named

False

False

OnPremises
Credential

OBSOLETE: Specifies the credentials you want to use for authenticating with on-premises components.

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

True

Named

False

False

UseSSL

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

False

Named

False

False

SkipCA
Verification

OBSOLETE: For SSL connection.

Indicates that the cmdlet will skip Certificate Authority verification.

False

Named

False

False

Skip
CommonName
Verification

OBSOLETE: For SSL connection.

Indicates that the cmdlet will skip Common Name verification.

False

Named

False

False

Skip
Revocation
Check

OBSOLETE: 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

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

False

Named

False

False

Configure
Throttling
Policy

OBSOLETE: 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

SharePointServerName

Specifies SharePoint server name.

True

Named

False

False

SharePointServerPort

Specifies SharePoint server port.

False

Named

False

False

SharePointCredential

Specifies the credentials you want to use for authenticating to organization with SharePoint On-premises components.

True

Named

False

False

SharePointGrantAccessToSiteCollections

Indicates if this cmdlet will automatically assign user a Site Collection Admin role to gain access to SharePoint site collections.

False

Named

False

False

SharePointUseSSL

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

False

Named

False

False

SharePointSkipCAVerification

For a secure connection.

Indicates that Certificate Authority verification check will not be performed.

False

Named

False

False

SharePointSkipCommonNameVerification

For a secure connection.

Indicates that common name verification check will not be performed.

False

Named

False

False

SharePointSkipRevocationCheck

For a secure connection.

Indicates that certificate revocation check will not be performed.

False

Named

False

False

ExchangeServerName

Specifies Exchange server name.

False

Named

False

False

ExchangeOnPremisesCredential

Specifies the credentials you want to use for authenticating with the Exchange components.

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

False

Named

False

False

ExchangeUseSSL

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

False

Named

False

False

ExchangeSkipCAVerification

For a secure connection.

Indicates that Certificate Authority verification check will not be performed.

False

Named

False

False

ExchangeSkipCommonNameVerification

For a secure connection.

Indicates that common name verification check will not be performed.

False

Named

False

False

ExchangeSkipRevocationCheck

For a secure connection.

Indicates that certificate revocation check will not be performed.

False

Named

False

False

ExchangeOnPremises
Grant
Impersonation

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

False

Named

False

False

ExchangeConfigure
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 $officeCreds variable.
  2. Run Add-VBOOrganization with the $officeCreds variable. Use Office365GrantAccessToSiteCollections parameter to assign user Site Collection Admin rights for accessing site collections and sites.

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

PS C:\PS> Add-VBOOrganization -Type Office365 -Office365Region Germany -Office365Credential $officeCreds -Office365GrantAccessToSiteCollections

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 $onPremisesExchangeCreds variable.
  2. Save the Microsoft Exchange organization server name to the $exchangeServer variable.
  3. Run Add-VBOOrganization with the $exchangeCreds and $exchangeServer variable

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

PS C:\PS> $exchangeServer = "Exchange Server Name"

PS C:\PS> Add-VBOOrganization -Type OnPremises –ExchangeServerName $exchangeServer -ExchangeOnPremisesCredential $onPremisesExchangeCreds

Example 3

This example shows how to add On-Premises Microsoft SharePoint 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 Sharepoint organization. Save the result to the $onPremiseSharePointCreds variable.
  2. Save the Microsoft SharePoint organization server name to the $sharePointServer variable.
  3. Run Add-VBOOrganization with the $onPremiseSharePointCreds and $sharePointServer variable

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

PS C:\PS> $sharePointServer = "SharePoint Server Name"

PS C:\PS> Add-VBOOrganization -Type OnPremises -SharePointServerName $sharePointServer -OnPremisesCredential $onPremiseSharePointCreds

Example 4

This example shows how to add On-Premises organization with both Microsoft Exchange and Microsoft SharePoint components 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 $onPremiseExchangeCreds variable.
  2. Run Get-Credential to create a credential object. Type the credentials you want to use for authenticating with On-Premises Microsoft SharePoint organization. Save the result to the $onPremiseSharePointCreds variable.
  3. Save the Microsoft Exchange organization server name to the $exchangeServer variable.
  1. Save the Microsoft SharePoint organization server name to the $sharePointServer variable.
  2. Run Add-VBOOrganization with the $onPremiseExchangeCreds, $onPremiseSharePointCreds, $exchangeServer and $sharePointServer variable.

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

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

PS C:\PS> $exchangeServer = "Exchange Server Name"

PS C:\PS> $sharePointServer = "SharePoint Server Name"

PS C:\PS> Add-VBOOrganization -Type OnPremises -ExchangeServerName $exchangeServer –ExchangeOnPremisesCredential $onPremiseExchangeCreds -SharePointServerName $sharePointServer -SharePointCredential $onPremiseSharePointCreds

Example 5

This example shows how to add Hybrid organization, which contains only Microsoft Exchange On-Premises components 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 $officeCreds 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 $onPremiseExchangeCreds variable.
  3. Save the Microsoft Exchange organization server name to the $exchangeServer variable.
  4. Run Add-VBOOrganization with the $officeCreds, $exchangeServer and $onPremiseExchangeCreds variables.

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

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

PS C:\PS> $exchangeServer = "Exchange Server Name"

PS C:\PS> Add-VBOOrganization -Type Hybrid -Office365Credential $officeCreds -ExchangeServerName $exchangeServer -ExchangeOnPremisesCredential $onPremiseExchangeCreds

Example 6

This example shows how to add Hybrid organization, which contains only Microsoft SharePoint On-Premises components 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 $officeCreds variable.
  2. Run Get-Credential to create a credential object. Type the credentials you want to use for authenticating with On-Premises Microsoft SharePoint organization. Save the result to the $onPremiseSharePointCreds variable.
  3. Save the Microsoft SharePoint organization server name to the $sharePointServer variable.
  4. Run Add-VBOOrganization with the $officeCreds, $sharePointServer and $onPremiseSharePointCreds variables.

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

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

PS C:\PS> $sharePointServer = "SharePoint Server Name"

PS C:\PS> Add-VBOOrganization -Type Hybrid -Office365Credential $officeCreds -SharePointServerName $sharePointServer -SharePointCredential $onPremiseSharePointCreds

Example 7

This example shows how to add Hybrid organization with both On-Premises Microsoft Exchange and On-Premises Microsoft SharePoint components 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 $officeCreds 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 $onPremiseExchangeCreds variable.
  3. Run Get-Credential to create a credential object. Type the credentials you want to use for authenticating with On-Premises Microsoft SharePoint organization. Save the result to the $onPremiseSharePointCreds variable.
  4. Save the Microsoft Exchange organization server name to the $exchangeServer variable.
  5. Save the Microsoft SharePoint organization server name to the $sharePointServer variable.
  6. Run Add-VBOOrganization with the $officeCreds, $exchangeServer, $sharePointServer, $onPremiseExchangeCreds and $onPremiseSharePointCreds variables.

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

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

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

PS C:\PS> $exchangeServer = "Exchange Server Name"

PS C:\PS> $sharePointServer = "SharePoint Server Name"

PS C:\PS> Add-VBOOrganization -Type Hybrid -Office365Credential $officeCreds -ExchangeServerName $exchangeServer - ExchangeOnPremisesCredential $onPremiseExchangeCreds -SharePointServerName $sharePointServer -SharePointCredential $onPremiseSharePointCreds

Example 8

OBSOLETE: 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 $onPremiseExchangeCreds variable.
  2. Save the Microsoft Exchange organization server name to the $exchangeServer variable.
  3. Run Add-VBOOrganization with the $exchangeServer, $onPremiseExchangeCreds variable. Use the following parameters:

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

PS C:\PS> $exchangeServer = "Exchange Server Name"

PS C:\PS> Add-VBOOrganization -Type OnPremises -Server $exchangeServer -OnPremisesCredential $onPremiseExchangeCreds

Example 9

OBSOLETE: This example shows how to add Hybrid organization, which contains Exchange On-Premises parts, 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 $officeCreds 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 $onPremiseExchangeCreds variable.
  3. Save the Microsoft Exchange organization server name to the $exchangeServer variable.
  4. Run Add-VBOOrganization with the $officeCreds, $exchangeServer, $onPremiseExchangeCreds variable.

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

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

PS C:\PS> $exchangeServer = "Exchange Server Name"

PS C:\PS> Add-VBOOrganization -Type Hybrid -Office365Credential $officeCreds -Server $exchangeServer -OnPremisesCredential $onPremiseExchangeCreds

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference