サポートと今すぐチャット
サポートとのチャット

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

Set-ASWorkflowPolicyStep

SYNOPSIS

Set command to workflow policy.

SYNTAX

Set-ASWorkflowPolicyStep [-Core] <ConnectCore> [-WorkflowSequenceId] <int> -WorkflowPolicyId] [<int>-CommandId] <int>] [[-SequenceOrder] <int>] [[-WorkflowTriggerDefinition] [<WorkflowTriggerDefinitionEnum[]>-IsWaitOnAllPrevious] [<bool>

-RunInParallelWithPrevious] [<bool>-RetryFailed] [<bool>-RetryFailedAfterMinutes] [<int>-RetryUnresponsive] [<bool>-RetryUnresponsiveAfterMinutes] [<int>-IsContainerGranularityOnly] [<bool> [<CommonParameters>]

DESCRIPTION

The Set-ASWorkflowPolicyStep cmdlet updates workflow policy step = updates step of workflow policy. 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:

Set-ASWorkflowPolicyStep -WorkflowPolicyId 48 -WorkflowSequenceId 265 -SequenceOrder 0

​/* Changes order of specified Workflow Step within defined Workflow Policy */

Set-ASWorkflowPolicyStep -WorkflowPolicyId 48 -WorkflowSequenceId 265 -WorkflowTriggerDefinition NoTrigger -RunInParallelWithPrevious 0 -RetryFailed 0 -RetryFailedAfterMinutes 10

​​/* Changes various settings of specified Workflow Step within defined Workflow Policy */

​Get-ASWorkflowPolicyStep -WorkflowPolicyId 48 | Set-ASWorkflowPolicyStep -WorkflowTriggerDefinition NoTrigger -RetryFailed 1 -RetryFailedAfterMinutes 120

​​​/* Retrieves all Workflow Steps of specified Workflow Policy and then sets various settings for each */

Add-ASFilterPolicy

SYNOPSIS

Add new filter policies.

SYNTAX

Add-ASFilterPolicy [[-Core] <ConnectCore>] [[-Name] <string[]>] [<CommonParameters>]

DESCRIPTION

The Add-ASFilterPolicy cmdlet adds new Filter Policies. The Filter Policy can be used as an input parameter for the Add-ASContainerMapping command. 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:

Add-ASFilterPolicy -Name "NEW FILTER POLICY NAME

/* Creates new Filter Policy (filter condition is required to be created afterwards) */

Add-ASFilterCondition

SYNOPSIS

Add new filter condition.

SYNTAX

Add-ASFilterCondition [[-Core] <ConnectCore>] [-FilterPolicyId] <int[]> [-FilterDefinition] <FilterDefinitionEnum> [-Operator] <FilterOperatorEnum> [-Value] <DateTime/long/bool/string> [-Unit] <FilterDefinitionItemSizeUnitEnum> [<CommonParameters>]

DESCRIPTION

The Add-ASFilterCondition cmdlet adds new filter condition for existing filter policy. You have to add value in according to filter definition type. These are DateTime (ArchivedDate,ItemDate), string (Path,RetentionCategory), long (ItemSize) and boolean (HasLegalHold). 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:

FilterPolicyId, ConditionDefinition

 

Patameters according to ConditionDefinition value:

For ArchivedDate and ItemDate: Operator (Equal/YoungerThan/OlderThan/NotEqual/Like/NotLike), Value

For Path: Operator (Equal/NotEqual/Like/NotLike), Value

For RetentionCategory: Operator (Equal/GreaterEqual/GreaterThan/LessEqual/LesserThan/NotEqual/Like), Value

For HasShortcut : no more parameters

For ItemSize: Operator (Equal/NotEqual/Like/NotLike), Value, Unit (B, KiB, MiB, GiB)

For HasLegalHold: Value (True/False)

 

Example:

Add-ASFilterCondition -FilterPolicyId 3 -FilterDefinition HasShortcut

/* Creates new Filter Condition for specified Filter Policy */

$filtePolicy = Add-ASFilterPolicy -Name "ARCHIVED DATE 01/01/2016"

Add-ASFilterCondition -FilterPolicyId $filtePolicy.FilterPolicyId -FilterDefinition ArchivedDate -Operator YoungerThan -Value "2016-1-1"

Add-ASFilterCondition -FilterPolicyId $filtePolicy.FilterPolicyId -FilterDefinition ArchivedDate -Operator OlderThan -Value "2016-1-2"

/* First creates new Filter Policy then two new Filter Conditions to filter out items archived at 01/01/2016 only */

Get-ASFilterPolicy -Name "FPNAME" | Add-ASFilterCondition -FilterDefinition ItemDate -Operator Equal -Value "2016-1-1"

/* Creates new Filter Condition for specified Filter Policy */

Get-ASFileNamePolicy

SYNOPSIS

Get file name policy.

SYNTAX

Get-ASFileNamePolicy [-Core] <ConnectCore> -FileNamePolicyId] [<int> [[-Name] <string>] [<CommonParameters>]

DESCRIPTION

The Get-ASFileNamePolicy cmdlet gets file name policy. 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-ASFileNamePolicy

​/* Retrieves all file name policies */

Get-ASFileNamePolicy -Name Ownerless

​/* Retrieves only specified file name policy */

 

関連ドキュメント

The document was helpful.

評価を選択

I easily found the information I needed.

評価を選択