This is an archive version of the document. To get the most up-to-date information, see the current version.New-VBRProtectionGroupDeploymentOptions
Short Description
Creates Veeam Agent deployment settings.
Applies to
Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
New-VBRProtectionGroupDeploymentOptions [-DistributionServer <CHost>] [-InstallAgent] [-UpgradeAutomatically] [-InstallDriver] [-RebootIfRequired] [<CommonParameters>] |
Detailed Description
The cmdlet creates the VBRProtectionGroupDeploymentOptions object containing Veeam Agent deployment settings. Per these settings, you can instruct Veeam Backup & Replication to automatically install and upgrade Veeam Agents on discovered computers.
To apply deployment settings to a protection group, run Set-VBRProtectionGroup.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
|---|---|---|---|---|---|
DistributionServer | Specifies a distribution server. The cmdlet will instruct Veeam Backup & Replication to use this server to upload Veeam Agent setup files and private fixes to computers added to the protection group. Accepts servers added to Veeam Backup & Replication. | False | Named | True (ByValue, | False |
InstallAgent | Indicates that Veeam Backup & Replication will automatically install Veeam Agents on all discovered computers of the protection group. | False | Named | True (ByProperty | False |
UpgradeAutomatically | Indicates that Veeam Backup & Replication will automatically upgrade Veeam Agents on discovered computers when the new Veeam Agent version or private fix appears on the distribution server. | False | Named | True (ByProperty | False |
InstallDriver | Used only for Veeam Agent for Microsoft Windows. Indicates that Veeam Backup & Replication will automatically install the CBT driver on discovered computers. | False | Named | True (ByProperty | False |
RebootIfRequired | Indicates that Veeam Backup & Replication will reboot discovered computers if required. NOTE: Reboot is required after the CBT driver installation. | False | Named | True (ByProperty | 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
VBRProtectionGroupDeploymentOptions
Example 1
This example shows how to create an object containing the following Veeam Agent deployment settings:
- Veeam Agents will be installed automatically on discovered computers.
- Veeam Agents will be upgraded automatically to the version of Veeam Agent on the distribution server.
You will need to perform the following steps:
- Get the server added to Veeam Backup & Replication. This server will be used as a distribution server. To get the server, run Get-VBRServer. Save the result to the $server variable.
- Create an object with the Veeam Agent deployment settings. To do this, run New-VBRProtectionGroupDeploymentOptions with the $server variable, InstallAgent and UpgradeAutomatically parameters.
$server = Get-VBRServer -Name support.east.local New-VBRProtectionGroupDeploymentOptions -DistributionServer $server -InstallAgent -UpgradeAutomatically |
Example 2
This example shows how to apply Veeam Agent deployment settings to a protection group. Per these settings, Veeam Backup & Replication will automatically install Veeam Agents on discovered computers and automatically upgrade them.
You will need to perform the following steps:
- Create an object with Veeam Agent deployment settings. To do this, perform the following steps:
- Run Get-VBRServer to get the distribution server. Save the result to the $server variable.
- Run New-VBRProtectionGroupDeploymentOptions with the $server variable, InstallAgent and UpgradeAutomatically parameters. Save the result to the $deployment variable.
- Apply Veeam Agent deployment settings to a protection group. To do this, perform the following steps:
- Run Get-VBRProtectionGroup to get a protection group to which you want to apply Veeam Agent deployment settings. Save the result to the $group variable.
- Run Set-VBRProtectionGroup with the $group and $deployment variables.
$server = Get-VBRServer -Name support.east.local $deployment = New-VBRProtectionGroupDeploymentOptions -DistributionServer $server -InstallAgent -UpgradeAutomatically $group = Get-VBRProtectionGroup -Name "East Computers" Set-VBRProtectionGroup -ProtectionGroup $group -DeploymentOptions $deployment |
Related Commands
