Set-VBRNasFilerSMBServer

Short Description

Modifies settings of SMB shares located on an enterprise NAS system added to the inventory.

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

Syntax

This cmdlet provides the following parameter sets:

OverwriteSettings (Default)

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

[-MetaMigrationType <VBRNASBackupMetaMigrationType>]

[-RetrievalSettings <VBRUnstructuredBackupColdStorageRetrievalSettings>]

[-BackupIOControlLevel <VBRNASBackupIOControlLevel>] [-Force] [<CommonParameters>]

AddCredentials

Set-VBRNasFilerSMBServer -Server <VBRSANNASSMBServer> [-User <String>] [-Password <String>]

[-CacheRepository <CBackupRepository>] [-MetaMigrationType <VBRNASBackupMetaMigrationType>]

[-RetrievalSettings <VBRUnstructuredBackupColdStorageRetrievalSettings>]

[-BackupIOControlLevel <VBRNASBackupIOControlLevel>] [-Force] [<CommonParameters>]

Credentials

Set-VBRNasFilerSMBServer -Server <VBRSANNASSMBServer> [-AccessCredentials <CCredentials>]

[-CacheRepository <CBackupRepository>] [-MetaMigrationType <VBRNASBackupMetaMigrationType>]

[-RetrievalSettings <VBRUnstructuredBackupColdStorageRetrievalSettings>]

[-BackupIOControlLevel <VBRNASBackupIOControlLevel>] [-Force] [<CommonParameters>]

InheritSettings

Set-VBRNasFilerSMBServer -Server <VBRSANNASSMBServer> [-MetaMigrationType <VBRNASBackupMetaMigrationType>]

[-RetrievalSettings <VBRUnstructuredBackupColdStorageRetrievalSettings>] [-InheritSettingsFromFiler] [-Force] [<CommonParameters>]

Detailed Description

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

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
AccessCredentials	Specifies credentials that the cmdlet will use to authenticate against the enterprise NAS system.	`CCredentials`	False	Named	False
BackupIOControlLevel	Specifies a speed that Veeam Backup & Replication will use to read data from the file server. You can specify either of the following speed: `Lowest` `Low` `Medium` `High` `Highest`	`VBRNASBackupIOControlLevel`	False	Named	False
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.	`CBackupRepository`	False	Named	False
Force	Defines that the cmdlet will modify settings of SMB shares without showing warnings in the PowerShell console.	`SwitchParameter`	False	Named	False
InheritSettingsFromFiler	Defines that the SMB file share will inherit settings of the enterprise SMB system. If you provide this parameter, the cmdlet will inherit cache settings, throttling settings and credentials. Note: You must provide the `MetaMigrationType` to inherit cache repository settings.	`SwitchParameter`	True	Named	False
MetaMigrationType	Specifies how the cmdlet will migrate metadata. You can use one of the following options: `CheckExistence` — use this option to check that metadata is available on the current cache repository. `CopyMetaFromCache` — use this option to migrate metadata from source cache repository to a new cache repository. Note: If metadata in a source cache repository is corrupted, the cmdlet will copy data from the archive repository. `DownloadMetaFromArchive` — use this option to migrate metadata from archive repository or from replica metadata in archive repository.	`VBRNASBackupMetaMigrationType`	False	Named	False
Password	Specifies the password. The cmdlet will use this password to authenticate against the enterprise NAS system.	`String`	False	Named	False
RetrievalSettings	Specifies the retrieval policy settings. The cmdlet will use these settings to retrieve data from archive repositories. Accepts the `VBRUnstructuredBackupColdStorageRetrievalSettings` object. To create this object, run the `New-VBRUnstructuredBackupColdStorageRetrievalSettings` cmdlet.	`VBRUnstructuredBackupColdStorageRetrievalSettings`	False	Named	False
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-VBRUnstructuredServer` cmdlet.	`VBRSANNASSMBServer`	True	Named	True (ByPropertyName, ByValue)
User	Specifies the user name. The cmdlet will apply this user name to authenticate against the enterprise NAS system.	`String`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see 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-VBRNasFilerSMBServer Example 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-VBRUnstructuredServer -SANEntity $volume

$cacherepo = Get-VBRBackupRepository -Name "Cache repository 1"

Set-VBRNasFilerSMBServer -Server $isi -CacheRepository $cacherepo

Perform the following steps:

Run the Get-VBRIsilonHost cmdlet. Specify the Name parameter value. Save the result to the $isilonhost variable.
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.
Run the Get-VBRUnstructuredServer cmdlet. Set the $volume variable as the SANEntity parameter value. Save the result to the $volume variable.
Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $cacherepo variable.
Run the Set-VBRNasFilerSMBServer cmdlet. Set the $isi variable as the Server parameter value. Set the $cacherepo variable as the CacheRepository parameter value.

Set-VBRNasFilerSMBServer Example 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-VBRUnstructuredServer -SANEntity $volume

Set-VBRNasFilerSMBServer -Server $isi -InheritSettingsFromFiler

Perform the following steps:

Run the Get-VBRIsilonHost cmdlet. Specify the Name parameter value. Save the result to the $isilonhost variable.
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.
Run the Get-VBRUnstructuredServer cmdlet. Set the $volume variable as the SANEntity parameter value. Save the result to the $volume variable.
Run the Set-VBRNasFilerSMBServer cmdlet. Set the $isi variable as the Server parameter value. Provide the InheritSettingsFromFiler parameter.