지금 지원 담당자와 채팅
지원 담당자와 채팅

Archive Shuttle 11.5 - PowerShell Guide

Archive Shuttle and PowerShell Get Archive Shuttle commands Public commands table Available commands sorted to groups Available commands
Connect-ASCore Connect to core in AS.Cloud? Set-ASConfiguration Get-ASConfiguration Add-ASSettingSchedule Set-ASSettingSchedule Get-ASSettingSchedule Add-ASSettingDefinitionToSchedule Get-ASFailedItemThreshold Set-ASFailedItemThreshold Get-ASWatermark Set-ASWatermark Get-ASRetentionCategory Get-ASEVRetentionCategoryMapping Add-ASEVRetentionCategoryMapping Add-ASWorkflowPolicy Set-ASWorkflowPolicy Get-ASWorkflowPolicyStep Add-ASWorkflowPolicyStep Set-ASWorkflowPolicyStep Add-ASFilterPolicy Add-ASFilterCondition Get-ASFileNamePolicy Set-ASFileNamePolicy Add-ASFileNamePolicy? Get-ASTargetPathNamePolicy? Set-ASTargetPathNamePolicy? Add-ASTargetPathNamePolicy? Add-ASO365LeaversConfiguration Get-ASO365License Set-ASO365LeaversConfiguration Get-ASO365LeaversConfiguration Get-ASModule Set-ASModule Set-ASModuleLogLevel Get-ASModulePerformance Enable-ASModule Disable-ASModule Start-ASModule Stop-ASModule Restart-ASModule Start-ASCommand Get-ASCommandQueueStatus Set-ASCommandIntervalLastExecutedDate Get-ASScheduledTask Set-ASScheduledTask Enable-ASActiveDirectorySync Disable-ASActiveDirectorySync Get-ASADGroup Get-ASADGroupMember Get-ASADDomain Start-ASSyncADDomains Get-ASExchangeServer Get-ASExchangeDatabase Add-ASEnvironment Set-ASEnvironment Get-ASEnvironment Get-ASVaultStore Enable-ASArchiveGathering Disable-ASArchiveGathering Start-ASArchiveGathering Get-ASLicense Add-ASLink Get-ASLink Get-ASLinkHealth Get-ASLinkModule Set-ASLinkModule Remove-ASLinkDatabase Add-ASItemDatabase Set-ASStagingAreaPath Start-ASStagingAreaCleanup Get-ASProgressStatistics Add-ASPstSourcePath Remove-ASPstSourcePath Set-ASPstSourcePath Set-ASPstTargetPath Set-ASPstTemporaryPath Add-ASContainer Add-ASContainerToUser Get-ASArchive Get-ASUser Get-ASContainers Get-AdamContainer Get-ASMailbox Get-ASUserSyncStatus Set-ASContainer Start-ASSyncADUsers Start-ASO365SyncMailboxes Start-ASADSyncSingleUser Start-ASO365SyncSingleUser Add-ASContainerMapping Set-ASContainerMapping Get-ASBulkMappingWizardTemplate Get-ASMappings Get-ASPremigrationStatus Get-ASStage1Statistics Get-ASStage2Status Get-ASWorkflowPolicy Get-ASFilterPolicy? Enable-ASCollection Enable-ASMigration Disable-ASCollection Disable-ASMigration Enable-ASStage2 Start-ASRetryFailedItems Remove-ASContainerMapping Add-ASMappingConfigurationTemplate??? Set-ASMappingConfigurationTemplate??? Get-ASMappingConfigurationTemplate??? Remove-ASMappingConfigurationTemplate??? Add-ASJEUserGroup? Get-ASJEUserGroup Set-ASJEUserGroup Add-ASFolderNamePolicy Get-ASFolderNamePolicy Set-ASFolderNamePolicy? Get-ASJESenderRecipient Add-ASJEUserMapping Get-ASJEUserMapping Set-ASJEUserMapping Remove-ASJEUserMapping Add-ASJELeaverMapping Get-ASJELeaverMapping Set-ASJELeaverMapping Remove-ASJELeaverMapping Get-ASJEStage1Statistics Add-ASJEEmailAddressRule Get-ASJEEmailAddressRule Set-ASJEEmailAddressRule Remove-ASJEEmailAddressRule Add-ASJEADUserRule Get-ASJEADUserRule Remove-ASJEADUserRule Add-ASJEDistributionListRule Get-ASJEDistributionListRule Remove-ASJEDistributionListRule Set-ASJEDistributionListRule Copy-ASJEAutoCreationRules (Copy-ASJECreationRules) Get-ASMailboxQuotaStatus?? Update-ASMailboxSizeAndQuota?? Get-ASJELeaversStatus Set-ASJELeaversStatus Add-ASGroup Set-ASGroup Get-ASGroup Add-ASUserToGroup Add-ASTag Set-ASTag Get-ASTag Add-ASContainerToTag Recreate-ASMapiProfile Set-ASStage2Status Set-ASPremigrationAction Get-ASHealthStatus Get-ASModuleCredential Set-ASModuleCredential

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-ASO365SyncMailboxes -LinkId "0d4ad6b3-263c-e611-813b-005056b84ed8"

  Result:

 Office365 sync  mailboxes  command  queued.​

