Set-VBRMySQLProcessingOptions

Short Description

Modifies settings for processing backed-up MySQL databases for Veeam Agent backup jobs.

Syntax

This cmdlet provides the following parameter sets:

Credentials (Default)

Set-VBRMySQLProcessingOptions -Options <VBRMySQLProcessingOptions> [-Credentials <CCredentials>] [<CommonParameters>]
PasswordFilePath

Set-VBRMySQLProcessingOptions -Options <VBRMySQLProcessingOptions> [-PasswordFilePath <String>] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings for processing backed-up MySQL databases for Veeam Agent backup jobs.

Note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Credentials	Specifies the MySQL credentials that Veeam Agent will use to connect to the MySQL Server. Accepts the `CCredentials` object. To get this object, run the `Get-VBRCredentials` cmdlet.	`CCredentials`	False	Named	False
Options	Specifies settings for backed-up MySQL database. The cmdlet will modify these settings. Accepts the `VBRMySQLProcessingOptions` object. To create this object, run the `New-VBRMySQLProcessingOptions` cmdlet.	`VBRMySQLProcessingOptions`	True	Named	True (ByValue)
PasswordFilePath	Specifies the absolute path for the password file. Veeam Agent will use this password file to connect to the MySQL Server. Default: "`/root/.my.cnf"` Note: Start the absolute path with the / symbol. The cmdlet will return an error if you provide this parameter when the `Credentials` parameter is already specified.	`String`	False	Named	False

<CommonParameters>

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

Output Object

This cmdlet returns the VBRMySQLProcessingOptions object that contains settings for processing backed-up MySQL databases.

Examples

Set-VBRMySQLProcessingOptions Example 1. Modifying Credentials for MySQL Database Processing Settings

This example shows how to modify credentials for MySQL database processing settings.

$options = New-VBRMySQLProcessingOptions

$creds = Get-VBRCredentials

Set-VBRMySQLProcessingOptions -Options $options -Credentials $creds

Perform the following steps:

Run the New-VBRMySQLProcessingOptions cmdlet. Save the result to the $options variable.
Run the Get-VBRCredentials cmdlet. Save the result to the $creds variable.
Run the Set-VBRMySQLProcessingOptions cmdlet. Set the $options variable as the Options parameter value. Set the $creds variable as the Credentials parameter.

Set-VBRMySQLProcessingOptions Example 2. Modifying Absolute Path of Password File for MySQL Database Processing Settings

This example shows how to modify absolute path of a password file for MySQL database processing settings.

$options = New-VBRMySQLProcessingOptions

Set-VBRMySQLProcessingOptions -Options $options -PasswordFilePath "/home/mydir/.my.cnf"

Perform the following steps:

Run the New-VBRMySQLProcessingOptions cmdlet. Save the result to the $options variable.
Run the Set-VBRMySQLProcessingOptions cmdlet. Set the $options variable as the Options parameter value. Specify the PasswordFilePath parameter value.