Export-GOGroups

SYNOPSIS

Exports groups from a Google Workspace tenant.

SYNTAX

Help (Default)

Export-GOGroups [-ShowPrereqs] [<CommonParameters>]

Action

Export-GOGroups -ConfigNode <String> [-Target <String>] [-Format <String>]
 [<CommonParameters>]

DESCRIPTION

Use the Export-GOGroups cmdlet to export groups from a Google Workspace tenant.

Note that the exported groups are distribution groups and not Google Groups.

See the Notes section for cmdlet requirements.

EXAMPLES

Example 1: Export raw data

Export-GOGroups -ConfigNode Source -Format Csv >'groups.csv'

This example exports all groups from a Google Workspace tenant. The exported data is formatted as CSV and saved to the file groups.csv.

Example 2: Map data for Google Workspace

Export-GOGroups -ConfigNode Source -Target Google -Format Csv >'groups.csv'

This example exports all groups from a Google Workspace tenant. The exported data is formatted as CSV, mapped for import into Google Workspace, and saved to the file groups.csv.

Example 3: Map data for Microsoft 365

Export-GOGroups -ConfigNode Source -Target M365 -Format Csv >'groups.csv'

This example exports all groups from a Google Workspace tenant. The exported data is formatted as CSV, mapped for import into Microsoft 365, and saved to the file groups.csv.

PARAMETERS

-ConfigNode

The config.psd1 configuration node to use.

Type: String
Parameter Sets: Action
Aliases:
Accepted values: Source, Target

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Format

The output type for exported data.

Note that extended properties cannot be serialized into CSV format. When using -Format Csv, extended properties will display as System.Collections.Hashtable in the output.

Type: String
Parameter Sets: Action
Aliases:
Accepted values: Csv, Json, Objects

Required: False
Position: Named
Default value: Objects
Accept pipeline input: False
Accept wildcard characters: False

-ShowPrereqs

Prints the cmdlet prerequisites.

Type: SwitchParameter
Parameter Sets: Help
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Target

Specifies a mapping target for the exported data. Exported data mapped for a supported target is directly consumable by a corresponding import cmdlet.

To export unmapped data, use -Target None.

Type: String
Parameter Sets: Action
Aliases:
Accepted values: Google, GroupWise, M365, None

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

System.Object[]

NOTES

Required config.psd1 configurations

• GOAdmin
• GOServiceAccountKey
• GOTenant

Required APIs

• Admin SDK
• Contacts

Required scopes

• https://www.googleapis.com/auth/admin.directory.group.readonly
• https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly
• https://www.googleapis.com/auth/contacts.readonly
• https://www.googleapis.com/auth/admin.directory.user.readonly
• https://www.googleapis.com/auth/admin.directory.domain.readonly
• https://www.googleapis.com/auth/userinfo.email

RELATED LINKS

TMCTools configuration options