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

Add-VBRSmbV3Cluster

In this article

Short Description

Adds an SMB3 cluster to Veeam Backup & Replication.

Applies to

Platform: Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Add-VBRSmbV3Cluster -Name <String> -User <String> -Password <String> [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

-OR-

Add-VBRSmbV3Cluster -Name <String> [-Description <String>] -Credentials <CCredentials> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Related Commands

Get-VBRCredentials

Detailed Description

This cmdlet adds an SMB3 cluster to the Veeam Backup & Replication managing console.

If you include your virtual machines in clusters, you need to add the clusters to Veeam Backup & Replication to be able to manage your virtual infrastructure via Veeam Backup & Replication console. When you add a cluster, you start managing the VMs that are part of the cluster automatically.

When you remove a Hyper-V cluster from Veeam Backup & Replication managing console, the VMs that are part of the cluster are removed too. If you want to manage individual VMs with Veeam Backup & Replication, you need to add them as standalone SMB3 servers.

Run Add-VBRSmbV3Host to add a standalone SMB3 server to Veeam Backup & Replication.

When adding a new SMB3 cluster, you will need to provide either username and password or credentials. This cmdlet provides syntax for both scenarios accordingly. When you provide authentication with the Hyper-V cluster, you get equal rights for all clustered VMs.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Name	Specifies the full DNS name or IP address of the SMB3 cluster.	True	Named	False	False
User	Specifies the user name you want to use for authenticating with the SMB3 cluster. If you use the Username/Password scenario, the -Credentials parameter must be omitted.	True	Named	False	False
Password	Specifies the password you want to use for authenticating with the SMB3 cluster. If you use the Username/Password scenario, the -Credentials parameter must be omitted.	True	Named	False	False
Description	Specifies the description of the SMB3 cluster. If not set, Veeam Backup & Replication will enter date and time of creation by default.	False	Named	False	False
Credentials	Specifies the credentials you want to use for authenticating with the SMB3 cluster. If you use the Credentials scenario, the -User and -Password parameters must be omitted.	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 1

This command adds a new SMB3 cluster named "SMBCLUSTER01" using username and password. The user name is "Administrator", and the password is "Password". The description is "Hyper-V SMB Share Cluster 01".

Add-VBRSmbV3Cluster -Name "SMBCLUSTER01" -User "Administrator" -Password "Password" -Description "Hyper-V SMB Share Cluster 01"

Example 2

This command adds a new SMB3 cluster named "SMBCLUSTER01" using credentials. The credentials object is obtained with Get-VBRCredentials and assigned to the $Administrator variable beforehand. The description is "Hyper-V SMB Share Cluster 01".

Add-VBRHvCluster -Name "SMBCLUSTER01" -Description "Hyper-V SMB Share Cluster 01" -Credentials $Administrator