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

Set-VBOOrganization

Short Description

Modifies organization settings.

Syntax

This cmdlet provides 1 parameter set:

  • For modifying Office 365, Hybrid or On-Premises organizations with or without Microsoft Exchange and/or SharePoint On-Premises components:

Set-VBOOrganization -Organization <VBOOrganization> [-Type <VBOOrganizationType> {OnPremises | Office365 | Hybrid}] [-Office365Region <VBOOffice365Region> {Worldwide | Germany | China | USDefence | USGovernment}] [-Office365Credential <pscredential>] [-Office365GrantImpersonation] [-Office365GrantAccessToSiteCollection] [-Office365UseVeeamAADApplication] [-IsExchange] [-ExchangeServerName <string>] [-ExchangeOnPremisesCredential <pscredential>] [-ExchangeOnPremisesGrantImpersonation] [-ExchangeConfigureThrottlingPolicy] [-ExchangeUseSSL] [-ExchangeSkipCAVerification] [-ExchangeSkipCommonNameVerification] [-ExchangeSkipRevocationCheck] [-IsSharePoint] [-SharePointServerName <string>] [-SharePointServerPort <int>] [-SharePointCredential <pscredential>] [-SharePointGrantAccessToSiteCollections] [-SharePointUseSSL] [-SharePointSkipCAVerification] [-SharePointSkipCommonNameVerification] [-SharePointSkipRevocationCheck]  [<CommonParameters>]

  • [OBSOLETE] For modifying Microsoft Office 365 organizations. This parameter set is obsolete. Use parameters "IsExchange" or "IsSharePoint" and "ExchangeServerName" or "SharePointServerName" when change the type of the Office 365 organizations.

Set-VBOOrganization -Organization <VBOOrganization> [-Type <VBOOrganizationType> {OnPremises | Office365 | Hybrid}] [-Office365Region <VBOOffice365Region> {Worldwide | Germany | China | USDefence | USGovernment}] [-Office365Credential <pscredential>] [-Office365GrantImpersonation] [-Office365GrantAccessToSiteCollection] [-Server <string>] [-OnPremisesCredential <pscredential>] [-OnPremisesGrantImpersonation] [-ConfigureThrottlingPolicy] [-UseSSL] [-SkipCAVerification] [-SkipCommonNameVerification] [-SkipRevocationCheck]  [<CommonParameters>]

Detailed Description

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

To modify settings, enter the corresponding parameters with new values. The parameters that you omit will remain unchanged. To edit organization settings, make sure all jobs configured for that organization are in the Disabled state.

Set-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

Organization

Specifies Exchange organization that you want to modify.

True

Named

True (ByValue)

False

Type

Specifies Exchange organization type:

  • Office365
  • OnPremises
  • Hybrid

Use this parameter to update the type of your Exchange organization in Veeam Backup for Microsoft Office 365 configuration.

False

Named

False

False

Office365
Region

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

  • Worldwide
  • USGovernment
  • Germany
  • China
  • USDefence

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".

False

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 a Site Collection Admin rights in order to access 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

Specifies Microsoft Exchange server EWS endpoint URL.

False

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.

False

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 a secure connection.

Indicates that Certificate Authority verification check will not be performed.

False

Named

False

False

Skip
CommonName
Verification

For a secure connection.

Indicates that common name verification check will not be performed.

False

Named

False

False

Skip
Revocation
Check

For a secure connection.

Indicates that certificate revocation check will not be performed.

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

IsExchange

Indicates if the selected organization contains Microsoft Exchange components.

False

Named

False

False

IsSharePoint

Indicates if the selected organization contains Microsoft SharePoint components.

False

Named

False

False

SharePointServerName

Specifies SharePoint server name.

False

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.

False

Named

False

False

SharePointGrantAccessToSiteCollections

Indicates if you choose to automatically grant required permissions and assign roles 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

<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 update the type of your organization from Microsoft Office 365 to Hybrid.

You will need to perform the following steps:

  1. Run Get-VBOOrganization to get Microsoft Office 365 organization and save the result to the $organization variable.
  2. Run Get-Credential to create a credential object. Type the credentials you want to use for authenticating with your Microsoft Office 365 organization. Save the result to the $officeCreds variable.
  3. Run Get-Credential to create a credential object. Type the 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 $exchangeServer variable.
  5. Run Set-VBOOrganization with the $organization, $officeCreds, $exchangeCreds and $exchangeServer variables and the IsExchange parameter.

PS C:\PS> $organization = Get-VBOOrganization -Name "ABC"

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

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

PS C:\PS> $serverName = "Exchange_Server_Name"

PS C:\PS> Set-VBOOrganization -Organization $organization -Type Hybrid -Office365Credential $officeCreds -IsExchange –ExchangeServerName $serverName –ExchangeOnPremisesCredential -$exchangeCreds

Example 2

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

You will need to perform the following steps:

  1. Run Get-VBOOrganization to get the Hybrid organization and save the result to the $organization variable.
  2. Run Get-Credential to create a credential object. Type the credentials you want to use for authenticating with your Microsoft Office 365 organization. Save the result to the $officeCreds variable.
  3. Run Set-VBOOrganization with the $organization and $officeCreds variables.

PS C:\PS> $organization = Get-VBOOrganization -Name "ABC"

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

PS C:\PS> Set-VBOOrganization -Organization $organization -Type Office365 - Office365Credential $officeCreds

Example 3

This example shows how to add Microsoft SharePoint On-Premises component to the On-Premises Microsoft Exchange organization.

You will need to perform the following steps:

  1. Run Get-VBOOrganization to get the On-Premises Microsoft Exchange organization and save the result to the $organization variable.
  2. Run Get-Credential to create a credential object. Type the credentials you want to use for authenticating with your On-Premises Exchange organization. Save the result to the $exchangeCreds variable.
  3. Run Get-Credential to create a credential object. Type the 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 Set-VBOOrganization with the $organization, $exchangeCreds, $sharePointCreds and $sharePointServer variables and IsSharepoint parameter.

PS C:\PS> $organization = Get-VBOOrganization -Name "ABC"

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

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

PS C:\PS> $sharePointServer = "SharePoint_Server_Name"

PS C:\PS> Set-VBOOrganization -Organization $organization -Type OnPremises –ExchangeOnPremisesCredential -$exchangeCreds -IsSharePoint –SharePointServerName $sharePoiintServerName -SharePointOnPremisesCredential -$sharePointCreds

Example 4

This example shows how to remove Microsoft SharePoint On-Premises component from the On-Premises Microsoft Exchange and Microsoft SharePoint organization.

You will need to perform the following steps:

  1. Run Get-VBOOrganization to get the On-Premises Microsoft Exchange and Microsoft SharePoint organization and save the result to the $organization variable.
  2. Run Get-Credential to create a credential object. Type the credentials you want to use for authenticating with your On-Premises Exchange organization. Save the result to the $exchangeCreds variable.
  3. Run Set-VBOOrganization with the $organization and $exchangeCreds. Set the IsSharePoint parameter to False. Note that you must enter your credentials for all of the remaining organization servers even if they are not changed.

PS C:\PS> $organization = Get-VBOOrganization -Name "ABC"

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

PS C:\PS> Set-VBOOrganization -Organization $organization -Type OnPremises – ExchangeOnPremisesCredential -$exchangeCreds -IsSharePoint:$false

Related Commands

Get-VBOOrganization

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference