Set-VBRNASBackupArchivalOptions (obsolete)

Short Description

Modifies retention policy for file versions.

Note

This cmdlet is obsolete. Run the Set-VBRUnstructuredBackupArchivalOptions cmdlet instead.

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

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 of retention policy for file versions that are kept on the long-term repository.

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 the retention policy for file versions. The cmdlet will modify the settings of this policy. Accepts the `VBRNASBackupArchivalOptions` object. To create this object, run the `New-VBRNASBackupArchivalOptions` 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

VBRNASBackupArchivalOptions

Examples

Modifying Filter Settings of Retention Policy for Deleted File Versions

This example shows how to modify filter settings of the retention policy for deleted file versions. The retention policy will have the following settings:

The long-term repository will keep .DOCX and .PDF file extensions.
The long-term repository will not keep .EXE and .JPEG file extensions.

$archiveOptions = New-VBRNASBackupArchivalOptions -ArchivalType ExclusionMask -ExclusionMask ('*.jpeg', '*.exe')

$newArchiveOptions = Set-VBRNASBackupArchivalOptions -Options $archiveOptions -ArchivalType InclusionMask -InclusionMask ('*.docx', '*.pdf')

Perform the following steps:

Run the New-VBRNASBackupArchivalOptions cmdlet. Specify the ExclusionMask parameter value. Save the result to the $archiveOptions variable.
Run the Set-VBRNASBackupArchivalOptions cmdlet. Specify the following settings:
- Set the $archiveoptions variable as the Options parameter value.
- Set the InclusionMask as the ArchivalType parameter value.
- Specify the InclusionMask parameter value.
- Save the result to the $newArchiveOptions variable to be used with other cmdlets.

New-VBRNASBackupArchivalOptions