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

Set-VBOOnPremConnectionSettings

Short Description

Modifies connection settings to access on-premises Microsoft organizations.

Syntax

This cmdlet provides the following parameter sets.

  • Modify connection settings to access on-premises Microsoft Exchange organizations:

Set-VBOOnPremConnectionSettings -Settings <VBOOnPremConnectionSettings> [-Credential <pscredential>] [-ServerName <string>] [-UseSSL] [-SkipCAVerification] [-SkipCommonNameVerification] [-SkipRevocationCheck] [-ConfigureUserAccount] [-ConfigureThrottlingPolicy]  [<CommonParameters>]

  • Modify connection settings to access on-premises Microsoft SharePoint organizations

Set-VBOOnPremConnectionSettings -Settings <VBOOnPremConnectionSettings> [-Credential <pscredential>] [-ServerName <string>] [-ServerPort <uint16>] [-UseSSL] [-SkipCAVerification] [-SkipCommonNameVerification] [-SkipRevocationCheck]  [<CommonParameters>]

Detailed Description

This cmdlet modifies connection settings to access on-premises Microsoft organizations. You can apply these settings to add on-premises Microsoft organizations to Veeam Backup for Microsoft Office 365 infrastructure.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Settings

Specifies the authentication settings that you want to modify.

Accepts the VBOOnPremConnectionSettings object.

True

Named

True (ByValue)

False

Credential

Specifies credentials. The cmdlet will use these credentials to connect to an on-premises Microsoft organization.

NOTE: You must specify credentials in in one of the following formats:

  • Account@domain
  • Domain\account

False

Named

False

False

ServerName

Specifies a name of an on-premises Microsoft server. The cmdlet will connect to this server.

False

Named

False

False

ServerPort

Specifies a port number that the cmdlet will use to connect to the on-premises Microsoft SharePoint server.

NOTE: This cmdlet is not required if you want to add the on-premises Microsoft Exchange organization.

False

Named

False

False

UseSSL

Enables SSL encryption. The cmdlet will establish secure connection with on-premises Microsoft server using SSL.

False

Named

False

False

SkipCAVerification

For SSL connection.

Indicates that the cmdlet will skip the certificate trusted authority verification.

False

Named

False

False

SkipCommonNameVerification

For SSL connection.

Indicates that the cmdlet will skip the certificate common name verification.

False

Named

False

False

SkipRevocationCheck

For SSL connection.

Indicates that the cmdlet will skip the certificate revocation check.

False

Named

False

False

ConfigureUserAccount

Indicates that the cmdlet will assign the user to the ApplicationImpersonation role.

False

Named

False

False

ConfigureThrottlingPolicy

Indicates that the cmdlet will skip the default Exchange throttling policy and will use the VeeamArchiverThrottlingPolicy that provides unlimited network bandwidth.

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 modify connection settings for a Microsoft Exchange on-premises organization with a name "ABC":

  1. Run Get-Credential to create a credential object. Enter credentials you want to use for authenticating with a Microsoft Exchange on-premises organization. Save the result to the $Credentials variable.
  2. Run Get-VBOOrganization to get an organization with the name "ABC". Save the result to the $Organization variable.
  3. Run Set-VBOOnPremConnectionSettings with the $Organization.OnPremExchangeConnectionSettings and $Credentials variables and a ServerName parameter value to modify the connection settings of  a Microsoft Exchange on-premises organization with a name "ABC".

$Credentials = Get-Credential

$Organization = Get-VBOOrganization -Name "ABC"

Set-VBOOnPremConnectionSettings -Settings $Organization.OnPremExchangeConnectionSettings -Credential $Credentials -ServerName Support.North

Example 2

This example shows how to modify connection settings for a Microsoft SharePoint on-premises organization with a name "ABC":

  1. Run Get-Credential to create a credential object. Enter credentials you want to use for authenticating with a Microsoft SharePoint organization. Save the result to the $Credentials variable.
  2. Run Get-VBOOrganization to get an organization with the name "ABC". Save the result to the $Organization variable.
  3. Run Set-VBOOnPremConnectionSettings with the $Organization.OnPremSharePointConnectionSettings and $Credentials variables and ServerName and ServerPort parameters values to modify the connection settings of a Microsoft SharePoint on-premises organization with a name "ABC".

$Credentials = Get-Credential

$Organization = Get-VBOOrganization -Name "ABC"

Set-VBOOnPremConnectionSettings -Settings $Organization.OnPremSharePointConnectionSettings -Credential $Credentials -ServerName Support.North -ServerPort 5986

Related Commands

Get-VBOOrganization

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference