New-VBRCSVContainer

In this article

    Short Description

    Creates a scope of computers listed in a CSV file.

    Applies to

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

    Syntax

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

    Detailed Description

    This cmdlet creates the VBRCSVContainer object. This object contains a scope of computers listed in a CSV file. Use this object to create a protection group with the Add-VBRProtectionGroup cmdlet.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Path

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

    True

    Named

    True (ByValue
    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.

    True

    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 about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

    Return Type

    VBRCSVContainer

    Example 1

    This example shows how to create a scope of computers from a CSV file located on your computer.

    You will need to perform the followings steps:

    1. Specify custom credentials for computers from a CSV file:
    • Run Get-Credential to create a credential object you want to use for authenticating with computers. Type the credentials and save the result to the $ccreds variable.
    • Run New-VBRCSVCustomCredentials with the $ccreds variable. Use the ForEach statement to apply the same credentials to multiple computers. Save the result to the $custom variable.
    1. Create a scope of computers from a CSV file located on your computer. To do this, run New-VBRCSVContainer with the $custom variable. Use the Path parameter to specify the path to the CSV file. Use the MasterCredentials parameter to specify Master account credentials.

    $ccreds = Get-Credential

    $custom = @("172.19.51.55", "sup-v8931") | ForEach { New-VBRCSVCustomCredentials -HostName $_ -Credentials $ccreds}

    $netcreds = Get-Credential

    New-VBRCSVContainer -Path "C:\Computers.csv" -MasterCredentials support\jsmith -UseCustomCredentials -CustomCredentials $custom

    Example 2

    This example shows how to create a scope of computers from a CSV file located on a file share.

    You will need to perform the followings steps:

    1. Specify custom credentials for computers from a CSV file:
    • Run Get-Credential to create a credential object you want to use for authenticating with computers. Type the credentials and save the result to the $ccreds variable.
    • Run New-VBRCSVCustomCredentials with the $ccreds variable. Use the ForEach statement to apply the same credentials to multiple computers. Save the result to the $custom variable.
    1. Create a scope of computers from a CSV file located on a file share.
    • Run Get-Credential to create a credential object you want to use for authenticating with the shared folder. Type the credentials and save the result to the $netcreds variable.
    • Run New-VBRCSVContainer with the $custom and $netcreds variables. Use the Path parameter to specify the path to the CSV file. Use the MasterCredentials parameter to specify Master account credentials.

    $ccreds = Get-Credential

    $custom = @("172.19.51.55", "sup-v8931") | ForEach { New-VBRCSVCustomCredentials -HostName $_ -Credentials $ccreds}

    $netcreds = Get-Credential

    New-VBRCSVContainer -Path "//support.local/east/Computers.csv" -MasterCredentials support\jsmith -NetworkCredentials $netcreds -UseCustomCredentials -CustomCredentials $custom

    Example 3

    This example shows how to create a protection group with a scope of computers from a CSV file.

    You will need to perform the following steps:

    1. Create a scope of computers from a CSV file located on a file share:
    • Run Get-Credential to create a credential object you want to use for authenticating with computers. Type the credentials and save the result to the $ccreds variable.
    • Run New-VBRCSVCustomCredentials with the $ccreds variable. Use the ForEach statement to apply the same credentials to multiple computers. Save the result to the $custom variable.
    • Run Get-Credential to create a credential object you want to use for authenticating with the shared folder. Type the credentials and save the result to the $netcreds variable.
    • Run New-VBRCSVContainer with the $custom and $netcreds variables. Save the result to the $csvscope variable.
    1. Create a protection group. To do this, run Add-VBRProtectionGroup with the $csvscope variable.

    $ccreds = Get-Credential

    $custom = @("172.19.51.55", "sup-v8931") | ForEach { New-VBRCSVCustomCredentials -HostName $_ -Credentials $ccreds}

    $netcreds = Get-Credential

    $csvscope = New-VBRCSVContainer -Path "//support.local/east/Computers.csv" -MasterCredentials support\jsmith -NetworkCredentials $netcreds -UseCustomCredentials -CustomCredentials $custom

    Add-VBRProtectionGroup -Name "CSV" -Container $csvscope

    Related Commands

    New-VBRCSVCustomCredentials

    Add-VBRProtectionGroup