Archive Shuttle 11.3 - PowerShell Guide

Start-ASO365SyncMailboxes

SYNOPSIS

Starts active directory sync.

SYNTAX

Start-ASSyncADUsers [-Core] <ConnectCore> [-DistinguishedName] <string[]> [<CommonParameters>]

DESCRIPTION

The Start-ASSyncADUsers cmdlet starts Active Directory sync. After the command is executed, the module status can be checked in the Archive Shuttle user interface. All parameters in the cmdlet are mandatory. You can specify core as a parameter, or call Connect-ASCore once and the core parameter will be automatically added from the session state.

Example:

Start-ASADSyncSingleUser

SYNOPSIS

Starts active directory synchronization.

SYNTAX

Start-ASADSyncSingleUser [-Core] <ConnectCore> [-SAMAccountName] <string[]> [-UPN] <string[]> [<CommonParameters>]

DESCRIPTION

The Start-ASADSyncSingleUser starts active directory synchronization. Core parameter in the cmdlet is mandatory. You can specify core as a parameter, or call Connect-ASCore once and the core parameter will be automatically added from the session state.

Example:

Start-ASO365SyncSingleUser

SYNOPSIS

Starts Office 365 synchronization.

SYNTAX

Start-ASO365SyncSingleUser [-Core] <ConnectCore> [-SAMAccountName] <string[]> [-UserPrincipalName] <string[]> [[-CollectMailbox]<SwitchParameter>] [[-SkipUserCheck] <SwitchParameter>] [<CommonParameters>]

DESCRIPTION

The Start-ASO365SyncSingleUser starts Active Directory synchronization. Parameter -SAMAccountName can be partial. If multiple users have a similar name, an exception will occur with the message "Too many users found with userName". You can specify core as a parameter, or call Connect-ASCore once and the core parameter will be automatically added from the session state.

Example:

Add-ASContainerMapping

SYNOPSIS

Creates a new mapping for a source and target container.

SYNTAX

Add-ASContainerMapping [[-Core] <ConnectCore>] -TargetContainerType <TargetContainerTypeEnum> -SourceContainerIds <Guid[]> [-MappingTemplateId <int>] [[-WorkflowPolicyId] <int>] [[-FilterPolicyId] <int>] [-MigrationEnabled] <SwitchParameter> [-ItemGatheringEnabled] <SwitchParameter> [-OwnerlessWorkflowPolicyId] <int> [-IsSameUser] <SwitchParameter> [-IsDifferentUser] <SwitchParameter>   [-DifferentUserTargetDomainId] <int> [-DifferentUserMatchingCriteria] <ContainerMappingMatchingFlags[]> [-ContainerMappingAction] <ContainerMappingActionEnum> [-TargetLinkId] <Guid> [-Office365TargetType] <Office365TargetTypeEnum> [-MailboxType]<MailboxKindEnum> [-SecondaryMailboxUnavailableAction] <SecondaryMailboxUnavailableActionEnum> [-Priority] <int> [-PstFileNamePolicyId] <int> [-TargetContainerId] <int> [[-ItemGatheringScheduleDateTime] <DateTime>] [[-MigrationScheduleDateTime] <DateTime>] [[-UserDefinedTokenValue] <string>] [[-UseRecipientsCollectedViaEVIndexForExport] <SwitchParameter>] [[-UseAlternateMailboxes] <SwitchParameter>] [[-CollectSenderRecipientsOnExport] <SwitchParameter>] [[-TargetPathNamePolicyId] <int>] [[-PreMigrationWorkflowPolicyId] <int>] [[-EnableSecondaryMailbox] <SwitchParameter>] [<CommonParameters>]

DESCRIPTION

The Add-ASContainerMapping cmdlet gets SourceContainerId, WorkflowId, FilterP​olicyId parameters and creates a mapping. After the command is executed, the mapping can be checked in the Archive Shuttle user interface. All parameters in the cmdlet are mandatory except FilterPolicyId.

You can specify core as a parameter, or call Connect-ASCore once and the core parameter will be automatically added from the session state.

·All TargetContainerTypes have common parameters:

oSourceContainerIds, WorkflowPolicyId, FilterPolicyId, MigrationEnabled, ItemGatheringEnabled, OwnerlessWorkflowPolicyId, Priority;

·According to TargetContainerTypes parameter value there are additional parameters.

ofor Enterprise Vault, there are two possibilities:

i.IsSameUser, ContainerMappingAction, TargetLinkId;

ii.isDifferentUser, DifferentUserTargetDomainId, DifferentUserMatchingCriteria, ContainerMappingAction, TargetLinkId;

ofor Office 365:

i.Office365TargetType, MailboxType, SecondaryMailboxUnavailableAction, TargetLinkId;

ofor Exchange, there are two possibilities:

i.MailboxType, SecondaryMailboxUnavailableAction, IsSameUser;

ii.MailboxType, SecondaryMailboxUnavailableAction, isDifferentUser, DifferentUserTargetDomainId, DifferentUserMatchingCriteria;

ofor PST:

i.TargetLinkId, PstFileNamePolicyId;

ofor ProofPoint:

i.TargetLinkId;

ofor Manual (default):

i.TargetContainerId, SourceContainerIds, WorkflowPolicyId, FilterPolicyId, MigrationEnabled, ItemGatheringEnabled, Priority;

DateTime parameters should be specified in UTC format.

Example: