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

Set-VBOOrganization

Short Description

Modifies Microsoft organization settings.

Syntax

In Veeam Backup for Microsoft Office 365 3.0 this cmdlet has been updated with the following cmdlet set:

Set-VBOOrganization -Organization <VBOOrganization> [-Name <String>] [-Office365ExchangeConnectionsSettings <VBOOffice365ConnectionSettings>] [-Office365SharePointConnectionsSettings <VBOOffice365ConnectionSettings>][-Region <VBOOffice365Region>] [-VeeamAADApplicationUsed <SwitchParameter>] [-OnPremExchangeConnectionSettings <VBOExchangeOnPremConnectionSettings>] [-OnPremSharePointConnectionSettings <VBOSharePointOnPremConnectionSettings>] [-EnableOffice365Exchange <SwitchParameter>] [-EnableOffice365SharePoint <SwitchParameter>] [-EnableOnPremExchange <SwitchParameter>] [-EnableOnPremSharePoint <SwitchParameter>] [<CommonParameters>]

Obsolete cmdlet sets

The following cmdlet set is obsolete and has been designed for Veeam Backup for Microsoft Office 365 version 2.0. It still works in Veeam Backup for Microsoft Office 365 version 3.0 but may not be supported in the next versions of Veeam Backup for Microsoft Office 365.

  • To modify Microsoft Office 365 organizations and both on-premises Microsoft SharePoint and on-premises Microsoft Exchange organizations:

Set-VBOOrganization -Organization <VBOOrganization> [-SharePointSkipCAVerification <SwitchParameter>][-SharePointUseSSL <SwitchParameter>] [-SharePointGrantAccessToSiteCollections <SwitchParameter>][-SharePointCredential <PSCredential>] [-SharePointServerPort <Int32>] [-SharePointServerName <String>][-IsSharePoint <SwitchParameter>] [-ExchangeSkipRevocationCheck <SwitchParameter>][-ExchangeSkipCommonNameVerification <SwitchParameter>] [-ExchangeSkipCAVerification <SwitchParameter>][-SharePointSkipCommonNameVerification <SwitchParameter>] [-ExchangeUseSSL <SwitchParameter>][-ExchangeOnPremisesGrantImpersonation <SwitchParameter>] [-ExchangeOnPremisesCredential <PSCredential>][-ExchangeServerName <String>] [-IsExchange <SwitchParameter>] [-Office365GrantAccessToSiteCollection<SwitchParameter>] [-Office365GrantImpersonation <SwitchParameter>] [-Office365Credential <PSCredential>][-Office365UseVeeamAADApplication <SwitchParameter>] [-Office365Region <VBOOffice365Region>] [-Type <VBOOrganizationType>] [-ExchangeConfigureThrottlingPolicy <SwitchParameter>] [-SharePointSkipRevocationCheck<SwitchParameter>] [<CommonParameters>]

The following cmdlet set is obsolete and has been designed for Veeam Backup for Microsoft Office 365 version 1.5. It still works in Veeam Backup for Microsoft Office 365 version 2.0 and version 3.0 but may not be supported in the next versions of Veeam Backup for Microsoft Office 365.

  • To modify Microsoft Office 365 organizations:

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

Detailed Description

This cmdlet modifies settings of an organization added to Veeam Backup for Microsoft Office 365 infrastructure.

To modify settings, enter the corresponding parameters with new values. The parameters that you omit will remain unchanged.

Set-VBOOrganization Important!

You must set the Office365ExchangeConnectionsSettings and Office365SharePointConnectionsSettings parameters to the same type of the authentication mode —  basic or modern.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Organization

Specifies a Microsoft organization. The cmdlet will modify settings of this Microsoft organization.

True

Named

True (ByValue)

False

Name

Specifies a name of a Microsoft organization. The cmdlet will replace the existing name of an organization with this name.

False

Named

False

False

Office365ExchangeConnectionsSettings

Specifies connection settings. The cmdlet will use these settings to connect to Microsoft organization and add the Office 365 Exchange organization to Veeam Backup for Microsoft Office 365.

False

Named

False

False

Office365SharePointConnectionsSettings

Specifies connection settings for the Microsoft Office 365 SharePoint organization component.

False

Named

False

False

OnPremExchangeConnectionSettings

Specifies connection settings for the Microsoft on-premises Exchange organization component.

False

Named

False

False

OnPremSharePointConnectionSettings

Specifies connection settings for the Microsoft on-premises SharePoint organization component.

False

Named

False

False

Region

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

  • China
  • Germany
  • USDefence
  • USGovernment
  • Worldwide

Default: Worldwide

False

Named

False

False

VeeamAADApplicationUsed

Indicates that the cmdlet will use Veeam application to connect to Microsoft Graph.

NOTE: You must set this parameter to the True value for the following Microsoft Azure Regions:

  • China
  • Germany

Default: False

False

Named

False

False

EnableOffice365Exchange

Indicates that the cmdlet will enable connection to the Microsoft Office 365 Exchange organization component.

False

Named

False

False

EnableOffice365SharePoint

Indicates that the cmdlet will enable connection to the Microsoft Office 365 SharePoint organization component.

False

Named

False

False

EnableOnPrem365Exchange

Indicates that the cmdlet will enable connection to the Microsoft On-Premise Exchange organization component.

False

Named

False

False

EnableOnPrem365SharePoint

Indicates that the cmdlet will enable connection to the Microsoft On-Premise SharePoint organization component.

False

Named

False

False

Type

NOTE: This parameter is obsolete.

Specifies the type of the organization deployment:

  • Office365
  • On-premises
  • Hybrid

False

Named

False

False

Office365
Region

NOTE: This parameter is obsolete.

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

NOTE: This parameter is obsolete

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

You must specify the organization user name in one of the following formats:

  • Username@domain.com
  • User@domain.onmicrosoft.com

False

Named

False

False

Office365
Grant
Impersonation

NOTE: This parameter is obsolete.

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

False

Named

False

False

Office365
Grant
AccessToSite
Collections

NOTE: This parameter is obsolete.

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

False

Named

False

False

Office365
UseVeeam
AADApplication

NOTE: This parameter is obsolete.

Indicates that the cmdlet will use Veeam application to connect to Microsoft Graph.

NOTE: You must set this parameter to the True value for the following Microsoft Azure Regions:

  • China
  • Germany

Default: False

False

Named

False

False

Server

NOTE: This parameter is obsolete.

Specifies Microsoft Exchange server EWS endpoint URL.

False

Named

False

False

OnPremises
Credential

NOTE: This parameter is obsolete.

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

You must specify the organization user name in one of the following formats:

  • Username@domain.com
  • User@domain.onmicrosoft.com

False

Named

False

False

UseSSL

NOTE: This parameter is obsolete.

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

False

Named

False

False

SkipCA
Verification

NOTE: This parameter is obsolete.

For SSL connection.

Indicates that the cmdlet will skip Certificate Authority verification.

False

Named

False

False

Skip
CommonName
Verification

NOTE: This parameter is obsolete.

For SSL connection.

Indicates that the cmdlet will skip Common Name verification.

False

Named

False

False

Skip
Revocation
Check

NOTE: This parameter is 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

NOTE: This parameter is 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

NOTE: This parameter is obsolete.

Indicates that the cmdlet will configure VeeamArchiverThrottlingPolicy to connect to Microsoft Exchange organization server.

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

False

Named

False

False

IsExchange

NOTE: This parameter is obsolete.

Indicates if the selected organization contains Microsoft Exchange components.

False

Named

False

False

IsSharePoint

NOTE: This parameter is obsolete.

Indicates if the selected organization contains Microsoft SharePoint components.

False

Named

False

False

SharePointServerName

NOTE: This parameter is obsolete.

Specifies SharePoint server name.

False

Named

False

False

SharePointServerPort

NOTE: This parameter is obsolete.

Specifies SharePoint server port.

False

Named

False

False

SharePointCredential

NOTE: This parameter is obsolete.

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

False

Named

False

False

SharePointGrantAccessToSiteCollections

NOTE: This parameter is obsolete.

Indicates if you choose to automatically grant required permissions and assign roles to gain access to SharePoint site collections.

False

Named

False

False

SharePointUseSSL

NOTE: This parameter is obsolete.

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

False

Named

False

False

SharePointSkipCAVerification

NOTE: This parameter is obsolete.

For a secure connection.

Indicates that Certificate Authority verification check will not be performed.

False

Named

False

False

SharePointSkipCommonNameVerification

NOTE: This parameter is obsolete.

For a secure connection.

Indicates that common name verification check will not be performed.

