New-VBRProtectionGroupDeploymentOptions

Short Description

Defines protection group deployment settings.

Applies to

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

Syntax

This cmdlet provides parameter sets that allow you to:

Define deployment settings for the Veeam Agent protection group.

New-VBRProtectionGroupDeploymentOptions [-DistributionServer <CHost>] [-DistributionRepository <VBRObjectStorageRepository>] [-InstallAgent] [-UpgradeAutomatically] [-InstallDriver] [-RebootIfRequired] [-InstallApplicationPlugins] [<CommonParameters>]

Define deployment settings for the Veeam Plug-in protection group.

Detailed Description

The cmdlet creates the VBRProtectionGroupDeploymentOptions object. This object contains the deployment settings for a protection group. You can use these settings to automatically install and upgrade Veeam Agent or Veeam Plug-ins on discovered computers.

To apply deployment settings to a protection group, run the Set-VBRProtectionGroup cmdlet.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
DistributionServer	Specifies a distribution server. The cmdlet will instruct Veeam Backup & Replication to use this server to upload Veeam Agent or Veeam Plug-in setup files and private fixes to computers added to the protection group. Accepts servers added to Veeam Backup & Replication.	False	Named	True (ByValue, ByProperty Name)	False
DistributionRepository	For protection groups for cloud machines. Specifies an object storage repository (either Microsoft Azure blob storage or Amazon S3 object storage repository) that will act as a distribution repository. Veeam Backup & Replication will use this repository to upload Veeam Agent setup files to cloud machines added to the protection group.	False	Named	True (ByProperty Name)	False
InstallAgent	Indicates that Veeam Backup & Replication will automatically install Veeam Agent or Veeam Plug-in on all discovered computers of the protection group.	False	Named	True (ByProperty Name)	False
UpgradeAutomatically	Indicates that Veeam Backup & Replication will automatically upgrade Veeam Agent or Veeam Plug-in on discovered computers when the new Veeam Agent version or private fix appears on the distribution server.	False	Named	True (ByProperty Name)	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 Name)	False
RebootIfRequired	Indicates that Veeam Backup & Replication will reboot discovered computers if required. NOTE: Reboot is required after the CBT driver inAccepts the VBRDailyOptions object. To get this object, run the Get-VBRDailyOptions cmdlet.stallation.	False	Named	True (ByProperty Name)	False
InstallApplicationPlugins	Defines that the cmdlet will define deployment settings for the Veeam Plug-in protection group.	False	Named	True (ByProperty Name)	False
ApplicationTypes	Specifies an array of Veeam Plug-ins that you want to install on the protected computers: OracleRMAN: for Veeam Plug-in for Oracle RMAN SAPHANA: for Veeam Plug-in for SAP HANA SAPOnOracle: for Veeam Plug-in for SAP on Oracle Accepts the VBRApplicationType[] object. To get this object, run the Get-VBRDiscoveredApplication cmdlet.	False	Named	True (ByProperty Name)	False

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

Get-VBRServer

Get-VBRProtectionGroup

Set-VBRProtectionGroup