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

Set-ASStage2Status

SYNOPSIS

Set the status for container mapping in stage 2.

SYNTAX

Set-ASStage2Status [-Core] <ConnectCore> [-ContainerMappingId] <int[]> [-Action] <Stage2Action> [[-WorkflowPolicyId] <int>] [[-WorkflowPolicyName] <string>] [<CommonParameters>]​

DESCRIPTION

The Set-ASStage2Action will run the chosen stage 2 action. 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-ASStage2Status -ContainerMappingId '2' -Action ChangePolicy -WorkflowPolicyId 145

Set-ASStage2Status -ContainerMappingId '2' -Action Retry

Set-ASPremigrationAction

SYNOPSIS

Set the status for container mapping in pre-migration.

SYNTAX

Set-ASPremigrationAction [-Core] <ConnectCore> [-ContainerMappingId] <int[]> [-Action] <Stage2Action> [[-WorkflowPolicyId] <int>] [[-WorkflowPolicyName] <string>] [<CommonParameters>]

DESCRIPTION

The Set-ASPremigrationAction will run choosen premigration action. 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-ASPremigrationAction -ContainerMappingId 3 -Action ChangePolicy -WorkflowPolicyId 107

/* Will change pre-migration workflow policy for specified ContainerMappingId */

Set-ASPremigrationAction -ContainerMappingId 3 -Action Pause

/* Will pause pre-migration workflow policy */

Get-ASHealthStatus

SYNOPSIS

Get the health status (UI/WS/DB/License) of Archive Shuttle/MM.

SYNTAX

Get-ASHealthStatus [-Core] <ConnectCore> [[-UIStatus] <SwitchParameter>] [[-WSStatus] <SwitchParameter>] [[-DBStatus] <SwitchParameter>] [[-IncludeItemDbs] <SwitchParameter>] [[-LicenseStatus] <SwitchParameter>] [<CommonParameters>]

DESCRIPTION

The Get-ASHealthStatus will return the AS/MM health status for UI/WS/DB/License. You can specify core as a parameter, or call Connect-ASCore once and the core parameter will be automatically added from the session state. Output is in the form of objects that can be further parsed in the pipeline. The user can use command ConvertToJson to unpack the object to a .json format. In the output, there is also Boolean object with name "IsHealthy" that is set to true when no errors/exceptions occur during the check, and also object errors where the found errors are stored and shown when some exceptions occur.

Example:

Get-ASHealthStatus

Get-ASHealthStatus | ConvertTo-Json -Depth 6

/* Retrieve all parameters */

/* Retrieve all parameters unpacked*/

Get-ASModuleCredential

SYNOPSIS

Gets module credentials.

SYNTAX

Get-ASModuleCredential [-Core] <ConnectCore> [-CredentialType] <CredentialType> [[-Name] <string>] [[-ModuleId] <Guid>] <CommonParameters>]

DESCRIPTION

The Get-ASModuleCredential cmdlet gets module credential.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-ASModuleCredential -CredentialType Office365

Get-ASModuleCredential -CredentialType Exchange | Out-File 'c:\check.txt'

/* Retrieve all credentials (type Office 365) */

/* Retrieve all credentials (type Exchange) and saves it into a .txt file*/

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating