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

New-VBRPeriodicallyOptions

Short Description

Creates periodically schedule settings.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Requires Veeam Agent for Microsoft Windows/Veeam Agent for Linux license

Syntax

New-VBRPeriodicallyOptions [-PeriodicallyKind <VBRPeriodicallyKinds> {Hours | Minutes | Continuously}] [-FullPeriod <int>] [-PeriodicallySchedule <VBRBackupWindowOptions>] [-HourlyOffset <int>]  [<CommonParameters>]

Detailed Description

This cmdlet creates an object containing periodically schedule settings. You can use this object to create a discovery schedule for a protection group. Per this schedule, Veeam Backup & Replication performs a discovery operation: connects to computers of a selected protection group and gathers information about them.

To create a discovery schedule, run New-VBRProtectionGroupScheduleOptions.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Periodically
Kind

Specifies the type of periodically schedule settings:

  • Hours: Veeam Backup & Replication will perform discovery operations repeatedly in specified number of hours (for example, every 6 hours).
  • Minutes: Veeam Backup & Replication will perform discovery operations repeatedly in specified number of minutes (for example, every 30 minutes).
  • Continuously: Veeam Backup & Replication will discover new computers in a non-stop manner.

False

Named

True (ByValue,
ByProperty
Name)

False

FullPeriod

Specifies the number of hours or minutes for the PeriodicallyKind parameter.

Permitted values:

  • For Hours: 1, 2, 3, 4, 6, 8, 12, 24.
  • For Minutes: 1-999.

False

Named

True (ByProperty
Name)

False

Periodically
Schedule

Specifies the discovery window. The cmdlet sets the time period within which Veeam Backup & Replication is allowed to perform discovery operations for computers of a protection group.

False

Named

True (ByProperty
Name)

False

Hourly
Offset

Used for adjusting the discover window start time.

Specifies the number of minutes (1-59). Discovery operations will start at the hour set in the discovery window plus the indicated period (for example, at 8:30).

False

Named

True (ByProperty
Name)

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

VBRPeriodicallyOptions

Example 1

This command creates an object containing periodically schedule settings.

PS C:\PS> New-VBRPeriodicallyOptions -FullPeriod 12 -PeriodicallyKind Hours

Example 2

This example shows how to create a discovery schedule for a protection group. Per this schedule, Veeam Backup & Replication will perform new computer discovery every 12 hours.

You will need to perform the following steps:

  1. Create an object with periodically schedule settings. To do this, run New-VBRPeriodicallyOptions. Save the result to the $periodically variable.
  2. Run New-VBRProtectionGroupScheduleOptions with the $periodically variable.

PS C:\PS> $periodically = New-VBRPeriodicallyOptions -FullPeriod 12 -PeriodicallyKind Hours

PS C:\PS> New-VBRProtectionGroupScheduleOptions -PolicyType Periodically -PeriodicallyOptions $periodically

Example 3

This example shows how to apply a discovery schedule to a protection group. Per this schedule, Veeam Backup & Replication will perform new computer discovery every 12 hours.

You will need to perform the following steps:

  1. Create an object with periodically schedule settings. To do this, run New-VBRPeriodicallyOptions. Save the result to the $periodically variable.
  2. Create a discovery schedule for a protection group. To do this, run New-VBRProtectionGroupScheduleOptions with the $periodically variable. Save the result to the $schedule variable.
  3. Apply a discovery schedule to a protection group:

PS C:\PS> $periodically = New-VBRPeriodicallyOptions -FullPeriod 12 -PeriodicallyKind Hours

PS C:\PS> $schedule = New-VBRProtectionGroupScheduleOptions -PolicyType Periodically -PeriodicallyOptions $periodically

PS C:\PS> $group = Get-VBRProtectionGroup -Name "East Computers"

PS C:\PS> Set-VBRProtectionGroup -ProtectionGroup $group -ScheduleOptions $schedule

Related Commands

New-VBRDailyOptions

New-VBRProtectionGroupScheduleOptions

Get-VBRProtectionGroup

Set-VBRProtectionGroup

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management 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 Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation