Chatee ahora con Soporte
Chat con el soporte

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

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 PowerShell module

oMinimum: v3.0.0

oRecommended: v3.2.0

oSupport up to: v3.5.1

info

NOTE: PowerShell compliance commands still need to use Global Admin credentials to connect to Exchange Online. Microsoft does not support AccessToken parameter for the Connect-IPPSSession command. PowerShell compliance is used to get a list of compliance tags.

 

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”

 

info

NOTE: PowerShell should be launched as an administrator.

 

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:

Get-Module -ListAvailable

/* list of all installed PS modules – should contain Archive Shuttle PowerShell version. 1.0 */​

Get-Command -Module ArchiveShuttle.PowerShell

​/* list of all public Archive Shuttle commands for PowerShell*/

Get-Command -Module ArchiveShuttle.PowerShell*|Sort-Object ModuleName,Name

/* list of all Archive Shuttle commands (public and extended) for PowerShell*/

Public commands table

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

Name

PowerShell specific

(N/A in UI)

Created in (version)

Updated in (version)

Add-ASContainer

X

7.7

9.7

Add-ASContainerMapping

 

<= 7.0

10.5

Add-ASContainerToTag

 

7.7

9.7

Add-ASContainerToUser

 

10.5

 

Add-ASEnvironment

 

<= 7.0

9.7

Add-ASEVRetentionCategoryMapping

 

8.3

9.8

Add-ASFileNamePolicy

 

8.3

 

Add-ASFilterCondition

 

7.9

 

Add-ASFilterPolicy

 

7.9

 

Add-ASFolderNamePolicy

 

8.4

 

Add-ASGroup

 

7.5

7.7

Add-ASItemDatabase

 

<= 7.0

9.0

Add-ASJEADUserRule

 

9.4

9.7

Add-ASJEDistributionListRule

 

10.1

 

Add-ASJEEmailAddressRule

 

9.4

9.7

Add-ASJELeaverMapping

 

9.4

10.0

Add-ASJEUserGroup

 

8.4

9.7

Add-ASJEUserMapping

 

8.4

10.0

Add-ASLink

 

<= 7.0

10.1

Add-ASMappingConfigurationTemplate

 

9.3

 

Add-ASModulePool

 

N/A

 

Add-ASModuleToModulePool

 

N/A

 

Add-ASO365LeaversConfiguration

 

8.3

10.6

Add-ASPstSourcePath

 

<= 7.0

 

Add-ASSettingDefinitionToSchedule

Removed

8.3

9.1

Add-ASSettingSchedule

 

8.3

9.1

Add-ASTag

 

7.7

 

Add-ASTargetPathNamePolicy

 

10.2

 

Add-ASUserToGroup

 

7.5

7.6

Add-ASWorkflowPolicy

 

7.9

10.5

Add-ASWorkflowPolicyStep

 

7.10

9.0

Connect-ASCore

X

6.7

7.7

Copy-ASJEAutoCreationRules

 

9.4

10.1

Disable-ASActiveDirectorySync

 

<= 7.0

 

Disable-ASArchiveGathering

 

<= 7.0

 

Disable-ASCollection

 

<= 7.0

 

Disable-ASMigration

 

<= 7.0

 

Disable-ASModule

 

<= 7.0

 

Enable-ASActiveDirectorySync

 

<= 7.0

 

Enable-ASArchiveGathering

 

<= 7.0

 

Enable-ASCollection

 

<= 7.0

 

Enable-ASMigration

 

<= 7.0

 

Enable-ASModule

 

<= 7.0

 

Enable-ASStage2

 

<= 7.0

8.2

Get-AdamContainer

 

7.7

 

Get-ASADDomain

 

7.7

 

Get-ASADGroup

 

7.7

 

Get-ASADGroupMember

 

7.7

 

Get-ASArchive

 

10.1

 

Get-ASBulkMappingWizardTemplate

 

10.6

 

Get-ASCommandQueueStatus

X

7.7

 

Get-ASConfiguration

X

<= 7.0

9.1

Get-ASContainers

 

<= 7.0

9.7

Get-ASCoreVersion

 

8.0

 

Get-ASEnvironment

 

7.8

9.7

Get-ASEVRetentionCategoryMapping

 

8.3

 

Get-ASExchangeDatabase

 

7.7

 

Get-ASExchangeServer

 

7.7

 

Get-ASFailedItemThreshold

 

7.7

 

Get-ASFileNamePolicy

 

8.3

 

Get-ASFilterPolicy

 

<= 7.0

7.2

Get-ASFolderNamePolicy

 

8.4

 

Get-ASGroup

 

7.5

7.7

Get-ASHealthStatus

 

10.5

 

Get-ASJEADUserRule

 

9.4

10.1

Get-ASJEDistributionListRule

 

10.1

 

Get-ASJEEmailAddressRule

 

9.4

10.1

Get-ASJELeaverMapping

 

9.4

9.7

Get-ASJELeaversStatus

 

9.6

 

Get-ASMailboxQuotaStatus

 

10.7

 

Get-ASJEMailboxQuotaStatus

 

9.5

10.7 (removed)

Get-ASJESenderRecipient

 

8.4

10.0

Get-ASJEStage1Statistics

 

8.4

 

Get-ASJEUserGroup

 

8.4

9.7

Get-ASJEUserMapping

 

8.4

9.3

Get-ASLicense

 

10.1

 

Get-ASLink

 

<= 7.0

9.7

Get-ASLinkHealth

 

7.7

9.7

Get-ASLinkModule

 

<= 7.0

 

Get-ASMailbox

 

7.7

10.1

Get-ASMappingConfigurationTemplate

 

9.3

 

Get-ASMappings

 

<= 7.0

10.0

Get-ASModule

 

<= 7.0

9.9

Get-ASModuleCredential

 

10.7

 

Get-ASModulePerformance

 

7.9

7.10

Get-ASModulePool

 

N/A

 

Get-ASO365LeaversConfiguration

 

8.3

9.4

Get-ASO365License

 

8.3

 

Get-ASPremigrationStatus

 

10.7

 

Get-ASProgressStatistics

 

10.1

 

Get-ASRetentionCategory

 

7.9

7.10

Get-ASScheduledTask

X

10.1

 

Get-ASSettingSchedule

 

8.3

9.1

Get-ASStage1Statistics

 

<= 7.0

10.0

Get-ASStage2Status

 

<= 7.0

10.0

Get-ASTag

 

7.7

 

Get-ASTargetPathNamePolicy

 

10.2

 

Get-ASUser

 

7.7

9.7

Get-ASUserSyncStatus

X

7.5

 

Get-ASVaultStore

 

<= 7.0

 

Get-ASWatermark

 

7.7

8.1

Get-ASWorkflowPolicy

 

<= 7.0

7.2

Get-ASWorkflowPolicyStep

 

7.10

8.2

Recreate-ASMapiProfile

 

9.8

 

Remove-ASContainerMapping

 

7.10

8.0

Remove-ASJEADUserRule

 

9.4

10.1

Remove-ASJEDistributionListRule

 

10.1

 

Remove-ASJEEmailAddressRule

 

9.4

10.1

Remove-ASJELeaverMapping

 

9.4

9.7

Remove-ASJEUserMapping

 

8.4

9.7

Remove-ASLinkDatabase

X

<= 7.0

9.0

Remove-ASMappingConfigurationTemplate

 

9.3

 

Remove-ASModuleFromModulePool

 

N/A

 

Remove-ASModulePool

 

N/A

 

Remove-ASPstSourcePath

 

<= 7.0

 

Restart-ASModule

 

7.8

 

Set-ASCommandIntervalLastExecutedDate

X

7.7

 

Set-ASConfiguration

O

<= 7.0

9.7

Set-ASContainer

 

10.4

 

Set-ASContainerMapping

 

7.8

10.5

Set-ASEnvironment

 

<= 7.0

9.7

Set-ASFailedItemThreshold

 

7.7

 

Set-ASFileNamePolicy

 

8.3

 

Set-ASFolderNamePolicy

 

8.4

 

Set-ASGroup

 

7.5

7.7

Set-ASJEDistributionListRule

 

10.1

 

Set-ASJEEmailAddressRule

 

9.4

10.1

Set-ASJELeaverMapping

 

9.4

9.7

Set-ASJELeaversStatus

 

9.6

9.9

Set-ASJEUserGroup

 

8.4

9.7

Set-ASJEUserMapping

 

8.4

9.7

Set-ASLinkModule

 

<= 7.0

7.8

Set-ASMappingConfigurationTemplate

 

9.3

 

Set-ASModule

 

<= 7.0

9.7

Set-ASModuleCredential

 

10.7

 

Set-ASModuleLogLevel

 

<= 7.0

 

Set-ASModulePool

 

N/A

 

Set-ASO365LeaversConfiguration

 

8.3

10.6

Set-ASPremigrationAction

 

10.5

 

Set-ASPstSourcePath

 

<= 7.0

 

Set-ASPstTargetPath

 

<= 7.0

 

Set-ASPstTemporaryPath

 

9.8

 

Set-ASScheduledTask

X

10.1

 

Set-ASSettingSchedule

 

8.3

 

Set-ASStage2Status​

 

9.9

 

Set-ASStagingAreaPath

 

<= 7.0

 

Set-ASTag

 

7.7

 

Set-ASTargetPathNamePolicy

 

10.2

 

Set-ASWatermark

 

7.7

8.1

Set-ASWorkflowPolicy

 

7.9

7.10

Set-ASWorkflowPolicyStep

 

7.10

9.0

Start-ASADSyncSingleUser

X

7.5

 

Start-ASArchiveGathering

 

<= 7.0

 

Start-ASCommand

X

<= 7.0

 

Start-ASModule

 

<= 7.0

9.7

Start-ASO365SyncMailboxes

 

<= 7.0

 

Start-ASO365SyncSingleUser

X

7.5

 

Start-ASRetryFailedItems

 

7.8

 

Start-ASScheduledTask

Removed

<= 7.0

10.1

Start-ASStagingAreaCleanup

 

9.2

 

Start-ASSyncADDomains

 

<= 7.0

 

Start-ASSyncADUsers

 

<= 7.0

 

Stop-ASModule

 

<= 7.0

 

Update-ASMailboxSizeAndQuota

 

10.7

 

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

Herramientas de autoservicio
Base de conocimientos
Notificaciones y alertas
Soporte de productos
Descargas de software
Documentación técnica
Foros de usuarios
Tutoriales en video
Aviso de actualizaciones de páginas web (RSS)
Comuníquese con nosotros
Obtenga asistencia con las licencias
Soporte Técnico
Ver todos
Documentos relacionados

The document was helpful.

Seleccionar calificación

I easily found the information I needed.

Seleccionar calificación