Connects to a Veeam backup server.
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>]
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.
Accept Pipeline Input
Specifies the Veeam server to which you want to connect.
Accepts the CHost object. To get this object, run the Get-VBRServer cmdlet.
Specifies the port for connection.
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.
Specifies the password you want to use for authenticating with the Veeam server.
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.
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Example 1. Connecting to Veeam Backup Server as Current User
This command connects to the 18.104.22.168 Veeam backup server as a current user.
Example 2. Connecting to Veeam Backup Server with User/Password Authentication
This command connects to the 22.214.171.124 server using the User/Password authentication.
Example 3. Connecting to Veeam Backup Server Using Credentials Prompt
This example shows how to connect to the 126.96.36.199 Veeam backup server using the credentials prompt.
Perform the following steps: