Add-VBRDiscoveredComputerConfigurationPolicy

Short Description

Updates Veeam Agent settings on discovered computers using available configuration options.

Important

Make sure to test this cmdlet in the lab before you run it in the production environment.

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

Syntax

This cmdlet provides the following parameter sets:

ProtectionGroup

Add-VBRDiscoveredComputerConfigurationPolicy -ProtectionGroup <VBRProtectionGroup[]> -AgentType <VBRAgentType>

-ConfigurationOption <VBRDiscoveredComputerConfigurationOption[]> [<CommonParameters>]

DiscoveredComputer

Add-VBRDiscoveredComputerConfigurationPolicy -DiscoveredComputer <VBRDiscoveredComputer[]>

-AgentType <VBRAgentType> -ConfigurationOption <VBRDiscoveredComputerConfigurationOption[]> [<CommonParameters>]

Detailed Description

This cmdlet updates Veeam Agent settings on individual computers or computers in protection groups using available configuration options. New settings are applied after the rescan operation.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
AgentType	Specifies the type of a Veeam Agent: `Windows` `Linux` `Mac` `Unix`	`VBRAgentType`	True	Named	True (ByPropertyName)
ConfigurationOption	Specifies the configuration option that you want to assign to discovered computers. Accepts the `VBRDiscoveredComputerConfigurationOption[]` object. To get this object, run the `New-VBRDiscoveredComputerConfigurationOption` cmdlet.	`VBRDiscoveredComputerConfigurationOption[]`	True	Named	True (ByPropertyName)
DiscoveredComputer	Specifies an array of discovered computers. The cmdlet will assign the configuration option to these computers. Accepts the `VBRDiscoveredComputer[]` object. To get this object, run the `Get-VBRDiscoveredComputer` cmdlet.	`VBRDiscoveredComputer[]`	True	Named	True (ByPropertyName)
ProtectionGroup	Specifies an array of protection groups to which you want to assign the configuration option. Accepts the `VBRProtectionGroup[]` object. To get this object, run the `Get-VBRProtectionGroup` cmdlet.	`VBRProtectionGroup[]`	True	Named	True (ByPropertyName, ByValue)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

VBRDiscoveredComputerConfigurationPolicy

Examples

Updating Path to Temporary Folder Storing SQL Backup Logs on Windows Computers

This example shows how to update the SqlTempLogPath registry value on Windows computers.

$group = Get-VBRProtectionGroup -Name "Windows"

$computers = Get-VBRDiscoveredComputer -ProtectionGroup $group

$SQLLogpath = New-VBRDiscoveredComputerConfigurationOption -Name "SqlTempLogPath" -Value "D:\Temp"

$configuration_policy = Add-VBRDiscoveredComputerConfigurationPolicy -DiscoveredComputer $computers -AgentType Windows -ConfigurationOption $SQLLogpath

Perform the following steps:

Run the Get-VBRProtectionGroup cmdlet. Specify the Name parameter value. Save the result to the $group variable.
Run the Get-VBRDiscoveredComputer cmdlet. Set the $group variable as the ProtectionGroup parameter value. Save the result to the $computers variable.
Run the New-VBRDiscoveredComputerConfigurationOption cmdlet. Specify the Name and the Value parameter values. Save the result to the $SQLLogpath variable.
Run the Add-VBRDiscoveredComputerConfigurationPolicy cmdlet. Specify the following settings:
- Set the $computers variable as the DiscoveredComputer parameter value.
- Specify the AgentType parameter value.
- Set the $SQLLogpath variable as the ConfigurationOption parameter value.
Save the result to the $configuration_policy variable.