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

Add-ASSettingDefinitionToSchedule

SYNOPSIS

Add Archive Shuttle setting definition into schedule.

SYNTAX

Add-ASSettingDefinitionToSchedule [-Core] <ConnectCore> [-SettingDefinitionId] [<int>] [-SettingSchedulerId] [<SettingSchedulerId>] -DefaultValueNumeric] [<long>-DefaultValueText] [<string> [<CommonParameters>]

DESCRIPTION

The Add-ASSettingDefinitionToSchedule cmdlet creates relation between schedule and setting definition. 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-ASSettingDefinitionToSchedule -SettingSchedulerId 1 -SettingDefinition EVCollectorParallelism -DefaultValueNumeric 12​

​/* Adds custom configuration parameter into specified schedule profile

Get-ASFailedItemThreshold

SYNOPSIS

Gets failed item threshold.

SYNTAX

Get-ASFailedItemThreshold [-Core] <ConnectCore> [-LinkId] <Guid[]> [-ContainerMappingId] <int[]> [-GetAll] <SetFailedItemThresholdTable> [<CommonParameters>]

DESCRIPTION

The Get-ASFailedItemThreshold cmdlet returns value of Failed item threshold. 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:

Get-ASFailedItemThreshold  -GetAll  Link  

Get-ASFailedItemThreshold  -GetAll  ContainerMapping

​​/* ​Retrieves threshold for all links or all containers */

Get-ASFailedItemThreshold  -LinkId  "5bb2fc14-5cc1-461d-951c-ff0618b27883"

​/* Retrieves threshold for specified link only */

Get-ASLink  -Type  EnterpriseVault  |  Get-ASFailedItemThreshold

​​/* ​Retrieves threshold for Enterprise Vault links only */

Get-ASFailedItemThreshold  -GetAll  Link  |  Where-Object {$_.FailedItemThreshold  -eq  2}

​​/* ​Retrieves all links with threshold=2 */

Set-ASFailedItemThreshold

SYNOPSIS

Sets failed item threshold.

SYNTAX

Set-ASFailedItemThreshold [-Core] <ConnectCore> [-LinkId] <Guid[]> [-ContainerMappingId] <int[]> [-SetAll] <SetFailedItemThresholdTable> [-FailedItemThreshold] <int[]> [<CommonParameters>]

DESCRIPTION

The Set-ASFailedItemThreshold cmdlet Sets value for Failed item threshold. 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.

There are three variations of parameters:

1.LinkId, FailedItemThreshold

2.ContainerMappingId, FailedItemThreshold

3.SetAll(None/Link/ContainerMapping), FailedItemThreshold

Example:

Set-ASFailedItemThreshold -FailedItemThreshold 1 -LinkId "83139672-f03c-e611-813c-005056b84ed8"

​/* ​Sets threshold for specified link only */

Set-ASFailedItemThreshold -FailedItemThreshold 1 -ContainerMappingId 1

​​/* Sets threshold for specified mapping only (it's possible to enter multiple mappingIds separated by comma) */

Set-ASFailedItemThreshold -FailedItemThreshold 1 -SetAll ContainerMapping

​/* Sets threshold for all existing mappings (can be also set for all existing links) */

Get-ASLink -Type EnterpriseVault | Set-ASFailedItemThreshold -FailedItemThreshold 1

​​/* Sets threshold for all EV links only */

Get-ASWatermark

SYNOPSIS

Gets low or high watermark of link path.

SYNTAX

Get-ASWatermark [-Core] <ConnectCore> [-LinkId] <Guid[]> [[-Type] <WatermarkType>] [<CommonParameters>]

DESCRIPTION

The Get-ASWatermark cmdlet gets 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 return 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. 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:

Get-ASWatermark

Get-ASWatermark -LinkId "f3872fec-d9dd-459d-8e2b-c68156a9d81e" -Type StagingAreaPath -LowWatermark 1474836480 -HighWatermark 1474836480

Get-ASWatermark -LinkId "f3872fec-d9dd-459d-8e2b-c68156a9d81e" -Type PstOutputPath -LowWatermark 1474836480 -HighWatermark 1474836480

/* ​Retrieves staging area watermarks for all links*/

/* ​Retrieves staging area watermarks of specified link*/

/* ​Retrieves PST output path watermarks of specified PST link*/

Get-ASWatermark -LinkId "f3872fec-d9dd-459d-8e2b-c68156a9d81e"

​/* Retrieves staging area watermarks for specified link */

Get-ASLink -LinkName "EnterpriseVault10" |Get-ASWatermark

/* Retrieves staging area watermarks of link with specified name */

Get-ASLink -Type EnterpriseVault | Get-ASWatermark

​/* Retrieves staging area  watermarks for all Enterprise Vault links */

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating