Add-VBRSmbV3Host

Short Description

Adds an SMB3 host to the backup infrastructure.

Applies to

Platform: Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides parameter sets that allow you to:

Add a SMB3 host using the account user name and password.

Add-VBRSmbV3Host -Name <String> -User <String> -Password <String> [-Description <String>] [<CommonParameters>]

Add a SMB3 host using credentials managed by Veeam Backup & Replication.

Add-VBRSmbV3Host -Name <String> [-Description <String>] -Credentials <CCredentials> [<CommonParameters>]

Detailed Description

This cmdlet adds an SMB3 host to the backup infrastructure.

If an SMB3 host is part of a cluster, add the SMB3 cluster instead of standalone SMB3 host.

Run the Add-VBRSmbV3Cluster cmdlet to add an SMB3 cluster.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Name	Specifies the DNS name of the SMB3 host.	String	True	Named	False
User	Specifies the user name you want to use for authenticating with the SMB3 host.	String	True	Named	False
Password	Specifies the password you want to use for authenticating with the SMB3 host.	String	True	Named	False
Description	Specifies the description of the SMB3 host.	String	False	Named	False
Credentials	Specifies the credentials you want to use for authenticating with the SMB3 host.	Accepts the CCredentials object. To get this object, run the Get-VBRCredentials cmdlet	True	Named	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

None.

Examples

Add-VBRSmbV3Host Example 1. Adding New SMB3 Host Using User Name and Password

This command adds a new SMB3 host named SMBShare010 with the Administrator user name and the qwerty password of the account. The description is Hyper-V SMB Share Host 01.

Add-VBRSmbV3Host -Name "SMBShare010" -User "Administrator" -Password "qwerty" -Description "Hyper-V SMB Share Host 010"

Add-VBRSmbV3Host Example 2. Adding New SMB3 Host Using Credentials

This example shows how to add a new SMB3 host named SMBShare010 using credentials. The description is Hyper-V SMB Share Host 01.

$Administrator = Get-VBRCredentials

Add-VBRSmbV3Host -Name "SMBShare010" -Description "Hyper-V SMB Share Host 010" -Credentials $Administrator

Perform the following steps:

Run the Get-VBRCredentials cmdlet. Save the result to the $Administrator variable.
Run the Add-VBRSmbV3Host cmdlet. Specify the Name parameter value. Specify the Description parameter value. Set the $Administrator variable as the Credentials parameter value.

Related Commands

Get-VBRCredentials