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

Set-ASContainerMapping

SYNOPSIS

Sets attributes of existing container mapping.

SYNTAX

Set-ASContainerMapping [-Core] <ConnectCore> [-ContainerMappingId] <int[]> [[-WorkflowPolicyId] <int>] [[-FilterPolicyId] <int>] [[-MigrationEnabled] <bool>] [[-ItemGatheringEnabled] <bool>] [[-Priority] <byte>] [[-ItemGatheringScheduleDateTime]

<DateTime>] [[-MigrationScheduleDateTime] <DateTime>] [[-ContainerMappingTemplateId] <int?>] [[-UserDefinedTokenValue] <string>] [[-UseRecipientsCollectedViaEVIndexForExport] <bool>] [[-DefaultRolloverBytes] <long?>] [[-DefaultRolloverItemCount] <int?>]

[[-TargetPathNamePolicyId] <int>] [[-PreMigrationWorkflowPolicyId] <int>] [<CommonParameters>]

DESCRIPTION

The Set-ASContainerMapping cmdlet sets various variables of container mapping,  After the command is executed, the mapping can be checked in the Archive Shuttle user interface. All parameters in the cmdlet are mandatory except FilterPolicyId. You can specify core as a parameter, or call Connect-ASCore once and the core parameter will be automatically added from the session state. DateTime parameters should be specified in UTC format.

Example:

Set-ASContainerMapping -ContainerMappingId 2 -WorkflowPolicyId 6 -FilterPolicyId 1 -Priority 10 -MigrationEnabled 0 -ItemGatheringEnabled 0

​/* Sets existing mapping parameters */

Set-ASContainerMapping -ContainerMappingId 1 -Priority 10

​/* Sets priority of specified container mapping */

​Set-ASContainerMapping -ContainerMappingId 1 -ItemGatheringScheduleDateTime ((GET-DATE).AddDays(1).ToUniversalTime()) -MigrationScheduleDateTime ((GET-DATE).AddDays(1).ToUniversalTime())

/* By specifying highlighted parameters (DateTimeUTC), it is posible to postpone item collection or migration of the mapping (in case it wasn't already enabled) */​

Set-ASContainerMapping -ContainerMappingId 1 -ContainerMappingTemplateId 1

Set-ASContainerMapping -ContainerMappingId 1 -ContainerMappingTemplateId 0

Set-ASContainerMapping -ContainerMappingId 2 -UserDefinedTokenValue UDTV

/* Assigns mapping template to specified container mapping */​

/* Removes mapping template assignment from specified container mapping */​​

/* Assigns User defined token value for specified Container Mapping */

​Set-ASContainerMapping  -ContainerMappingId 1 -DefaultRolloverBytes 524288000 -DefaultRolloverItemCount 600

​/* Set DefaultRolloverThreshold bytes and DefaultRolloverItem count for mappings to PST - Threshold will be ignored for mappings with already finished routing */​​

Set-ASContainerMapping -ContainerMappingId 1 -PreMigrationWorkflowPolicyId 107

/* Set PreMigrationWorkflowPolicy for mapping */

Get-ASBulkMappingWizardTemplate

SYNOPSIS

Gets bulk mapping wizard templates.

SYNTAX

Get-ASBulkMappingWizardTemplate [-Core] <ConnectCore> [[-BulkMappingWizardTemplateId] <int>] [[-BulkMappingWizardTemplateName] <string>] [[-ContainerMappingId] <int>] [<CommonParameters>]

DESCRIPTION

The Get-ASBulkMappingWizardTemplate will return mapping templates. 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-ASBulkMappingWizardTemplate | Where-Obect{$_.Name -like 'Ev2*'}

​/* Retrieves all bulk mapping wizard templates templates with name begins with "EV2"*/

Get-ASBulkMappingWizardTemplate -BulkMappingWizardTemplateId 7

​/*Retrieves bulk mapping wizard templates template with id 7 */

Get-ASMappings

SYNOPSIS

Displays information about containers mappings.

SYNTAX

Get-ASMappings -Core] <ConnectCore>] [[-ContainerMappingId] <int[]>] [[-ContainerId] <Guid>] [[-ContainerMappingType] <ContainerMappingType>] [[-IncludeVirtualJournalSubmappings] [<SwitchParameter> [[-Skip] <uint64>] [[-First] <uint64>] [<CommonParameters>]

DESCRIPTION

The Get-ASMappings cmdlet gets data regarding a specified container mapping or mappings. Results contain: Container Mapping Id, Source Container Name, Target Container Name, Item Gathering Enabled, Migration Enabled, Stage 2 Enabled, Stage 2 Finished and VirtualJournalMasterMappingId. By default, all container mapping details are displayed after the command executes. 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:

​Get-ASMappings | Select-Object ContainerMappingId,SourceContainer | Sort-Object SourceContainer

​/* Retrieves first 1000 mappings, sorted by SourceContainer

​Get-ASMappings -ContainerMappingId 1

​Get-ASMappings -ContainerMappingId 1,2,3

Get-ASMappings -All

​/* Retrieves mapping with exact mapping ID */

/* Retrieves array of mappings based on entered mapping ids */

/* Retrieves all existing mappings */

​Get-ASMappings -ContainerId "0c9119c5-1c9a-439b-9067-03f70aeb125a" -ContainerMappingType Source

​/* Retrieves mappings which contain specified container ID as a source */

​​Get-ASMappings -IncludeVirtualJournalSubmappings​

 

 

Get-ASMappings-ContainerMappingId1-IncludeVirtualJournalSubmappings|Where-Object {$_.VirtualJournalMasterContainerMappingId -ne$null }

/* Retrieves also submappings of virtual journal */​

 

 

/* Retrieves only submappings of specified virtual journal master mapping */

 

 

Get-ASPremigrationStatus

SYNOPSIS

Show pre-migration information.

SYNTAX

Get-ASPremigrationStatus [[-Core] <ConnectCore>] [[-ContainerMappingId] <int[]>] [[-All] <int[]>] [[-Skip] <uint64>] [[-First] <uint64>] [<CommonParameters>]

DESCRIPTION

The Get-ASPremigrationStatus cmdlet gets information about Pre-migration for specified container mappings. By default, all container mapping Pre-migration information is returned after the command executes. 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:

Get-ASPremigrationStatus

/* Retrieves pre-migration statuses of all container mappings */

Get-ASPremigrationStatus -ContainerMappingId 1

/* Retrieves pre-migration status of a specific container mapping */

Get-ASPremigrationStatus -First 2

Get-ASPremigrationStatus -Skip 2

/* Retrieves pre-migration status of first 2 container mappings */

/* Skip 2 pre-migration statuses */

Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen