This is an archive version of the document. To get the most up-to-date information, see the current version.

Get-VBOOrganizationGroup

In this article

    Short Description

    Returns organization groups.

    Syntax

    This cmdlet provides the following parameter sets.

    • Get all organization groups

    Get-VBOOrganizationGroup -Organization <VBOOrganization> [-Type <VBOOrganizationGroupType> {Office365 | Security | Distribution | DynamicDistribution}] [-NotInJob]  [<CommonParameters>]

    • Return an organization group by name

    Get-VBOOrganizationGroup -Organization <VBOOrganization> [-Name <string>] [-Type <VBOOrganizationGroupType> {Office365 | Security | Distribution | DynamicDistribution}] [-NotInJob]  [<CommonParameters>]

    Detailed Description

    This cmdlet returns Exchange and Microsoft Office 365 SharePoint organization groups.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Organization

    Specifies an organization. This cmdlet returns organization groups of a specified organization.

    True

    Named

    True (ByValue)

    False

    Name

    Specifies the name of the organization group. This cmdlet returns organization groups with this name.

    False

    Named

    False

    False

    NotInJob

    Indicates that the cmdlet will return groups that are not assigned to any of the backup jobs.

    Groups that are backed up by the "EntireOrganization" job are considered to be "NotInJob" as well.

    False

    Named

    False

    True

    Type

    Specifies the type of the organization group:

    • Office 365
    • Security
    • Distribution
    • DynamicDistribution

    This cmdlet returns organization group with this type. It will not return organization groups of an on-premises organization with SharePoint components.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

    Example 1

    This example shows how to get all organization groups in the "ABC" organization:

    1. Run Get-VBOOrganization with a Name parameter to get the organization with a name "ABC". Save the result to the $org variable.
    2. Run Get-VBOrganizationGroup with the $org variable to get all organization groups of an organization with a name "ABC".

    $org = Get-VBOOrganization -Name "ABC"

    Get-VBOOrganizationGroup -Organization $org

    Example 2

    This example shows how to get an organization group with a name "UsersAlpha" from the "ABC" organization:

    1. Run Get-VBOOrganization with a Name parameter to get the organization with a name "ABC". Save the result to the $org variable.
    2. Run Get-VBOrganizationGroup with the $org variable and a Name parameter to get an organization group with a name "UsersAlpha".

    $org = Get-VBOOrganization -Name "ABC"

    Get-VBOOrganizationGroup -Organization $org -Name "UsersAlpha"

    Example 3

    This example shows how to get all organization groups with a name starting with "A" of an Office 365 type that are not specifically assigned to any backup job.

    1. Run Get-VBOOrganization with a Name parameter to get the organization with a name "ABC". Save the result to the $org variable.
    2. Run Get-VBOrganizationGroup with the $org variable, a Name parameter and a specified Type parameter to get an organization group of an Office365 type with a name starting with "A". use NotInJob parameter to get only organization groups that are not specifically assigned to any backup job.

    $org = Get-VBOOrganization -Name "ABC"

    Get-VBOOrganizationGroup -Organization $org -Name "A*" -Type Office365 -NotInJob

    Related Commands

    Get-VBOOrganization

    I want to report a typo

    There is a misspelling right here:

     

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