Get-VEADContainer

In this article

    Short Description

    Returns backed-up Active Directory containers.

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Get all Active Directory containers in a domain.

    Get-VEADContainer [-Domain] <VEADDomain> [[-Type] {UsersAndComputers | GroupPolicyObjects | IntegratedDNS | ConfigurationPartition}] [-Recurse]  [<CommonParameters>]

    • Get Active Directory containers added to a parent container.

    Get-VEADContainer [-Container] <VEADContainer> [[-Type] {UsersAndComputers | GroupPolicyObjects | IntegratedDNS | ConfigurationPartition}] [-Recurse]  [<CommonParameters>]

    Detailed Description

    This cmdlet returns the VEADContainer object that contains an array of Active Directory containers. Use this object to restore Active Directory data.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Domain

    Specifies an Active Directory domain. The cmdlet will return an array of containers that are available in this domain.

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

    True

    0

    True (ByValue)

     

    Container

    Specifies a parent container. The cmdlet will return containers that are available in this parent container.

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

    True

    0

    True (ByValue)

     

    Type

    Specifies a type of an Active Directory container that you want to get. You can specify one of the following type:

    • UsersAndComputers
    • GroupPolicyObjects
    • IntegratedDNS
    • ConfigurationPartition

    VEADContainerType

    False

    1

    False

     

    Id

    Specifies an ID of an Active Directory child container. The cmdlet will return the Active Directory child container with this ID.

    Guid

    False

    1

    False

     

    Name

    Specifies a name of an Active Directory child container. The cmdlet will return the Active Directory child container with this 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 VEADContainer[] object that contains an array of Active Directory containers.

    Examples

    Get-VEADContainerExample 1. Getting Active Directory Containers from Domain

    This example shows how to get top-level Active Directory containers that are added to a domain.

    $session = Get-VEADRestoreSession

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

    Get-VEADContainer -Domain $domain

    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.

    Get-VEADContainerExample 2. Getting Active Directory Container from Domain by Name

    This example shows how to get Active Directory containers that are added to a domain by an Active Directory container name.

    $session = Get-VEADRestoreSession

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

    Get-VEADContainer -Domain $domain -Name "Domain controller"

    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. Specify the Name parameter value.

    Get-VEADContainerExample 3. Getting Active Directory Container from Domain by ID

    This example shows how to get Active Directory containers that are added to a domain by an Active Directory container ID.

    $session = Get-VEADRestoreSession

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

    Get-VEADContainer -Domain $domain -ID "4e9c3f01-1955-453d-b2fe-80656d891708"

    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. Specify the ID parameter value.

    Get-VEADContainerExample 4. Getting Active Directory Containers from Parent Container

    This example shows how to get all Active Directory containers added to an Active Directory parent container.

    $session = Get-VEADRestoreSession

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

    $parentcontainer = Get-VEADContainer -Domain $domain

    Get-VEADContainer -Container $parentcontainer[8]

    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-VEADContainer cmdlet. Set the $parentcontainer variable as the Container parameter value. Specify the ordinal number of the parent container.

    Get-VEADContainerExample 5. Getting Active Directory Containers from Parent Container by Name

    This example shows how to get all Active Directory containers added to an Active Directory parent container by an Active Directory child container name.

    $session = Get-VEADRestoreSession

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

    $parentcontainer = Get-VEADContainer -Domain $domain

    Get-VEADContainer -Container $parentcontainer[8] -Name "Sales Mailboxes"

    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-VEADContainer cmdlet. Specify the following settings:
    • Set the $parentcontainer variable as the Container parameter value. Specify the ordinal number of the parent container.
    • Specify the Name parameter value.

    Get-VEADContainerExample 6. Getting Active Directory Containers from Parent Container by ID

    This example shows how to get all Active Directory containers added to a parent container by an Active Directory child container ID.

    $session = Get-VEADRestoreSession

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

    $parentcontainer = Get-VEADContainer -Domain $domain

    Get-VEADContainer -Container $parentcontainer[8] -ID "1b12ab63-4fc2-485d-a350-f5430ddde767"

    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-VEADContainer cmdlet. Specify the following settings:
    • Set the $parentcontainer variable as the Container parameter value. Specify the ordinal number of the parent container.
    • Specify the Id parameter value.

    Get-VEADContainerExample 7. Getting Active Directory Containers of Specific Type

    This example shows how to get all Active Directory containers of the Users And Computers type.

    $session = Get-VEADRestoreSession

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

    Get-VEADContainer -Domain $domain -Type UsersAndComputers

    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. Specify the Type parameter value.

    Related Commands