Connect-VBOServer

Short Description

Connects to the Veeam Backup for Microsoft 365 server.

Syntax

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

Detailed Description

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

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

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

Connect-VBOServer Note

This cmdlet requires a PSCredential object. To obtain a PSCredential object, run the Get-Credential cmdlet.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Server

Specifies the Veeam Backup for Microsoft 365 server. The cmdlet will connect to this server.

Default: localhost.

String

False

Named

False

False

Port

Specifies the port number. The cmdlet will use this port number to connect to Veeam Backup for Microsoft 365.

Default: 9191.

Int32

False

Named

False

False

Credential

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

If you do not provide this parameter, the cmdlet will use the the current account credentials.

PSCredential

False

Named

False

False

<CommonParameters>

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

Examples

Connect-VBOServerExample 1. Connecting to Server

This command connects to the Veeam Backup for Microsoft 365 server with the following settings:

  • The server IP address is 172.13.53.53.
  • To connect to the server, the cmdlet will use the current account credentials.

Connect-VBOServer -Server "172.13.53.53"

Connect-VBOServerExample 2. Connecting to Server Using Specific Credentials

This example shows how to connect to the Veeam Backup for Microsoft 365 server with the following settings:

  • The server IP address is 172.17.53.58.
  • To connect to the server, the cmdlet will use the credentials that you provide.

$creds = Get-Credential

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

Perform the following steps:

  1. Run the Get-Credential cmdlet. Enter the credentials you want to use to connect to the Veeam Backup for Microsoft 365 server. Save the result to the $creds variable.
  2. Run the Connect-VBOServer cmdlet. Set the $creds variable as the Credential parameter value.

Related Commands

Get-Credential