Set-VBRNasFilerSMBServer

In this article

    Short Description

    Modifies settings of SMB shares located on an enterprise NAS system and added to the backup infrastructure.

    Applies to

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

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Specify a cache repository to use for an SMB file share located on an enterprise NAS system.

    Set-VBRNasFilerSMBServer -Server <VBRSANNASSMBServer> [-CacheRepository <CBackupRepository>]  [<CommonParameters>]

    • Specify that an SMB file share located on an enterprise NAS system will inherit settings of the cache repository from NAS system settings.

    Set-VBRNasFilerSMBServer -Server <VBRSANNASSMBServer> -InheritSettingsFromFiler  [<CommonParameters>]

    Detailed Description

    This cmdlet modifies settings of SMB shares located on an enterprise NAS system and added to the backup infrastructure. You can either specify the cache repository manually or make the file share to inherit cache repository settings from the enterprise NAS system.

    To modify settings, enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Server

    Specifies an SMB file share. The cmdlet will modify settings for this file share.

    Accepts the VBRSANNASSMBServer (VBRNASServer) object. To get this object, run the Get-VBRNASServer cmdlet.

    True

    Named

    True (ByValue, ByPropertyName)

    CacheRepository

    Specifies a cache repository. The cmdlet will set this repository as a cache repository for the SMB file share.

    Accepts the CBackupRepository object. To get this object, run the Get-VBRBackupRepository cmdlet.

    False

    Named

    False

    InheritSettingsFromFiler

    Defines that the SMB file share will inherit cache repository settings from the settings of the enterprise NAS system that it is located on.

    SwitchParameter

    True

    Named

    False

    <CommonParameters>

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

    Output Object

    The cmdlet returns the VBRNASServer object that defines settings of the SMB file share located on the enterprise NAS system.

    Examples

    Set-VBRNasFilerSMBServerExample 1. Setting Cache Repository for SMB Share Manually

    This example shows how to modify SMB share: a cache repository is specified manually.

    $isilonhost = Get-VBRIsilonHost -Name "HostName"
    $volume = Get-VBRIsilonVolume -Name "SMB Share" -Host $isilonhost
    $isi = Get-VBRNASServer -SANEntity $volume
    $cacherepo = Get-VBRBackupRepository -Name "Cache repository 1"
    Set-VBRNasFilerSMBServer -Server $isi -CacheRepository $cacherepo

    Perform the following steps:

    1. Run the Get-VBRIsilonHost cmdlet. Specify the Name parameter value. Save the result to the $isilonhost variable.
    2. Run the Get-VBRIsilonVolume cmdlet. Specify the Name parameter value. Set the $isilonhost variable as the Host parameter value. Save the result to the $volume variable.
    3. Run the Get-VBRNASServer cmdlet. Set the $volume variable as the SANEntity parameter value. Save the result to the $volume variable.
    4. Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $cacherepo variable.
    5. Run the Set-VBRNasFilerSMBServer cmdlet. Specify the following settings:
    • Set the $isi variable as the Server parameter value.
    • Set the $cacherepo variable as the CacheRepository parameter value.

    Set-VBRNasFilerSMBServerExample 2. Setting Cache Repository Settings Inherited from NAS System for SMB Share

    This example shows how to modify SMB share: a cache repository settings are inherited from the enterprise NAS system on which the share is located.

    $isilonhost = Get-VBRIsilonHost -Name "HostName"
    $volume = Get-VBRIsilonVolume -Name "SMB Share" -Host $isilonhost
    $isi = Get-VBRNASServer -SANEntity $volume
    Set-VBRNasFilerSMBServer -Server $isi -InheritSettingsFromFiler

    Perform the following steps:

    1. Run the Get-VBRIsilonHost cmdlet. Specify the Name parameter value. Save the result to the $isilonhost variable.
    2. Run the Get-VBRIsilonVolume cmdlet. Specify the Name parameter value. Set the $isilonhost variable as the Host parameter value. Save the result to the $volume variable.
    3. Run the Get-VBRNASServer cmdlet. Set the $volume variable as the SANEntity parameter value. Save the result to the $volume variable.
    4. Run the Set-VBRNasFilerSMBServer cmdlet. Specify the following settings:
    • Set the $isi variable as the Server parameter value.
    • Specify the InheritSettingsFromFiler parameter.

    Related Commands

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.