Set-VBRCSVContainer

In this article

    Short Description

    Modifies a scope of computers listed in a CSV file.

    Applies to

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

    Syntax

    Set-VBRCSVContainer -Container <VBRCSVContainer> [-Path <string>] [-NetworkCredentials <CCredentials>] [-MasterCredentials <CCredentials>] [-UseCustomCredentials] [-CustomCredentials <VBRCSVCustomCredentials[]>] [<CommonParameters>]

    Detailed Description

    This cmdlet modifies the VBRCSVContainer object. This object contains the scope of computers you want to add to a protection group. To modify the settings of the scope, specify new values for the necessary parameters. The parameters you omit will remain unchanged.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Container

    Specifies the scope of computers that are listed in a CSV file.

    Accepts VBRCSVContainer type.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Path

    Specifies the path to the CSV file. The cmdlet will import computers' DNS names or IP addresses from this file.

    False

    Named

    True (ByProperty
    Name)

    False

    MasterCredentials

    Specifies Master account credentials for authenticating with all computers listed in a CSV file.

    For authenticating with computers that require different credentials, Veeam Backup & Replication uses custom credentials. If you want to use custom credentials for some computers, set the UseCustomCredentials parameter.

    False

    Named

    True (ByProperty
    Name)

    False

    NetworkCredentials

    Specifies the credentials you want to use for authenticating with the shared folder. The cmdlet will use these credentials if a CSV file is located on a file share.

    False

    Named

    True (ByProperty
    Name)

    False

    UseCustomCredentials

    Indicates that you want to use custom credentials for authenticating with some computers listed in a CSV file.

    To specify custom credentials, use the CustomCredentials parameter.

    False

    Named

    True (ByProperty
    Name)

    False

    CustomCredentials

    Specifies custom credentials for authenticating with associated computers.

    Accepts VBRCSVCustomCredentials[] type.

    False

    Named

    True (ByProperty
    Name)

    False

    <CommonParameters>

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

    Return Type

    VBRCSVContainer

    Example

    This example shows how to change Master account credentials for a protection group.

    You will need to perform the following steps:

    1. Run Get-VBRProtectionGroup to get the protection group whose settings you want to modify. Save the result to the $group variable.
    2. Get the protection scope. Use the Container property of the protection group object saved to the $group variable. Save the result to the $csv variable.
    3. Modify the protection scope. To do this, run Set-VBRCSVContainer with the $csv variable and MasterCredentials parameter. Save the result to the $newcsv variable.
    4. Run Set-VBRProtectionGroup with the $group and $newcsv variables.

    $group = Get-VBRProtectionGroup -Name "Support PG"

    $csv = $group.Container

    $newcsv = Set-VBRCSVContainer -Container $csv -MasterCredentials "supporteast\dstones"

    Set-VBRProtectionGroup -ProtectionGroup $group -Container $newcsv

    Related Commands

    Get-VBRProtectionGroup

    Set-VBRProtectionGroup