Logo

Documentation home for Transend tools

  • Export-GWApplications
  • Export-GWDomains
  • Export-GWGroups
  • Export-GWMailboxes
  • Export-GWNicknames
  • Export-GWOrgUnits
  • Export-GWResources
  • Export-GWSharedMailboxes
  • Export-GWUsers
  • Import-GWGroups
  • Import-GWResources
  • Import-GWSharedMailboxes
  • Import-GWUsers

    • Home

    Export-GWGroups

    SYNOPSIS

    Exports groups from a GroupWise tenant.

    SYNTAX

    Help (Default)

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

    Action

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

    DESCRIPTION

    Use the Export-GWGroups cmdlet to export groups from a GroupWise tenant.

    See the Notes section for cmdlet requirements.

    EXAMPLES

    Example 1: Export raw data

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

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

    Example 2: Map data for Google Workspace

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

    This example exports all groups from a GroupWise 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-GWGroups -ConfigNode Source -Target M365 -Format Csv >'groups.csv'

    This example exports all groups from a GroupWise 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

    • GWServer

    Optional config.psd1 configurations

    • GWInsecure
    • GWRestPort

    Required APIs

    • REST API

    TMCTools configuration options