Get-VEADItem

Short Description

Returns backed-up Active Directory objects.

Product: Veeam Backup & Replication

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

Syntax

This cmdlet provides the following parameter sets:

ByContainerParameterSet

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

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

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

Detailed Description

This cmdlet returns backed-up Active Directory objects.

Parameters

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.	`VEADContainer`	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.	`VEADDomain`	True	0	True (ByValue)
Id	Specifies an ID of an Active Directory object. The cmdlet will return Active Directory objects with the specified ID.	`Guid`	False	1	False
LDAPQuery	Specifies an LDAP search query. The cmdlet will return Active Directory objects according to this query.	`String`	True	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, the 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 Common Parameters section of Microsoft Learn.

Output Object

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

Examples

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

This example shows how to get all Active Directory objects from a specific parent container.

$session = Get-VEADRestoreSession

$domain = Get-VEADDomain -Session $session[3]

$parentcontainer = Get-VEADContainer -Domain $domain

Get-VEADItem -Container $parentcontainer[3]

Perform the following steps:

Run the Get-VEADRestoreSession cmdlet. Save the result to the $session variable.

The cmdlet will return an array of active restore sessions. Note the ordinal number of the necessary restore session (in this example, it is the fourth restore session in the array).
Run the Get-VEADDomain cmdlet. Set the $session variable as the Session parameter value and select the necessary restore session. Save the result to the $domain variable.
Run the Get-VEADContainer cmdlet. Set the $domain variable as the Domain parameter value. Save the result to the $parentcontainer variable.
Run the Get-VEADItem cmdlet. Set the $parentcontainer variable as the Container parameter value. Specify the ordinal number of the parent container.

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

This example shows how to get an Active Directory object with a specific ID from a specific Active Directory container.

$session = Get-VEADRestoreSession

$domain = Get-VEADDomain -Session $session[3]

$container = Get-VEADContainer -Domain $domain

Get-VEADItem -Container $container -Id "2687bd4b-1028-47e7-b720-6bf065179452"

Perform the following steps:

Run the Get-VEADRestoreSession cmdlet. Save the result to the $session variable.

The cmdlet will return an array of active restore sessions. Note the ordinal number of the necessary restore session (in this example, it is the fourth restore session in the array).
Run the Get-VEADDomain cmdlet. Set the $session variable as the Session parameter value and select the necessary restore session. Save the result to the $domain variable.
Run the Get-VEADContainer cmdlet. Set the $domain variable as the Domain parameter value. Save the result to the $container variable.
Run the Get-VEADItem cmdlet. Set the $container variable as the Container parameter value. Specify the Id parameter value.

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

This example shows how to get all Active Directory objects with a specific name from an Active Directory child container.

$session = Get-VEADRestoreSession

$domain = Get-VEADDomain -Session $session[3]

$parentcontainer = Get-VEADContainer -Domain $domain -Id 0486045e-b583-4559-a0ab-d78b99f1b95d

$childcontainer = Get-VEADContainer -Container $parentcontainer

Get-VEADItem -Container $childcontainer -Name "SalesMailbox"

Perform the following steps:

Run the Get-VEADRestoreSession cmdlet. Save the result to the $session variable.

The cmdlet will return an array of active restore sessions. Note the ordinal number of the necessary restore session (in this example, it is the fourth restore session in the array).
Run the Get-VEADDomain cmdlet. Set the $session variable as the Session parameter value and select the necessary restore session. Save the result to the $domain variable.
Run the Get-VEADContainer cmdlet. Set the $domain variable as the Domain parameter value. Specify the Id parameter value. Save the result to the $parentcontainer variable.
Run the Get-VEADContainer cmdlet. Set the $parentcontainer variable as the Container parameter value. Save the result to the $childcontainer variable.
Run the Get-VEADItem cmdlet. Set the $childcontainer variable as the Container parameter value. Specify the Name parameter value.

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

This example shows how to use an LDAP query to get an Active Directory object from a specific Active Directory container.

$session = Get-VEADRestoreSession

$domain = Get-VEADDomain -Session $session[3]

$container = Get-VEADContainer -Domain $domain

Get-VEADItem -Container $container -LDAPQuery "(cn=SalesMailboxe8e8782f639e4a24898b93c325d8ed9d)"

Perform the following steps:

Run the Get-VEADRestoreSession cmdlet. Save the result to the $session variable.

The cmdlet will return an array of active restore sessions. Note the ordinal number of the necessary restore session (in this example, it is the fourth restore session in the array).
Run the Get-VEADDomain cmdlet. Set the $session variable as the Session parameter value and select the necessary restore session. Save the result to the $domain variable.
Run the Get-VEADContainer cmdlet. Set the $domain variable as the Domain parameter value. Save the result to the $container variable.
Run the Get-VEADItem cmdlet. Set the $container variable as the Container parameter value. Specify the LDAPQuery parameter value.

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

This example shows how to use an LDAP query to get an Active Directory object from a specific domain.

$session = Get-VEADRestoreSession

$domain = Get-VEADDomain -Session $session[3]

Get-VEADItem -Domain $domain -LDAPQuery "(cn=ISW12R2SP13)"

Perform the following steps:

Run the Get-VEADRestoreSession cmdlet. Save the result to the $session variable.

The cmdlet will return an array of active restore sessions. Note the ordinal number of the necessary restore session (in this example, it is the fourth restore session in the array).
Run the Get-VEADDomain cmdlet. Set the $session variable as the Session parameter value and select the necessary restore session. Save the result to the $domain variable.
Run the Get-VEADItem cmdlet. Set the $domain variable as the Domain parameter value. Specify the LDAPQuery parameter value.