New-VBOOnPremConnectionSettings

In this article

    Short Description

    Defines connection settings to access on-premises Microsoft organizations.

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Define connection settings to access on-premises Microsoft Exchange organizations.

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

    • Define 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

    Type

    Required

    Position

    Accept Pipeline Input

    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

    PSCredential

    True

    Named

    False

    ServerName

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

    String

    True

    Named

    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.

    Uint16

    True

    Named

    False

    UseSSL

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

    SwitchParameter

    False

    Named

    False

    SkipCAVerification

    For SSL connection.

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

    SwitchParameter

    False

    Named

    False

    SkipCommonNameVerification

    For SSL connection.

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

    SwitchParameter

    False

    Named

    False

    SkipRevocationCheck

    For SSL connection.

    Defines that the cmdlet will skip the certificate revocation check.

    SwitchParameter

    False

    Named

    False

    ConfigureUserAccount

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

    SwitchParameter

    False

    Named

    False

    ConfigureThrottlingPolicy

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

    SwitchParameter

    False

    Named

    False

    <CommonParameters>

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

    Examples

    Example 1

    This example shows how to create Microsoft Exchange on-premises organization connection settings:

    1. Run the Get-Credential cmdlet 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 the New-VBOOnPremConnectionSettings cmdlet 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 using modern authentication with legacy protocols allowed with an application secret:

    1. Run the Get-Credential cmdlet 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 the ConvertTo-SecureString cmdlet with the AsPlainText parameter to turn the ApplicationSecret into the SecureString type. Save the result to the $ApplicationSecret variable.
    3. Run the New-VBOOnPremConnectionSettings cmdlet 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

    Related Commands

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.