New-VBRNASPermissionSet

In this article

    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.

    Applies to

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

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Create a permission set that denies access to the published SMB share to everyone except its owner.

    New-VBRNASPermissionSet [-RestorePoint] <VBRNASBackupRestorePoint[]> [-Owner] <string> -DenyEveryone  [<CommonParameters>]

    • Create a permission set that allows access to the published SMB share to everyone.

    New-VBRNASPermissionSet [-RestorePoint] <VBRNASBackupRestorePoint[]> [-Owner] <string> -AllowEveryone  [<CommonParameters>]

    • Create a permission set that allows 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.

    New-VBRNASPermissionSet [-RestorePoint] <VBRNASBackupRestorePoint[]> [-Owner] <string> -AllowSelected   -PermissionScope <string[]>  [<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

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    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 VBRNASBackupRestorePoint object. To get this object, run the Get-VBRNASBackupRestorePoint cmdlet.

    True

    0

    True (ByValue, ByPropertyName)

    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

    DenyEveryone

    Defines that the permission set will deny access to the published SMB share to everyone except its owner.

    SwitchParameter

    True

    Named

    False

    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 specified, the cmdlet will use the AllowEveryone parameter by default.

    SwitchParameter

    True

    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

    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

    <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 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-VBRNASPermissionSetExample 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-VBRNASBackup -Name "Daily SMB1 Backup"
    $nasBackupPoint = Get-VBRNASBackupRestorePoint -NASBackup $backup
    $permissions = New-VBRNASPermissionSet -RestorePoint $nasBackupPoint[0] -Owner "User 1" -DenyEveryone

    Perform the following steps:

    1. Run the Get-VBRNASBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
    2. Run the Get-VBRNASBackupRestorePoint cmdlet. Set the $backup variable as the NASBackup parameter value. Save the result to the $nasBackupPoint variable.
    3. 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-VBRNASPermissionSetExample 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-VBRNASBackup -Name "Daily SMB1 Backup"
    $nasBackupPoint = Get-VBRNASBackupRestorePoint -NASBackup $backup
    $permissions = New-VBRNASPermissionSet -RestorePoint $nasBackupPoint[0] -Owner "User 1" -AllowEveryone

    Perform the following steps:

    1. Run the Get-VBRNASBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
    2. Run the Get-VBRNASBackupRestorePoint cmdlet. Set the $backup variable as the NASBackup parameter value. Save the result to the $nasBackupPoint variable.
    3. 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-VBRNASPermissionSetExample 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-VBRNASBackup -Name "Daily SMB1 Backup"
    $nasBackupPoint = Get-VBRNASBackupRestorePoint -NASBackup $backup
    $permissions = New-VBRNASPermissionSet -RestorePoint $nasBackupPoint[0] -Owner "User 1" -AllowSelected -PermissionScope ("domain\user 2")

    Perform the following steps:

    1. Run the Get-VBRNASBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
    2. Run the Get-VBRNASBackupRestorePoint cmdlet. Set the $backup variable as the NASBackup parameter value. Save the result to the $nasBackupPoint variable.
    3. 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.

    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.