Chat now with support
Chat with Support

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

Set-ASJELeaverMapping

SYNOPSIS

Sets the Journal Explosion Leaver Mapping(s) parameters. Runs specific functionality for Journal Explosion Leaver Mappings.

SYNTAX

Set-ASJELeaverMapping [-Core] <ConnectCore> [-JournalExplosionLeaverMappingId] <int[]> [[-FolderNamePolicyId] <int?>] [[-FolderNamePolicyName] <string>] [[-RemoveFolderNamePolicy] <SwitchParameter>] [[-GroupId] <int?>] [[-GroupName] <string>] [[-RemoveGroup] <SwitchParameter>] [[-UserSid] <string>] [[-EnableForImport] <SwitchParameter>] [[-SetAsDistributionList] <SwitchParameter>] [[-MergeByPreviewSMTPAddress] <SwitchParameter>] [[-MergeByJournalExplosionLeaverMappingId] <int?>] [<CommonParameters>]​

DESCRIPTION

The Set-ASJELeaverMapping cmdlet sets the Journal Explosion Leaver Mapping(s) parameters. Runs specific functionality for Journal Explosion Leaver Mappings. Add 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:

Set-ASJELeaverMapping -JournalExplosionLeaverMappingId 10 -FolderNamePolicyId 1

Set-ASJELeaverMapping -JournalExplosionLeaverMappingId 10 -RemoveFolderNamePolicy

 

Set-ASJELeaverMapping -JournalExplosionLeaverMappingId 15 -GroupId 1

Set-ASJELeaverMapping -JournalExplosionLeaverMappingId 10 -RemoveGroup

 

Set-ASJELeaverMapping -JournalExplosionLeaverMappingId 10 -SetAsDistributionList

Set-ASJELeaverMapping -JournalExplosionLeaverMappingId 14 -EnableForImport

 

Set-ASJELeaverMapping -JournalExplosionLeaverMappingId 14 -UserSid S-1-5-21-141886343-4149337270-1996687478-3137​

/* Assigns specified Folder Name Policy to defined Journal Explosion Leaver Mapping */​

/* Removes Folder Name Policy from specified Journal Explosion Leaver Mapping */

 

/* Assigns specified Group to defined Journal Explosion Leaver Mapping */​

/* Removes Group from specified Journal Explosion Leaver Mapping */

 

/* Marks specified Journal Explosion Leaver Mapping as Distribution list */

/* Enables specified Journal Explosion Leaver Mapping for migration */

 

​/* Manual mapping of specified user to specified Journal Explosion Leaver Mapping */

Set-ASJELeaverMapping -JournalExplosionLeaverMappingId 5,6 -MergeByJELeaverMappingId 6

 

Set-ASJELeaverMapping -JournalExplosionLeaverMappingId 5,6 -MergeByPreviewSMTPAddress

 

Get-ASJELeaverMapping -ContainerMappingId 3 -All | Set-ASJELeaverMapping -MergeByPreviewSMTPAddress

 

 

Get-ASJELeaverMapping -All | Set-ASJELeaverMapping -MergeByPreviewSMTPAddress

/* Merges specified Journal explosion Leaver Mappings into one target SMTP Address taken from specified Journal Explosion Leaver Mapping */

/* Merges specified Journal Explosion Leaver Mappings based on Preview Address */

/* Merges automatically all Journal Explosion Leaver Mappings related to specified Journal Explosion Container Mapping. As a result, there will be multiple leaver mapping groups based on mutual preview addresses */

/* Merges automatically all Journal Explosion Leaver Mappings​. As result there will be multiple leaver mapping groups based on mutual preview addresses */​

-MergeByPreviewSMTPAddress does not automatically enable mappings for import! IT can be enabled afterwards by running command again with -EnableForImport parameter.

$email = "asqata-leaver-01@outlook.sk"

Get-ASJELeaverMapping -All | Where-Object {$_.OriginalSmtpAddress -eq $email} | ForEach-Object -Begin { $ids = @() } -Process { $ids += $_.JournalExplosionLeaverMappingId } -End { Set-ASJELeaverMapping -JournalExplosionLeaverMappingId $ids -MergeByJELeaverMappingId ($ids | Select-Object -First 1) }

 

