New-VBRPeriodicallyOptions

In this article

    Short Description

    Creates periodical schedule settings.

    Applies to

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

    Syntax

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

    Detailed Description

    This cmdlet creates an object containing periodical 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

    PeriodicallyKind

    Specifies the type of periodical 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

    PeriodicallySchedule

    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.

    Accepts VBRBackupWindowOptions type.

    False

    Named

    True (ByProperty
    Name)

    False

    HourlyOffset

    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 periodical schedule settings.

    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 periodical schedule settings. To do this, run New-VBRPeriodicallyOptions. Save the result to the $periodically variable.
    2. Run New-VBRProtectionGroupScheduleOptions with the $periodically variable.

    $periodically = New-VBRPeriodicallyOptions -FullPeriod 12 -PeriodicallyKind Hours

    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 periodical 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:

    $periodically = New-VBRPeriodicallyOptions -FullPeriod 12 -PeriodicallyKind Hours

    $schedule = New-VBRProtectionGroupScheduleOptions -PolicyType Periodically -PeriodicallyOptions $periodically

    $group = Get-VBRProtectionGroup -Name "East Computers"

    Set-VBRProtectionGroup -ProtectionGroup $group -ScheduleOptions $schedule

    Related Commands

    New-VBRDailyOptions

    New-VBRProtectionGroupScheduleOptions

    Get-VBRProtectionGroup

    Set-VBRProtectionGroup