Chat now with support
Chat with Support

Archive Shuttle 11.3 - 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-ASModulePerformance

SYNOPSIS

Gets list of module performance records.

SYNTAX

Get-ASModulePerformance [-Core] <ConnectCore> [[-ModuleId] <Guid[]>] [[-FromTimeStamp] <DateTime>] [<CommonParameters>]

DESCRIPTION

The Get-ASModulePerformance cmdlet gets a list of modules statistics. If FromTimeStamp parameter is not specified not set it will return latest record of module performance. 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-ASModulePerformance -ModuleId a5eb1281-de91-e611-8147-005056b84ed8 -FromTimeStamp "2016-10-24 09:00:00"

​/* Retrieves module performance records of specified module (time range: from specified UTC datetime to the latest record) */

Get-ASModulePerformance -ModuleId a5eb1281-de91-e611-8147-005056b84ed8

​​/* Retrieves latest module performance record of specified module */

Get-ASModule -ModuleType Office365Import | Get-ASModulePerformance | Select-Object -Property ModuleId, ServerCPU*

​​​/* Retrieves latest performance records of all O365 modules with filtered view of specified properties only */

info

NOTE: Since Archive Shuttle 7.10, the "-LatestRecord" parameter is not supported anymore. It is automatically applied unless "-FromTimeStamp" parameter is defined.

Enable-ASModule

SYNOPSIS

Enable module.

SYNTAX

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

DESCRIPTION

The Enable-ASModule cmdlet enables 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:

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

​

Get-ASModule -ModuleType​ DellArchiveManager | Enable-ASModule

​

Disable-ASModule

SYNOPSIS

Disable module.

SYNTAX

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

DESCRIPTION

The Disable-ASModule cmdlet disables 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:

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

​

Get-ASModule -ModuleType​ DellArchiveManager | Disable-ASModule

​

Start-ASModule

SYNOPSIS

Start module.

SYNTAX

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

DESCRIPTION

The Start-ASModule cmdlet start 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:

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

​

Get-ASModule -ModuleType​ DellArchiveManager | Start-ASModule

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

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating