This is an archive version of the document. To get the most up-to-date information, see the current version.

Set-VBOOrganization

Short Description

Modifies Microsoft organization settings.

Syntax

This cmdlet provides parameter sets that allow you to:

Modify Microsoft organizations and the specific services that are related to this organization.

Set-VBOOrganization -Organization <VBOOrganization> [-Name <string>] [-Office365ExchangeConnectionsSettings <VBOOffice365ConnectionSettings>] [-Office365SharePointConnectionsSettings <VBOOffice365ConnectionSettings>] [-Region <VBOOffice365Region> {Worldwide | Germany | China | USDefence | USGovernment}] [-VeeamAADApplicationUsed][-OnPremExchangeConnectionSettings <VBOExchangeOnPremConnectionSettings>] [-OnPremSharePointConnectionSettings <VBOSharePointOnPremConnectionSettings>] [-EnableOffice365Exchange] [-EnableOffice365SharePoint] [-EnableOffice365Teams] [-EnableOnPremExchange] [-EnableOnPremSharePoint] [<CommonParameters>]

Modify auxiliary backup accounts of the specific organization.

Set-VBOOrganization -Organization <VBOOrganization> [-BackupAccounts <VBOBackupAccount[]>] [<CommonParameters>]

Modify backup application settings of the specific organization.

Set-VBOOrganization -Organization <VBOOrganization> [-BackupApplications <VBOBackupApplication[]>] [<CommonParameters>]

Detailed Description

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

