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

Connect-VBOServer

In this article

    Short Description

    Connects to Veeam Backup for Microsoft Office 365 server.

    Syntax

    Connect-VBOServer [-Server <string>] [-Port <int>] [-Credential <pscredential>]  [<CommonParameters>]

    Detailed Description

    This cmdlet creates a connection with a local or remote Veeam Backup for Microsoft Office 365 server. The connection starts a Veeam Backup for Microsoft Office 365 PowerShell session. During the session you can perform all operations available with Veeam Backup for Microsoft Office 365 PowerShell.

    If you do not specify the server, you will connect to the local Veeam Backup for Microsoft Office 365 server.

    Within one session you can connect to one Veeam Backup for Microsoft Office 365 server. To connect to another Veeam Backup for Microsoft Office 365 server you will need to close the current session. Run the Disconnect-VBOServer cmdlet to stop the session with the current Veeam Backup for Microsoft Office 365 server.

    Connect-VBOServer Note:

    This cmdlet requires a PSCredential object. To obtain a PSCredential object, run the Get-Credential cmdlet as described in the Microsoft Powershell Reference.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Server

    Specifies Veeam Backup for Microsoft Office 365 server to which you want to connect.

    Default: localhost.

    False

    Named

    False

    False

    Port

    Specifies the port for connection.

    Default: 9191.

    False

    Named

    False

    False

    Credential

    Specifies credentials you want to use for authenticating against the Veeam Backup for Microsoft Office 365 server.

    If you do not provide this parameter, to authenticate against the Veeam Backup for Microsoft Office 365 server, the cmdlet will use the account under which you are currently logged in.

    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 connect to a Veeam Backup for Microsoft Office 365 server with the 172.13.53.53 IP. To connect to the server, the cmdlet will use the account under which you are currently logged in.

    Connect-VBOServer -Server "172.13.53.53"

    Example 2

    This command connects to a Veeam Backup for Microsoft Office 365 server with the 172.17.53.58 IP. To connect to the server, the cmdlet will use the credentials that you provide.

    1. Run the Get-Credential cmdlet to create a credential object. Enter the credentials you want to use to connect to the backup proxy. Save the result to the $creds variable.
    2. Run the Connect-VBOServer cmdlet. Set the $creds variable as the Credential parameter value.

    $creds = Get-Credential

    Connect-VBOServer -Server "172.17.53.58" -Credential $creds

    I want to report a typo

    There is a misspelling right here:

     

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