Chat now with support
Chat with Support

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

Disable-ASArchiveGathering

SYNOPSIS

Disables archive gathering.

SYNTAX

Disable-ASArchiveGathering [-Core] <ConnectCore> [[-LinkId] <GUID>] [[-VaultStoreId] <string>] [<CommonParameters>]

DESCRIPTION

The Disable-ASArchiveGathering cmdlet disables archive gathering. After the command is executed, the result 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:

Get-ASLink -LinkName​ "VS1" | Get-ASVaultStore | Disable-ASArchiveGathering

​/* Disables archive gathering for specified Enterprise Vault Vault Store through link name */

​Disable-ASArchiveGathering -LinkId​ "434b9603-1ab9-e511-80e6-005056b82cc9"

Disable-ASArchiveGathering -VaulStoreId​ "13851C140C2F8184F993AF0C26BDA3C6C1210000ev10-site"

​

$evlink = Get-ASLink -Type EnterpriseVault |Where-Object {$_.LinkName -like "*VS1*"}|Get-ASVaultStore

Disable-ASArchiveGathering -VaultStoreId $evlink.VaultStoreId

​​/* First Enterprise Vault Vault Store is searched through Link name then archive gathering disabled

info

NOTE: Currently, only Enterprise Vault is supported (7.7).

Start-ASArchiveGathering

SYNOPSIS

Start archive gathering.

SYNTAX

Start-ASArchiveGathering [-Core] <ConnectCore> [[-LinkId] <Guid[]>] [[-VaultStoreId] <string[]>] [<CommonParameters>]

DESCRIPTION

The Start-ASArchiveGathering cmdlet starts archive gathering. After the command is executed, the result 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:

​Get-ASLink -LinkName​ "VS1" | Get-ASVaultStore | Start-ASArchiveGathering

​/* Starts archive gathering for specified Enterprise Vault Vault Store through link name */​

​Start-ASArchiveGathering -LinkId​ "434b9603-1ab9-e511-80e6-005056b82cc9"

Start-ASArchiveGathering -VaulStoreId​ "13851C140C2F8184F993AF0C26BDA3C6C1210000ev10-site"

​

​$evlink = Get-ASLink -Type EnterpriseVault |Where-Object {$_.LinkName -like "*VS1*"}|Get-ASVaultStore

Start-ASArchiveGathering -VaultStoreId $evlink.VaultStoreId

​​​/* First Enterprise Vault Vault Store is searched through Link name, then archive gathering starts.

info

NOTE: Currently, only Enterprise Vault and EAS is supported (7.7).

Get-ASLicense

SYNOPSIS

Get information about licenses.

SYNTAX

Get-ASLicense [-Core] <ConnectCore> [<CommonParameters>]

DESCRIPTION

The Get-ASLicense will return info about licenses. 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-ASLicense

​/* Returns all information of Archive Shuttle license(s)

Add-ASLink

SYNOPSIS

Creates a new link.

SYNTAX

Add-ASLink [-Core] <ConnectCore> [-EnvironmentType] <ContainerTypeLinkEnum> [-LinkName] <string> [-LinkPath] <string> [-CustomerName] <string> [-NumberOfWorkers] <int> [-BatchSizeMb] <int> [-Format] <MailNativeFormatEnum> [-DefaultRolloverBytes] <long?>

[-DefaultRolloverItemCount <int?>] [-OutputPath] <string> [-LowWatermark <long?>] [-HighWatermark <long?>] [-FileNamePolicyId <int?>] -StorageType <StorageType> -Path <string> -AmazonS3Account <string> -AzureBlobStorage <string> [<CommonParameters>]​

DESCRIPTION

The Add-ASLink cmdlet creates a new link. For link type=PST, PST Output path watermarks can be specified. After the command is executed the link can be checked in the Archive Shuttle user interface. You can specify core as a parameter, or call Connect-ASCore once and the core parameter will be automatically added from the session state.

Common Parameters: EnvironmentType, LinkName. Other parameters depends on environment type.

·For type ProofPoint: LinkPath, CustomerName, NumberOfWorkers, BatchSizeMb.

·For type PST or PSTJournalExplosion: DefaultRolloverBytes, DefaultRolloverItemCount, OutputPath, LowWatermark, HighWatermark.

·For type PSTJournalExplosion: FileNamePolicyId

info

NOTE: Some parameters are dynamically added/removed (based on EnvironmentType)

Example:

Add-ASLink -EnvironmentType Office365 -LinkName "O365"

​/* Creates new Office 365 link */

Add-ASLink -EnvironmentType PST -Format PST -LinkName "PST as TARGET" -OutputPath \\UNCOutputPath-LowWatermark 21474836480 -HighWatermark 21474836480

​/* Creates PST Target link with PST Output path and its watermarks specified */

 

​​Add-ASLink -EnvironmentType Office365 -LinkName "O365"

​/* Creates new Office 365 link */

​Add-ASLink -EnvironmentType PST -Format PST -LinkName "PST as TARGET" -OutputPath \\UNCOutputPath-LowWatermark 21474836480 -HighWatermark 21474836480

​​/* Creates PST Target link with PST Output path and it's watermarks specified */

​Add-ASLink -EnvironmentType StorageImport -LinkName "Storage-Amazon" -StorageType AmazonS3 -AmazonS3Account AmazonS3Account -Path "NewBucketUser01\Folder01"​

​/* Creates Amazon Storage Import link */

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating