Chat now with support
Chat with Support

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

Get-ASJEEmailAddressRule

SYNOPSIS

Gets Journal Explosion email address rule.

SYNTAX

Get-ASJEEmailAddressRule [-Core] <ConnectCore> [[-JournalExplosionUserRuleId] <int[]>] [[-ContainerMappingId] <int[]>] [[-Expression] <string[]>] [[-EnableForImport] <bool?>] [<CommonParameters>]

DESCRIPTION

The Get-ASJEEmailAddressRule cmdlet gets Journal Explosion Email Address 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:

Get-ASJEEmailAddressRule -ContainerMappingId 1

Get-ASJEEmailAddressRule -JournalExplosionUserRuleId 2

Get-ASJEEmailAddressRule -ContainerMappingId 1 -JournalExplosionUserRuleId 2

​/* Gets email address rule for specified container mapping */

/* Gets email address rule with specified rule Id */

/* Gets email address rule for specified container mapping with specified rule id */

​​Get-ASMappings | Get-ASJEEmailAddressRule | Format-Table

Get-ASJEEmailAddressRule | Format-Table

 

/* Gets all email address rules of all available Journal Explosion mappings */​

Set-ASJEEmailAddressRule

SYNOPSIS

Sets Journal Explosion email address rule.

SYNTAX

Set-ASJEEmailAddressRule [-Core] <ConnectCore> [-JournalExplosionUserRuleId] <int> [-Expression] <string> [-EnableForImport] <bool?> [<CommonParameters>]

DESCRIPTION

The Set-ASJEEmailAddressRule cmdlet sets 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:

Set-ASJEEmailAddressRule -JournalExplosionUserRuleId 1 -Expression "*@TEST001.com" -EnableForImport $false

/* Changes existing email address rule and sets flag EnableForImport to FALSE */​

Get-ASMappings | Get-ASJEEmailAddressRule | Set-ASJEEmailAddressRule -EnableForImport $true

Get-ASJEEmailAddressRule | Set-ASJEEmailAddressRule -EnableForImport $true

/* Enables all existing email address rules of all available Journal Explosion mappings to TRUE */​

Remove-ASJEEmailAddressRule

SYNOPSIS

Removes Journal Explosion email address rule.

SYNTAX

Remove-ASJEEmailAddressRule [-Core] <ConnectCore> [[-JournalExplosionUserRuleId] <int[]>] [[-ContainerMappingId] <int[]>] [[-Expression] <string[]>] [<CommonParameters>]​

DESCRIPTION

The Remove-ASJEEmailAddressRule cmdlet removes Journal Explosion Email Address 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. Advanced parameters are supported by this command (Confirm,Whatif).

Example:

Remove-ASJEEmailAddressRule -JournalExplosionUserRuleId 1

Remove-ASJEEmailAddressRule -ContainerMappingId 1

Remove-ASJEEmailAddressRule -ContainerMappingId 1​ -JournalExplosionUserRuleId 1

Remove-ASJEEmailAddressRule -Expression *@qa.quadrotech-it.com

Remove-ASJEEmailAddressRule -ContainerMappingId 1 -Confirm:$false

/* Removes specified email address rule */

/* Remove all email address rules of specified Journal Explosion mapping */​

/* Remove specified email address rule of specified Journal Explosion mapping */

/* Remove email address rule of specified expression */

/* Remove all email address rules of specified Journal Explosion mapping straight away by ignoring confirm action */

 

Get-ASMappings | ForEach-Object {Remove-ASJEEmailAddressRule -ContainerMappingId $_.ContainerMappingId}

Get-ASMappings | Get-ASJEEmailAddressRule | ForEach-Object {Remove-ASJEEmailAddressRule -JournalExplosionUserRuleId $_.JournalExplosionUserRuleId}​

Remove-ASJEEmailAddressRule

/* Removes all email address rules of all Journal Explosion mappings */​​

Add-ASJEADUserRule

SYNOPSIS

Adds Journal Explosion Active Directory User Rule.

SYNTAX

Add-ASJEADUserRule [-Core] <ConnectCore> [-ContainerMappingId] <int> [-UserSid] <string[]> [<CommonParameters>]

DESCRIPTION

The Add-ASJEADUserRule cmdlet creates new Journal Explosion Active Directory User 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-ASJEADUserRule -ContainerMappingId 1 -UserSid S-1-5-21-141886343-4149337270-1996687478-1135

/* Creates Active Directory user rule for specified Journal Explosion mapping based on various user properties */​

​Get-ASUser -First 10 | Add-ASJEADUserRule -ContainerMappingId 1

/* Creates ten Active Directory user rules for specified Journal Explosion mapping */​

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating