Set-VBOConfigurationParameter

Short Description

Modifies configuration of the Veeam Backup for Microsoft 365 controller, backup proxy servers and backup proxy pools.

Syntax

Set-VBOConfigurationParameter [-WindowsCredential <PSCredential>] [-LinuxCredential <VBOLinuxCredential>]

[-Proxy <VBOProxy>] [-ProxyPool <VBOProxyPool>] -XPath <String> -Key <String> [-Value <String>]

[-RevertToDefault] [-Restart] [-Controller] [<CommonParameters>]

Detailed Description

This cmdlet allows you to configure parameters of the controller, backup proxy servers and backup proxy pools. Veeam Backup for Microsoft 365 saves configuration parameters of the Veeam Backup for Microsoft 365 controller to the Config.xml file, configuration parameters of backup proxy servers and backup proxy pools — to the Proxy.xml files.

To modify settings, you need to enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

Note

To enable the TLS encryption for the PostgreSQL instance traffic, use the following values for the Key parameter:

TlsEnabled. Use this parameter attribute to enable the TLS encryption for the PostgreSQL instance traffic.
CertificateThumbprint. Use this parameter attribute to provide the certificate thumbprint.

Consider that to enable the TLS encryption for the PostgreSQL instance traffic, you must specify both parameter attributes.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Controller	Defines that the cmdlet will configure parameters of the Veeam Backup for Microsoft 365 controller. Default: False	`SwitchParameter`	False	Named	False
Key	Specifies a name of the parameter attribute.	`String`	True	Named	False
LinuxCredential	Specifies Linux credentials. The cmdlet will use these credentials to connect to the Linux-based backup proxy server. Note: If the `ProxyPool` parameter is used, you must specify Linux credentials to connect to all Linux-based backup proxy servers in the backup proxy pool. Accepts the `VBOLinuxCredential` object. To get this object, run the `New-VBOLinuxCredential` cmdlet.	`VBOLinuxCredential`	False	Named	False
Proxy	Specifies a backup proxy server. The cmdlet will configure parameters of this backup proxy server. Accepts the `VBOProxy` object. To get this object, run the `Get-VBOProxy` cmdlet.	`VBOProxy`	False	Named	False
ProxyPool	Specifies a backup proxy pool. The cmdlet will configure parameters of all backup proxy servers added to this backup proxy pool. Accepts the `VBOProxyPool` object. To get this object, run the `Get-VBOProxyPool` cmdlet.	`VBOProxyPool`	False	Named	False
Restart	Defines that Veeam Backup for Microsoft 365 Proxy Service will be restarted to apply changes in configuration parameters. Default: False	`SwitchParameter`	False	Named	False
RevertToDefault	Defines that the cmdlet will revert the configuration parameters to the default values. Default: False	`SwitchParameter`	False	Named	False
Value	Specifies the parameter attribute value.	`String`	False	Named	False
WindowsCredential	Specifies Windows credentials. The cmdlet will use these credentials to connect to the Windows-based backup proxy server. Note: If the `ProxyPool` parameter is used, you must specify Windows credentials to connect to all Windows-based backup proxy servers in the backup proxy pool.	`PSCredential`	False	Named	False
XPath	Specifies the xpath path in the Config.xml or Proxy.xml file.	`String`	True	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About Common Parameters section of Microsoft Learn.

Examples

Set-VBOConfigurationParameter Example 1: Configuring Controller Parameters

This example shows how to configure parameters of the Veeam Backup for Microsoft 365 controller.

$xpath = "/Veeam/Archiver/Server"

$key = "TestKey"

$value = "TestValue"

Set-VBOConfigurationParameter -XPath $xpath -Key $key -Value $value -Controller

Perform the following steps:

Enter values for the XPath, Key and Value parameters. Save them to the $xpath, $key and $value variables.
Run the Set-VBOConfigurationParameter cmdlet. Specify the following settings:
- Set the $xpath variable as the XPath parameter value.
- Set the $key variable as the Key parameter value.
- Set the $value variable as the Value parameter value.
- Provide the Controller parameter.

Set-VBOConfigurationParameter Example 2: Configuring Linux-Based Backup Proxy Server Parameters

This example shows how to configure parameters of the Linux-based backup proxy server.

$xpath = "/Veeam/Archiver/Server"

$key = "TestKey"

$value = "TestValue"

$vboproxy = Get-VBOProxy -Hostname linux02

$pwd = ConvertTo-SecureString -String "Pa$$word123" -AsPlainText -Force

$linuxcredential = New-VBOLinuxCredential -Account "Administrator" -ElevateAccountToRoot -IgnoreFingerprintCheck -Password $pwd

Set-VBOConfigurationParameter -XPath $xpath -Key $key -Value $value -Proxy $vboproxy -LinuxCredential $linuxcredential -Restart

Perform the following steps:

Enter values for the XPath, Key and Value parameters. Save them to the $xpath, $key and $value variables.
Run the Get-VBOProxy cmdlet. Specify the Hostname parameter value. Save the result to the $vboproxy variable.
Run the ConvertTo-SecureString cmdlet. Specify the necessary parameters. Save the result to the $pwd variable.
Run the New-VBOLinuxCredential cmdlet. Specify the necessary parameters. Save the result to the $linuxcredential variable.
Run the Set-VBOConfigurationParameter cmdlet. Specify the following settings:
- Set the $xpath variable as the XPath parameter value.
- Set the $key variable as the Key parameter value.
- Set the $value variable as the Value parameter value.
- Set the $vboproxy variable as the Proxy parameter value.
- Set the $linuxcredential variable as the LinuxCredential parameter value.
- Provide the Restart parameter.

