Get-VBRRetentionPolicy

In this article

    Short Description

    Returns a retention policy for backup copy jobs.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Get-VBRRetentionPolicy -Job <CBackupJob>  [<CommonParameters>]

    Detailed Description

    This cmdlet returns a retention policy for backup copy jobs of the following types:

    • Backup copy jobs that process backups stored on external repositories.
    • Veeam Agent backup copy jobs.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Job

    Specifies a backup copy job. The cmdlet will return a retention policy for the specified job.

    True

    Named

    True (ByValue)

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

    Return Type

    Example

    This example shows how to get a retention policy for a backup copy job.

    1. Run Get-VBRJob to get the backup copy job. Save the result to the $job variable.
    2. Run Get-VBRRetentionPolicy with the $job variable.

    $job = Get-VBRJob -Name "EC2 BCJ 01"

    Get-VBRRetentionPolicy -Job $job

    Related Commands

    Get-VBRJob