To modify settings, enter the necessary 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	Type	Required	Position	Accept Pipeline Input
Organization	Specifies a Microsoft organization. The cmdlet will modify settings of this Microsoft organization.	Accepts the VBOOrganization object. To get this object, run the Get-VBOOrganization cmdlet.	True	Named	True (ByValue)
Name	Specifies a name of a Microsoft organization. The cmdlet will replace the existing name of an organization with this name.	String	False	Named	False
Office365ExchangeConnections Settings	Specifies connection settings. The cmdlet will use these settings to add Microsoft Exchange Online to Veeam Backup for Microsoft Office 365. Note: If you also want to add Microsoft SharePoint Online to the same Microsoft Office 365 organization, you must set the VBOOffice365ConnectionSettings object to the same type of authentication mode.	Accepts the VBOOffice365ConnectionSettings object. To get this object, run the New-VBOOffice365ConnectionSettings cmdlet.	False	Named	False
Office365SharePointConnections Settings	Specifies connection settings. The cmdlet will use these settings to add Microsoft SharePoint Online and Microsoft OneDrive for Business to Veeam Backup for Microsoft Office 365. Note: If you also want to run the script with the Office365ExchangeConnectionsSettings parameter, you must set the VBOOffice365ConnectionSettings object to the same type of authentication mode.	Accepts the VBOOffice365ConnectionSettings object. To get this object, run the New-VBOOffice365ConnectionSettings cmdlet.	False	Named	False
OnPremExchangeConnectionSettings	Specifies connection settings. The cmdlet will use these settings to add Microsoft on-premises Exchange organization to Veeam Backup for Microsoft Office 365.	Accepts the VBOExchangeOnPremConnectionSettings object. To get this object, run the New-VBOOnPremConnectionSettings cmdlet.	False	Named	False
OnPremSharePointConnection Settings	Specifies connection settings. The cmdlet will use these settings to add Microsoft on-premises SharePoint organization to Veeam Backup for Microsoft Office 365.	Accepts the VBOSharePointOnPremConnectionSettings object. To get this object, run the New-VBOOnPremConnectionSettings cmdlet.	False	Named	False
Region	Specifies Microsoft Azure region where Microsoft Office 365 organization datacenter is located: China Germany USDefence USGovernment Worldwide Default: Worldwide	VBOOffice365Region	False	Named	False
VeeamAADApplicationUsed	Defines that the cmdlet will use the 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	SwitchParameter	False	Named	False
EnableOffice365Exchange	Defines that the cmdlet will enable connection to the Microsoft Office 365 Exchange organization component.	SwitchParameter	False	Named	False
EnableOffice365SharePoint	Defines that the cmdlet will enable connection to the Microsoft Office 365 SharePoint organization component.	SwitchParameter	False	Named	False
EnableOffice365Teams	Defines that the cmdlet will enable connection to the Microsoft Teams organization component.	SwitchParameter	False	Named	False
EnableOnPremExchange	Defines that the cmdlet will enable connection to the Microsoft On-Premise Exchange organization component.	SwitchParameter	False	Named	False
EnableOnPremSharePoint	Defines that the cmdlet will enable connection to the Microsoft On-Premise SharePoint organization component.	SwitchParameter	False	Named	False
BackupAccounts	Specifies an array of auxiliary backup account to back up SharePoint and OneDrive for Business. The cmdlet will modify settings of the specified auxiliary backup account.	Accepts the VBOBackupAccount[] object. To get this object, run the Get-VBOApplication cmdlet.	False	Named	False
BackupApplications	Specifies an array of backup application settings. The cmdlet will modify settings of the specified backup application account.	Accepts the VBOBackupApplication[] object. To create this object, run the New-VBOBackupApplication cmdlet.	False Named False
ExchangeConfigureThrottlingPolicy	Note: This parameter is obsolete. Defines that the cmdlet will enable the throttling policy. The cmdlet will set throttling policy to unlimited for the account that you use to connect to Microsoft Exchange organization server..	SwitchParameter	False	Named	False
ExchangeOnPremisesCredential	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	PSCredential	False	Named	False
ExchangeOnPremisesGrant Impersonation	Note: This parameter is obsolete. Defines that backup jobs will be able to process all mailboxes within on-premises Microsoft Exchange organization.	SwitchParameter	False	Named	False
ExchangeServerName	Note: This parameter is obsolete. Specifies Microsoft Exchange server EWS endpoint URL.	String	False	Named	False
ExchangeSkipCAVerification	Note: This parameter is obsolete. For SSL connection. Defines that the cmdlet will skip Certificate Authority verification.	SwitchParameter	False	Named	False
ExchangeSkipCommonName Verification	Note: This parameter is obsolete. For SSL connection. Defines that the cmdlet will skip Common Name verification.	SwitchParameter	False	Named	False
ExchangeSkipRevocationCheck	Note: This parameter is obsolete. For SSL connection. Defines that the cmdlet will skip the check of certificate expiration against the certificate revocation list.	SwitchParameter	False	Named	False
ExchangeUseSSL	Note: This parameter is obsolete. Defines that the cmdlet will set up a secure connection with Microsoft Exchange organization server.	SwitchParameter	False	Named	False
Type	Note: This parameter is obsolete. Defines the type of the organization deployment: Office365 On-premises Hybrid	VBOOrganizationType	False	Named	False
Office365Region	Note: This parameter is obsolete. Specifies Microsoft Azure region where Microsoft Office 365 organization datacenter is located: Worldwide USGovernment Germany China USDefence Default: Worldwide	VBOOffice365Region	False	Named	False
Office365Credential	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	PSCredential	False	Named	False
Office365GrantImpersonation	Note: This parameter is obsolete. Defines that backup jobs will be able to process all mailboxes within Microsoft Office 365 organization.	SwitchParameter	False	Named	False
Office365GrantAccessToSite Collections	Note: This parameter is obsolete. Defines that the cmdlet will assign user Site Collection Administrator rights for accessing site collections and sites.	SwitchParameter	False	Named	False
Office365UseVeeamAADApplication	Note: This parameter is obsolete. Defines 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	SwitchParameter	False	Named	False
IsExchange	Note: This parameter is obsolete. Defines if the selected organization contains Microsoft Exchange components.	SwitchParameter	False	Named	False
IsSharePoint	Note: This parameter is obsolete. Defines if the selected organization contains Microsoft SharePoint components.	SwitchParameter	False	Named	False
SharePointServerName	Note: This parameter is obsolete. Specifies SharePoint server name.	String	False	Named	False
SharePointServerPort	Note: This parameter is obsolete. Specifies SharePoint server port.	Int	False	Named	False
SharePointCredential	Note: This parameter is obsolete. Specifies the credentials you want to use for authenticating to organization with SharePoint On-premises components.	PSCredential	False	Named	False
SharePointGrantAccessToSite Collections	Note: This parameter is obsolete. Defines if you choose to automatically grant required permissions and assign roles to gain access to SharePoint site collections.	SwitchParameter	False	Named	False
SharePointUseSSL	Note: This parameter is obsolete. Defines that the cmdlet will use a secure connection with Microsoft SharePoint server.	SwitchParameter	False	Named	False
SharePointSkipCAVerification	Note: This parameter is obsolete. For a secure connection. Defines that Certificate Authority verification check will not be performed.	SwitchParameter	False	Named	False
SharePointSkipCommonName Verification	Note: This parameter is obsolete. For a secure connection. Defines that common name verification check will not be performed.	SwitchParameter	False	Named	False
SharePointSkipRevocationCheck	Note: This parameter is obsolete. For a secure connection. Defines that certificate revocation check will not be performed.	SwitchParameter	False	Named	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Examples

Set-VBOOrganization Example 1. Modifying Services to Back Up SharPoint Online and OneDrive for Business

This example shows how to include SharePoint Online and OneDrive for Business service to a backup of the Microsoft organization.

$credentials = Get-Credential

$connection = New-VBOOffice365ConnectionSettings -Credential $Credentials -GrantRolesAndPermissions

$org = Get-VBOOrganization -Name "Atlanta"

Set-VBOOrganization -Organization $org -Office365ExchangeConnectionsSettings $connection -Office365SharePointConnectionsSettings $connection -EnableOffice365SharePoint

Perform the following steps:

Run the Get-Credential cmdlet. Enter credentials. Save the result to the $credentials variable.

Run the New-VBOOffice365ConnectionSettings cmdlet. Set the $credentials variable as the Credential parameter value. Provide the GrantRolesAndPermissions parameter. Save the result to the $connection variable.
Run the Get-VBOOrganization cmdlet. Specify the Name parameter value. Save the result to the $org variable.
Run the Set-VBOOrganization cmdlet. Specify the following settings:

Set the $org variable as the Organization parameter value.
Set the $connection variable as the Office365ExchangeConnectionsSettings parameter value.
Set the $connection variable as the Office365SharePointConnectionsSettings parameter value.
Provide the EnableOffice365SharePoint parameter.

Set-VBOOrganization Example 2. Modifying Auxiliary Backup Accounts

This example shows how to modify the auxiliary backup accounts that are used to back up SharePoint and OneDrive for Business.

$org = Get-VBOOrganization

$group = Get-VBOOrganizationGroup -Organization $org -Name "VBOWorkGroup"

$members = Get-VBOOrganizationGroupMember -Group $group

$pwd = ConvertTo-SecureString -String "Pa$$word123" -AsPlainText -Force

$account = New-VBOBackupAccount -SecurityGroupMember $members[0] -Password $pwd

$org = Get-VBOOrganization -Name "Atlanta"

Set-VBOOrganization -Organization $org -BackupAccounts $account

Perform the following steps:

Define settings of auxiliary backup accounts:

Run the Get-VBOOrganization cmdlet. Save the result to the $org variable.
Run the Get-VBOOrganizationGroup cmdlet. Set the $org variable as the Organization parameter value. Specify the Name parameter value. Save the result to the $group variable.
Run the Get-VBOOrganizationGroupMember cmdlet. Set the $group variable as the Group variable value. Save the result to the $members variable.
Run the ConvertTo-SecureString cmdlet. Specify the necessary parameters. Save the result to the $pwd variable.
Run the New-VBOBackupAccount cmdlet. Set the $members variable as the SecurityGroupMember parameter value. Set the $pwd variable as the Password parameter value. Save the result to the $pwd variable.