​/* This command is an alternative to the UI Action "Sync Mailboxes" for O365 Link (triggers Office365CollectMailboxes + Office365CollectArchiveMailboxes commands)  */

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-ASADSyncSingleUser -UserPrincipalName user1@l2.lab.quadrotech-it.com

Start-ASADSyncSingleUser-SAMAccountName muser1

Start-ASADSyncSingleUser-SAMAccountName user1,maor-l2ex10-qam-1001,user2

/* ​Syncs single Active Directory User based on UPN or SAMAccountName, (can also enter multiple users per one command) */

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:

Start-ASO365SyncSingleUser -SAMAccountName user1

Start-ASO365SyncSingleUser -UserPrincipalName user1@domain1.onmicrosoft.com

Start-ASO365SyncSingleUser -SAMAccountName user1,user2,user3

​/* Sync single Office 365 user based on UPN or SAMAccountName, also it's possible to enter multiple users per one command */

By default, this command queues Office365SyncSingleCloudOnlyUser command to sync single cloud-only user.

​Start-ASO365SyncSingleUser -SAMAccountName user1 -CollectMailbox

/* In case -CollectMailbox parameter is used, Office365CollectSingleMailbox and Office365CollectSingleArchiveMailbox commands are queued to collect Office365 user mailboxes */

Start-ASO365SyncSingleUser -UserPrincipalNameuser1@domain1.onmicrosoft.com  -SkipUserCheck

​/* Syncs single Office 365 user based on UPN without check of existence in Archive Shuttle database */

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:

​Add-ASContainerMapping -SourceContainerIds $SourceContainer1.ContainerId -TargetContainerId $TargetContainer1.ContainerId -WorkflowPolicyId 8 -FilterPolicyId 1 -MigrationEnabled -ItemGatheringEnabled

Manual mapping:

·New parameter "-TargetContainerType Manual" can be defined

·Omit TargetContainerType parameter - command will automatically consider Manual mapping type

Parameters supported for manual mapping: -SourceContainerIds -TargetContainerId -WorkflowPolicyId -FilterPolicyId -MigrationEnabled -ItemGatheringEnabled (MigrationEnabled,ItemGatheringEnabled are switch parameters - if used, migration and gathering is enabled)

​Add-ASContainerMapping -TargetContainerType Exchange -SourceContainerIds $SourceContainer.ContainerId -MailboxType OnPremisePrimary -IsSameUser -WorkflowPolicyId $wfpolicy.WorkflowPolicyId -FilterPolicyId $filterpolicy.FilterPolicyId -ItemGatheringScheduleDateTime ((GET-DATE).AddDays(1).ToUniversalTime()) -MigrationScheduleDateTime ((GET-DATE).AddDays(1).ToUniversalTime())

/* By specifying highlighted parameters (DateTimeUTC), it is possible to postpone item collection or migration of the mapping. */​

​Add-ASContainerMapping -TargetContainerType Office365 -SourceContainerIds $SourceContainer.ContainerId -Office365TargetType Normal -MailboxType OnlinePrimary -TargetLinkId "0d4ad6b3-263c-e611-813b-005056b84ed8" -WorkflowPolicyId 1 -OwnerlessWorkflowPolicyId 2 -FilterPolicyId 3 -MigrationEnabled -ItemGatheringEnabled -Priority 99

Command returns result with following information:

SourceContainerId : 9e45f73d-1b93-47ce-bcde-6986663c7912

ContainerMappingID : 8

Status : Success

ErrorMessage :

Error :

​Bulk mapping:

·Parameter "-TargetContainerType" must be defined first, with desired migration target set (enum available)

·Based on the target type, most of the related parameters are dynamically provided.

·UserDefinedTokenValue can be specified only for O365 JournalExplosion mapping type

Add-ASContainerMapping -TargetContainerType Office365 -SourceContainerIds $SourceContainer.ContainerId -Office365TargetType Normal -MailboxType OnlinePrimary -TargetLinkId "0d4ad6b3-263c-e611-813b-005056b84ed8" -WorkflowPolicyId 1 -OwnerlessWorkflowPolicyId 2 -FilterPolicyId 3 -ItemGatheringEnabled -Priority 99 -PreMigrationWorkflowPolicyId 107

Bulk mapping:

·Same as mapping above but with set -PremigrationWorkflowPolicy

·If MigrationEnabled switch is present, than it will be automatically set to false with warning message (WARNING: MigrationEnabled parameter was set to false because migration can't be enabled when Pre-migration policy is set)

관련 문서

The document was helpful.

평가 결과 선택

I easily found the information I needed.

평가 결과 선택