$emails = Get-ASJELeaverMapping -All | Select-Object OriginalSmtpAddress -Unique

ForEach ($email in $emails){

   Write-Host "email: $($email.OriginalSmtpAddress)" -ForegroundColor Yellow

   $mapping = Get-ASJELeaverMapping -All | Where-Object {$_.OriginalSmtpAddress -eq $email.OriginalSmtpAddress} | ForEach-Object -Begin { $ids = @() } -Process { $ids += $_.JournalExplosionLeaverMappingId } -End { Set-ASJELeaverMapping -JournalExplosionLeaverMappingId $ids -MergeByJELeaverMappingId ($ids | Select-Object -First 1) }

   $mapping | Format-Table -AutoSize

   Write-Host

}​

/* Retrieves all Journal Explosion Leaver Mappings with specified original email address and merges it into one mutual target */

 

 

 

​/* Retrieves Journal Explosion Leaver Mappings with specified original email address and merges it into one target. This happens in cycle for all original email addresses */

Remove-ASJELeaverMapping

SYNOPSIS

Removes the Journal Explosion Leaver Mapping(s).

SYNTAX

Remove-ASJELeaverMapping [-Core] <ConnectCore> [-JournalExplosionLeaverMappingId] <int[]> [<CommonParameters>]

DESCRIPTION

The Remove-ASJELeaverMapping cmdlet removes the Journal Explosion Leaver Mapping(s). Add 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:

Remove-ASJELeaverMapping -JournalExplosionLeaverMappingId 12

Get-ASJELeaverMapping -ContainerMappingId 2 | Remove-ASJELeaverMapping

Get-ASJELeaverMapping -ContainerMappingId 3,4 | Remove-ASJELeaverMapping

/* Removes Journal Explosion Leaver Mapping based on specified ID */

/* Retrieves all Journal Explosion Leaver Mappings of specified Journal Explosion Container Mapping and removes it */

/* Retrieves all Journal Explosion Leaver Mappings of specified Journal Explosion Container Mappings and removes it */

Mappings already enabled for migration cannot be removed!​

Get-ASJELeaverMapping -All | Remove-ASJELeaverMapping​

/* Retrieves all available Journal Explosion Leaver Mappings in Archive Shuttle database and removes it. Mappings already enabled for migration cannot be removed! */​

Get-ASJEStage1Statistics

SYNOPSIS

Get detail statistics for Journal Explosion submappings

SYNTAX

Get-ASJEStage1Statistics [-Core] <ConnectCore> [-ContainerMappingId] <int> [<CommonParameters>]

DESCRIPTION

The Get-ASJEStage1Statistics cmdlet gets Stage1 detail statistics of Journal Explosion User sub-mappings. 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:

​Get-ASJEStage1Statistics -ContainerMappingId 1 -All

/* Retrieves Stage1 statistics of all Journal Explosion User mappings of a specified Container mapping; it is also possible to retrieve stats only for one Container mapping at once (similar to Archive Shuttle UI) */​

Add-ASJEEmailAddressRule

SYNOPSIS

Add new Journal Explosion email address rule.

SYNTAX

Add-ASJEEmailAddressRule [-Core] <ConnectCore> [-Expression] <string> [-ContainerMappingId] <int> [-EnableForImport] <SwitchParameter> [<CommonParameters>]

DESCRIPTION

The Add-ASJEEmailAddressRule cmdlet adds new Journal Explosion Email Address Rule. 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:

Add-ASJEEmailAddressRule -ContainerMappingId 1 -Expression "*@test.com"

/* Creates new journal explosion email address rule for specified container mapping*/​

​​Add-ASJEEmailAd​dressRule -ContainerMappingId 1 -Expression "*@test.com" -EnableForImport ​​

/* Creates new journal explosion email address rule for specified container mapping​. Each user mapping created by this rule is automatically enabled for import */

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating