New-VBRNASPermissionSet

Short Description

Creates a permission set for instant restore of file share backups that will be used if the file share backup does not contain security information.

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

Syntax

This cmdlet provides the following parameter sets:

PermissionsAllowAll (Default)

New-VBRNASPermissionSet [-RestorePoint] <VBRUnstructuredBackupRestorePoint[]> [-Owner] <String>

[-AllowEveryone] [-Server <CHost>] [-UseLinuxLocalUser] [<CommonParameters>]
PermissionsDenyAll

New-VBRNASPermissionSet [-RestorePoint] <VBRUnstructuredBackupRestorePoint[]> [-Owner] <String> [-DenyEveryone]

[-Server <CHost>] [-UseLinuxLocalUser] [<CommonParameters>]

PermissionsAllowSelected

New-VBRNASPermissionSet [-RestorePoint] <VBRUnstructuredBackupRestorePoint[]> [-Owner] <String>

[-AllowSelected] -PermissionScope <String[]> [-Server <CHost>] [-UseLinuxLocalUser] [<CommonParameters>]

Detailed Description

The cmdlet creates a permission set for instant restore of file share backups that will be used if the file share backup does not contain security information.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
AllowEveryone	Defines that the permission set will allow access to the published SMB share to everyone. Note: If the `DenyEveryone`, `AllowSelected`, or `AllowEveryone` parameter is not specified, the cmdlet will use the `AllowEveryone` parameter by default.	`SwitchParameter`	False	Named	False
AllowSelected	Defines that the permission set will allow access to the published SMB share to the limited number of users specified in the `PermissionScope` parameter. This parameter must be specified together with the `PermissionScope` parameter.	`SwitchParameter`	True	Named	False
DenyEveryone	Defines that the permission set will deny access to the published SMB share to everyone except its owner.	`SwitchParameter`	True	Named	False
Owner	Specifies a name of the account or group in the user name or domain\\user name format. The cmdlet will use this parameter if the file share backup does not contain security information.	`String`	True	1	False
PermissionScope	Specifies an array of users. The cmdlet will provide these users with the access to the published SMB share. This parameter must be specified together with the `AllowSelected` parameter.	`String[]`	True	Named	False
RestorePoint	Specifies an array of restore points. The cmdlet will create a permission set with specific security settings for each of the specified restore points. Accepts the `VBRUnstructuredBackupRestorePoint[]` object. To get this object, run the `Get-VBRUnstructuredBackupRestorePoint` cmdlet.	`VBRUnstructuredBackupRestorePoint[]`	True	0	True (ByPropertyName, ByValue)
Server	Specifies the Linux mount server which local user account you want to use. Accepts the `CHost` object. To get this object, run the `Get-VBRServer` cmdlet.	`CHost`	False	Named	False
UseLinuxLocalUser	Defines that the permission set will use the Linux local user account.	`SwitchParameter`	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 a VBRNASPermissionSet object for each specified restore point. This object defines permission settings that will be applied to instant restore of file share backups.

Examples

New-VBRNASPermissionSet Example 1. Creating Permission Set to Deny Access to SMB Share to Everyone Except Owner

The following request creates a permission set that denies access to the published SMB share to everyone except its owner.

$backup = Get-VBRUnstructuredBackup -Name "Daily SMB1 Backup"

$nasBackupPoint = Get-VBRUnstructuredBackupRestorePoint -NASBackup $backup

$permissions = New-VBRNASPermissionSet -RestorePoint $nasBackupPoint[0] -Owner "User 1" -DenyEveryone

Perform the following steps:

Run the Get-VBRUnstructuredBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Get-VBRUnstructuredBackupRestorePoint cmdlet. Set the $backup variable as the NASBackup parameter value. Save the result to the $nasBackupPoint variable.
Run the New-VBRNASPermissionSet cmdlet. Specify the following parameters:
- Specify the first value from the array returned to the $nasBackupPoint variable as the RestorePoint parameter.
- Specify the Owner parameter value.
- Provide the DenyEveryone parameter.
- Save the result to the $permissions variable.

New-VBRNASPermissionSet Example 2. Creating Permission Set to Allow Access to SMB Share to Everyone

The following request creates a permission set that allows access to the published SMB share to everyone.

$backup = Get-VBRUnstructuredBackup -Name "Daily SMB1 Backup"

$nasBackupPoint = Get-VBRUnstructuredBackupRestorePoint -NASBackup $backup

$permissions = New-VBRNASPermissionSet -RestorePoint $nasBackupPoint[0] -Owner "User 1" -AllowEveryone

Perform the following steps:

Run the Get-VBRUnstructuredBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Get-VBRUnstructuredBackupRestorePoint cmdlet. Set the $backup variable as the NASBackup parameter value. Save the result to the $nasBackupPoint variable.
Run the New-VBRNASPermissionSet cmdlet. Specify the following parameters:
- Specify the first value from the array returned to the $nasBackupPoint variable as the RestorePoint parameter.
- Specify the Owner parameter value.
- Provide the AllowEveryone parameter.
- Save the result to the $permissions variable.

New-VBRNASPermissionSet Example 3. Creating Permission Set to Allow Access to SMB Share to Selected Users

The following request creates a permission set that allows access to the published SMB share to selected users.

$backup = Get-VBRUnstructuredBackup -Name "Daily SMB1 Backup"

$nasBackupPoint = Get-VBRUnstructuredBackupRestorePoint -NASBackup $backup

$permissions = New-VBRNASPermissionSet -RestorePoint $nasBackupPoint[0] -Owner "User 1" -AllowSelected -PermissionScope ("domain\user 2")

Perform the following steps:

Run the Get-VBRUnstructuredBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Get-VBRUnstructuredBackupRestorePoint cmdlet. Set the $backup variable as the NASBackup parameter value. Save the result to the $nasBackupPoint variable.
Run the New-VBRNASPermissionSet cmdlet. Specify the following parameters:
- Specify the first value from the array returned to the $nasBackupPoint variable as the RestorePoint parameter.
- Specify the Owner parameter value.
- Provide the AllowSelected parameter.
- Specify the PermissionScope parameter.
- Save the result to the $permissions variable.