False

Named

False

False

SharePointSkipRevocationCheck

NOTE: This parameter is obsolete.

For a secure connection.

Indicates that certificate revocation check will not be performed.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Example 1

This example shows how to update the type of your organization with a name "Columbus" from Microsoft Office 365 with the basic authentication to a Hybrid type with a modern Microsoft Office 365 authentication and an application certificate and an authentication against a Microsoft Exchange on-premises organization component.

  1. Run the Get-VBOOrganization cmdlet to get Microsoft Office 365 organization with the name "Columbus". Save the result to the $organization variable.
  2. Run the Get-Credential cmdlet to create a credential object. Enter credentials you want to use for authenticating with Microsoft Office 365 Exchange organization component. Save the result to the $Office365ExchangeCredentials variable.
  3. Run the ConvertTo-SecureString cmdlet to turn the application certificate password into a SecureString type. Provide the AsPlainText parameter. Save the result to the $ApplicationCertificatePassword variable.
  4. Run the New-VBOOffice365ConnectionSettings cmdlet. Set the $organization variable as the Organization parameter value. Set the $Office365ExchangeCredentials variable as the AppCredential parameter value. Set the $ApplicationCertificatePassword variable as the ApplicationCertificatePassword parameter value. Save the result to the $VBOOffice365ExchangeConnectionSettings.
  5. Run the Get-Credential cmdlet to create credential object. Enter credentials you want to use for authenticating with Microsoft Exchange on-premises organization component. Save the result to the $OnPremExchangeCredentials variable.
  6. Run the New-VBOOnPremConnectionSettings cmdlet to set the connection settings for the Microsoft Exchange on-premises organization components. Save the result to the $OnPremExchangeConnectionSettings.
  7. Run the Set-VBOOrganization cmdlet. Set the $organization variable as the Organization parameter value. Set the $VBOOffice365ExchangeConnectionSettings variable as the Office365ExchangeConnectionsSettings parameter value. Set the $OnPremExchangeConnectionSettings variable as the OnPremExchangeConnectionSettings parameter value. Provide the EnableOnPremExchange parameter to enable connection to the Microsoft Office 365 Exchange organization component.

$organization = Get-VBOOrganization -Name "Columbus"

$Office365ExchangeCredentials = Get-Credential

$ApplicationCertificatePassword = ConvertTo-SecureString -String "fCblKbIf+kY10+uB+rROD+wZPT/WxcDNX+EU2O33Q1s=" -AsPlainText -Force

$VBOOffice365ExchangeConnectionSettings = New-VBOOffice365ConnectionSettings -AppCredential $Office365ExchangeCredentials -ApplicationId d052f06e-1cfa-42ff-9636-9da5e7aa1fd1 -ApplicationCertificatePath "C:\ApplicationCertificate.pfx" -ApplicationCertificatePassword $ApplicationCertificatePassword -GrantRolesAndPermissions

New-VBOOffice365ConnectionSettings -Settings $organization.Office365ExchangeConnectionSettings -AppCredential $Office365ExchangeCredentials -ApplicationId d052f06e-1cfa-42ff-9636-9da5e7aa1fd1 -ApplicationCertificatePath "C:\ApplicationCertificate.pfx" -ApplicationCertificatePassword $ApplicationCertificatePassword

$OnPremExchangeCredentials = Get-Credential

$OnPremExchangeConnectionSettings = New-VBOOnPremConnectionSettings -Credential $OnPremExchangeCredentials -ServerName Support.North

Set-VBOOrganization -Organization $organization -Office365ExchangeConnectionsSettings $VBOOffice365ExchangeConnectionSettings -OnPremExchangeConnectionSettings $OnPremExchangeConnectionSettings -EnableOnPremExchange

Example 2

OBSOLETE: This example shows how to update the type of your organization from Microsoft Office 365 to Hybrid.

  1. Run the Get-VBOOrganization cmdlet to get your Microsoft Office 365 organization. Save the result to the $organization variable.
  2. Run the Get-Credential cmdlet to create a credential object. Enter credentials you want to use for authenticating with your Microsoft Office 365 organization. Save the result to the $officeCreds variable.
  3. Run the Get-Credential cmdlet to create a credential object. Enter credentials you want to use for authenticating with Microsoft Exchange on-premises organization. Save the result to the $exchangeCreds variable.
  4. Save the Microsoft Exchange organization server name to the $serverName variable.
  5. Run the Set-VBOOrganization cmdlet. Use the $organization variable as the Organization parameter value. Use Hybrid as the Type parameter value. Use the $officeCreds as the Office365Credential parameter value. Use the $exchangeCreds variable as the ExchangeOnPremisesCredential parameter value. Use the $serverName variable as the ExchangeServerName parameter value.

