Get-VEADItem

Short Description

Returns backed-up Active Directory objects.

Applies to

Veeam Backup & Replication

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

Syntax

This cmdlet provides parameter sets that allow you to:

  • Get Active Directory objects added to a specific container by the object ID or the object name.

Get-VEADItem [[-Name] <String>] [-Container] <VEADContainer> [-Recurse] [[-Id] <Guid>] [<CommonParameters>]

  • Get Active Directory objects added to a specific container by an LDAP query.

Get-VEADItem [-Container] <VEADContainer> [-LDAPQuery] <String> [<CommonParameters>]

  • Get Active Directory objects added to a specific domain by an LDAP query.

Get-VEADItem [-Domain] <VEADDomain> [-LDAPQuery] <String> [<CommonParameters>]>]

Detailed Description

This cmdlet returns backed-up Active Directory objects.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Container

Specifies an Active Directory container. The cmdlet will return an array of objects added to this container.

Accepts the VEADContainer object. To get this object, run the Get-VEADContainer cmdlet.

True

0

True (ByValue)

Domain

Specifies an Active Directory domain. The cmdlet will return an array of objects added to this domain.

Accepts the VEADDomain object. To get this object, run the Get-VEADDomain cmdlet.

True

0

True (ByValue)

LDAPQuery

Specifies an LDAP search query. The cmdlet will return Active Directory objects according to this query.

String

True

1

False

Id

Specifies an ID of an Active Directory object. The cmdlet will return Active Directory objects with the specified ID.

Guid

False

1

False

Name

Specifies a name of an Active Directory object. The cmdlet will return objects with the specified name.

String

False

2

False

Recurse

Defines that the cmdlet will return Active Directory objects with their child objects. For example, a Computer object can contain Shared Folder and Printer objects.

SwitchParameter

False

3

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Output Object

The cmdlet returns the VEADItem[] array that contains Active Directory items.

Examples

Get-VEADItemExample 1. Getting All Active Directory Objects from Specific Container

Get-VEADItemExample 2. Getting Active Directory Object with Specific ID from Specific Container

Get-VEADItemExample 3. Getting All Active Directory Objects with Specific Name from Specific Child Container

Get-VEADItemExample 4. Getting Active Directory Objects from Specific Container with LDAP Query

Get-VEADItemExample 5. Getting Active Directory Objects from Specific Domain with LDAP Query

Related Commands

Page updated 3/12/2025

Page content applies to build 12.3.1.1139