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

Set-ASJEUserMapping

SYNOPSIS

Set attributes for Journal Explosion user mappings.

SYNTAX

Set-ASJEUserMapping [-Core] <ConnectCore> [-JournalExplosionUserMappingId] <int[]> [[-FileNamePolicyId] <int>] [[-FileNamePolicyName] <string>] [[-RemoveFileNamePolicy] <SwitchParameter>] [[-FolderNamePolicyId] <int>] [[-FolderNamePolicyName] <string>] [[-RemoveFolderNamePolicy] <SwitchParameter>] [[-UserSid] <string>] [[-EnableForImport] <SwitchParameter>] [[-Pause] <SwitchParameter>] [[-Resume] <SwitchParameter>] [<CommonParameters>]

DESCRIPTION

The Set-ASJEUserMapping cmdlet sets attributes of Journal Explosion User 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. Cmdlet has three parameter sets, the first set contains ResetPolicies parameter, the second contains EnableForImport parameter. The third set consists of JournalExplosionGroupId,JournalExplosionGroupName, FolderNamePolicyId, FolderNamePolicyName and MappedSmtpAddress

Example:

​Set-ASJEUserMapping -JournalExplosionUserMappingId 1 -FolderNamePolicyId 2 -JournalExplosionGroupId 1

Set-ASJEUserMapping -JournalExplosionUserMappingId 1 -MappedSMTPAddress maor-l2ex10-001@lab.quadrotech-it.com

Set-ASJEUserMapping -JournalExplosionUserMappingId 1 -EnableForImport

Set-ASJEUserMapping -JournalExplosionUserMappingId 1 -Pause

Set-ASJEUserMapping -JournalExplosionUserMappingId 1 -EnableToRecreate 1

/* Assigns specified Folder Name policy and Journal Explotion Group to particular User mapping */

/* Assigns different SMTP address for specified Journal Explosion User mapping */

/* Enables Journal Explosion User mapping for import */​

/* Command sets Journal Explosion User mapping to paused state (IsReadyForImport parameter = 2). It can be resumed by other switch parameter -Resume */

/* Enables recreation for Journal Explosion User mapping. It is possible to disable recreation also by setting "0" for the same parameter​  */

Remove-ASJEUserMapping

SYNOPSIS

Removes Journal Explosion user mappings.

SYNTAX

Remove-ASJEUserMapping [-Core] <ConnectCore> -JournalExplosionUserMappingId] [<int[]>-PSJEUserMappingInfo] [<int[]> [<CommonParameters>]

DESCRIPTION

The Remove-ASJEUserMapping cmdlet removes Journal Explosion User 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. Cmdlet has one parameter; set JournalExplosionUserMappingId, consisting of array of integers. This parameter is mandatory. The user can retrieve this array by using Get-ASJEUserMapping cmdlet.

Example:

Remove-ASJEUserMapping -JournalExplosionUserMappingId 1

/* Removes specified Journal Explosion User mapping */​

Get-ASJEUserMapping -ContainerMappingId 1 -All | Remove-ASJEUserMapping | Format-Table

 

$JEUserMappings = Get-ASJEUserMapping -ContainerMappingId 1 -All

$JEUserMappings | Remove-ASJEUserMapping | Format-Table

,$JEUserMappings | Remove-ASJEUserMapping | Format-Table ​

/* Gets all Journal Explosion User mappings of specified Container mapping and removes them */​

 

/* This procedure shows how to retrieveJournal Explosion User mappings of specified Container mapping then User mappings can be removed through the pipe and with two methods:

1. Use it as is and mappings will be removed one by one in the background, or

2. Convert $JEUserMappings to array by using comma "," and mappings will be removed at once, which can be more efficient */​

Add-ASJELeaverMapping

SYNOPSIS

Adds new Journal Explosion Leaver Mapping(s).

SYNTAX

Add-ASJELeaverMapping [-Core] <ConnectCore> [[-ContainerMappingId] <int[]>] \[[-SenderRecipientId] <int[]>] [[OriginalSmtpAddress] <string[]>] [<CommonParameters>]

DESCRIPTION

The Add-ASJELeaverMapping cmdlet adds new 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:

Add-ASJELeaverMapping -ContainerMappingId 1

Add-ASJELeaverMapping -ContainerMappingId 1 -SenderRecipientId 10​ ​ OriginalSmtpAddress "email@email.com"

/* Creates Journal Explosion Leaver mappings based on JE Container Mapping */

/* Creates Journal Explosion Leaver mapping for specified sender/recipient  related to specified JE Container Mapping */

Get-ASJESenderRecipient -ContainerMappingId 2 -​​RecipientType Leaver | Add-ASJELeaverMapping

/* Retrieves only leaver sender/recipients of specified JE Container Mapping and creates Journal Explosion Leaver mappings */

​

info

NOTE: After the leaver mapping is created, the result returns property "UserMappingAssociationStatus", which indicates whether there is existing relation to user mapping (Associated/Enabled) or there is no user mapping created yet (not associated).

Get-ASJELeaverMapping

SYNOPSIS

Gets the Journal Explosion Leaver Mapping(s).

SYNTAX

Get-ASJELeaverMapping [-Core] <ConnectCore> [[-ContainerMappingId] <int[]>] [[-JournalExplosionLeaverMappingId] <int[]>] [[-All] <SwitchParameter>] [<CommonParameters>]

DESCRIPTION

The Get-ASJELeaverMapping cmdlet gets 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:

Get-ASJELeaverMapping -All -IncludeTotalCount

Get-ASJELeaverMapping -ContainerMappingId 2

Get-ASJELeaverMapping -JournalExplosionLeaverMappingId 1,2

/* Retrieves all Journal Explosion Leaver mappings and includes its total count */

/* Retrieves all Journal Explosion Leaver mappings of specified JE Container Mapping */​

/* Retrieves only Journal Explosion Leaver mappings based on JournalExplosionLeaverMappingIds*/​

$email = "email@domain.com"

Get-ASJELeaverMapping -All | Where-Object {$_.OriginalSmtpAddress -eq $email}​​

/* Retrieves only leaver mappings with specified original SMTP address */​

​​

UserMappingAssociationStatus​ property:

Not Associated  - leaver mapping exists but has no related user mapping created yet

Associated         - leaver mapping after "Enable For Import" has existing related user mapping but is not enabled for import (due to incorrect setting e.g. wrong FNP )

Enabled             -  leaver mapping after "Enable For Import" has existing related user mapping and is enabled for import.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating