Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

New-VBRTapeMediaPoolRetentionPolicy

Short Description

Creates a new VBRTapeMediaPoolRetentionPolicy object.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

New-VBRTapeMediaPoolRetentionPolicy [-Period <VBRTapeMediaPoolPeriod> {None | Days | Weeks | Months}] [-Type <VBRTapeMediaPoolRetentionType> {Never | Period | Cyclic}] [-Value <int>]  [<CommonParameters>]

Detailed Description

This cmdlet creates the VBRTapeMediaPoolRetentionPolicy object. This object contains the retention settings of media pool.

Retention policy sets overwrite protection rules. The rules are set to media pool and are applied to all tapes belonging to this media pool. After the retention period ends, the tape is queued for overwriting.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Type

Specifies the data retention type:

  • Never: the data is never overwritten. This option sets a lifelong protection for tapes.
  • Period: the data is protected for an indicated period. Use the Period and the Value parameters to indicate the period settings.
  • Cyclic: the data is not protected. The tapes are overwritten according to the tape rotation settings.

False

Named

False

False

Period

Specifies the data retention period. Use this parameter to indicate the time period for the Type parameter:

  • None: data is not protected. Tapes are overwritten according to the tape rotation settings.
  • Days: indicates that the data retention period is measured in days. Use the Value parameter to indicate the number of days to protect the data.
  • Weeks: indicates that the data retention period is measured in  weeks. Use the Value parameter to indicate the number of weeks to protect the data.
  • Months: indicates that the data retention period is measured in months. Use the Value parameter to indicate the number of months to protect the data.

False

Named

False

False

Value

Sets the number of days, weeks or month to protect the data. You can enter value between 1 and 999. Use this parameter to indicate the value if you set Period to Days, Weeks or Months.

False

Named

False

False

<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

VBRTapeMediaPoolRetentionPolicy

Example 1

This command creates a set of retention rules setting retention period to 14 days. The new settings are assigned to a variable that can be further used in Set-VBRTapeMediaPool to apply them.

  • The new retention settings are assigned to the '$newretention' variable.
  • The Type is set to 'Period', the Period is set to 'Days', and the Value is set to '14'.

PS C:\PS> $newretention = New-VBRTapeMediaPoolRetentionPolicy -Type Period -Period Days -Value 14

Example 2

This command switches off the retention. The new settings are assigned to a variable that can be further used in Set-VBRTapeMediaPool to apply them.

  • The new retention settings are assigned to the '$noretention' variable.
  • The Type is set to 'Cyclic'.

PS C:\PS> $noretention = New-VBRTapeMediaPoolRetentionPolicy -Type Cyclic

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Endpoint Backup Documentation

Veeam Management Pack Documentation