Connect-VBRServer

In this article

    Short Description

    Connects to a Veeam backup server.

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Connect to a Veeam backup server as a current user.

    Connect-VBRServer [-Server <string>] [-Port <int>]  [<CommonParameters>]

    • Connect to a Veeam backup server using User/Password authentication.

    Connect-VBRServer -User <string> -Password <string> [-Server <string>] [-Port <int>]  [<CommonParameters>]

    • Connect to a Veeam backup server using using the credentials prompt.

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

    Detailed Description

    This cmdlet creates connection with a local or remote Veeam backup server. The connection starts a Veeam PowerShell session during which you can perform all operations available with Veeam PowerShell.

    If you do not specify the server, you will connect to the local Veeam backup server.

    Within one PowerShell session, you can connect to one Veeam server. To connect to another Veeam server, you need to close the current session.

    Run the Disconnect-VBRServer cmdlet to stop session with the current Veeam server.

    Run the Get-VBRServerSession cmdlet to get information about the current session.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Server

    Specifies the Veeam server to which you want to connect.

    Default: localhost.

    Accepts the CHost object. To get this object, run the Get-VBRServer cmdlet.

    False

    Named

    False

    Port

    Specifies the port for connection.

    Default: 9392.

    Int

    False

    Named

    False

    User

    Specifies the user name you want to use for authenticating with the remote server.

    Note: You must specify the user name in the DOMAIN\username format.

    String

    True

    Named

    False

    Password

    Specifies the password you want to use for authenticating with the Veeam server.

    String

    True

    Named

    False

    Credential

    Specifies the credentials you want to use for authenticating with the Veeam server.

    Accepts the PSCredential object. To get this object, run the Get-Credential cmdlet.

    True

    Named

    False

    <CommonParameters>

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

    Return Type

    None

    Examples

    Connect-VBRServerExample 1. Connecting to Veeam Backup Server as Current User

    This command connects to the 192.24.125.135 Veeam backup server as a current user.

    Connect-VBRServer -Server 192.24.125.135

    Connect-VBRServerExample 2. Connecting to Veeam Backup Server with User/Password Authentication

    This command connects to the 192.24.125.135 server using the User/Password authentication.

    Connect-VBRServer -Server "192.24.125.135" -User "TECH\Administrator" -Password "Password"

    Connect-VBRServerExample 3. Connecting to Veeam Backup Server Using Credentials Prompt

    This example shows how to connect to the 192.24.125.135 Veeam backup server using the credentials prompt.

    Screds = Get-Credential

    Connect-VBRServer -Credential Screds -Server 192.24.125.135

    Perform the following steps:

    1. Run the Get-Credential cmdlet. The cmdelt will prompt for a user name and password. Enter the necessary values. Save the result to the Screds variable.
    2. Run the Connect-VBRServer cmdlet. Set the Screds variable as the Credential parameter value. Specify the Server parameter value.

    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.