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

Remove-ASLinkDatabase

SYNOPSIS

Remove Archive Shuttle link databases.

SYNTAX

Remove-ASDatabase [-Core] <ConnectCore> [-LinkId] <Guid[]> [-LinkName] <string[]> [-DeleteAll] <SwitchParameter> [[-DeleteHistoryDB] <SwitchParameter>] [<CommonParameters>]​

DESCRIPTION

The Remove-ASLinkDatabase cmdlet remove AS link databases. 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:

Remove-ASLinkDatabase -LinkName "LinkName01"

​​/* Removes link database of specified link */

​Remove-ASLinkDatabase -LinkName "LinkName01"  -DeleteHistoryDB

/* Removes link databases of specified link (including history database if exists) */​

​Remove-ASLinkDatabase -DeleteAll

​/* Removes all link databases at related Archive Shuttle Database Instance */

Add-ASItemDatabase

SYNOPSIS

Creates item database.

SYNTAX

Add-ASItemDatabase [-Core] <ConnectCore> -SqlServerName] [<string> [-LinkId] [<string>] [-LinkName] [<string>] [<CommonParameters>]

DESCRIPTION

The Add-ASItemDatabase cmdlet creates item database for link(s). Link names or linkIds can be used. 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:

$evlink = Get-ASLink -Type EnterpriseVault | Where-Object {$_.LinkName -eq "*LinkName01*"}

Add-ASItemDatabase -SqlServerName "172.0.0.0\INSTANCE1" -LinkId $evlink.LinkId

​

Set-ASStagingAreaPath

SYNOPSIS

Sets staging area.

SYNTAX

Set-ASStagingAreaPath [-Core] <ConnectCore> -Path] <string>] [[-Default] [<SwitchParameter>-LinkId] <Guid[]>] [[-Azure] [<SwitchParameter> [<CommonParameters>]

DESCRIPTION

The Set-ASStagingAreaPath cmdlet sets staging area. After the command is executed, the result 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.

Example:

​Set-ASStagingAreaPath -LinkId "d2f8f070-263c-e611-813b-005056b84ed8" -Path "\\UNCPath"

Set-ASStagingAreaPath -Path "\\UNCPath" -Default

Get-ASLink -LinkName "LinkName1"| Set-ASStagingAreaPath -Path "\\UNCPath"

​

​$evlink = Get-ASLink -Type EnterpriseVault |Where-Object {$_.LinkName -eq "LinkName1"}

Set-ASStagingAreaPath -Path "\\UNCPath" -LinkId $evlink.LinkID -Default

​

Start-ASStagingAreaCleanup

SYNOPSIS

Starts staging area cleanup for inserted LinkIds/ContainerMappingIds.

SYNTAX

Start-A​​​SStagingAreaCleanup [-Core] <ConnectCore> [-ContainerMappingIds] <int[]> [-LinkIds] <Guid[]> [-ItemAge] <ItemAgeEnum> [-IncludeDeletedMappings] <SwitchParameter> -SkipValidation] [<SwitchParameter> [<CommonParameters>]​​

DESCRIPTION

The Start-ASStagingAreaCleanup cmdlet starts staging area cleanup based on inserted parameters. There is option to start cleanup based on ContainerMappingIds or LinkIds. Parameter ItemAge defines items with certain age which will be taken into account for deletion. This parameter is also related to System Configuration setting ClearStagingAreaFilesOlderThan [242]. For the option ContainerMappingIds, there is additional parameter SkipValidation; items from Staging area will be deleted without core check, so also items which were not ingested yet and have NULL value stored for columns ImportStartedDateUtc and ImportedDateUtc in ItemRouting table will be deleted from Staging area.  

In case LinkIds are used for cleanup there is additional parameter IncludeDeletedMappings.

Example:

Start-ASStagingAreaCleanup -ContainerMappingId 1 -ItemAge OlderThanConfiguredHours

Start-ASStagingAreaCleanup -ContainerMappingId 1,2,3 -ItemAge All​

Start-ASStagingAreaCleanup -ContainerMappingId 1,2,3 -ItemAge All -SkipValidation​

/* Removes legacy files of certain age from staging area of specified container mapping */

/* Removes legacy files from staging area of specified list of container mappings */​

/* Removes legacy files from staging area of specified list of container mappings without core check */

Start-ASStagingAreaCleanup -LinkId e438fb86-4574-490a-8bc4-4d3ec58c65be -ItemAge All

 

 

Start-ASStagingAreaCleanup -LinkId e438fb86-4574-490a-8bc4-4d3ec58c65be -ItemAge All -IncludeDeletedMappingItems

/* Removes all legacy files from staging area of specified link. Basically it will find all container mappings related to specified link and cleans the legacy files */

/* Removes all legacy files from staging area of specified link. and includes also data of already deleted mappings */

​

​Get-ASLink -Type EnterpriseVault | ForEach-Object {Start-ASStagingAreaCleanup -LinkId $_.LinkId -ItemAge OlderThanConfiguredHours -IncludeDeletedMappingItems}

/* Retrieves all EnterpriseVault links and then removes all legacy files from staging area (files of deleted mappings included) */​

Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen