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

New-VBOOnPremConnectionSettings

Short Description

Defines connection settings to access on-premises Microsoft organizations.

Syntax

This cmdlet provides the following parameter sets.

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

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

  • Defines connection settings to access on-premises Microsoft SharePoint organizations:

New-VBOOnPremConnectionSettings -Credential <pscredential> -ServerName <string> -ServerPort <uint16> [-UseSSL] [-SkipCAVerification] [-SkipCommonNameVerification] [-SkipRevocationCheck] [-ConfigureUserAccount] [-ConfigureThrottlingPolicy]  [<CommonParameters>]

Detailed Description

This cmdlet defines 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.

The cmdlet will create the VBOOnPremConnectionSettings object that contains connection settings to access the following types of on-premises Microsoft organizations:

  • On-premises Microsoft Exchange organizations
  • On-premises Microsoft SharePoint organizations

Run the Add-VBOOrganization cmdlet to add Microsoft organizations to Veeam Backup for Microsoft Office 365 infrastructure.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

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

True

Named

False

False

ServerName

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

True

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.

True

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 create Microsoft Exchange on-premises organization connection settings:

  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 New-VBOOnPremConnectionSettings with the $Credentials variable to create Microsoft Exchange on-premises organization connection settings.

$Credentials = Get-Credential

New-VBOOnPremConnectionSettings -Credential $Credentials -ServerName Support.North

Example 2

This example shows how to create Microsoft SharePoint organization connection settings with a modern authentication with an application secret:

  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 ConvertTo-SecureString with the AsPlainText parameter to turn the ApplicationSecret into SecureString type. Save the result to the $ApplicationSecret variable.
  3. Run New-VBOOnPremConnectionSettings with the $Credentials variable and the ServerName and ServerPort parameters values to create Microsoft SharePoint on-premises organization connection settings.

$Credentials = Get-Credential

New-VBOOnPremConnectionSettings -Credential $Credentials -ServerName Support.North -ServerPort 5986

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference