Set-VBRApplicationBackupRepository

Short Description

Modifies application backup repository settings.

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

Syntax

Set-VBRApplicationBackupRepository -Repository <VBRApplicationBackupRepository> [-Name <String>]

[-Description <String>] [-RepositoryPermissions <VBRApplicationBackupRepositoryPermission[]>]

[-EnableKerberosPermissions] [-KerberosPermissions <VBRApplicationBackupRepositoryKerberosPermission[]>]

[-ScheduleOptions <VBRApplicationBackupRepositoryScheduleOptions>]

[-NotificationOptions <VBRNotificationOptions>] [-RetentionDays <Int32>] [<CommonParameters>]

Detailed Description

This cmdlet modifies a application backup 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
Description	Specifies the description of the application backup repository.	`String`	False	Named	False
EnableKerberosPermissions	Enables Kerberos authentication for accessing the NFS share.	`SwitchParameter`	False	Named	False
KerberosPermissions	Specifies permissions for accessing the NFS share with Kerberos credentials. Accepts the `VBRApplicationBackupRepositoryKerberosPermission[]` object. To create this object, run the `New-VBRKerberosPermission` cmdlet.	`VBRApplicationBackupRepositoryKerberosPermission[]`	False	Named	False
Name	Specifies the name of the application backup repository.	`String`	False	Named	False
NotificationOptions	Specifies notification settings for the snapshot creation. Accepts the `VBRNotificationOptions` object. To create this object, run the `New-VBRNotificationOptions` cmdlet.	`VBRNotificationOptions`	False	Named	False
Repository	Specifies an application backup repository you want to modify. Accepts the `VBRApplicationBackupRepository` object. To get this object, run the `Get-VBRApplicationBackupRepository` cmdlet.	`VBRApplicationBackupRepository`	True	Named	True (ByPropertyName, ByValue)
RepositoryPermissions	Specifies host permissions for accessing the NFS share. Accepts the `VBRApplicationBackupRepositoryPermission[]` object. To create this object, run the `New-VBRApplicationBackupRepositoryPermission` cmdlet.	`VBRApplicationBackupRepositoryPermission[]`	False	Named	False
RetentionDays	Specifies the number of days for the snapshot retention policy.	`Int32`	False	Named	False
ScheduleOptions	Specifies the schedule settings for the snapshot creation. Accepts the `VBRApplicationBackupRepositoryScheduleOptions` object. To get this object, run the `New-VBRApplicationBackupRepositoryScheduleOptions` cmdlet.	`VBRApplicationBackupRepositoryScheduleOptions`	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 VBRApplicationBackupRepository object that contains settings of the application backup repository.

Examples

Modifying Snapshot Schedule Settings for Application Backup Repository

This example shows how to modify the snapshot creation schedule for the application backup repository named Oracle FRA Repository.

$repository = Get-VBRApplicationBackupRepository -Name "Oracle FRA Repository"

$options = New-VBRApplicationBackupRepositoryScheduleOptions

Set-VBRApplicationBackupRepository -Repository $repository -ScheduleOptions $options

Perform the following steps:

Run the Get-VBRApplicationBackupRepository cmdlet. Specify the Name parameter value. Save the result to the $repository variable.
Run the New-VBRApplicationBackupRepositoryScheduleOptions cmdlet. Save the result to the $options variable.
Run the Set-VBRApplicationBackupRepository cmdlet. Set the $repository variable as the Repository parameter value. Set the $options variable as the ScheduleOptions parameter value.