Chat now with support
Chat with Support

Archive Shuttle 11.2 - 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

Remove-ASJEDistributionListRule

SYNOPSIS

Remove Distribution List rule.

SYNTAX

Remove-ASJEDistributionListRule [-Core] <ConnectCore> [-JournalExplosionDistributionListRuleId] <int[]> [-ContainerMappingId] <int[]> [-Expression] <string[]> [<CommonParameters>]​

DESCRIPTION

The Remove-ASJEDistributionListRule will remove existing distribution list rule. 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-ASJEDistributionListRule

Remove-ASJEDistributionListRule  -ContainerMappingId 1,2 -Confirm:$false

Remove-ASJEDistributionListRule -JournalExplosionDistributionListRuleId 1,2

Remove-ASJEDistributionListRule -Expression "dll*"

/* Removes Distribution list rules for all Journal Transformation mappings */

/* Removes Distribution list rules for specified Journal Transformation mappings by ignoring confirm action */

/* Removes Distribution list rules for specified Journal Transformation mappings by ignoring confirm action */

/* Removes Distribution list rule of specified expression */

Set-ASJEDistributionListRule

SYNOPSIS

Set Distribution List rule.

SYNTAX

Set-ASJEDistributionListRule [-Core] <ConnectCore> [-JournalExplosionDistributionListRuleId] <int> [-Expression] <string> [<CommonParameters>]​

DESCRIPTION

The Set-ASJEDistributionListRule will adjust existing distribution list rule. 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-ASJEDistributionListRule -JournalExplosionDistributionListRuleId 1 -Expression "dll2*"​

/* Changes Distribution list rule expression for specified Journal Transformation DistributionListRuleId */

Copy-ASJEAutoCreationRules (Copy-ASJECreationRules)

SYNOPSIS

Copies Journal Explosion Auto Creation rule(s).

SYNTAX

Copy-ASJEAutoCreationRules [-Core] <ConnectCore> [-SourceContainerMappingId] <int> [-TargetContainerMappingIds] <int[]> [[-EmailAddressRule] <SwitchParameter>] [[-UserQueue] <SwitchParameter>] [[-DistributionListRule] <SwitchParameter>] [[-ReplaceExistingRules] <SwitchParameter>] [<CommonParameters>]

DESCRIPTION

The Copy-ASJECreationRules cmdlet copies the Journal Explosion Creation rule(s). 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:

Copy-ASJEAutoCreationRules -TargetContainerMappingIds 2,3​ -SourceContainerMappingId 1 -EmailAddressRule -UserQueue -DistributionListRule

Copy-ASJEAutoCreationRules -SourceContainerMappingId 1 -TargetContainerMappingIds 2,3 -EmailAddressRule -UserQueue -DistributionListRule -ReplaceExistingRules

Copy-ASJEAutoCreationRules -SourceJournalExplosionEmailRuleIds 119,120,121 -SourceJournalExplosionUserQueueIds 351,352,353 -TargetContainerMappingIds 2,3 -ReplaceExistingRules

Copy-ASJEAutoCreationRules -TargetContainerMappingIds 2,3​ -SourceContainerMappingId 1 -EmailAddressRule      -DistributionListRule

Copy-ASJEAutoCreationRules -TargetContainerMappingIds 2,3​ -SourceContainerMappingId 1 -EmailAddressRule      -DistributionListRule

/* Copies all Auto-creation rules from specified source Journal Explosion mapping into specified Journal Explosion mappings (origin rules in target mappings will be kept */

/* Copies all auto-creation rules from specified source Journal Explosion mapping into specified mappings (origin rules in target mappings will be removed)  */

/* Copies specified email address and Active Directory user rules into specified Journal Explosion mappings */​

/* Copy selected auto-creation rules (EmailAddressRule and DistributionListRule) from specified source Journal Transformation mapping into specified mappings (origin rules in target mappings will be kept */

/* Copy selected auto-creation rules (EmailAddressRule and DistributionListRule) from specified source Journal Transformation mapping into specified mappings (only selected rules in target mappings will be removed, for other rules - in this case -UserQueue rules will be kept */

Get-ASMailboxQuotaStatus??

SYNOPSIS

Gets the Mailbox Quota status.

SYNTAX

Get-ASMailboxQuotaStatus [-Core] <ConnectCore> [[-UserSid] <string[]>] [[-PrimarySmtpAddress] <string[]>] [[-JournalTransformation] <SwitchParameter>] [[-All] <SwitchParameter>] [<CommonParameters>]

DESCRIPTION

The Get-ASMailboxQuotaStatus cmdlet gets the Mailbox Quota status. 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:

Get-ASMailboxQuotaStatus -UserSid "S-1-5-21-1234567890-100000000-100000000-1000"

Get-ASMailboxQuotaStatus -PrimarySmtpAddress "email@email.com"

/* Retrieves storage quotas for specified mailbox based on UserSID */

/* Retrieves storage quotas for specified mailbox based on email address */

Get-ASMailboxQuotaStatus

Get-ASMailboxQuotaStatus -JournalTransformation

Get-ASMailboxQuotaStatus -All -IncludeTotalCount

/* Retrieves storage quotas for first 1000 mailboxes */

/* Retrieves storage quotas only for Journal Transformation user mappings */

/* Retrieves storage quotas for all mailboxes and includes count of returned records */​

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating