Logo

Documentation home for Transend tools

Export-GWResources

SYNOPSIS

Exports resources from a GroupWise tenant.

SYNTAX

Help

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

Action

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

DESCRIPTION

Use the Export-GWResources cmdlet to export resources from a GroupWise tenant.

See the Notes section for cmdlet requirements.

EXAMPLES

Example 1: Export raw data

Export-GWResources -ConfigNode Source -Format Csv >'resources.csv'

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

Example 2: Map data for Google Workspace

Export-GWResources -ConfigNode Source -Target Google -Format Csv >'resources.csv'

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

Example 3: Map data for Microsoft 365

Export-GWResources -ConfigNode Source -Target M365 -Format Csv >'resources.csv'

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

Example 4: Map data for a migration list

Export-GWResources -ConfigNode Source -Target TMC -Format Csv >'resources.csv'

This example exports all resources from a GroupWise tenant. The exported data is formatted as CSV, mapped for use as a migration list, and saved to the file resources.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, TMC, 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 keys

These configuration keys are scoped to the Source or Target node in config.psd1.

  • GWRestServer: The FQDN or IP address of a server running the GroupWise Admin Service.

  • GWSoapServers: A hashtable of post office objects. Each key should be the post office identifier as it appears in the GroupWise system. For each key, define Host and Port sub-keys that define the FQDN or IP address and port number, respectively. For example: PO1 = @{ Host = '192.168.0.101'; Port = '7191' }.

  • GWTrustedAppName: The name of the GroupWise trusted app.

  • GWTrustedAppKey: The key associated with the GroupWise trusted app.

Optional config.psd1 keys

These configuration keys are scoped to the Source or Target node in config.psd1.

  • GWRestInsecure: Determines whether certificates will be checked for REST API connections.

    Default: $false

  • GWRestPort: The port to connect to when making REST API connections.

    Default: 9710

  • GWRestTlsProtocol: The TLS protocol version to use when making REST API connections. Valid values are Default, Tls, Tls11, Tls12 and Tls13.

    Default: Default

  • GWSkipEmailAliasesInCache: Determines whether email aliases will be fetched when building out the lookup cache. If you do not require email aliases to be available in lookups (e.g., you are only updating objects to set forwarding addresses), this can save considerable time during cache initialization. Do not use this option if you need access to email aliases.

    Default: $false

  • GWSoapInsecure: Determines whether certificates will be checked for SOAP API connections.

    Default: $false

Required APIs

  • REST API
  • SOAP API

General configuration options