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

Set-ASWatermark

SYNOPSIS

Sets low or high watermark of link path.

SYNTAX

Set-ASWatermark [-Core] <ConnectCore> [-LinkId] <Guid[]> [-LowWatermark] <long[]> [-HighWatermark] <long[]> [[-Type] <WatermarkType(StagingAreaPath/PstOutputPath)>] [<CommonParameters>]

DESCRIPTION

The Set-ASWatermark cmdlet sets value for low or high watermark of links staging area path (-Type StagingAreaPath) or PST output path (-Type PstOutputPath). If no LinkId is set, it will set staging area watermark values of all links. If no Type is specified, StagingAreaPath type will be used as default. 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.

 

Staging Area:

LowWaterMark - If the free disk space on a links' staging area drops below this value, exporting of new data will be suspended.

HighWaterMark - If the amount of data which has been exported, but not imported for a particular link exceeds this value, exporting of new data will be suspended.

 

PST Output Path:

LowWatermark: If the free disk space where the PST output path folder is located drops below this value, moving of PST files from staging area will be suspended.

HighWatermark: If the amount of data within the PST output path exceeds this value, moving of PST files from staging area will be suspended.

 

Example:

Set-ASWatermark -LowWatermark 1474836480 -HighWatermark 1474836480

Set-ASWatermark -Type StagingAreaPath -LowWatermark 1474836480 -HighWatermark 1474836480

Set-ASWatermark -Type PstOutputPath -LowWatermark 1474836480 -HighWatermark 1474836480

​/* ​Sets watermark 1 GB for all staging area paths existing in Archive Shuttle system */

/* ​​Sets watermark 1 GB for all staging area paths existing in Archive Shuttle system */

/* ​Sets watermark 1 GB for all PST Output paths of PST links existing in Archive Shuttle system */

Set-ASWatermark -LinkId "e4b4d6e1-10e4-4bdd-8adb-ff8605b81538" -LowWatermark 5474836480 -HighWatermark 5474836480

​​/* ​Sets watermark for staging area related to specified link */

Get-ASLink -LinkName "EnterpriseVault10" | Set-ASWatermark -LowWatermark 15474836480 -HighWatermark 5474836480

​​​/* ​Sets watermark for staging area related to specified link */

Get-ASRetentionCategory

SYNOPSIS

Gets retention category.

SYNTAX

Get-ASRetentionCategory [[-Core] <ConnectCore>] [[-Name] <string[]>] [[-EVSiteId] <string[]>] [[-EVRetentionCategoryId] <string[]>] [<CommonParameters>]

DESCRIPTION

The Get-EVRetentionCategory return EV retention category. 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-ASRetentionCategory

​/* Retrieves all EV Retention Categories */

Get-ASRetentionCategory -EVRetentionCategoryId 173E142CD3FDE11479691B286FF8B920B1b10000QA-EV10-01.qa.lab.quadrotech-it.com

​​/* Retrieves specified EV Retention Category based on Retention Category ID*/

Get-ASRetentionCategory | Where-Object { $_.Name -like "TEST*"}| Format-Table -AutoSize

​​​/* Retrieves all EV Retention Categories with name starting with "TEST" + results are formatted in table */

Get-ASEVRetentionCategoryMapping

SYNOPSIS

Get retention category mapping.

SYNTAX

Get-ASEVRetentionCategoryMapping [-Core] <ConnectCore> -SourceSiteName] [<string>-SourceSiteId] [<string>-SourceRetentionCategoryName] <string>] [[-SourceRetentionCategoryId] <string>] [[-TartgetSiteName] [<string>-TartgetSiteId] [<string>

-TartgetRetentionCategoryName] [<string>-TartgetRetentionCategoryId] [<string> [<CommonParameters>]

DESCRIPTION

The Get-ASEVRetentionCategoryMapping cmdlet gets retention category mapping. 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-ASEVRetentionCategoryMapping -IncludeTotalCount

​/* Retrieves all Enterprise Vault retention category mappings and total count of results */

​Get-ASEVRetentionCategoryMapping -SourceSiteName "EV12" | Format-Table -AutoSize

​/* Retrieves only Enterprise Vault retention category mappings of specified Enterprise Vault site */

Add-ASEVRetentionCategoryMapping

SYNOPSIS

Add retention category mapping.

SYNTAX

Add-ASEVRetentionCategoryMapping [-Core] <ConnectCore> [-Intrasite] <SwitchParameter> [-SourceEVRetentionCategoryId] <SwitchParameter> [-SourceEVSite] <string> [-SourceRetentionCategoryName] <string>[-TargetEVRetentionCategoryId] <string> [-TargetO365RetentionId] <string>[[-TargetEVSite] <string>] [[-TargetO365LinkId] <string>] [-TargetRetentionName] <string> [<CommonParameters>]

DESCRIPTION

The Add-ASEVRetentionCategoryMapping cmdlet creates new retention category mapping. 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:

​Add-ASEVRetentionCategoryMapping -Intrasite

​​​/* Creates mapping for all intrasite retention categories (UI action button "Add Intrasite Migration Mappings") */

​Add-ASEVRetentionCategoryMapping -SourceEVSite "EV10" -SourceRetentionCategoryName "Name1"

TargetEVSite "EV12" -TargetRetentionName "Name2"

​​​​/* Creates retention maping with specified parameters for EV Extrasite migrations */​

Add-ASEVRetentionCategoryMapping -SourceEVSite "EV10"-SourceRetentionCategoryName "Name1" -TargetO365 "O365GUID" -TargetRetentionName "O365TAG"

​/* Creates retention maping with specified parameters for EV to O365 migrations - feature message stamping with O365 retention tag*/​

Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen