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

Connect-VBRServer

In this article

Short Description

Connects to Veeam backup server.

Syntax

This cmdlet provides three parameter sets.

To connect as a current user:

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

To connect using credentials:

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

To connect using a PSCredential object:

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

Related Commands

Get-VBRServer

Get-VBRLocalhost

Get-VBRCredentials

Return Type

None

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 connect to the local Veeam backup server.

Within one session, you can connect to one Veeam server. To connect to another Veeam server, you need to close the current session. Run Disconnect-VBRServer to stop session with the current Veeam server.

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

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Server	Specifies the Veeam server to which you want to connect. Default: localhost.	False	Named	False	False
Port	Specifies the port for connection. Default: 9392.	False	Named	False	False
User	Specifies the user name you want to use for authenticating with the remote server. Note that you should use DOMAIN\USERNAME usernames format.	True	Named	False	False
Password	Specifies the password you want to use for authenticating with the Veeam server.	True	Named	False	False
Credential	Specifies the credentials you want to use for authenticating with the Veeam server.	True	Named	False	False

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example

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

PS C:\PS> Connect-VBRServer -Server "172.17.53.36" -User "Administrator" -Password "Password"