Chat now with support
Chat with Support

Archive Shuttle 11.2 - 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

Stop-ASModule

SYNOPSIS

Stop module.

SYNTAX

Stop-ASModule [-Core] <ConnectCore> [-ModuleId] <Guid[]> [<CommonParameters>]

DESCRIPTION

The Stop-ASModule cmdlet stop module. After the command is executed, the module status can be checked in the Archive Shuttle user interface. All parameters in the cmdlet are 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:

​Stop-ASModule -ModuleId​ "434b9603-1ab9-e511-80e6-005056b82cc9" ​

​

​Get-ASModule -ModuleType​ DellArchiveManager | Stop-ASModule

​

Restart-ASModule

SYNOPSIS

Restart module.

SYNTAX

Restart-ASModule [-Core] <ConnectCore> [-ModuleId] <Guid[]> [<CommonParameters>]

DESCRIPTION

The Restart-ASModule cmdlet restart module. After the command is executed, the module status can be checked in the Archive Shuttle user interface. All parameters in the cmdlet are 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:

Restart-ASModule -ModuleId​ "434b9603-1ab9-e511-80e6-005056b82cc9" ​

​

Get-ASModule -ModuleType​ DellArchiveManager | Restart-ASModule

​​/* Retrieves specified module and restarts it (it can have small delay) */

Start-ASCommand

SYNOPSIS

Start command immediately.

SYNTAX

Start-ASCommand [-Core] <ConnectCore> [-Command] <CommandEnum[]> [<CommonParameters>]

DESCRIPTION

The Start-ASCommand cmdlet starts command immediately. After the command is executed, the result can be checked in the Archive Shuttle user interface/logs. 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:

​Start-ASCommand -Command Office365CollectLicenses

​/* Command to collect Office 365 licenses is set to be executed */

Get-ASCommandQueueStatus

SYNOPSIS

Returns status of command.

SYNTAX

Get-ASCommandQueueStatus -Core <ConnectCore> [[-CommandId] <int>] [[-ModuleId] <Guid[]>] [<CommonParameters>]

DESCRIPTION

The Get-ASCommandQueueStatus returns command queue status. 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-ASCommandQueueStatus

​/* Retrieves statuses of all commands within CommandQueue table */

​​Get-ASCommandQueueStatus -CommandId 801

​​/* Retrieves status of specified command */

​Get-ASCommandQueueStatus -ModuleId b305cf97-f93d-e611-813c-005056b84ed8 -CommandId 801

​​​/* Retrieves status of specified command related to specified module */

​Get-ASCommandQueueStatus | Where-Object {$_.TaskExecutionStatusId -eq "Success"}

​​​​/* Retrieves only successfully processed commands */

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating