Get-VEADItem

Short Description

Returns backed-up Aсtive Directory objects.

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 [-Container] <VEADContainer> [[-Id] <guid>] [[-Name] <string>] [[-Recurse]]  [<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 Aсtive Directory objects.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

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-VEADDomain 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

1

False

 

Recurse

Indicates that the cmdlet will look for objects from all Active Directory child containers.

SwitchParamter

False

1

False

 

<CommonParameters>

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

Output Object

The cmdlet returns the VEADItem object that contains an array of Active Directory objects.

Examples

Get-VEADItemExample 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:

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

The Get-VEADRestoreSession cmdlet will return an array of active restore sessions. Mind the ordinal number of the necessary restore session (in our example, it is the fourth restore session in the array).

  1. Run the Get-VEADDomain cmdlet. Set the $session variable as the Session parameter value. Save the result to the $domain variable.
  2. Run the Get-VEADContainer cmdlet. Set the $domain variable as the Domain parameter value. Save the result to the $parentcontainer variable.
  3. Run the Get-VEADItem cmdlet. Set the $parentcontainer variable as the Container parameter value. Specify the ordinal number of the parent container.

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

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

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

  1. Run the Get-VEADRestoreSession cmdlet. Save the result to the $session variable.
  2. The Get-VEADRestoreSession cmdlet will return an array of active restore sessions. Mind the ordinal number of the necessary restore session (in our example, it is the fourth restore session in the array).
  3. Run the Get-VEADDomain cmdlet. Set the $session variable as the Session parameter value. Save the result to the $domain variable.
  4. Run the Get-VEADContainer cmdlet. Set the $domain variable as the Domain parameter value. Save the result to the $container variable.
  5. Run the Get-VEADItem cmdlet. Set the $container variable as the Container parameter value. Specify the Id parameter value.

Get-VEADItemExample 3. Getting All Active Directory Objects from Specific Container by Object Name

This example shows how to get an Active Directory object that is added to an Active Directory child container by the object name.

$session = Get-VEADRestoreSession

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

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

$childcontainer = Get-VEADContainer -Container $parentcontainer

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

Perform the following steps:

  1. Run the Get-VEADRestoreSession cmdlet. Save the result to the $session variable.
  2. The Get-VEADRestoreSession cmdlet will return an array of active restore sessions. Mind the ordinal number of the necessary restore session (in our example, it is the fourth restore session in the array).
  3. Run the Get-VEADDomain cmdlet. Set the $session variable as the Session parameter value. Save the result to the $domain variable.
  4. 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.
  5. Run the Get-VEADContainer cmdlet. Set the $parentcontainer variable as the Container parameter value. Save the result to the $childcontainer variable.
  6. Run the Get-VEADItem cmdlet. Set the $childcontainer variable as the Container parameter value. Specify the Name parameter value.

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

This example shows how to get an Active Directory object that is added to a specific Active Directory container by an LDAP query.

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

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

The Get-VEADRestoreSession cmdlet will return an array of active restore sessions. Mind the ordinal number of the necessary restore session (in our example, it is the fourth restore session in the array).

  1. Run the Get-VEADDomain cmdlet. Set the $session variable as the Session parameter value. Save the result to the $domain variable.
  2. Run the Get-VEADContainer cmdlet. Set the $domain variable as the Domain parameter value. Save the result to the $container variable.
  3. Run the Get-VEADItem cmdlet. Set the $container variable as the Container parameter value. Specify the LDAPQuery parameter value.

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

This example shows how to get an Active Directory object that is added to a specific domain by an LDAP query.

$session = Get-VEADRestoreSession

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

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

Perform the following steps:

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

The Get-VEADRestoreSession cmdlet will return an array of active restore sessions. Mind the ordinal number of the necessary restore session (in our example, it is the fourth restore session in the array).

  1. Run the Get-VEADDomain cmdlet. Set the $session variable as the Session parameter value. Save the result to the $domain variable.
  2. Run the Get-VEADItem cmdlet. Set the $domain variable as the Domain parameter value. Specify the LDAPQuery parameter value.

Related Commands

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.