Run the Get-VBOOrganization cmdlet. Specify the Name parameter value. Save the result to the $org variable.
Run the Set-VBOOrganization cmdlet. Set the $org variable as the Organization parameter value. Set the $account variable as the BackupAccounts parameter value.

Set-VBOOrganization Example 3. Adding Array of Backup Application to Veeam Backup for Microsoft Office 365

This example shows how to add an array of backup applications to the Veeam Backup for Microsoft Office 365 infrastructure.

$org = Get-VBOOrganization

$apps = Get-VBOApplication -Organization $org

$backupApp1 = New-VBOBackupApplication -Application $apps -ApplicationCertificatePath "C:\certificate\cert.pfx (3).pfx" -ApplicationCertificatePassword $securepassword

$backupApp2 = New-VBOBackupApplication -Application $apps -ApplicationCertificatePath "C:\certificate\cert.pfx (3).pfx" -ApplicationCertificatePassword $securepassword

$backupApp3 = New-VBOBackupApplication -Application $apps -ApplicationCertificatePath "C:\certificate\cert.pfx (3).pfx" -ApplicationCertificatePassword $securepassword

$AppArray = $backupApp1,$backupApp2,$backupApp3

Set-VBOOrganization -Organization $org -BackupApplications $AppArray

Perform the following steps:

Get an array of Azure AD applications:

Run the Get-VBOOrganization cmdlet. Save the result to the $org variable.
Run the Get-VBOApplication cmdlet. Set the $org variable as the Organization parameter.

Modify backup application settings:

Run the New-VBOBackupApplication cmdlet. Specify the Application, ApplicationCertificatePath and ApplicationCertificatePassword parameters. Save the result to the $backupApp1 variable.
Run the New-VBOBackupApplication cmdlet. Specify the Application, ApplicationCertificatePath and ApplicationCertificatePassword parameters. Save the result to the $backupApp2 variable.
Run the New-VBOBackupApplication cmdlet. Specify the Application, ApplicationCertificatePath and ApplicationCertificatePassword parameters. Save the result to the $backupApp3 variable.

Set the $AppArray variable value to the sequence of the $backupApp1, $backupApp2 and $backupApp3 variables.
Run the Set-VBOOrganization cmdlet. Set the $org variable as the Organization parameter. Set the $AppArray variable as the BackupApplications parameter value.

Set-VBOOrganization Example 4. Modifying Backup Application Settings

This example shows how to modify the existing backup application. The cmdlet will replace it with the new BackupApp09 backup application to back up SharePoint and OneDrive for Business.

$securepassword = Read-Host "Enter your password" -AsSecureString

Enter your password: **********

$org = Get-VBOOrganization -Name "Atlanta"

$backupApp = New-VBOBackupApplication -Name "BackupApp09" -Organization $org -ApplicationCertificatePath "C:\certificate\cert.pfx" -ApplicationCertificatePassword $securepassword

Set-VBOOrganization -Organization $org -BackupApplications $backupApp

Perform the following steps:

Specify the secure password:

Run the Read-Host cmdlet. Specify the message that the console will display as a prompt. Specify the AsSecureString parameter. Save the result to the $securepassword variable.
Enter the password.

Run the Get-VBOOrganization cmdlet. Save the result to the $org variable.
Run the New-VBOBackupApplication cmdlet. Specify the Name, Organization, ApplicationCertificatePath and ApplicationCertificatePassword parameters.
Run the Set-VBOOrganization cmdlet. Set the $org variable as the Organization parameter value. Set the $backupApp variable as the BackupApplications parameter value.

Related Commands