Connect-VBRServer
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 <Int32>] [-Timeout <Int32>] [-ForceAcceptTlsCertificate] [<CommonParameters>] |
- Connect to a Veeam backup server using User/Password authentication.
|
Connect-VBRServer [-Server <String>] [-Port <Int32>] -User <String> -Password <String> [-Timeout <Int32>] [-ForceAcceptTlsCertificate] [<CommonParameters>] |
- Connect to a Veeam backup server using using the credentials prompt.
|
Connect-VBRServer [-Server <String>] [-Port <Int32>] -Credential <PSCredential> [-Timeout <Int32>] [-ForceAcceptTlsCertificate] [<CommonParameters>] |
- Connect to the Veeam Backup & Replication server that the console is currently connected to.
|
Connect-VBRServer [-Server <String>] [-Port <Int32>] [-Timeout <Int32>] [-ForceAcceptTlsCertificate] [<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, the cmdlet connects to the local Veeam backup server.
If you open PowerShell from the Veeam Backup & Replication console, the cmdlet is called automatically and connects to the server to which the console is currently connected.
|
Note |
|
Only local and domain user accounts can be used for authentication. User accounts with SAML authentication are not supported. |
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. If PowerShell is launched from the Veeam Backup & Replication console, the server is inherited from the console session. |
Accepts the CHost object. To get this object, run the Get-VBRServer cmdlet. |
False |
Named |
False |
|
Port |
Specifies the port for connection. Default: 443. |
Int |
False |
Named |
False |
|
Timeout |
Specifies timeout in seconds for waiting for a blocked session. Default: 30. |
Int32 |
False |
Named |
False |
|
ForceAcceptTlsCertificate |
Defines that the cmdlet will accept the backup server TLS certificate. |
SwitchParameter |
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 or UPN 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. Note: When creating the PSCredential object, you must specify the user name in the DOMAIN\Username or UPN format. |
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 Microsoft Docs.
Output Object
None.
Examples
Example 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.
|
Example 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.
|
Example 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.
Perform the following steps:
|
Related Commands