Chat now with support
Chat mit 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

Get-ASStage1Statistics

SYNOPSIS

Show Stage 1 statistics.

SYNTAX

Get-ASStage1Statistics -Core] <ConnectCore>] [[-ContainerMappingId] <int[]>] [[-IncludeVirtualJournalSubmappings] [<SwitchParameter> -All] <SwitchParameter>] [[-JournalExplosion] [<SwitchParameter> [[-Skip] <uint64>] [[-First] <uint64>] [<CommonParameters>]

DESCRIPTION

The Get-ASStage1Statistics cmdlet gets Stage 1 statistics for specified container mappings. Result contains: Container Mapping Id, Source Full Name, IsJournalExplosion, Routed Count, Exported Items Count, Exported Items Percentage, Imported Items Count, Exploded Routings Count *, EnabledForJournalExplosionImport* (* - significant only for JE), Imported Items Percentage and VirtualJournalMasterMappingId. By default, all container mapping statistics are returned after the command executes. When using the JournalExplosion parameter, only JournalExplosion mapping statistics are returned. The core parameter 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-ASStage1Statistics

Get-ASStage1Statistics -ContainerMappingId 1,2,3

Get-ASStage1Statistics -ContainerMappingId "EnterID"

Result:

ContainerMappingId  

SourceFullName        

RoutedCount            

ExportStatistics.ProcessedItems

ExportStatistics.ErrorsCount

ExportStatistics.Percentage

ImportStatistics.ProcessedItems

ImportStatistics.ErrorsCount

ImportStatistics.Percentage

----------------------

----------------------

----------------------

----------------------

----------------------

----------------------

----------------------

----------------------

----------------------

1

Archive1

33

32

1

96%

32

0

96%

 

​

​Get-ASStage1Statistics | fl

Result:        

​

ContainerMappingId                : 1

SourceFullName                       : peho-ms-o365-016

SourceGroup                            :

RoutedCount                            : 1000

ExportStatistics                     : ArchiveShuttle.Common.Resources.PowerShell.Commands.MigrationStatistics

ImportStatistics                   : ArchiveShuttle.Common.Resources.PowerShell.Commands.MigrationStatistics

Priority                                     : 10

MigrationEnabled                    : True

ItemGatheringEnabled            : True

Stage2Enabled                        : True

Stage2Finished                        : 1

IsJournalExplosion                   : False

ExplodedRoutingsCount                  :

EnabledForJournalExplosionImport       :

VirtualJournalMasterContainerMappingId :

SourceTag                                : {tag1, tag2, tag3, tag5}

TargetTag                                 : {tag5, tag7}

 

Get-ASStage1Statistics -ContainerMappingId 1 | Select-Object -ExpandProperty ExportStatistics

Result:

ProcessedItems                  RetryableErrorsCount            PermanentErrorsCount            ErrorsCount              Percentage                    SizeOriginal (B)        SizeComplressed (B)                    --------------                            --------------------                           --------------------                       -----------                     ----------                       ------------------           ---------------------

            33                                              1                                                    0                                          0                                96

​Use command with parameter to expand property ExportStatistics or ImportStatistics (only one property can be expanded at the time)

 

​ ​Commands can be used together with Select/Where clause. Examples below describe how to use it in case of expanded properties where exact property names are required (e.g. ImportStatistics.Percentage):

Get-ASStage1Statistics | Where-Object {$_.ImportStatistics.Percentage -eq 100}

 

Get-ASStage1Statistics |Where-Object {$_.ImportStatistics.Percentage -le 99} | Select-Object -ExpandProperty ImportStatistics

Get-ASStage1Statistics | Where-Object {$_.ExportStatistics.ErrorsCount -eq $_.ImportStatistics.ErrorsCount}

Get-ASStage1Statistics | Where-Object {$_.ExportStatistics.ProcessedItems -eq $_.ImportStatistics.ProcessedItems}

/* Retrieves only mappings where import progress = 100% */

/* Retrieves only mappings where import progress is less or equal 99% + expand details of these statistics */

/* Retrieves only mappings where export and import statistic values are equal */

​Get-ASStage1Statistics -JournalExplosion

/* Retrieves only journal explosion mappings

Journal Explosion has dedicated command to retrieve more statistics: Get-ASJEStage1Statistics

*/​

Get-ASStage1Statistics-IncludeVirtualJournalSubmappings

Get-ASStage1Statistics-IncludeVirtualJournalSubmappings|Where-Object {$_.VirtualJournalMasterContainerMappingId -ne$null }

/* Retrieves stats also for submappings of virtual journal master mappings */​

/* Retrieves stats only for submappings of specified virtual journal master mappings */​​

Get-ASStage2Status

SYNOPSIS

Shows Stage 2 information.

SYNTAX

Get-ASStage2Status [[-Core] <ConnectCore>] [[-ContainerMappingId] <int[]>] [[-All] <int[]>] [[-Skip] <uint64>] [[-First] <uint64>] [<CommonParameters>]

DESCRIPTION

The Get-ASStage2Status cmdlet gets information about Stage 2 for specified container mappings. Result contains: Container Mapping Id, Source Container, Target Container, Current Command Name, Current Command Status, Current Command Error, isFinished and VirtualJournalMasterMappingId. By default, all container mapping Stage 2 information is returned after the command executes. The core parameter 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-ASStage2Status

Get-ASStage2Status -All -IncludeTotalCount

Get-ASStage2Status -ContainerMappingId 1,2,3

Get-ASStage2Status -ContainerMappingId 1

Result:

ContainerMappingId

SourceContainer

TargetContainer

CurrentCommandName

CurrentCommandStatus

CurrentCommandError

Finished

------------------

--------------

---------------

------------------

--------------------

-------------------

--------

1

sourceuser1

targetuser1

WaitForImportFinished

Queued

FALSE

 

​

Get-ASStage2Status -ContainerMappingId 1 | fl

Result:

 

ContainerMappingId              : 1

SourceContainerName          : peho-ms-o365-016

SourceTag                              : {tag1, tag2, tag3, tag5}

TargetContainerName           : peho-ms-o365-016

TargetTag                               : {tag5, tag7}

WorkflowState                       : Enabled

CurrentCommandName        : NativeImportRename

CurrentCommandId               : 1203

CurrentCommandStatus         : Success

CurrentCommandError           :

CurrentCommandLastUpdateDateUtc        : 10.08.2020 13:20:18

CurrentWorkflowRetryFailedAfterMinutes : 60

CurrentWorkflowRetryFailed  : True

NextCommandName             :

NextCommandId                    :

IsFinished                      ​​          : True

VirtualJournalMasterContainerMappingId :

 

​

​Get-ASStage2Status | Where-Object {$_.VirtualJournalMasterContainerMappingId -ne $null }

/* Retrieves only submappings of virtual journal master mappings */​

Get-ASWorkflowPolicy

SYNOPSIS

Gets list of available Workflow Policies.

SYNTAX

Get-ASWorkflowPolicy [[-Core] <ConnectCore>] [[-Name] <string[]>] [[-WorkflowPolicyId] <int[]>] [[-Skip] <uint64>] [[-First] <uint64>] [<CommonParameters>]

DESCRIPTION

The Get-ASWorkflowPolicy cmdlet gets a list of available Workflow Policies. The Workflow Policy can be used as an input parameter for the Add-ASContainerMapping command. The core parameter 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-ASWorkflowPolicy -IncludeTotalCount

Get-ASWorkflowPolicy -Name "EnterpriseVault to Office 365 Leavers" | fl

Get-ASFilterPolicy?

SYNOPSIS

Show list of available Filter Policies.

SYNTAX

Get-ASFilterPolicy [[-Core] <ConnectCore>] [[-Name] <string>] [[-FilterPolicyId] <int[]>] [[-Skip] <uint64>] [[-First] <uint64>] [<CommonParameters>]

DESCRIPTION

The Get-ASFilterPolicy cmdlet gets a list of available Filter Policies. The Filter Policy can be used as an input parameter for the Add-ASContainerMapping command. The core parameter 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-ASFilterPolicy -IncludeTotalCount

Get-ASFilterPolicy -Name "Default (No Filter)"

Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen