Add-VBRSmbV3Host

In this article

    Short Description

    Adds an SMB3 host to Veeam Backup & Replication.

    Applies to

    Platform: Hyper-V

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

    Syntax

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

    -OR-

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

    Detailed Description

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

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

    Run Add-VBRSmbV3Cluster to add an SMB3 cluster.

    When adding a new SMB3 host, you will need to provide either user name and password or credentials. This cmdlet provides syntax for both scenarios accordingly.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Name

    Specifies the DNS name of the SMB3 host.

    True

    Named

    False

    False

    User

    Specifies the user name you want to use for authenticating with the SMB3 host.

    True

    Named

    False

    False

    Password

    Specifies the password you want to use for authenticating with the SMB3 host.

    True

    Named

    False

    False

    Description

    Specifies the description of the SMB3 host.

    False

    Named

    False

    False

    Credentials

    Specifies the credentials you want to use for authenticating with the SMB3 host.

    True

    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.

    Example 1

    This command adds a new SMB3 host named "SMBShare010" using user name and password. The user name is "Administrator", and the password is "Password". The description is "Hyper-V SMB Share Host 01".

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

    Example 2

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

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

    Related Commands

    Get-VBRCredentials

    Get-VBRServer

    Remove-VBRServer