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

Get-VBRProtectionGroup

Short Description

Returns protection groups.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

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

Syntax

This cmdlet provides 5 parameter sets.

  • For getting all protection groups:

Get-VBRProtectionGroup  [<CommonParameters>]

  • For getting protection groups by ID:

Get-VBRProtectionGroup [-Id <guid[]>]  [<CommonParameters>]

  • For getting protection groups by name:

Get-VBRProtectionGroup [-Name <string[]>]  [<CommonParameters>]>]

  • For getting protection groups by type (Custom/ManuallyAdded):

Get-VBRProtectionGroup [-Type <VBRProtectionGroupType[]> {Custom | ManuallyAdded}]  [<CommonParameters>]

  • For getting protection groups by protection scope (IndividualComputers/ActiveDirectory/CSV):

Get-VBRProtectionGroup [-ContainerType <VBRProtectionGroupContainerType[]> {IndividualComputers | ActiveDirectory | CSV}]  [<CommonParameters>]

Detailed Description

This cmdlet returns protection groups.

You can get all protection groups or search for instances directly by name, ID, type or protection scope. Use an appropriate parameter set for each case.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Id

Specifies the array of protection group IDs. The cmdlet will return protection groups with these IDs.

False

Named

True (ByValue,
ByProperty
Name)

False

Name

Specifies the array of protection group names. The cmdlet will return protection groups with these names.

False

Named

True (ByProperty
Name)

True

Type

Specifies protection group types:

  • Custom: protection groups created for individual computers, Active Directory objects or computers listed in a CSV file.
  • ManuallyAdded: protection groups created for computers that were added to a Veeam Agent backup job.

The cmdlet will return protection groups of these types.

False

Named

True (ByProperty
Name)

False

ContainerType

Specifies the array of protection scope types:

  • ActiveDirectory: a scope of Active Directory objects
  • IndividualComputers: a scope of individual computers
  • CSV: a scope of computers listed in a CSV file

The cmdlet will return protection groups created for these protection scope types.

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

VBRProtectionGroup[]

Example 1

This command returns all protection groups added to Veeam Backup & Replication.

PS C:\PS> Get-VBRProtectionGroup

Example 2

This command returns protection groups by ID.

PS C:\PS> Get-VBRProtectionGroup -Id 4022509c-3308-4883-b166-118bdf7480ea, 730dc485-84c2-4a9d-86e7-2e35d1d5a0be

Example 3

This command returns protection groups created for the scope of Active Directory objects.

PS C:\PS> Get-VBRProtectionGroup -ContainerType ActiveDirectory

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

Backup and Restore of SQL Server Databases

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