Imports shared mailboxes into a GroupWise tenant.
Import-GWSharedMailboxes
[-ShowPrereqs]
[<CommonParameters>]
Import-GWSharedMailboxes
-ConfigNode <String>
-Csv <String>
[-TranslationCsv <String>]
[-IgnoreErrors]
[-SkipValidation]
[-ValidateOnly]
[<CommonParameters>]
Use the Import-GWSharedMailboxes cmdlet to import shared mailboxes
into a GroupWise tenant.
See the Notes section for cmdlet requirements.
Import-GWSharedMailboxes -ConfigNode Target -Csv 'shared_mailboxes.csv' -ValidateOnly
This example validates all data for the shared mailboxes in the shared_mailboxes.csv
file but does not perform the operation. This is a recommended first step so any
warnings can be addressed first.
Import-GWSharedMailboxes -ConfigNode Target -Csv 'shared_mailboxes.csv'
This example imports all shared mailboxes from the shared_mailboxes.csv file.
Import-GWSharedMailboxes -ConfigNode Target -Csv 'shared_mailboxes.csv' -TranslationCsv 'translations.csv'
This example imports all shared mailboxes from the shared_mailboxes.csv file.
Data is translated according to the mappings provided in the translations.csv
file.
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
The path to a CSV file containing objects to import. See the Notes section for the required format.
Type: String
Parameter Sets: Action
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Validation errors stop execution prior to the import by default. Use
-IgnoreErrors to proceed with error records omitted.
Note that global errors are not impacted by this option.
Type: SwitchParameter
Parameter Sets: Action
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Skips the property validation stage of the import. Data supplied via the
-Csv parameter will be used as-is, which may lead to runtime errors.
Type: SwitchParameter
Parameter Sets: Action
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
The path to the CSV file containing translation mappings. The file must use
SourceName;TargetName as the field identifiers.
Type: String
Parameter Sets: Action
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Validation and import are both performed by default. Use -ValidateOnly to
perform the validation but skip the import.
It is recommended to run a -ValidateOnly pass first to identify potential
issues prior to importing data. Note that records with validation errors will
fail to import unless -IgnoreErrors is used, but records with validation
warnings proceed without the data triggering the warning. A -ValidateOnly pass
allows you to inspect these warnings before data is written and make any
necessary changes.
Type: SwitchParameter
Parameter Sets: Action
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
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
GWRuleType: Determines the type of GroupWise forwarding rule to create when importing or updating users, resources
and shared mailboxes. The available options are SimpleForward to forward messages or Forward to forward
attachments.
Default: SimpleForward
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
Required CSV format
| Property | Required | Multi-value | Notes |
|---|---|---|---|
| InScope | True | False | Allowed values: Yes, True, No and False. |
| Domain | True | False | The GroupWise domain. |
| PostOffice | True | False | The GroupWise post office. |
| DisplayName | True | False | |
| LoginId | True | False | |
| EmailAddress | True | False | |
| OwnerIdentity | True | False | The user who will be given the Owner role for the resource. |
| EmailAliasesToAdd | False | True | |
| MailboxForwardAndStoreAddressesToAdd | False | True |
CSV fields should be separated by semicolons. For example,
InScope;Domain....
Multi-value fields should be separated by commas. For example,
value1,value2....
Email aliases are implemented as nicknames in the GroupWise system, which are equivalent to the local part of an email address or alias. When adding a nickname, the nickname is associated with all available internet domains in the tenant. It is not possible to limit the internet domains for which a nickname applies, which means adding an email alias for any available internet domain will add an email alias for all available internet domains.