Set-VBOConfigurationParameter Example 3: Configuring Windows-Based Backup Proxy Server Parameters

This example shows how to configure parameters of the Windows-based backup proxy server.

$xpath = "/Veeam/Archiver/Server"

$key = "TestKey"

$value = "TestValue"

$vboproxy = Get-VBOProxy -Hostname 172.17.53.53

$winserverCredentials = Get-Credential

Set-VBOConfigurationParameter -XPath $xpath -Key $key -Value $value -Proxy $vboproxy -WindowsCredential $winserverCredentials -Restart

Perform the following steps:

Enter values for the XPath, Key and Value parameters. Save them to the $xpath, $key and $value variables.
Run the Get-VBOProxy cmdlet. Specify the Hostname parameter value. Save the result to the $vboproxy variable.
Run the Get-Credential cmdlet. Enter the credentials you want to use to connect to the backup proxy server. Save the result to the $winserverCredentials variable.
Run the Set-VBOConfigurationParameter cmdlet. Specify the following settings:
- Set the $xpath variable as the XPath parameter value.
- Set the $key variable as the Key parameter value.
- Set the $value variable as the Value parameter value.
- Set the $vboproxy variable as the Proxy parameter value.
- Set the $winserverCredentials variable as the WindowsCredential parameter value.
- Provide the Restart parameter.

Set-VBOConfigurationParameter Example 4: Configuring Backup Proxy Pool Parameters

This example shows how to configure parameters of backup proxy servers added to the backup proxy pool.

$xpath = "/Veeam/Archiver/Server"

$key = "TestKey"

$value = "TestValue"

$vboproxypool = Get-VBOProxyPool -Name "Pool"

$winserverCredentials = Get-Credential

$pwd = ConvertTo-SecureString -String "Pa$$word123" -AsPlainText -Force

$linuxcredential = New-VBOLinuxCredential -Account "Administrator" -ElevateAccountToRoot -IgnoreFingerprintCheck -Password $pwd

Set-VBOConfigurationParameter -XPath $xpath -Key $key -Value $value -ProxyPool $vboproxypool -WindowsCredential $winserverCredentials -LinuxCredential $linuxcredential -Restart

Perform the following steps:

Enter values for the XPath, Key and Value parameters. Save them to the $xpath, $key and $value variables.
Run the Get-VBOProxyPool cmdlet. Specify the Name parameter value. Save the result to the $vboproxypool variable.
Run the Get-Credential cmdlet. Enter the credentials you want to use to connect to the backup proxy server. Save the result to the $winserverCredentials variable.
Run the ConvertTo-SecureString cmdlet. Specify the necessary parameters. Save the result to the $pwd variable.
Run the New-VBOLinuxCredential cmdlet. Specify the necessary parameters. Save the result to the $linuxcredential variable.
Run the Set-VBOConfigurationParameter cmdlet. Specify the following settings:
- Set the $xpath variable as the XPath parameter value.
- Set the $key variable as the Key parameter value.
- Set the $value variable as the Value parameter value.
- Set the $vboproxypool variable as the ProxyPool parameter value.
- Set the $winserverCredentials variable as the WindowsCredential parameter value.
- Set the $linuxcredential variable as the LinuxCredential parameter value.
- Provide the Restart parameter.

Set-VBOConfigurationParameter Example 5: Reverting Configuration Parameters to Default Values

This example shows how to revert configuration parameters of the Windows-based backup proxy server to default values.

$xpath = "/Veeam/Archiver/Server"

$key = "TestKey"

$vboproxy = Get-VBOProxy -Hostname 172.17.53.53

$winserverCredentials = Get-Credential

Set-VBOConfigurationParameter -XPath $xpath -Key $key -Proxy $vboproxy -WindowsCredential $winserverCredentials -RevertToDefault -Restart

Perform the following steps:

Enter values for the XPath and Key parameters. Save them to the $xpath and $key variables.
Run the Get-VBOProxy cmdlet. Specify the Hostname parameter value. Save the result to the $vboproxy variable.
Run the Get-Credential cmdlet. Enter the credentials you want to use to connect to the backup proxy server. Save the result to the $winserverCredentials variable.
Run the Set-VBOConfigurationParameter cmdlet. Specify the following settings:
- Set the $xpath variable as the XPath parameter value.
- Set the $key variable as the Key parameter value.
- Set the $vboproxy variable as the Proxy parameter value.
- Set the $winserverCredentials variable as the WindowsCredential parameter value.
- Provide the RevertToDefault parameter.
- Provide the Restart parameter.

Set-VBOConfigurationParameter Example 6: Enabling TLS Encryption on Veeam Backup for Microsoft 365 Controller

These commands enable the TLS encryption for the PostgreSQL instance traffic on the Veeam Backup for Microsoft 365 controller.

Set-VBOConfigurationParameter -XPath "/Veeam/Archiver/ControllerPostgres" -Key "TlsEnabled" -Value "True" -Controller

Set-VBOConfigurationParameter -XPath "/Veeam/Archiver/ControllerPostgres" -Key "CertificateThumbprint" -Value "86F1769B6E0544E16A6EA1E9E9BC0BB71A8DE900" -Controller

Set-VBOConfigurationParameter -XPath "/Veeam/Archiver/RemoteProxyDeploymentSettings" -Key "TlsEnabled" -Value "True" -Controller

Set-VBOConfigurationParameter -XPath "/Veeam/Archiver/RemoteProxyDeploymentSettings" -Key "CertificateThumbprint" -Value "86F1769B6E0544E16A6EA1E9E9BC0BB71A8DE900" -Controller