$organization = Get-VBOOrganization -Name "Columbus"

$officeCreds = Get-Credential

$exchangeCreds = Get-Credential

$serverName = "Exchange_Server_Name"

Set-VBOOrganization -Organization $organization -Type Hybrid -Office365Credential $officeCreds -IsExchange –ExchangeServerName $serverName –ExchangeOnPremisesCredential -$exchangeCreds

Example 3

OBSOLETE: This example shows how to update the type of your organization from Hybrid to Microsoft Office 365.

  1. Run the Get-VBOOrganization cmdlet to get your Hybrid organization. Save the result to the $organization variable.
  2. Run the Get-Credential cmdlet to create a credential object. Enter credentials you want to use for authenticating with your Microsoft Office 365 organization. Save the result to the $officeCreds variable.
  3. Run the Set-VBOOrganization cmdlet. Use the $organization variable as the Organization parameter value. Use Office365 as the Type parameter value. Use the $officeCreds variable as the Office365Credential parameter value.

$organization = Get-VBOOrganization -Name "Columbus"

$officeCreds = Get-Credential

Set-VBOOrganization -Organization $organization -Type Office365 -Office365Credential $officeCreds

Example 4

OBSOLETE: This example shows how to add Microsoft SharePoint on-premises component to the on-premises Microsoft Exchange organization.

  1. Run the Get-VBOOrganization cmdlet to get the on-premises Microsoft Exchange organization. Save the result to the $organization variable.
  2. Run the Get-Credential cmdlet to create a credential object. Enter credentials you want to use for authenticating with your on-premises Exchange organization. Save the result to the $exchangeCreds variable.
  3. Run the Get-Credential cmdlet to create a credential object. Enter credentials you want to use for authenticating with your on-premises SharePoint organization. Save the result to the $sharePointCreds variable.
  4. Save the Microsoft SharePoint organization server name to the $sharePointServer variable.
  5. Run the Set-VBOOrganization cmdlet. Set the $organization variable as the Organization parameter value. Set the $exchangeCreds variable as the ExchangeOnPremisesCredential parameter value. Set the IsSharePoint parameter to declare Microsoft SharePoint components for the modified organization. Set the $sharePointCreds variable as the SharePointOnPremisesCredential parameter value. Set the $sharePointServer variable as the SharePointServerName parameter value.

$organization = Get-VBOOrganization -Name "Columbus"

$exchangeCreds = Get-Credential

$sharePointCreds = Get-Credential

$sharePointServer = "SharePoint_Server_Name"

Set-VBOOrganization -Organization $organization -Type OnPremises –ExchangeOnPremisesCredential -$exchangeCreds -IsSharePoint –SharePointServerName $sharePoiintServerName -SharePointOnPremisesCredential -$sharePointCreds

Example 5

OBSOLETE: This example shows how to remove Microsoft SharePoint on-premises component from the on-premises Microsoft Exchange and Microsoft SharePoint organization.

  1. Run the Get-VBOOrganization cmdlet to get the on-premises Microsoft Exchange and Microsoft SharePoint organization and save the result to the $organization variable.
  2. Run the Get-Credential cmdlet to create a credential object. Enter credentials you want to use for authenticating with your on-premises Exchange organization. Save the result to the $exchangeCreds variable.
  3. Run the Set-VBOOrganization cmdlet. Set the $organization variable as the Organization parameter value. Set the $exchangeCreds variable as the ExchangeOnPremisesCredtial parameter value. Set the IsSharePoint parameter as False to remove the Microsoft SharePoint on-premises components from the Microsoft SharePoint organization. You must enter your credentials for all of the remaining organization servers even if they are not changed.

$organization = Get-VBOOrganization -Name "Columbus"

$exchangeCreds = Get-Credential

Set-VBOOrganization -Organization $organization -Type OnPremises –ExchangeOnPremisesCredential -$exchangeCreds -IsSharePoint:$false

Related Commands

Get-VBOOrganization

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference