Archive Shuttle 11.3 - PowerShell Guide

Archive Shuttle and PowerShell

The PowerShell module allows you to manage Archive Shuttle migrations using a command line interface approach. Using PowerShell means that much of the administration work can be configured to be executed remotely, and it can be part of other scripted solutions (such as AD user migration, or Exchange Mailbox migration).

PowerShell module requirements

Before installing the PowerShell Module the following requirements need to be met:

·.Net Framework 4.0

·Exchange Online v3.2.0 PowerShell module

Connecting to Archive Shuttle Core

To issue any commands via PowerShell, the first step is to connect to the Archive Shuttle Core. This can be done as follows:

$Core = Connect-ASCore –ComputerName “Name of Server” –Credential “some domain\user”

You will then be prompted for the password for the account.

The $Core variable can then be used for additional commands, as shown in the example in the next section.

To connect to a Cloud Core, use:

$Core = Connect-ASCore –ComputerName cloudtenantname.archiveshuttle.com -AuthenticationType Basic -UseHTTPS –Credential “cloud account”

Performing a Command

Once a connection has been made to the Archive Shuttle Core, commands can be executed. For example, a list of current mappings can be shown as follows:

Get-ASMappings –Core $Core

PowerShell paging functionality

The standard PowerShell paging functionality commands can be used with the Archive Shuttle cmdlets. For example:

Get-ASContainers -Core $core -first 10 -skip 0

Get Archive Shuttle commands

Begin by running PowerShell as an Administrator on your virtual machine. The following PowerShell commands can be performed:

Public commands table

This table contains list of all PowerShell commands with version where command was created or updated.

Available commands sorted to groups

Core

·Connect-ASCore

·Connect to core in AS.CLOUD

Configuration

·Get-ASConfiguration

·Set-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-ASFilterCondition

·Add-ASFilterPolicy

·Get-ASFileNamePolicy

·Set-ASFileNamePolicy

·Add-ASFileNamePolicy

·Get-ASTargetPathNamePolicy

·Set-ASTargetPathNamePolicy

·Add-ASTargetPathNamePolicy

·Get-ASO365License

·Add-ASO365LeaversConfiguration

·Set-ASO365LeaversConfiguration

·Get-ASO365LeaversConfiguration

Module

·Get-ASModule

·Get-ASModuleCredential

·Set-ASModule

·Set-ASModuleCredential

·Set-ASModuleLogLevel

·Get-ASModulePerformance

·Enable-ASModule

·Disable-ASModule

·Start-ASModule

·Stop-ASModule

·Restart-ASModule

Command

·Start-ASCommand

·Get-ASCommandQueueStatus

·Set-ASCommandIntervalLastExecutedDate

·Recreate-ASMapiProfile

Scheduled Task

·Get-ASScheduledTask

·Set-ASScheduledTask

Active Directory

·Enable-ASActiveDirectorySync

·Disable-ASActiveDirectorySync

·Get-ASADGroup

·Get-ASADGroupMember

Domain

·Get-ASADDomain

·Start-ASSyncADDomains

Exchange

·Get-ASExchangeServer

·Get-ASExchangeDatabase

Environment

·Add-ASEnvironment

·Set-ASEnvironment

·Get-ASEnvironment

Vault Store

·Get-ASVaultStore

Archive Gathering

·Enable-ASArchiveGathering

·Disable-ASArchiveGathering

·Start-ASArchiveGathering

License

·Get-ASLicense

Link

·Add-ASLink

·Get-ASLink

·Get-ASLinkHealth

·Get-ASLinkModule

·Set-ASLinkModule

·Remove-ASLinkDatabase

·Add-ASItemDatabase

Staging Area

·Set-ASStagingAreaPath

·Start-ASStagingAreaCleanup

Performance

·​Get-ProgressStatistics​

·Get-ASHealthStatus

PST

·Add-ASPstSourcePath

·Remove-ASPstSourcePath

·Set-ASPstSourcePath

·Set-ASPstTargetPath

·​Set-ASPstTemporary​Path

User & Container & Mailbox

·Add-ASContainer

·Add-ASContainerToUser

·Get-ASArchive

·Get-ASUser

·Get-ASContainers

·Get-AdamContainer

·Get-ASMailbox​

·Get-ASUserSyncStatus

·Get-ASMailboxQuotaStatus

·Update-ASMailboxSizeAndQuota

·Set-ASContainer

·Start-ASSyncADUsers

·Start-ASO365SyncMailboxes

·Start-ASADSyncSingleUser

·Start-ASO365SyncSingleUser

Mapping

·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

·Set-ASStage2Status​

·Set-ASPremigrationAction

Journal Explosion

·Add-ASJEUserGroup

·Get-ASJEUserGroup

·Set-ASJEUserGroup

·Add-ASFolderNamePolicy

·Set-ASFolderNamePolicy

·Get-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

·Set-ASJEADUserRule

·Remove-ASJEADUserRule

·Add-ASJEDistributionListRule

·Get-ASJEDistributionListRule

·Remove-ASJEDistributionListRule

·Set-ASJEDistributionListRule​

·Copy-ASJECreationRules

·Get-ASJELeaversStatus

·Set-ASJELeaversStatus

Groups & Tags

·Add-ASGroup

·Set-ASGroup

·Get-ASGroup

·Add-ASUserToGroup

·Add-ASTag

·Set-ASTag

·Get-ASTag

·Add-ASContainerToTag